Endpoints
| Method | Path | Description | Credits |
|---|---|---|---|
| GET | /v1/usage | Aggregated usage statistics | 0 |
| GET | /v1/credits | Credit balance summary | 0 |
Usage statistics
The usage endpoint provides:- Request counts (total, successful, failed) per API key
- Credit consumption per key
- Custom date range filtering with
start_dateandend_date
Credit summary
The credits endpoint returns:- Current credit balance across all keys
- Credit limits per plan
- Next reset date
These endpoints are free — use them to build dashboards or set up alerting when credits are running low.
Related pages
Credits
Credit costs per endpoint and plan details.
Rate limits
Request limits by plan and retry strategies.
Authentication
Set up your API key for account access.
Errors
Error codes and response format.
Frequently asked questions
Do account endpoints consume credits?
Do account endpoints consume credits?
No. Both
GET /v1/usage and GET /v1/credits are free. You can call them as often as you need without affecting your credit balance. They’re designed for monitoring, so feel free to poll them from dashboards or alerting systems.How often is usage data updated?
How often is usage data updated?
Usage data updates in real time. Each API call is reflected in the
/v1/usage response immediately. Credit balances from /v1/credits also update instantly after every request, so you always see an accurate count of remaining credits.Can I set up alerts when my credits are running low?
Can I set up alerts when my credits are running low?
The API doesn’t have built-in alerting, but you can build it yourself. Poll
GET /v1/credits on a schedule (e.g., hourly) and trigger a notification when the remaining balance drops below your threshold. Since this endpoint is free, there’s no cost to frequent polling.