API reference

API reference · API

List this account's video jobs

GET/v1/videosAPI key

Newest first unless order=asc, a page of limit (1 to 100, 20 unless set).

Parameters

Path and query parameters
FieldTypeWhat it is
after (query)stringA job id to page after.
limit (query)integer1 to 100. From 1 to 100.
order (query)stringasc or desc. One of "asc", "desc".

Answer 200

A list.

Fields of the 200 answer
FieldTypeWhat it is
objectstringOne of "list".
dataarray of object
data[].idrequiredstringvideo_, sound_, mesh_ or still_ then 24 hex digits.
data[].objectrequiredstringOne of "video", "sound", "mesh", "still".
data[].modelrequiredstring
data[].statusrequiredstringOne of "queued", "in_progress", "completed", "failed", "cancelled".
data[].progressinteger0 until completed, then 100.
data[].created_atrequiredinteger
data[].completed_atinteger or null
data[].expires_atinteger or nullWhen the file stops being fetchable: 60 minutes after completion.
data[].promptstring or null
data[].secondsstring
data[].sizestring
data[].resolutionstring
data[].aspect_ratiostring
data[].audioboolean
data[].reference_countintegerHow many reference pictures it was sent; the pictures are not kept.
data[].content_typestring or null
data[].hold_microsrequiredintegerThe worst case held while it runs.
data[].cost_microsinteger or nullWhat it was billed, never past the hold.
data[].cancel_requestedboolean
data[].errorobject or nullgeneration_failed, deadline_exceeded, provider_unanswered (billed its hold), submit_lost or model_unavailable.
data[].error.codestring
data[].error.messagestring
first_idstring or null
last_idstring or null
has_moreboolean

Errors

  • 400OpenAI shaped error.
  • 404OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter