Skip to main content
GET
Get video task

Authorizations

Authorization
string
header
required

An API key created in the OmniRelay console. The owner can view it again in the console after confirming their identity.

Path Parameters

id
string
required

Task ID returned when the task was created.

Response

Current task state.

id
string
required
model
string
required
status
enum<string>
required

succeeded is charged; failed, expired and cancelled are not.

Available options:
queued,
running,
succeeded,
failed,
expired,
cancelled
created_at
integer
required

Unix seconds.

updated_at
integer
required

Unix seconds.

content
object
duration
integer
ratio
string
resolution
string
framespersecond
integer
seed
integer
generate_audio
boolean
usage
object
error
object

Why the task was not generated.

cost_microusd
integer

Charge in micro-USD after your discount. Present once the task is settled.