Skip to main content
GET
Get Usage

Overview

Returns usage statistics for your API key, including job count and storage usage.

Header Parameters

string
required
Your API key for authentication

Response

string
Your account/client name
integer
Total number of jobs created
number
Total storage used in gigabytes
number
Storage currently reserved by in-progress jobs (in gigabytes). Released when jobs complete or fail.
number
Effective storage usage: storage_usage_gb + storage_reserved_gb. Used for quota enforcement.
string
Start of current billing period (if Stripe billing enabled)
string
End of current billing period (if Stripe billing enabled)
number
Storage used in current billing period (if Stripe billing enabled)
number
Storage limit in gigabytes (only present for trial/limited keys)
integer
Storage limit in bytes (only present for trial/limited keys)
number
Remaining storage in gigabytes before quota is reached (only present for trial/limited keys)
string
Error message when billing info retrieval fails (only present when Stripe billing is configured and an error occurs)
string
Maximum video resolution allowed for this API key (e.g., "720", "1080"). Only present if a resolution limit is configured.
integer
Maximum video duration in seconds allowed for this API key (e.g., 600 for 10 min). Only present if a duration limit is configured.
integer
Maximum file size per video in bytes. Only present if a file size limit is configured.
number
Maximum file size per video in megabytes. Only present if a file size limit is configured.

Example

Success Response

Error Responses

Usage Tracking

Job Count

Incremented each time you call POST /jobs. For batch operations, each episode counts as one job.

Storage Usage

Cumulative total of all files uploaded to S3. This includes:
  • Successfully completed videos
  • All formats (MP4, MKV, MP3)
Deleting files from S3 does not decrease the storage counter. This metric tracks total data transferred.

Storage Quota (Trial Keys)

API keys with a storage limit (e.g., 1 TB trial keys) include quota information in the response. When the limit is reached, new jobs are rejected with a 403 Forbidden error:
The response fields vary depending on your key type:

Monitoring Usage