Update User Settings

Update the current user’s settings and preferences.

POST /api/v1/settings

Update User Settings

cURL

curl --request POST \
  --url https://app.all-hands.dev/api/v1/settings \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Token: <api-key>' \
  --data '
{
  "language": "<string>",
  "agent": "<string>",
  "max_iterations": 123,
  "security_analyzer": "<string>",
  "confirmation_mode": true,
  "llm_model": "<string>",
  "llm_api_key": "<string>",
  "llm_base_url": "<string>",
  "user_version": 123,
  "remote_runtime_resource_factor": 123,
  "secrets_store": {
    "provider_tokens": {},
    "custom_secrets": {}
  },
  "enable_default_condenser": true,
  "enable_sound_notifications": false,
  "enable_proactive_conversation_starters": true,
  "enable_solvability_analysis": true,
  "user_consents_to_analytics": true,
  "sandbox_base_container_image": "<string>",
  "sandbox_runtime_container_image": "<string>",
  "mcp_config": {
    "sse_servers": [
      {
        "url": "<string>",
        "api_key": "<string>"
      }
    ],
    "stdio_servers": [
      {
        "name": "<string>",
        "command": "<string>",
        "args": [
          "<string>"
        ],
        "env": {}
      }
    ],
    "shttp_servers": [
      {
        "url": "<string>",
        "api_key": "<string>",
        "timeout": 60
      }
    ]
  },
  "disabled_skills": [
    "<string>"
  ],
  "search_api_key": "<string>",
  "sandbox_api_key": "<string>",
  "max_budget_per_task": 123,
  "condenser_max_size": 123,
  "email": "<string>",
  "email_verified": true,
  "git_user_name": "<string>",
  "git_user_email": "<string>",
  "v1_enabled": true,
  "sandbox_grouping_strategy": "NO_GROUPING"
}
'

200

{}

Authorizations

X-Access-Token · string · header · required

Body

application/json

Persisted settings for OpenHands sessions

language · string | null

agent · string | null

max_iterations · integer | null

security_analyzer · string | null

confirmation_mode · boolean | null

llm_model · string | null

llm_api_key · string<password> | null

llm_base_url · string | null

user_version · integer | null

remote_runtime_resource_factor · integer | null

secrets_store · Secrets · object

Show child attributes

enable_default_condenser · boolean · default: true

enable_sound_notifications · boolean · default: false

enable_proactive_conversation_starters · boolean · default: true

enable_solvability_analysis · boolean · default: true

user_consents_to_analytics · boolean | null

sandbox_base_container_image · string | null

sandbox_runtime_container_image · string | null

mcp_config · MCPConfig · object

Configuration for MCP (Message Control Protocol) settings.

Attributes: sse_servers: List of MCP SSE server configs stdio_servers: List of MCP stdio server configs. These servers will be added to the MCP Router running inside runtime container. shttp_servers: List of MCP HTTP server configs.

Show child attributes

disabled_skills · string[] | null

search_api_key · string<password> | null

sandbox_api_key · string<password> | null

max_budget_per_task · number | null

condenser_max_size · integer | null

email · string | null

email_verified · boolean | null

git_user_name · string | null

git_user_email · string | null

v1_enabled · boolean · default: true

sandbox_grouping_strategy · enum<string> · default: NO_GROUPING

Strategy for grouping conversations within sandboxes.

Available options: NO_GROUPING, GROUP_BY_NEWEST, LEAST_RECENTLY_USED, FEWEST_CONVERSATIONS, ADD_TO_ANY

Response

200

application/json

Settings stored successfully

The response is of type Response 200 Store Settings Api V1 Settings Post · object.