POST/v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}

Attach a child agent to an agent

Links a child agent as a route on a parent agent. Use the parent_agent_uuid and child_agent_uuid path parameters to identify the agents, and optionally provide if_case and route_name to configure the route. The response identifies the linked parent and child agents.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 4 body fields
parent_agent_uuidstringrequired
The unique identifier of the parent agent to receive the child agent route.
child_agent_uuidstringrequired
The identifier of the child agent to link as a route.

Optional information for linking an agent route.

child_agent_uuidstringoptional
Routed agent id
if_casestringoptional
A condition associated with the route.
parent_agent_uuidstringoptional
A unique identifier for the parent agent.
route_namestringoptional
Name of route

6 status codes
200Returns an object identifying the linked parent agent and child agent.
child_agent_uuidstringoptional
Routed agent id
parent_agent_uuidstringoptional
A unique identifier for the parent agent.
401Returned when authentication fails because the credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when the requested resource is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultReturned when an unexpected error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 is returned when authentication credentials are invalid. A 404 is returned when a resource addressed by the parent_agent_uuid path parameter or child_agent_uuid path parameter is not found. A 429 indicates that the API rate limit has been exceeded, and a 500 indicates a server error.