Skip to main content

​
Base URL

https://tornado.velys.software

​
Authentication

All endpoints require the x-api-key header: 
curl -H "x-api-key: sk_your_api_key" https://tornado.velys.software/usage

​
Endpoints Overview

​
Jobs

MethodEndpointDescription
POST/jobsCreate a download job
GET/jobs/{id}Get job status

​
Batch Operations

MethodEndpointDescription
GET/batch/{id}Get batch status

​
User

MethodEndpointDescription
GET/usageGet usage statistics
POST/user/bucketConfigure S3 storage

​
Dashboard

MethodEndpointDescription
GET/dashboard/statsGet aggregated stats
GET/dashboard/jobsList jobs with pagination
GET/dashboard/batchesList batch operations
GET/dashboard/dailyGet 7-day stats for chart

​
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://tornado.velys.software/swagger
This Swagger UI allows you to test endpoints directly in your browser.