Validate Profile
curl --request POST \
--url https://api.example.com/api/profiles/{name}/validate \
--header 'Content-Type: application/json' \
--header 'X-Session-API-Key: <api-key>' \
--data '
{
"llm": {
"api_key": "<string>",
"api_mode": "auto",
"api_version": "<string>",
"auth_type": "api_key",
"aws_access_key_id": "<string>",
"aws_bedrock_runtime_endpoint": "<string>",
"aws_profile_name": "<string>",
"aws_region_name": "<string>",
"aws_role_name": "<string>",
"aws_secret_access_key": "<string>",
"aws_session_name": "<string>",
"aws_session_token": "<string>",
"base_url": "<string>",
"caching_prompt": true,
"capability_overrides": {},
"custom_tokenizer": "<string>",
"disable_stop_word": false,
"disable_vision": true,
"drop_params": true,
"enable_encrypted_reasoning": true,
"extended_thinking_budget": 200000,
"extra_headers": {},
"fallback_strategy": {
"fallback_llms": [
"<string>"
],
"profile_store_dir": "<string>"
},
"force_string_serializer": true,
"inline_image_urls": true,
"input_cost_per_token": 1,
"litellm_extra_body": {},
"log_completions": false,
"log_completions_folder": "logs/completions",
"max_input_tokens": 2,
"max_message_chars": 30000,
"max_output_tokens": 2,
"model": "gpt-5.6",
"model_canonical_name": "<string>",
"native_tool_calling": true,
"num_retries": 5,
"ollama_base_url": "<string>",
"openrouter_app_name": "OpenHands",
"openrouter_site_url": "https://docs.all-hands.dev/",
"output_cost_per_token": 1,
"prompt_cache_retention": "24h",
"provider_connection_id": "<string>",
"reasoning_effort": "high",
"retry_max_wait": 64,
"retry_min_wait": 8,
"retry_multiplier": 8,
"seed": 123,
"stream": false,
"stream_idle_timeout": 300,
"subscription_vendor": "openai",
"temperature": 1,
"timeout": 300,
"top_k": 1,
"top_p": 0.5,
"usage_id": "default"
}
}
'import requests
url = "https://api.example.com/api/profiles/{name}/validate"
payload = { "llm": {
"api_key": "<string>",
"api_mode": "auto",
"api_version": "<string>",
"auth_type": "api_key",
"aws_access_key_id": "<string>",
"aws_bedrock_runtime_endpoint": "<string>",
"aws_profile_name": "<string>",
"aws_region_name": "<string>",
"aws_role_name": "<string>",
"aws_secret_access_key": "<string>",
"aws_session_name": "<string>",
"aws_session_token": "<string>",
"base_url": "<string>",
"caching_prompt": True,
"capability_overrides": {},
"custom_tokenizer": "<string>",
"disable_stop_word": False,
"disable_vision": True,
"drop_params": True,
"enable_encrypted_reasoning": True,
"extended_thinking_budget": 200000,
"extra_headers": {},
"fallback_strategy": {
"fallback_llms": ["<string>"],
"profile_store_dir": "<string>"
},
"force_string_serializer": True,
"inline_image_urls": True,
"input_cost_per_token": 1,
"litellm_extra_body": {},
"log_completions": False,
"log_completions_folder": "logs/completions",
"max_input_tokens": 2,
"max_message_chars": 30000,
"max_output_tokens": 2,
"model": "gpt-5.6",
"model_canonical_name": "<string>",
"native_tool_calling": True,
"num_retries": 5,
"ollama_base_url": "<string>",
"openrouter_app_name": "OpenHands",
"openrouter_site_url": "https://docs.all-hands.dev/",
"output_cost_per_token": 1,
"prompt_cache_retention": "24h",
"provider_connection_id": "<string>",
"reasoning_effort": "high",
"retry_max_wait": 64,
"retry_min_wait": 8,
"retry_multiplier": 8,
"seed": 123,
"stream": False,
"stream_idle_timeout": 300,
"subscription_vendor": "openai",
"temperature": 1,
"timeout": 300,
"top_k": 1,
"top_p": 0.5,
"usage_id": "default"
} }
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({
llm: {
api_key: '<string>',
api_mode: 'auto',
api_version: '<string>',
auth_type: 'api_key',
aws_access_key_id: '<string>',
aws_bedrock_runtime_endpoint: '<string>',
aws_profile_name: '<string>',
aws_region_name: '<string>',
aws_role_name: '<string>',
aws_secret_access_key: '<string>',
aws_session_name: '<string>',
aws_session_token: '<string>',
base_url: '<string>',
caching_prompt: true,
capability_overrides: {},
custom_tokenizer: '<string>',
disable_stop_word: false,
disable_vision: true,
drop_params: true,
enable_encrypted_reasoning: true,
extended_thinking_budget: 200000,
extra_headers: {},
fallback_strategy: {fallback_llms: ['<string>'], profile_store_dir: '<string>'},
force_string_serializer: true,
inline_image_urls: true,
input_cost_per_token: 1,
litellm_extra_body: {},
log_completions: false,
log_completions_folder: 'logs/completions',
max_input_tokens: 2,
max_message_chars: 30000,
max_output_tokens: 2,
model: 'gpt-5.6',
model_canonical_name: '<string>',
native_tool_calling: true,
num_retries: 5,
ollama_base_url: '<string>',
openrouter_app_name: 'OpenHands',
openrouter_site_url: 'https://docs.all-hands.dev/',
output_cost_per_token: 1,
prompt_cache_retention: '24h',
provider_connection_id: '<string>',
reasoning_effort: 'high',
retry_max_wait: 64,
retry_min_wait: 8,
retry_multiplier: 8,
seed: 123,
stream: false,
stream_idle_timeout: 300,
subscription_vendor: 'openai',
temperature: 1,
timeout: 300,
top_k: 1,
top_p: 0.5,
usage_id: 'default'
}
})
};
fetch('https://api.example.com/api/profiles/{name}/validate', 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://api.example.com/api/profiles/{name}/validate",
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([
'llm' => [
'api_key' => '<string>',
'api_mode' => 'auto',
'api_version' => '<string>',
'auth_type' => 'api_key',
'aws_access_key_id' => '<string>',
'aws_bedrock_runtime_endpoint' => '<string>',
'aws_profile_name' => '<string>',
'aws_region_name' => '<string>',
'aws_role_name' => '<string>',
'aws_secret_access_key' => '<string>',
'aws_session_name' => '<string>',
'aws_session_token' => '<string>',
'base_url' => '<string>',
'caching_prompt' => true,
'capability_overrides' => [
],
'custom_tokenizer' => '<string>',
'disable_stop_word' => false,
'disable_vision' => true,
'drop_params' => true,
'enable_encrypted_reasoning' => true,
'extended_thinking_budget' => 200000,
'extra_headers' => [
],
'fallback_strategy' => [
'fallback_llms' => [
'<string>'
],
'profile_store_dir' => '<string>'
],
'force_string_serializer' => true,
'inline_image_urls' => true,
'input_cost_per_token' => 1,
'litellm_extra_body' => [
],
'log_completions' => false,
'log_completions_folder' => 'logs/completions',
'max_input_tokens' => 2,
'max_message_chars' => 30000,
'max_output_tokens' => 2,
'model' => 'gpt-5.6',
'model_canonical_name' => '<string>',
'native_tool_calling' => true,
'num_retries' => 5,
'ollama_base_url' => '<string>',
'openrouter_app_name' => 'OpenHands',
'openrouter_site_url' => 'https://docs.all-hands.dev/',
'output_cost_per_token' => 1,
'prompt_cache_retention' => '24h',
'provider_connection_id' => '<string>',
'reasoning_effort' => 'high',
'retry_max_wait' => 64,
'retry_min_wait' => 8,
'retry_multiplier' => 8,
'seed' => 123,
'stream' => false,
'stream_idle_timeout' => 300,
'subscription_vendor' => 'openai',
'temperature' => 1,
'timeout' => 300,
'top_k' => 1,
'top_p' => 0.5,
'usage_id' => 'default'
]
]),
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://api.example.com/api/profiles/{name}/validate"
payload := strings.NewReader("{\n \"llm\": {\n \"api_key\": \"<string>\",\n \"api_mode\": \"auto\",\n \"api_version\": \"<string>\",\n \"auth_type\": \"api_key\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_bedrock_runtime_endpoint\": \"<string>\",\n \"aws_profile_name\": \"<string>\",\n \"aws_region_name\": \"<string>\",\n \"aws_role_name\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"aws_session_name\": \"<string>\",\n \"aws_session_token\": \"<string>\",\n \"base_url\": \"<string>\",\n \"caching_prompt\": true,\n \"capability_overrides\": {},\n \"custom_tokenizer\": \"<string>\",\n \"disable_stop_word\": false,\n \"disable_vision\": true,\n \"drop_params\": true,\n \"enable_encrypted_reasoning\": true,\n \"extended_thinking_budget\": 200000,\n \"extra_headers\": {},\n \"fallback_strategy\": {\n \"fallback_llms\": [\n \"<string>\"\n ],\n \"profile_store_dir\": \"<string>\"\n },\n \"force_string_serializer\": true,\n \"inline_image_urls\": true,\n \"input_cost_per_token\": 1,\n \"litellm_extra_body\": {},\n \"log_completions\": false,\n \"log_completions_folder\": \"logs/completions\",\n \"max_input_tokens\": 2,\n \"max_message_chars\": 30000,\n \"max_output_tokens\": 2,\n \"model\": \"gpt-5.6\",\n \"model_canonical_name\": \"<string>\",\n \"native_tool_calling\": true,\n \"num_retries\": 5,\n \"ollama_base_url\": \"<string>\",\n \"openrouter_app_name\": \"OpenHands\",\n \"openrouter_site_url\": \"https://docs.all-hands.dev/\",\n \"output_cost_per_token\": 1,\n \"prompt_cache_retention\": \"24h\",\n \"provider_connection_id\": \"<string>\",\n \"reasoning_effort\": \"high\",\n \"retry_max_wait\": 64,\n \"retry_min_wait\": 8,\n \"retry_multiplier\": 8,\n \"seed\": 123,\n \"stream\": false,\n \"stream_idle_timeout\": 300,\n \"subscription_vendor\": \"openai\",\n \"temperature\": 1,\n \"timeout\": 300,\n \"top_k\": 1,\n \"top_p\": 0.5,\n \"usage_id\": \"default\"\n }\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://api.example.com/api/profiles/{name}/validate")
.header("X-Session-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"llm\": {\n \"api_key\": \"<string>\",\n \"api_mode\": \"auto\",\n \"api_version\": \"<string>\",\n \"auth_type\": \"api_key\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_bedrock_runtime_endpoint\": \"<string>\",\n \"aws_profile_name\": \"<string>\",\n \"aws_region_name\": \"<string>\",\n \"aws_role_name\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"aws_session_name\": \"<string>\",\n \"aws_session_token\": \"<string>\",\n \"base_url\": \"<string>\",\n \"caching_prompt\": true,\n \"capability_overrides\": {},\n \"custom_tokenizer\": \"<string>\",\n \"disable_stop_word\": false,\n \"disable_vision\": true,\n \"drop_params\": true,\n \"enable_encrypted_reasoning\": true,\n \"extended_thinking_budget\": 200000,\n \"extra_headers\": {},\n \"fallback_strategy\": {\n \"fallback_llms\": [\n \"<string>\"\n ],\n \"profile_store_dir\": \"<string>\"\n },\n \"force_string_serializer\": true,\n \"inline_image_urls\": true,\n \"input_cost_per_token\": 1,\n \"litellm_extra_body\": {},\n \"log_completions\": false,\n \"log_completions_folder\": \"logs/completions\",\n \"max_input_tokens\": 2,\n \"max_message_chars\": 30000,\n \"max_output_tokens\": 2,\n \"model\": \"gpt-5.6\",\n \"model_canonical_name\": \"<string>\",\n \"native_tool_calling\": true,\n \"num_retries\": 5,\n \"ollama_base_url\": \"<string>\",\n \"openrouter_app_name\": \"OpenHands\",\n \"openrouter_site_url\": \"https://docs.all-hands.dev/\",\n \"output_cost_per_token\": 1,\n \"prompt_cache_retention\": \"24h\",\n \"provider_connection_id\": \"<string>\",\n \"reasoning_effort\": \"high\",\n \"retry_max_wait\": 64,\n \"retry_min_wait\": 8,\n \"retry_multiplier\": 8,\n \"seed\": 123,\n \"stream\": false,\n \"stream_idle_timeout\": 300,\n \"subscription_vendor\": \"openai\",\n \"temperature\": 1,\n \"timeout\": 300,\n \"top_k\": 1,\n \"top_p\": 0.5,\n \"usage_id\": \"default\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/profiles/{name}/validate")
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 \"llm\": {\n \"api_key\": \"<string>\",\n \"api_mode\": \"auto\",\n \"api_version\": \"<string>\",\n \"auth_type\": \"api_key\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_bedrock_runtime_endpoint\": \"<string>\",\n \"aws_profile_name\": \"<string>\",\n \"aws_region_name\": \"<string>\",\n \"aws_role_name\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"aws_session_name\": \"<string>\",\n \"aws_session_token\": \"<string>\",\n \"base_url\": \"<string>\",\n \"caching_prompt\": true,\n \"capability_overrides\": {},\n \"custom_tokenizer\": \"<string>\",\n \"disable_stop_word\": false,\n \"disable_vision\": true,\n \"drop_params\": true,\n \"enable_encrypted_reasoning\": true,\n \"extended_thinking_budget\": 200000,\n \"extra_headers\": {},\n \"fallback_strategy\": {\n \"fallback_llms\": [\n \"<string>\"\n ],\n \"profile_store_dir\": \"<string>\"\n },\n \"force_string_serializer\": true,\n \"inline_image_urls\": true,\n \"input_cost_per_token\": 1,\n \"litellm_extra_body\": {},\n \"log_completions\": false,\n \"log_completions_folder\": \"logs/completions\",\n \"max_input_tokens\": 2,\n \"max_message_chars\": 30000,\n \"max_output_tokens\": 2,\n \"model\": \"gpt-5.6\",\n \"model_canonical_name\": \"<string>\",\n \"native_tool_calling\": true,\n \"num_retries\": 5,\n \"ollama_base_url\": \"<string>\",\n \"openrouter_app_name\": \"OpenHands\",\n \"openrouter_site_url\": \"https://docs.all-hands.dev/\",\n \"output_cost_per_token\": 1,\n \"prompt_cache_retention\": \"24h\",\n \"provider_connection_id\": \"<string>\",\n \"reasoning_effort\": \"high\",\n \"retry_max_wait\": 64,\n \"retry_min_wait\": 8,\n \"retry_multiplier\": 8,\n \"seed\": 123,\n \"stream\": false,\n \"stream_idle_timeout\": 300,\n \"subscription_vendor\": \"openai\",\n \"temperature\": 1,\n \"timeout\": 300,\n \"top_k\": 1,\n \"top_p\": 0.5,\n \"usage_id\": \"default\"\n }\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"error": {
"message": "<string>",
"type": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Profiles
Validate Profile
Pre-flight check: fire a minimal LLM completion to catch misconfigurations.
Instantiates the submitted LLM config and sends a 1-token completion to surface errors like invalid model names, missing provider prefixes, bad base URLs, and invalid API keys — before the profile is saved.
Transient errors (rate limits, timeouts) are treated as non-blocking: the
response is valid=True with no error, since those don’t indicate a
misconfigured profile.
POST
/
api
/
profiles
/
{name}
/
validate
Validate Profile
curl --request POST \
--url https://api.example.com/api/profiles/{name}/validate \
--header 'Content-Type: application/json' \
--header 'X-Session-API-Key: <api-key>' \
--data '
{
"llm": {
"api_key": "<string>",
"api_mode": "auto",
"api_version": "<string>",
"auth_type": "api_key",
"aws_access_key_id": "<string>",
"aws_bedrock_runtime_endpoint": "<string>",
"aws_profile_name": "<string>",
"aws_region_name": "<string>",
"aws_role_name": "<string>",
"aws_secret_access_key": "<string>",
"aws_session_name": "<string>",
"aws_session_token": "<string>",
"base_url": "<string>",
"caching_prompt": true,
"capability_overrides": {},
"custom_tokenizer": "<string>",
"disable_stop_word": false,
"disable_vision": true,
"drop_params": true,
"enable_encrypted_reasoning": true,
"extended_thinking_budget": 200000,
"extra_headers": {},
"fallback_strategy": {
"fallback_llms": [
"<string>"
],
"profile_store_dir": "<string>"
},
"force_string_serializer": true,
"inline_image_urls": true,
"input_cost_per_token": 1,
"litellm_extra_body": {},
"log_completions": false,
"log_completions_folder": "logs/completions",
"max_input_tokens": 2,
"max_message_chars": 30000,
"max_output_tokens": 2,
"model": "gpt-5.6",
"model_canonical_name": "<string>",
"native_tool_calling": true,
"num_retries": 5,
"ollama_base_url": "<string>",
"openrouter_app_name": "OpenHands",
"openrouter_site_url": "https://docs.all-hands.dev/",
"output_cost_per_token": 1,
"prompt_cache_retention": "24h",
"provider_connection_id": "<string>",
"reasoning_effort": "high",
"retry_max_wait": 64,
"retry_min_wait": 8,
"retry_multiplier": 8,
"seed": 123,
"stream": false,
"stream_idle_timeout": 300,
"subscription_vendor": "openai",
"temperature": 1,
"timeout": 300,
"top_k": 1,
"top_p": 0.5,
"usage_id": "default"
}
}
'import requests
url = "https://api.example.com/api/profiles/{name}/validate"
payload = { "llm": {
"api_key": "<string>",
"api_mode": "auto",
"api_version": "<string>",
"auth_type": "api_key",
"aws_access_key_id": "<string>",
"aws_bedrock_runtime_endpoint": "<string>",
"aws_profile_name": "<string>",
"aws_region_name": "<string>",
"aws_role_name": "<string>",
"aws_secret_access_key": "<string>",
"aws_session_name": "<string>",
"aws_session_token": "<string>",
"base_url": "<string>",
"caching_prompt": True,
"capability_overrides": {},
"custom_tokenizer": "<string>",
"disable_stop_word": False,
"disable_vision": True,
"drop_params": True,
"enable_encrypted_reasoning": True,
"extended_thinking_budget": 200000,
"extra_headers": {},
"fallback_strategy": {
"fallback_llms": ["<string>"],
"profile_store_dir": "<string>"
},
"force_string_serializer": True,
"inline_image_urls": True,
"input_cost_per_token": 1,
"litellm_extra_body": {},
"log_completions": False,
"log_completions_folder": "logs/completions",
"max_input_tokens": 2,
"max_message_chars": 30000,
"max_output_tokens": 2,
"model": "gpt-5.6",
"model_canonical_name": "<string>",
"native_tool_calling": True,
"num_retries": 5,
"ollama_base_url": "<string>",
"openrouter_app_name": "OpenHands",
"openrouter_site_url": "https://docs.all-hands.dev/",
"output_cost_per_token": 1,
"prompt_cache_retention": "24h",
"provider_connection_id": "<string>",
"reasoning_effort": "high",
"retry_max_wait": 64,
"retry_min_wait": 8,
"retry_multiplier": 8,
"seed": 123,
"stream": False,
"stream_idle_timeout": 300,
"subscription_vendor": "openai",
"temperature": 1,
"timeout": 300,
"top_k": 1,
"top_p": 0.5,
"usage_id": "default"
} }
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({
llm: {
api_key: '<string>',
api_mode: 'auto',
api_version: '<string>',
auth_type: 'api_key',
aws_access_key_id: '<string>',
aws_bedrock_runtime_endpoint: '<string>',
aws_profile_name: '<string>',
aws_region_name: '<string>',
aws_role_name: '<string>',
aws_secret_access_key: '<string>',
aws_session_name: '<string>',
aws_session_token: '<string>',
base_url: '<string>',
caching_prompt: true,
capability_overrides: {},
custom_tokenizer: '<string>',
disable_stop_word: false,
disable_vision: true,
drop_params: true,
enable_encrypted_reasoning: true,
extended_thinking_budget: 200000,
extra_headers: {},
fallback_strategy: {fallback_llms: ['<string>'], profile_store_dir: '<string>'},
force_string_serializer: true,
inline_image_urls: true,
input_cost_per_token: 1,
litellm_extra_body: {},
log_completions: false,
log_completions_folder: 'logs/completions',
max_input_tokens: 2,
max_message_chars: 30000,
max_output_tokens: 2,
model: 'gpt-5.6',
model_canonical_name: '<string>',
native_tool_calling: true,
num_retries: 5,
ollama_base_url: '<string>',
openrouter_app_name: 'OpenHands',
openrouter_site_url: 'https://docs.all-hands.dev/',
output_cost_per_token: 1,
prompt_cache_retention: '24h',
provider_connection_id: '<string>',
reasoning_effort: 'high',
retry_max_wait: 64,
retry_min_wait: 8,
retry_multiplier: 8,
seed: 123,
stream: false,
stream_idle_timeout: 300,
subscription_vendor: 'openai',
temperature: 1,
timeout: 300,
top_k: 1,
top_p: 0.5,
usage_id: 'default'
}
})
};
fetch('https://api.example.com/api/profiles/{name}/validate', 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://api.example.com/api/profiles/{name}/validate",
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([
'llm' => [
'api_key' => '<string>',
'api_mode' => 'auto',
'api_version' => '<string>',
'auth_type' => 'api_key',
'aws_access_key_id' => '<string>',
'aws_bedrock_runtime_endpoint' => '<string>',
'aws_profile_name' => '<string>',
'aws_region_name' => '<string>',
'aws_role_name' => '<string>',
'aws_secret_access_key' => '<string>',
'aws_session_name' => '<string>',
'aws_session_token' => '<string>',
'base_url' => '<string>',
'caching_prompt' => true,
'capability_overrides' => [
],
'custom_tokenizer' => '<string>',
'disable_stop_word' => false,
'disable_vision' => true,
'drop_params' => true,
'enable_encrypted_reasoning' => true,
'extended_thinking_budget' => 200000,
'extra_headers' => [
],
'fallback_strategy' => [
'fallback_llms' => [
'<string>'
],
'profile_store_dir' => '<string>'
],
'force_string_serializer' => true,
'inline_image_urls' => true,
'input_cost_per_token' => 1,
'litellm_extra_body' => [
],
'log_completions' => false,
'log_completions_folder' => 'logs/completions',
'max_input_tokens' => 2,
'max_message_chars' => 30000,
'max_output_tokens' => 2,
'model' => 'gpt-5.6',
'model_canonical_name' => '<string>',
'native_tool_calling' => true,
'num_retries' => 5,
'ollama_base_url' => '<string>',
'openrouter_app_name' => 'OpenHands',
'openrouter_site_url' => 'https://docs.all-hands.dev/',
'output_cost_per_token' => 1,
'prompt_cache_retention' => '24h',
'provider_connection_id' => '<string>',
'reasoning_effort' => 'high',
'retry_max_wait' => 64,
'retry_min_wait' => 8,
'retry_multiplier' => 8,
'seed' => 123,
'stream' => false,
'stream_idle_timeout' => 300,
'subscription_vendor' => 'openai',
'temperature' => 1,
'timeout' => 300,
'top_k' => 1,
'top_p' => 0.5,
'usage_id' => 'default'
]
]),
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://api.example.com/api/profiles/{name}/validate"
payload := strings.NewReader("{\n \"llm\": {\n \"api_key\": \"<string>\",\n \"api_mode\": \"auto\",\n \"api_version\": \"<string>\",\n \"auth_type\": \"api_key\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_bedrock_runtime_endpoint\": \"<string>\",\n \"aws_profile_name\": \"<string>\",\n \"aws_region_name\": \"<string>\",\n \"aws_role_name\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"aws_session_name\": \"<string>\",\n \"aws_session_token\": \"<string>\",\n \"base_url\": \"<string>\",\n \"caching_prompt\": true,\n \"capability_overrides\": {},\n \"custom_tokenizer\": \"<string>\",\n \"disable_stop_word\": false,\n \"disable_vision\": true,\n \"drop_params\": true,\n \"enable_encrypted_reasoning\": true,\n \"extended_thinking_budget\": 200000,\n \"extra_headers\": {},\n \"fallback_strategy\": {\n \"fallback_llms\": [\n \"<string>\"\n ],\n \"profile_store_dir\": \"<string>\"\n },\n \"force_string_serializer\": true,\n \"inline_image_urls\": true,\n \"input_cost_per_token\": 1,\n \"litellm_extra_body\": {},\n \"log_completions\": false,\n \"log_completions_folder\": \"logs/completions\",\n \"max_input_tokens\": 2,\n \"max_message_chars\": 30000,\n \"max_output_tokens\": 2,\n \"model\": \"gpt-5.6\",\n \"model_canonical_name\": \"<string>\",\n \"native_tool_calling\": true,\n \"num_retries\": 5,\n \"ollama_base_url\": \"<string>\",\n \"openrouter_app_name\": \"OpenHands\",\n \"openrouter_site_url\": \"https://docs.all-hands.dev/\",\n \"output_cost_per_token\": 1,\n \"prompt_cache_retention\": \"24h\",\n \"provider_connection_id\": \"<string>\",\n \"reasoning_effort\": \"high\",\n \"retry_max_wait\": 64,\n \"retry_min_wait\": 8,\n \"retry_multiplier\": 8,\n \"seed\": 123,\n \"stream\": false,\n \"stream_idle_timeout\": 300,\n \"subscription_vendor\": \"openai\",\n \"temperature\": 1,\n \"timeout\": 300,\n \"top_k\": 1,\n \"top_p\": 0.5,\n \"usage_id\": \"default\"\n }\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://api.example.com/api/profiles/{name}/validate")
.header("X-Session-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"llm\": {\n \"api_key\": \"<string>\",\n \"api_mode\": \"auto\",\n \"api_version\": \"<string>\",\n \"auth_type\": \"api_key\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_bedrock_runtime_endpoint\": \"<string>\",\n \"aws_profile_name\": \"<string>\",\n \"aws_region_name\": \"<string>\",\n \"aws_role_name\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"aws_session_name\": \"<string>\",\n \"aws_session_token\": \"<string>\",\n \"base_url\": \"<string>\",\n \"caching_prompt\": true,\n \"capability_overrides\": {},\n \"custom_tokenizer\": \"<string>\",\n \"disable_stop_word\": false,\n \"disable_vision\": true,\n \"drop_params\": true,\n \"enable_encrypted_reasoning\": true,\n \"extended_thinking_budget\": 200000,\n \"extra_headers\": {},\n \"fallback_strategy\": {\n \"fallback_llms\": [\n \"<string>\"\n ],\n \"profile_store_dir\": \"<string>\"\n },\n \"force_string_serializer\": true,\n \"inline_image_urls\": true,\n \"input_cost_per_token\": 1,\n \"litellm_extra_body\": {},\n \"log_completions\": false,\n \"log_completions_folder\": \"logs/completions\",\n \"max_input_tokens\": 2,\n \"max_message_chars\": 30000,\n \"max_output_tokens\": 2,\n \"model\": \"gpt-5.6\",\n \"model_canonical_name\": \"<string>\",\n \"native_tool_calling\": true,\n \"num_retries\": 5,\n \"ollama_base_url\": \"<string>\",\n \"openrouter_app_name\": \"OpenHands\",\n \"openrouter_site_url\": \"https://docs.all-hands.dev/\",\n \"output_cost_per_token\": 1,\n \"prompt_cache_retention\": \"24h\",\n \"provider_connection_id\": \"<string>\",\n \"reasoning_effort\": \"high\",\n \"retry_max_wait\": 64,\n \"retry_min_wait\": 8,\n \"retry_multiplier\": 8,\n \"seed\": 123,\n \"stream\": false,\n \"stream_idle_timeout\": 300,\n \"subscription_vendor\": \"openai\",\n \"temperature\": 1,\n \"timeout\": 300,\n \"top_k\": 1,\n \"top_p\": 0.5,\n \"usage_id\": \"default\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/profiles/{name}/validate")
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 \"llm\": {\n \"api_key\": \"<string>\",\n \"api_mode\": \"auto\",\n \"api_version\": \"<string>\",\n \"auth_type\": \"api_key\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_bedrock_runtime_endpoint\": \"<string>\",\n \"aws_profile_name\": \"<string>\",\n \"aws_region_name\": \"<string>\",\n \"aws_role_name\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"aws_session_name\": \"<string>\",\n \"aws_session_token\": \"<string>\",\n \"base_url\": \"<string>\",\n \"caching_prompt\": true,\n \"capability_overrides\": {},\n \"custom_tokenizer\": \"<string>\",\n \"disable_stop_word\": false,\n \"disable_vision\": true,\n \"drop_params\": true,\n \"enable_encrypted_reasoning\": true,\n \"extended_thinking_budget\": 200000,\n \"extra_headers\": {},\n \"fallback_strategy\": {\n \"fallback_llms\": [\n \"<string>\"\n ],\n \"profile_store_dir\": \"<string>\"\n },\n \"force_string_serializer\": true,\n \"inline_image_urls\": true,\n \"input_cost_per_token\": 1,\n \"litellm_extra_body\": {},\n \"log_completions\": false,\n \"log_completions_folder\": \"logs/completions\",\n \"max_input_tokens\": 2,\n \"max_message_chars\": 30000,\n \"max_output_tokens\": 2,\n \"model\": \"gpt-5.6\",\n \"model_canonical_name\": \"<string>\",\n \"native_tool_calling\": true,\n \"num_retries\": 5,\n \"ollama_base_url\": \"<string>\",\n \"openrouter_app_name\": \"OpenHands\",\n \"openrouter_site_url\": \"https://docs.all-hands.dev/\",\n \"output_cost_per_token\": 1,\n \"prompt_cache_retention\": \"24h\",\n \"provider_connection_id\": \"<string>\",\n \"reasoning_effort\": \"high\",\n \"retry_max_wait\": 64,\n \"retry_min_wait\": 8,\n \"retry_multiplier\": 8,\n \"seed\": 123,\n \"stream\": false,\n \"stream_idle_timeout\": 300,\n \"subscription_vendor\": \"openai\",\n \"temperature\": 1,\n \"timeout\": 300,\n \"top_k\": 1,\n \"top_p\": 0.5,\n \"usage_id\": \"default\"\n }\n}"
response = http.request(request)
puts response.read_body{
"valid": true,
"error": {
"message": "<string>",
"type": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
Path Parameters
Required string length:
1 - 64Pattern:
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$Body
application/json
Request body for LLM pre-flight validation.
Accepts an LLM config (same shape as SaveProfileRequest.llm) so the
frontend can validate a draft before persisting it.
Language model interface for OpenHands agents.
The LLM class provides a unified interface for interacting with various language models through the litellm library. It handles model configuration, API authentication, retry logic, and tool calling capabilities.
Attributes: model: Model name (e.g., "gpt-5.6"). api_key: API key for authentication. base_url: Custom API base URL. num_retries: Number of retry attempts for failed requests. timeout: Request timeout in seconds.
Example: ```python from openhands.sdk import LLM from pydantic import SecretStr
llm = LLM(
model="gpt-5.6",
api_key=SecretStr("your-api-key"),
usage_id="my-agent"
)
# Use with agent or conversation
```
Show child attributes
Show child attributes
Was this page helpful?