Usage API
Track and monitor API usage and quotas.
Endpoints#
| Method | Endpoint | Description |
|---|---|---|
GET | /usage | Get current period usage |
GET | /usage/history | Get historical usage |
GET | /usage/breakdown | Get usage by category |
Usage Object#
Loading code block...
Get Current Usage#
Loading code block...
Example Request#
Loading code block...
Response#
Loading code block...
Get Usage History#
Loading code block...
Query Parameters#
| Parameter | Type | Description |
|---|---|---|
period | string | daily, weekly, monthly (default: daily) |
start | string | Start date (ISO 8601) |
end | string | End date (ISO 8601) |
metric | string | Specific metric to retrieve |
Example Request#
Loading code block...
Response#
Loading code block...
Get Usage Breakdown#
Loading code block...
Query Parameters#
| Parameter | Type | Description |
|---|---|---|
groupBy | string | project, agent, skill, endpoint |
start | string | Start date (ISO 8601) |
end | string | End date (ISO 8601) |
Example Request#
Loading code block...
Response#
Loading code block...
Breakdown by Project#
Loading code block...
Loading code block...
Usage Limits by Plan#
| Metric | Free | Pro | Team | Enterprise |
|---|---|---|---|---|
| API Calls/month | 1,000 | 10,000 | 50,000 | Custom |
| Agent Invocations/month | 50 | 1,000 | 5,000 | Custom |
| Skill Applications/month | 20 | 500 | 2,500 | Custom |
| Context Generations/month | 20 | 500 | 2,500 | Custom |
| Projects | 1 | 10 | 50 | Unlimited |
Usage Alerts#
Configure alerts when approaching limits:
Loading code block...
Request Body#
Loading code block...
Response#
Loading code block...
Export Usage Data#
Loading code block...
Query Parameters#
| Parameter | Type | Description |
|---|---|---|
format | string | csv or json (default: json) |
start | string | Start date |
end | string | End date |
Example Request#
Loading code block...
Quota Reset#
Quotas reset on the 1st of each month at 00:00 UTC.
Check when quota resets:
Loading code block...
Overage Handling#
When you exceed your plan's limits:
| Plan | Behavior |
|---|---|
| Free | Requests blocked until reset |
| Pro | Charged per-request overage fee |
| Team | Charged per-request overage fee |
| Enterprise | Custom agreement |
Overage Response#
Loading code block...