a13nDocs
API referenceUsage

Usage Agents

GET/api/v1/usage/agents

Authorization

AuthorizationBearer <token>

A workspace API key (a13n_...)

In: header

Query Parameters

start*Start
Formatdate-time
end*End
Formatdate-time
limit?Limit
Range1 <= value <= 100
Default50
cursor?|null

Header Parameters

X-Workspace-ID?|

The workspace ID a login session acts in; required with a login session. An API key acts in its own workspace and needs none; naming another is forbidden.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/usage/agents?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
{  "items": [    {      "agent_id": "string",      "name": "string",      "runs": {        "average_duration_seconds": 0,        "runs": 0      },      "usage": {        "cache_hit_rate": 0,        "cache_read_tokens": 0,        "cost": "string",        "input_tokens": 0,        "output_tokens": 0,        "requests": 0,        "unpriced_requests": 0      }    }  ],  "next_cursor": "string"}