Store Settings

POST /api/settings

Store Settings

cURL

curl --request POST \
  --url https://app.all-hands.dev/api/settings \
  --header 'Content-Type: application/json' \
  --header 'X-Session-API-Key: <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>",
  "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>"
      }
    ]
  },
  "search_api_key": "<string>",
  "sandbox_api_key": "<string>",
  "max_budget_per_task": 123,
  "email": "<string>",
  "email_verified": true,
  "git_user_name": "<string>",
  "git_user_email": "<string>"
}
'

import requests

url = "https://app.all-hands.dev/api/settings"

payload = {
    "language": "<string>",
    "agent": "<string>",
    "max_iterations": 123,
    "security_analyzer": "<string>",
    "confirmation_mode": True,
    "llm_model": "<string>",
    "llm_api_key": "<string>",
    "llm_base_url": "<string>",
    "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>"
            }
        ]
    },
    "search_api_key": "<string>",
    "sandbox_api_key": "<string>",
    "max_budget_per_task": 123,
    "email": "<string>",
    "email_verified": True,
    "git_user_name": "<string>",
    "git_user_email": "<string>"
}
headers = {
    "X-Session-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Session-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    language: '<string>',
    agent: '<string>',
    max_iterations: 123,
    security_analyzer: '<string>',
    confirmation_mode: true,
    llm_model: '<string>',
    llm_api_key: '<string>',
    llm_base_url: '<string>',
    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>'}]
    },
    search_api_key: '<string>',
    sandbox_api_key: '<string>',
    max_budget_per_task: 123,
    email: '<string>',
    email_verified: true,
    git_user_name: '<string>',
    git_user_email: '<string>'
  })
};

fetch('https://app.all-hands.dev/api/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.all-hands.dev/api/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'language' => '<string>',
    'agent' => '<string>',
    'max_iterations' => 123,
    'security_analyzer' => '<string>',
    'confirmation_mode' => true,
    'llm_model' => '<string>',
    'llm_api_key' => '<string>',
    'llm_base_url' => '<string>',
    '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>'
                ]
        ]
    ],
    'search_api_key' => '<string>',
    'sandbox_api_key' => '<string>',
    'max_budget_per_task' => 123,
    'email' => '<string>',
    'email_verified' => true,
    'git_user_name' => '<string>',
    'git_user_email' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Session-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.all-hands.dev/api/settings"

	payload := strings.NewReader("{\n  \"language\": \"<string>\",\n  \"agent\": \"<string>\",\n  \"max_iterations\": 123,\n  \"security_analyzer\": \"<string>\",\n  \"confirmation_mode\": true,\n  \"llm_model\": \"<string>\",\n  \"llm_api_key\": \"<string>\",\n  \"llm_base_url\": \"<string>\",\n  \"remote_runtime_resource_factor\": 123,\n  \"secrets_store\": {\n    \"provider_tokens\": {},\n    \"custom_secrets\": {}\n  },\n  \"enable_default_condenser\": true,\n  \"enable_sound_notifications\": false,\n  \"enable_proactive_conversation_starters\": true,\n  \"enable_solvability_analysis\": true,\n  \"user_consents_to_analytics\": true,\n  \"sandbox_base_container_image\": \"<string>\",\n  \"sandbox_runtime_container_image\": \"<string>\",\n  \"mcp_config\": {\n    \"sse_servers\": [\n      {\n        \"url\": \"<string>\",\n        \"api_key\": \"<string>\"\n      }\n    ],\n    \"stdio_servers\": [\n      {\n        \"name\": \"<string>\",\n        \"command\": \"<string>\",\n        \"args\": [\n          \"<string>\"\n        ],\n        \"env\": {}\n      }\n    ],\n    \"shttp_servers\": [\n      {\n        \"url\": \"<string>\",\n        \"api_key\": \"<string>\"\n      }\n    ]\n  },\n  \"search_api_key\": \"<string>\",\n  \"sandbox_api_key\": \"<string>\",\n  \"max_budget_per_task\": 123,\n  \"email\": \"<string>\",\n  \"email_verified\": true,\n  \"git_user_name\": \"<string>\",\n  \"git_user_email\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Session-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.all-hands.dev/api/settings")
  .header("X-Session-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"language\": \"<string>\",\n  \"agent\": \"<string>\",\n  \"max_iterations\": 123,\n  \"security_analyzer\": \"<string>\",\n  \"confirmation_mode\": true,\n  \"llm_model\": \"<string>\",\n  \"llm_api_key\": \"<string>\",\n  \"llm_base_url\": \"<string>\",\n  \"remote_runtime_resource_factor\": 123,\n  \"secrets_store\": {\n    \"provider_tokens\": {},\n    \"custom_secrets\": {}\n  },\n  \"enable_default_condenser\": true,\n  \"enable_sound_notifications\": false,\n  \"enable_proactive_conversation_starters\": true,\n  \"enable_solvability_analysis\": true,\n  \"user_consents_to_analytics\": true,\n  \"sandbox_base_container_image\": \"<string>\",\n  \"sandbox_runtime_container_image\": \"<string>\",\n  \"mcp_config\": {\n    \"sse_servers\": [\n      {\n        \"url\": \"<string>\",\n        \"api_key\": \"<string>\"\n      }\n    ],\n    \"stdio_servers\": [\n      {\n        \"name\": \"<string>\",\n        \"command\": \"<string>\",\n        \"args\": [\n          \"<string>\"\n        ],\n        \"env\": {}\n      }\n    ],\n    \"shttp_servers\": [\n      {\n        \"url\": \"<string>\",\n        \"api_key\": \"<string>\"\n      }\n    ]\n  },\n  \"search_api_key\": \"<string>\",\n  \"sandbox_api_key\": \"<string>\",\n  \"max_budget_per_task\": 123,\n  \"email\": \"<string>\",\n  \"email_verified\": true,\n  \"git_user_name\": \"<string>\",\n  \"git_user_email\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.all-hands.dev/api/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Session-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"language\": \"<string>\",\n  \"agent\": \"<string>\",\n  \"max_iterations\": 123,\n  \"security_analyzer\": \"<string>\",\n  \"confirmation_mode\": true,\n  \"llm_model\": \"<string>\",\n  \"llm_api_key\": \"<string>\",\n  \"llm_base_url\": \"<string>\",\n  \"remote_runtime_resource_factor\": 123,\n  \"secrets_store\": {\n    \"provider_tokens\": {},\n    \"custom_secrets\": {}\n  },\n  \"enable_default_condenser\": true,\n  \"enable_sound_notifications\": false,\n  \"enable_proactive_conversation_starters\": true,\n  \"enable_solvability_analysis\": true,\n  \"user_consents_to_analytics\": true,\n  \"sandbox_base_container_image\": \"<string>\",\n  \"sandbox_runtime_container_image\": \"<string>\",\n  \"mcp_config\": {\n    \"sse_servers\": [\n      {\n        \"url\": \"<string>\",\n        \"api_key\": \"<string>\"\n      }\n    ],\n    \"stdio_servers\": [\n      {\n        \"name\": \"<string>\",\n        \"command\": \"<string>\",\n        \"args\": [\n          \"<string>\"\n        ],\n        \"env\": {}\n      }\n    ],\n    \"shttp_servers\": [\n      {\n        \"url\": \"<string>\",\n        \"api_key\": \"<string>\"\n      }\n    ]\n  },\n  \"search_api_key\": \"<string>\",\n  \"sandbox_api_key\": \"<string>\",\n  \"max_budget_per_task\": 123,\n  \"email\": \"<string>\",\n  \"email_verified\": true,\n  \"git_user_name\": \"<string>\",\n  \"git_user_email\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{}

Authorizations

X-Session-API-Key · 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

remote_runtime_resource_factor · integer | null

secrets_store · UserSecrets · 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 | null

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

search_api_key · string<password> | null

sandbox_api_key · string<password> | null

max_budget_per_task · number | null

email · string | null

email_verified · boolean | null

git_user_name · string | null

git_user_email · string | null

Response

200

application/json

Settings stored successfully

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