Skip to main content

​
Base URL

https://api.tornadoapi.io

​
Authentication

All endpoints require the x-api-key header: 
curl -H "x-api-key: sk_your_api_key" https://api.tornadoapi.io/usage

​
Endpoints Overview

​
Jobs

MethodEndpointDescription
POST/jobsCreate a download job
GET/jobs/{id}Get job status
GET/jobsList all jobs
DELETE/jobs/{id}Cancel a pending job
POST/jobs/{id}/retryRetry a failed job
DELETE/jobs/{id}/fileDelete a job’s file from storage

​
Bulk

MethodEndpointDescription
POST/jobs/bulkCreate multiple download jobs at once

​
Metadata

MethodEndpointDescription
POST/metadataExtract video metadata without downloading

​
Batch Operations

MethodEndpointDescription
GET/batch/{id}Get batch status
PATCH/batch/{id}/jobsRename jobs in a paused batch
POST/batch/{id}/startStart a paused batch

​
User

MethodEndpointDescription
GET/usageGet usage statistics
POST/user/s3Configure S3-compatible storage (AWS S3, R2, MinIO, etc.)
DELETE/user/s3Remove S3 storage configuration
POST/user/blobConfigure Azure Blob Storage
DELETE/user/blobRemove Azure Blob Storage configuration
POST/user/gcsConfigure Google Cloud Storage
DELETE/user/gcsRemove Google Cloud Storage configuration
POST/user/ossConfigure Alibaba Cloud OSS
DELETE/user/ossRemove Alibaba OSS configuration
POST/user/bucketConfigure S3 storage (legacy, use /user/s3 instead)
DELETE/user/bucketRemove S3 storage (legacy)

​
Response Format

All responses are JSON. Successful responses have a 2xx status code.

​
Success Response

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Error Response

{
  "error": "Invalid API Key"
}

​
Status Codes

CodeDescription
200Success
201Created (for POST requests)
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
404Not Found - Resource doesn’t exist
500Internal Server Error
504Gateway Timeout - Long operation timed out

​
Rate Limits

Currently no strict rate limits. Recommended:
  • Max 500 concurrent jobs
  • Poll status every 2-5 seconds

​
OpenAPI Spec

Interactive API documentation (Swagger UI) is available at: 
https://api.tornadoapi.io/swagger
This Swagger UI allows you to test endpoints directly in your browser.