Skip to main content
GET
/
jobs
List Jobs
curl --request GET \
  --url https://api.example.com/jobs \
  --header 'x-api-key: <x-api-key>'
{
  "jobs": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
      "status": "Completed",
      "s3_key": "videos/my-video.mp4",
      "error": null,
      "step": "Finished",
      "created_at": 1705507200000,
      "finished_at": 1705507260000,
      "file_size": 52428800
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "url": "https://www.youtube.com/watch?v=abc123",
      "status": "Processing",
      "s3_key": null,
      "error": null,
      "step": "Downloading",
      "created_at": 1705507100000,
      "finished_at": null,
      "file_size": null
    }
  ],
  "total": 142,
  "limit": 20,
  "offset": 0
}

​
Overview

Returns a paginated list of jobs with optional status filtering. Jobs are returned in reverse chronological order (newest first).

​
Header Parameters

​
x-api-key
string
required
Your API key for authentication

​
Query Parameters

​
limit
integer
default:"20"
Number of jobs to return. Maximum: 100
​
offset
integer
default:"0"
Number of jobs to skip for pagination
​
status
string
Filter by job status: pending, processing, completed, failed

​
Response

​
jobs
array
Array of job objects
​
total
integer
Total number of jobs (ignoring filters)
​
limit
integer
Number of jobs requested
​
offset
integer
Number of jobs skipped

​
Job Object

​
id
string
Job UUID
​
url
string
Original video URL
​
status
string
Job status: Pending, Processing, Completed, Failed
​
s3_key
string
S3 object key (when completed)
​
error
string
Error message (when failed)
​
step
string
Current processing step: Queued, Downloading, Muxing, Uploading, Finished
​
created_at
integer
Creation timestamp (milliseconds since epoch)
​
finished_at
integer
Completion timestamp (milliseconds since epoch)
​
file_size
integer
File size in bytes (when completed)

​
Examples

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

​
Success Response

{
  "jobs": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
      "status": "Completed",
      "s3_key": "videos/my-video.mp4",
      "error": null,
      "step": "Finished",
      "created_at": 1705507200000,
      "finished_at": 1705507260000,
      "file_size": 52428800
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "url": "https://www.youtube.com/watch?v=abc123",
      "status": "Processing",
      "s3_key": null,
      "error": null,
      "step": "Downloading",
      "created_at": 1705507100000,
      "finished_at": null,
      "file_size": null
    }
  ],
  "total": 142,
  "limit": 20,
  "offset": 0
}

​
Error Responses

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