Skip to main content
PATCH
Update Parent Agent

Authorizations

Authorization
string
header
required

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

Path Parameters

parent_agent_id
integer
required

Body

application/json
parent_agent_type_key
string | null

Updated parent agent type key from agents.agent_name.

parent_agent_type
string | null

Updated human-readable parent agent type from agents.agent_displayName.

agent_name
string | null

Updated parent agent name. Spaces are converted to underscores and the stored key is lowercase, alphanumeric/underscore, and at most 50 characters.

description
string | null

Updated summary of what the parent agent should accomplish.

configs
ParentAgentConfigRequest · object

Updated default behavior for the entire flow.

llm_model
integer | null

Updated default 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.

active
boolean | null

Updated on/off state for the parent agent.

state_function
StateFunctionRule · object[] | null

Updated routing rules for the parent-agent flow.

Response

Successful Response

success
boolean
required

Whether the request was successful.

data
ParentAgentMutationData · object
required

Parent agent mutation results.

error_type
string | null

Type of error if the request failed.

error_message
string | null

Error message or informational message.