Skip to navigation

Get Video Task

Returns the current status of a video task (generation or editing). Tasks belong to the API key that created them; querying another key’s task returns 403. Task records are kept for 24 hours and return 404 afterwards. Poll every 3~10 seconds until the task reaches a terminal state (completed / failed). When the upstream query is temporarily unreachable, the gateway returns the cached status without blocking task progress. On failure, pre-deducted fees are automatically refunded.

Authentication

AuthorizationBearer

Use Authorization: Bearer $JOY_TOKEN_API_KEY.

Path parameters

task_idstringRequired
The task id returned by the creation endpoint.

Response

Current task status.
task_idstring
Task id.
statusenum

Task state; stop polling once completed or failed.

Allowed values:
modelstring
The actually selected model name.
progressinteger0-100

Progress percentage, 0~100.

createdlong

Unix timestamp (seconds) of task creation.

result_urlstringOptionalformat: "uri"

Present when completed. Upstream result URL, time-limited; download promptly or use GET /openai/v1/videos/{task_id}/content.

durationdoubleOptional

Present when completed. Actual video length in seconds (may be fractional).

completed_atlongOptional

Present when completed. Unix timestamp (seconds) of task completion.

errorobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
503
Service Unavailable Error