Skip to main content
PATCH
Update Org

Authorizations

X-Access-Token
string
header
required

Headers

X-Org-Id
string | null

Path Parameters

org_id
string<uuid> | null
required

Body

application/json

Request model for updating an organization.

agent_settings_diff and conversation_settings_diff are sparse diffs that are deep-merged into the org row and then validated as full settings before persistence.

name
string | null
Required string length: 1 - 255
contact_name
string | null
contact_email
string<email> | null
conversation_expiration
integer | null
remote_runtime_resource_factor
integer | null
Required range: x > 0
billing_margin
number | null
Required range: 0 <= x <= 1
enable_proactive_conversation_starters
boolean | null
sandbox_base_container_image
string | null
sandbox_runtime_container_image
string | null
sandbox_api_key
string | null
max_budget_per_task
number | null
Required range: x > 0
v1_enabled
boolean | null
search_api_key
string | null
llm_api_key
string | null
agent_settings_diff
Agent Settings Diff · object | null
conversation_settings_diff
Conversation Settings Diff · object | null

Response

Successful Response

Response model for organization.

id
string
required
name
string
required
contact_name
string
required
contact_email
string
required
conversation_expiration
integer | null
remote_runtime_resource_factor
integer | null
billing_margin
number | null
enable_proactive_conversation_starters
boolean
default:true
sandbox_base_container_image
string | null
sandbox_runtime_container_image
string | null
org_version
integer
default:0
agent_settings
OpenHandsAgentSettings · object

Settings for a standard LLM-backed :class:Agent.

This is the long-standing AgentSettings shape; fields here build the default Agent (LLM + tools + MCP + condenser + critic).

conversation_settings
ConversationSettings · object
search_api_key
string | null
sandbox_api_key
string | null
max_budget_per_task
number | null
v1_enabled
boolean | null
credits
number | null
is_personal
boolean
default:false