APIFree
APIFree
Video Generation

GET /v1/videos/{task_id}

Retrieve the current status of a video generation task.

Retrieve the current status of a video generation task.

Description

Use this endpoint to poll the status of an asynchronous video generation task after calling POST /v1/videos.

This endpoint is also available through the compatibility route GET /v1/openai/videos/{task_id} with identical behavior.

Path parameters

NameTypeRequiredDescription
task_idstringYesVideo task identifier returned by the create endpoint.

Headers

NameTypeRequiredDescription
AuthorizationstringYesBearer token in the format Bearer YOUR_API_KEY.

Example request

curl https://api.apifree.ai/v1/videos/video_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Response schema

A successful response returns the current task object. Typical fields include:

FieldTypeDescription
idstringVideo task ID.
objectstringObject type, typically video.
created_at / createdintegerUnix timestamp for task creation time.
statusstringCurrent task status.
modelstringModel used for generation.
progressintegerProgress percentage when available.
secondsstring / integerVideo duration.
sizestringVideo size.

Typical status values include:

  • queued
  • in_progress
  • completed
  • failed

Example response:

{
  "id": "video_abc123",
  "object": "video",
  "created_at": 1758941485,
  "status": "in_progress",
  "model": "video-model-id",
  "progress": 42,
  "seconds": "8",
  "size": "1280x720"
}

Polling guidance

  • Poll every 5 to 15 seconds for long-running jobs.
  • Stop polling when the task reaches completed or failed.
  • If the task succeeds, the final response may include result metadata returned by the upstream provider.

Errors

Typical error cases include:

  • Missing task_id
  • Authentication failure
  • Task not found
  • Upstream status query failure