Read one agent by ID. Returns 404 when the agent does not exist or is not accessible to this key. Requires the read:agents permission.
Authorization
BearerAuth read:agentsAuthorizationBearer <token>
In: header
Scope: read:agents
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/agents/string"{
"id": "a1b2c3d4e5",
"name": "Acme Support",
"url": "https://acme.com",
"status": "ready",
"createdAt": "2026-07-01T09:30:00.000Z"
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}List agents GET
List the agents this API key can access. Use the returned `id` in every per-agent endpoint. Requires the `read:agents` permission.
Send a message to an agent POST
Send a visitor message to an agent and receive its reply as JSON. Each delivered message uses one message credit from the account plan. Conversations appear in the dashboard Inbox under the API channel. Requires the `write:chat` permission.