Usage

Monitor your current billing period usage, quotas, and API request statistics.

Get Usage Statistics

GET/v1/usage

Returns comprehensive usage information for your organization including audio/video quota, credit balance, and API request statistics.

200 OK
{
"success": true,
"data": {
"period_start": "2026-01-01T00:00:00.000Z",
"period_end": "2026-02-01T00:00:00.000Z",
"audio": {
"quota": 10,
"used": 7,
"remaining": 3
},
"video": {
"quota": 5,
"used": 2,
"remaining": 3
},
"credits": {
"available": 25,
"audio_credits": 15,
"video_credits": 10,
"expiring_soon": 5
},
"api_requests": {
"today": 45,
"daily_limit": 500,
"this_minute": 3,
"minute_limit": 60
}
},
"request_id": "req_1kn5f2a_a3b4c5d6e7f8",
"timestamp": "2026-01-18T14:30:00.000Z"
}

Response Fields

Billing Period

FieldTypeDescription
period_startstringStart of current billing period (ISO 8601)
period_endstringEnd of current billing period (ISO 8601)

Audio & Video QuotasVideo Coming Soon

FieldTypeDescription
audio.quotaintegerMonthly audio episode limit
audio.usedintegerAudio episodes used this period
audio.remainingintegerRemaining audio episodes
video.quotaintegerMonthly video episode limit
video.usedintegerVideo episodes used this period
video.remainingintegerRemaining video episodes

Credits

FieldTypeDescription
credits.availableintegerTotal available credits (audio + video)
credits.audio_creditsintegerAudio episode credits available
credits.video_creditsintegerVideo episode credits available (coming soon)
credits.expiring_soonintegerCredits expiring within 30 days

API Requests

FieldTypeDescription
api_requests.todayintegerAPI requests made today (UTC)
api_requests.daily_limitintegerMaximum daily requests for your tier
api_requests.this_minuteintegerRequests made in the current minute
api_requests.minute_limitintegerMaximum requests per minute for your tier

Rate Limit Headers

All API responses include rate limit and quota information in headers:

X-RateLimit-Limit: 500
X-RateLimit-Remaining: 455
X-RateLimit-Reset: 1705622400
X-RateLimit-Limit-Minute: 60
X-RateLimit-Remaining-Minute: 57
X-Quota-Audio-Limit: 10
X-Quota-Audio-Remaining: 3
X-Quota-Video-Limit: 5
X-Quota-Video-Remaining: 3
X-Quota-Reset: 2026-02-01T00:00:00Z
X-Quota-Credits-Available: 25
HeaderDescription
X-RateLimit-LimitYour daily request limit
X-RateLimit-RemainingRemaining requests today
X-RateLimit-ResetUnix timestamp when daily limit resets
X-RateLimit-Limit-MinuteYour per-minute request limit
X-RateLimit-Remaining-MinuteRemaining requests this minute
X-Quota-Audio-LimitMonthly audio episode limit
X-Quota-Audio-RemainingRemaining audio episodes
X-Quota-Video-LimitMonthly video episode limit (coming soon)
X-Quota-Video-RemainingRemaining video episodes (coming soon)
X-Quota-ResetISO 8601 timestamp for quota reset
X-Quota-Credits-AvailableAvailable credit balance