Skip to navigation
EndpointsVideos

Start a video

Starts a video job and returns it with status queued. Poll GET /v1/videos/{id} until it is completed, then download it from GET /v1/videos/{id}/content.

Authentication

AuthorizationBearer

Your API key, sk-..., from Console → API keys.

Request

This endpoint expects an object.
modelstringRequired
promptstringRequired
secondsstringOptional

Length of the video, such as "4". Each model has its own choices.

sizestringOptional

Resolution, such as 1280x720.

input_referencestringOptionalformat: "binary"
An image to start the video from, on models that take one.
userstringOptional
metadatamap from strings to stringsOptional

Response

The new job.
idstringOptional
objectenumOptional
Allowed values:
modelstringOptional
statusenumOptional
Allowed values:
progressintegerOptional0-100
secondsstringOptional
sizestringOptional
created_atintegerOptional
Unix seconds.
completed_atinteger or nullOptional
errorobject or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
502
Bad Gateway Error