Get Agent Profile
curl --request GET \
--url https://api.example.com/api/agent-profiles/{name} \
--header 'X-Access-Token: <api-key>'import requests
url = "https://api.example.com/api/agent-profiles/{name}"
headers = {"X-Access-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Access-Token': '<api-key>'}};
fetch('https://api.example.com/api/agent-profiles/{name}', 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/agent-profiles/{name}",
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-Access-Token: <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://api.example.com/api/agent-profiles/{name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Access-Token", "<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://api.example.com/api/agent-profiles/{name}")
.header("X-Access-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/agent-profiles/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Access-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"name": "<string>",
"profile": {
"name": "<string>",
"llm_profile_ref": "<string>",
"schema_version": 2,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 0,
"mcp_server_refs": [
"<string>"
],
"agent_kind": "openhands",
"agent": "CodeActAgent",
"tools": [
{
"name": "<string>",
"params": {}
}
],
"system_message_suffix": "<string>",
"disabled_skills": [
"<string>"
],
"condenser": {
"enabled": true,
"max_size": 240,
"condenser_kind": "llm_summarizing",
"max_tokens": 1,
"keep_first": 2,
"minimum_progress": 0.1,
"hard_context_reset_max_retries": 5,
"hard_context_reset_context_scaling": 0.8
},
"verification": {
"critic_enabled": false,
"critic_mode": "finish_and_message",
"enable_iterative_refinement": false,
"critic_threshold": 0.6,
"max_refinement_iterations": 3,
"critic_server_url": "<string>",
"critic_model_name": "<string>"
},
"enable_sub_agents": false,
"enable_switch_llm_tool": true,
"tool_concurrency_limit": 1
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Agent Profiles
Get Agent Profile
Get a stored profile — secret-free at rest, nothing to mask.
Unlike the LLM-profile GET in org_profiles, there is no
X-Expose-Secrets handling here at all: the profile carries only
references (llm_profile_ref, mcp_server_refs) and a
disabled_skills deny-list of names.
GET
/
api
/
agent-profiles
/
{name}
Get Agent Profile
curl --request GET \
--url https://api.example.com/api/agent-profiles/{name} \
--header 'X-Access-Token: <api-key>'import requests
url = "https://api.example.com/api/agent-profiles/{name}"
headers = {"X-Access-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Access-Token': '<api-key>'}};
fetch('https://api.example.com/api/agent-profiles/{name}', 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/agent-profiles/{name}",
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-Access-Token: <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://api.example.com/api/agent-profiles/{name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Access-Token", "<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://api.example.com/api/agent-profiles/{name}")
.header("X-Access-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/agent-profiles/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Access-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"name": "<string>",
"profile": {
"name": "<string>",
"llm_profile_ref": "<string>",
"schema_version": 2,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"revision": 0,
"mcp_server_refs": [
"<string>"
],
"agent_kind": "openhands",
"agent": "CodeActAgent",
"tools": [
{
"name": "<string>",
"params": {}
}
],
"system_message_suffix": "<string>",
"disabled_skills": [
"<string>"
],
"condenser": {
"enabled": true,
"max_size": 240,
"condenser_kind": "llm_summarizing",
"max_tokens": 1,
"keep_first": 2,
"minimum_progress": 0.1,
"hard_context_reset_max_retries": 5,
"hard_context_reset_context_scaling": 0.8
},
"verification": {
"critic_enabled": false,
"critic_mode": "finish_and_message",
"enable_iterative_refinement": false,
"critic_threshold": 0.6,
"max_refinement_iterations": 3,
"critic_server_url": "<string>",
"critic_model_name": "<string>"
},
"enable_sub_agents": false,
"enable_switch_llm_tool": true,
"tool_concurrency_limit": 1
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
Required string length:
1 - 64Pattern:
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$Query Parameters
Response
Successful Response
agent_kind="openhands" profile — references an LLM profile by name.
Mirrors the configurable surface of
:class:~openhands.sdk.settings.model.OpenHandsAgentSettings, except the
concrete llm is replaced by :attr:llm_profile_ref (resolved against
the LLM profile store) and mcp_config by the inherited
:attr:~AgentProfileBase.mcp_server_refs.
- OpenHandsAgentProfile
- ACPAgentProfile
Show child attributes
Show child attributes
Was this page helpful?
⌘I

