OpenAI
Retrieve video
Retrieve the status of a video job by ID.
Call Create video first and replace video_123 with its ID; poll until completed before downloading.
GET
/openai/v1/videos/{video_id}● SupportedRequest parameters
video_idstring必填path: Id of the video job whose output you want, the `id` returned by createVideo. The job must be completed; before that the call answers 400.
Returns
200 video
Reads the job's current status and progress. Keep polling while status is queued or in_progress, inspect error when it is failed, and download the content only once it is completed. An unknown job returns 404.
Errors follow the OpenAI format — see error codes
Response
HTTP 200
Success
application/json
| Name | Type | Description |
|---|---|---|
| id | string | Id of the video job; pass it as `video_id` to retrieve, download or delete it. |
| object | string | Object type; always `video`. |
| model | string | Model that generates the video. |
| status | string | Lifecycle of the job. Poll until it is `completed` or `failed`. |
| progress | integer | Progress from 0 to 100. It is 0 until the job completes and 100 once it has. |
| created_at | integer | Unix time in seconds at which the job was created. |
| completed_at | integer | null | Unix time in seconds at which the job completed; null until then. |
| expires_at | integer | null | Unix time in seconds after which the output expires; null because outputs currently have no expiry. |
| seconds | string | Length of the video in seconds, as a string; for a completed job it is the delivered length. |
| size | string | Resolution of the video as `WIDTHxHEIGHT`; null when the provider did not report one. |
| prompt | string | null | Prompt the job was created with. |
| remixed_from_video_id | null | Always null; remix is not supported. |
| error | object | null | Why the job failed; null unless status is `failed`. |
| error.code | string | Machine-readable failure code. |
| error.message | string | Human-readable failure message. |
| polling_url | string | Relative URL to poll for the job state; same as retrieveVideo for this job. |
| unsigned_urls | array<string> | Relative URLs of the finished output; empty until the video is ready. Download them with the same API key. |
| usage | object | Cost of the job; present once a price applies. |
| usage.cost | number | Cost of the job in USD: delivered seconds times the per-second price once completed, 0 while running. |