Retrieve a video generation task
get/v1/video/generations/{task_id}
Retrieve the status and result of a video generation task.
Task statuses:
queued: waiting in the queuein_progress: generatingcompleted: finishedfailed: failed
Authentication
Send your OLETOKEN API key as a Bearer token. Keys are created on the API Keys page of the console.
Authorization: Bearer $OLETOKEN_API_KEYParameters
| Field | Type | Required | Description |
|---|---|---|---|
| task_idpath | string | Task ID |
Responses
200Task status retrieved
| Field | Type | Required | Description |
|---|---|---|---|
| task_id | string | — | Task ID |
| status | stringqueuedin_progresscompletedfailed | — | Task status |
| url | string | — | Video URL (when the task succeeded) |
| format | string | — | Video format |
| metadata | VideoTaskMetadata | — | — |
| duration | number | — | Actual video duration |
| fps | integer | — | Actual frame rate |
| width | integer | — | Actual width |
| height | integer | — | Actual height |
| seed | integer | — | The random seed that was used |
| error | VideoTaskError | — | — |
| code | integer | — | Error code |
| message | string | — | Error message |
404Task not found
| Field | Type | Required | Description |
|---|---|---|---|
| error | object | — | — |
| message | string | — | Error message |
| type | string | — | Error type |
| param | string | null | — | The parameter involved |
| code | string | null | — | Error code |
Example request
curl -X GET 'https://api.oletoken.ai/v1/video/generations/{task_id}' \
-H "Authorization: Bearer $OLETOKEN_API_KEY"