Appearance
Fresh 2026
Usage API
REST endpoints for querying Agent Handler usage by organization and by Registered User, including per-tool breakdowns.
All endpoints require start_time and end_time query parameters (ISO 8601). For authentication, see API overview.
GET /api/v1/usage/
Returns total credit and call usage for the organization.
json
{
"total_credits_used": 500,
"total_call_count": 2100,
"last_updated_at": "2026-06-03T17:00:00Z"
}GET /api/v1/usage/registered-users/
Returns credit and call usage broken down per Registered User. Paginated.
json
[
{
"registered_user_id": "uuid",
"credits_used": 250,
"call_count": 1050
}
]GET /api/v1/usage/registered-users/{registered_user_id}/
Returns a full tool-level breakdown for a single Registered User. Useful for surfacing action-level telemetry such as emails sent or Slack messages posted.
json
{
"registered_user_id": "uuid",
"total_credits_used": 250,
"total_call_count": 1050,
"last_updated_at": "2026-06-03T17:00:00Z",
"tool_breakdown": [
{
"connector_id": "uuid",
"tool_name": "gmail__send_email",
"credit_type": "simple",
"credits_used": 100,
"call_count": 47
},
{
"connector_id": "uuid",
"tool_name": "slack__send_message",
"credit_type": "simple",
"credits_used": 50,
"call_count": 12
}
]
}