Load Settings

GET /api/settings

Load Settings

cURL

curl --request GET \
  --url https://app.all-hands.dev/api/settings \
  --header 'X-Session-API-Key: <api-key>'

import requests

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

headers = {"X-Session-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Session-API-Key': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Session-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.all-hands.dev/api/settings")
  .header("X-Session-API-Key", "<api-key>")
  .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::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'

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

200

{
  "llm_api_key_set": true,
  "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>",
  "provider_tokens_set": {},
  "search_api_key_set": false
}

{}

{}

Authorizations

X-Session-API-Key · string · header · required

Response

200

application/json

Successful Response

Settings with additional token data for the frontend

llm_api_key_set · boolean · required

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

provider_tokens_set · Provider Tokens Set · object | null

Show child attributes

search_api_key_set · boolean · default: false