Skip to main content
Retrieves a single agent. By default, the id path parameter is matched against the internal agent ID. Set by_custom_id=true to look up the agent by its custom identifier instead.
Permission required: agent:read

Path Parameters

id
string
required
Agent identifier. Interpreted as the internal ID by default, or as the custom ID when by_custom_id is true.

Query Parameters

by_custom_id
boolean
When true, the id path parameter is matched against the agent’s custom_id instead of its internal id.

Response

data
object