Skip to main content

​
Check status

GET /video-status/{path}
Auth: Public (rate limited)

​
Path parameters

​
path
string
required
Storage path of the video file.videos/clip.mp4 · clip.mp4

​
Response

{
  "status": "running",
  "progress": 62,
  "startedAt": "2024-03-15T10:30:00.000Z",
  "completedAt": null,
  "error": null,
  "message": "Processing in progress"
}
​
status
string
One of: not_found · pending · running · completed · error
​
progress
number
Processing progress from 0 to 100.
​
startedAt
string
ISO 8601 timestamp when processing started. null if not yet started.
​
completedAt
string
ISO 8601 timestamp when processing finished. null if still in progress.
​
error
string
Error message if status is error.
Status codes: 200 success · 404 file not found

​
Example

curl http://localhost:3000/video-status/videos/clip.mp4

​
Get optimized video size

GET /video-status/{path}/size
Returns the file size of the optimized (processed) video variant. Returns 404 if the optimized version is not yet ready. Auth: Public (rate limited)

​
Response

{
  "size": 2097152,
  "status": "ready"
}
​
size
number
Optimized video size in bytes.
​
status
string
Always "ready" when the endpoint returns 200.
Status codes: 200 ready · 404 not yet processed

​
Example

curl http://localhost:3000/video-status/videos/clip.mp4/size

Queue Events (SSE)

Real-time updates without polling.

Queue Jobs

Manage jobs by ID.

Transform Media

Apply transformations to videos.