Skip to main content
GET
Retrieve a video job

Authorizations

Authorization
string
header
required

Your Deepshi API key, sent as Authorization: Bearer <key>.

Path Parameters

video_id
string
required

The job id returned by POST /v1/videos.

Response

The video job.

A video generation job.

id
string

The job id. Pass it to the retrieve, content, and delete endpoints.

object
string

Object type, always video.

Example:

"video"

model
string

The video model id you requested.

status
enum<string>

Lifecycle state of the job.

Available options:
queued,
in_progress,
completed,
failed
size
string

The resolution the job bills at.

seconds
string

The clip length the job bills at, in seconds.

created_at
integer<int64>

Unix timestamp when the job was created.

completed_at
integer<int64> | null

Unix timestamp when the job completed.

videos
object[]

The generated video, present when status is completed.

error
object | null

Present when status is failed. Explains the failure; the job is not charged.