Administer

Usage API

Query credit and call usage programmatically.

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.

1{
2  "total_credits_used": 500,
3  "total_call_count": 2100,
4  "last_updated_at": "2026-06-03T17:00:00Z"
5}

GET /api/v1/usage/registered-users/

Returns credit and call usage broken down per Registered User. Paginated.

1[
2  {
3    "registered_user_id": "uuid",
4    "credits_used": 250,
5    "call_count": 1050
6  }
7]

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.

1{
2  "registered_user_id": "uuid",
3  "total_credits_used": 250,
4  "total_call_count": 1050,
5  "last_updated_at": "2026-06-03T17:00:00Z",
6  "tool_breakdown": [
7    {
8      "connector_id": "uuid",
9      "tool_name": "gmail__send_email",
10      "credit_type": "simple",
11      "credits_used": 100,
12      "call_count": 47
13    },
14    {
15      "connector_id": "uuid",
16      "tool_name": "slack__send_message",
17      "credit_type": "simple",
18      "credits_used": 50,
19      "call_count": 12
20    }
21  ]
22}