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
| Name | Type | Required | Description |
|---|---|---|---|
task_id | string | Yes | Video task identifier returned by the create endpoint. |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Bearer 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:
| Field | Type | Description |
|---|---|---|
id | string | Video task ID. |
object | string | Object type, typically video. |
created_at / created | integer | Unix timestamp for task creation time. |
status | string | Current task status. |
model | string | Model used for generation. |
progress | integer | Progress percentage when available. |
seconds | string / integer | Video duration. |
size | string | Video size. |
Typical status values include:
queuedin_progresscompletedfailed
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
completedorfailed. - 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