Skip to content

DocsAPI referenceAccount

Usage by key

The organization's credits and jobs per API key, MCP app and the dashboard for a range, the same lines and totals as the billing page's "Usage by key". The billing period counts a job in the period it was admitted in; the last 30 days and a month count a job by when it ended. A scoped API key needs the usage:read scope (full keys may call it).

GET /v1/usage

Needs an API key: Authorization: Bearer $VIDEXO_API_KEY.

Parameters

Parameters
NameInTypeDescription
range querystringperiod (the current billing period, the default), last_30_days, or a UTC month YYYY-MM of the last 12, the current one included.

Request

bash
curl "$VIDEXO_API_URL/v1/usage?range=last_30_days" \
  -H "Authorization: Bearer $VIDEXO_API_KEY"

Response

200 JSON
{
  "range": {
    "name": "last_30_days",
    "from": "2026-10-05T12:00:00.000Z",
    "to": "2026-11-04T12:00:00.000Z"
  },
  "credits": 1465.2,
  "jobs": 214,
  "data": [
    {
      "credential": {
        "kind": "api_key",
        "id": "key_2Hs8vQ1pRm",
        "name": "production-worker",
        "state": "active"
      },
      "jobs": 187,
      "credits": 1310.7
    },
    {
      "credential": {
        "kind": "oauth",
        "id": "ogr_7d2k9m4q1x8c3v6b5n0z2w1r",
        "name": "Claude",
        "state": "active"
      },
      "jobs": 19,
      "credits": 121.4
    },
    {
      "credential": {
        "kind": "dashboard",
        "id": null,
        "name": null,
        "state": null
      },
      "jobs": 8,
      "credits": 33.1
    }
  ]
}

Responses

Responses
StatusBodyWhen
200KeyUsageUsage by key for the range.
400Probleminvalid_request: range is not one of the ranges offered
401Problemauthentication_failed (missing_api_key, invalid_api_key, api_key_revoked, api_key_expired)
403Problempermission_denied (token_scope): a client token cannot call this route; permission_denied (key_scope): a scoped API key without usage:read
429Problemrate_limited