List videos

GET /openai/v1/videos● Supported

Official OpenAI docs ↗

Request parameters

afterstring可选
query: Cursor: the id of the video job after which the page starts, normally the `last_id` of the previous page. It must refer to an existing job of yours, otherwise the call fails.
Pagination works; limit is 1–100, order is asc/desc, and after must refer to an existing job.
limitinteger可选
默认 20
query: Maximum number of jobs per page, from 1 to 100; defaults to 20.
Pagination works; limit is 1–100, order is asc/desc, and after must refer to an existing job.
orderany可选
默认 "desc"
query: Sort order by creation time: desc (default) lists the newest job first, asc the oldest first.
Pagination works; limit is 1–100, order is asc/desc, and after must refer to an existing job.
取值 ascdesc

Returns

200 list

Lists the video jobs of your account. limit is 1–100, order is asc or desc, and after must refer to an existing job.

Errors follow the OpenAI format — see error codes

Response

HTTP 200

Success

application/json

Name	Type	Description
object	string	Object type; always `list`.
data	array<object>	Video jobs of the caller, newest first by default.
data[].id	string	Id of the video job; pass it as `video_id` to retrieve, download or delete it.
data[].object	string	Object type; always `video`.
data[].model	string	Model that generates the video.
data[].status	string	Lifecycle of the job. Poll until it is `completed` or `failed`.
data[].progress	integer	Progress from 0 to 100. It is 0 until the job completes and 100 once it has.
data[].created_at	integer	Unix time in seconds at which the job was created.
data[].completed_at	integer \| null	Unix time in seconds at which the job completed; null until then.
data[].expires_at	integer \| null	Unix time in seconds after which the output expires; null because outputs currently have no expiry.
data[].seconds	string	Length of the video in seconds, as a string; for a completed job it is the delivered length.
data[].size	string	Resolution of the video as `WIDTHxHEIGHT`; null when the provider did not report one.
data[].prompt	string \| null	Prompt the job was created with.
data[].remixed_from_video_id	null	Always null; remix is not supported.
data[].error	object \| null	Why the job failed; null unless status is `failed`.
data[].polling_url	string	Relative URL to poll for the job state; same as retrieveVideo for this job.
data[].unsigned_urls	array<string>	Relative URLs of the finished output; empty until the video is ready. Download them with the same API key.
data[].usage	object	Cost of the job; present once a price applies.
has_more	boolean	Whether more jobs exist beyond this page; pass `last_id` as `after` to read them.
first_id	string \| null	Id of the first job in this page; null for an empty page.
last_id	string \| null	Id of the last job in this page; null for an empty page.