Skip to main content
POST
Materialize Agent Profile

Authorizations

X-Session-API-Key
string
header
required

Path Parameters

name
string
required
Required string length: 1 - 64
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

Body

application/json
profile
OpenHandsAgentProfile · object

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.

Response

Successful Response

Side-effect-free report of what :func:resolve_agent_profile would do.

Consumed by POST /{id}/materialize (#3719) and the canvas editor. The verdict (:attr:valid) and the dangling-ref lists match exactly what a real resolve produces; :attr:resolved_settings is the redacted settings dump (present only when :attr:valid).

agent_kind
string
required
acp_api_key_secret_name
string | null
acp_base_url_secret_name
string | null
acp_file_secret_names
string[]
dangling_mcp_server_refs
string[]
dangling_meta_profile_llm_refs
string[]
dangling_meta_profile_ref
string | null
disabled_skills
string[]
errors
string[]
llm_api_key_set
boolean
default:false
llm_profile_ref
string | null
llm_profile_resolved
boolean
default:false
mcp_server_refs
string[] | null
meta_profile_ref
string | null
resolved_mcp_config_keys
string[]
resolved_settings
Resolved Settings · object | null
resolved_skills
string[]
secret_refs
string[] | null
unusable_tools
string[]

Selected tools the runtime cannot run. An unavailable browser is left out of the launch; any other such tool fails the launch or fails when the agent uses it.

valid
boolean
default:false