Skip to main content
PATCH
Update Sub-Agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

sub_agent_id
integer
required

Body

application/json
sub_agent_name
string | null

Updated display name for the sub-agent. The API derives the stored key from this value when provided.

Minimum string length: 1
agent_type
enum<string> | null

Updated sub-agent type.

Available options:
assistant,
user_proxy
description
string | null

Updated description that explains the sub-agent's intent.

system_prompt
string | null

Updated prompt template ID used as the sub-agent system prompt.

system_prompt_template
SystemPromptCreateRequest · object | null

System prompt template to create when system_prompt ID is not provided.

llm_model
integer | null

Updated LLM model ID. If omitted, provide llm_model_name to resolve the model by name.

llm_model_name
string | null

LLM model name to resolve when llm_model ID is not provided.

model_config
SubAgentModelConfigRequest · object | null

Updated assistant-only LLM settings for this sub-agent.

config
SubAgentConfigRequest · object

Updated sub-agent behavior, visibility, memory, and structured output settings.

Response

Successful Response

success
boolean
required

Whether the request was successful.

data
SubAgentMutationData · object
required

Sub-agent mutation results.

error_type
string | null

Type of error if the request failed.

error_message
string | null

Error message or informational message.