Skip to main content
GET
/
usage
Get Usage
curl --request GET \
  --url https://api.example.com/usage
{
  "client_name": "My Application",
  "usage_count": 1523,
  "storage_usage_gb": 45.67
}

​
Overview

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

​
Request

No request body required. Authentication via x-api-key header.

​
Response

​
client_name
string
Your account/client name
​
usage_count
integer
Total number of jobs created
​
storage_usage_gb
number
Total storage used in gigabytes
​
billing_period_start
string
Start of current billing period (if Stripe billing enabled)
​
billing_period_end
string
End of current billing period (if Stripe billing enabled)
​
current_period_usage_gb
number
Storage used in current billing period (if Stripe billing enabled)

​
Example

curl -X GET "https://tornado.velys.software/usage" \
  -H "x-api-key: sk_your_api_key"

​
Success Response

{
  "client_name": "My Application",
  "usage_count": 1523,
  "storage_usage_gb": 45.67
}

​
Error Responses

{
  "error": "Missing x-api-key header"
}

​
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.

​
Monitoring Usage

import requests

def check_usage(api_key):
    response = requests.get(
        "https://tornado.velys.software/usage",
        headers={"x-api-key": api_key}
    )
    data = response.json()

    print(f"Client: {data['client_name']}")
    print(f"Jobs: {data['usage_count']}")
    print(f"Storage: {data['storage_usage_gb']:.2f} GB")

check_usage("sk_your_api_key")