Skip to content

Agents

Agents are the top-level entity in Chronary. Each agent can own multiple calendars and has its own availability.

POST /v1/agents
FieldTypeRequiredDescription
namestringYes1–255 characters
typestringYesai, human, or resource
descriptionstringNoFree-text description
metadataobjectNoKey-value pairs, max 16KB JSON
Terminal window
curl -X POST https://api.chronary.ai/v1/agents \
-H "Authorization: Bearer chr_sk_test_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"name": "Sales Agent - Acme Corp",
"type": "ai",
"description": "Handles meeting scheduling for the sales team",
"metadata": { "team": "sales" }
}'
{
"id": "agt_a1b2c3d4",
"org_id": "org_abc",
"name": "Sales Agent - Acme Corp",
"type": "ai",
"status": "active",
"description": "Handles meeting scheduling for the sales team",
"metadata": { "team": "sales" },
"created_at": "2026-04-04T12:00:00Z",
"updated_at": "2026-04-04T12:00:00Z"
}

Triggers an agent.created webhook.

StatusTypeCause
429quota_exceededAgent limit reached on your plan

GET /v1/agents
ParameterTypeDefaultDescription
typestringFilter by ai, human, or resource
statusstringFilter by active, paused, or decommissioned
limitinteger501–200
offsetinteger0Pagination offset
Terminal window
curl "https://api.chronary.ai/v1/agents?type=ai&status=active&limit=10" \
-H "Authorization: Bearer chr_sk_test_your_key_here"
{
"data": [
{
"id": "agt_a1b2c3d4",
"name": "Sales Agent - Acme Corp",
"type": "ai",
"status": "active",
...
}
],
"total": 3,
"limit": 10,
"offset": 0
}

GET /v1/agents/:id
Terminal window
curl https://api.chronary.ai/v1/agents/agt_a1b2c3d4 \
-H "Authorization: Bearer chr_sk_test_your_key_here"
StatusTypeCause
404not_foundAgent not found

PATCH /v1/agents/:id
FieldTypeDescription
namestring1–255 characters
descriptionstring | nullSet to null to clear
metadataobjectReplaces existing metadata
statusstringactive or paused

At least one field must be provided.

Terminal window
curl -X PATCH https://api.chronary.ai/v1/agents/agt_a1b2c3d4 \
-H "Authorization: Bearer chr_sk_test_your_key_here" \
-H "Content-Type: application/json" \
-d '{ "status": "paused" }'

Triggers an agent.updated webhook.

StatusTypeCause
404not_foundAgent not found

DELETE /v1/agents/:id

Sets the agent status to decommissioned. Returns 204 No Content.

Terminal window
curl -X DELETE https://api.chronary.ai/v1/agents/agt_a1b2c3d4 \
-H "Authorization: Bearer chr_sk_test_your_key_here"
StatusTypeCause
404not_foundAgent not found