Docs
API ReferenceReferenceAgents

Get an agent

GET
/agents/{agentId}

One published Agent. An Agent in another organization, an unpublished one, or an id that is not an Agent is the same 404. Requires the agents:read scope.

AuthorizationBearer <token>

An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).

In: header

Path Parameters

agentId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "agent": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "services": {      "conversation": true    }  }}