Get video status

GET https://api.ofox.io/v1/videos/{id}

Query the status and result of a task. After you create a task, poll this endpoint until status reaches a terminal state — completed, failed, cancelled, or expired.

curl https://api.ofox.io/v1/videos/9bcf3c60-7db2-4e1a-a1b2-c3d4e5f60718 \
  -H "Authorization: Bearer $OFOX_API_KEY"

Rate limiting

This endpoint is rate-limited per API key (default 5 req/s with a burst of 20). Requests over the limit return 429 rate_limited with a Retry-After: 1 header. Creating (POST) and cancelling (DELETE) are not subject to this limit.

Response

{
  "id": "9bcf3c60-7db2-4e1a-a1b2-c3d4e5f60718",
  "status": "completed",
  "model": "bytedance/seedance-2.5",
  "prompt": "A golden retriever running on the beach at sunset",
  "unsigned_urls": ["https://upstream.example/out.mp4"],
  "mirror_urls":   ["https://cdn.ofox.io/videos/vgen_xxx.mp4?sig=..."],
  "usage": {
    "video_seconds": 5,
    "video_cost": "0.4000000000"
  },
  "created_at": 1776211362,
  "updated_at": 1776211400
}

{
  "id": "9bcf3c60-7db2-4e1a-a1b2-c3d4e5f60718",
  "status": "failed",
  "model": "bytedance/seedance-2.5",
  "prompt": "A golden retriever running on the beach at sunset",
  "error": {
    "code": "expired",
    "message": "Generation timed out"
  },
  "created_at": 1776211362,
  "updated_at": 1776211600
}

A timeout is reported as status: "failed" with error.code set to expired. For the full list of error codes, see Error codes.

The Video object

State machine

Seven states, built on the OpenRouter naming and extended with cancelled / expired.

Transitions: pending → queued → in_progress → completed is the success path. Any non-terminal state can move to failed, cancelled, or expired.

Video URLs

A successful task may return two sets of URLs, depending on whether the model’s provider has CDN mirroring enabled.