Usage

GET /v1/usage

Get current usage counters and plan limits for the billing period.

Example

curl https://api.vidocu.ai/v1/usage \
  -H "Authorization: Bearer vdo_live_your_key_here"

Response 200 OK

{
  "plan": "growth",
  "period": {
    "start": "2024-02-01T00:00:00.000Z",
    "end": null
  },
  "usage": {
    "apiCalls": 1542,
    "videoMinutes": 45.3,
    "exports": 12,
    "analyses": 28,
    "translations": 5,
    "helpArticles": 8,
    "voiceovers": 3
  },
  "limits": {
    "videoMinutesPerMonth": 120,
    "requestsPerMinute": 200
  }
}

Response fields

Field	Type	Description
plan	string	Current plan: starter, growth, scale, or enterprise
period.start	string	Billing period start
period.end	string | null	Billing period end (null for current period)
usage.apiCalls	number	Total API calls this period
usage.videoMinutes	number	Video minutes processed
usage.exports	number	Videos exported
usage.analyses	number	Videos analyzed
usage.translations	number	Translations completed
usage.helpArticles	number	Articles generated
usage.voiceovers	number	Voiceovers generated
limits.videoMinutesPerMonth	number	Monthly video minute limit (-1 = unlimited)
limits.requestsPerMinute	number	API requests per minute limit

Errors

Status	Code	Cause
401	authentication_error	Invalid or missing API key