Skip to main content
DELETE
Delete a video job

Authorizations

Authorization
string
header
required

A workspace API key in an Authorization: Bearer header. A missing header, a scheme other than Bearer, a key of the wrong shape, and a key we reject are all 401.

Path Parameters

id
string
required

The video job id the create answered.

Response

The provider's answer, relayed, with its model field rewritten to the public id the create returned (provider/model).

One video job, as the provider reports it, with external URLs omitted and model rewritten to the public id the create returned. Providers report different extra fields; only the fields below are promised.

id
string
required

The job id the create answered. Pass it to the follow-up paths.

Example:

"video_123"

object
enum<string>
required
Available options:
video
model
string
required

The public provider/model id the create returned, so a poll names the model exactly as the create did.

Example:

"openai/sora-2"

status
enum<string>
required

Where the job stands. A provider that answers succeeded means completed.

Available options:
queued,
in_progress,
completed,
failed,
cancelled,
succeeded
progress
integer

How far along the provider says the job is, 0 to 100.

created_at
integer | null

When the job was created, in Unix seconds.

size
string

The requested size, in OpenAI WIDTHxHEIGHT spelling.

Example:

"1280x720"

seconds
string

The seconds of video, as a decimal string. A completed job reports what it rendered; settlement never charges above what the hold covered.

Example:

"8"

error
object

Present when the job failed: the provider's reason, with a stable code and a prose message.