API ReferenceVideo Generation

Submit a video generation request

Submits a video generation request and returns a polling URL to check status

Authentication

AuthorizationBearer
API key as bearer token in Authorization header

Request

This endpoint expects an object.
modelstringRequired
promptstringRequired
aspect_ratioenumOptional
Aspect ratio of the generated video
durationintegerOptional>=0
Duration of the generated video in seconds
generate_audiobooleanOptional
Whether to generate audio alongside the video. Defaults to true for models that support audio output, false otherwise.
input_referenceslist of objectsOptional
Reference images to guide video generation
providerobjectOptional

Provider-specific passthrough configuration

resolutionenumOptional
Resolution of the generated video
seedintegerOptional
If specified, the generation will sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed for all providers.
sizestringOptional

Exact pixel dimensions of the generated video in “WIDTHxHEIGHT” format (e.g. “1280x720”). Interchangeable with resolution + aspect_ratio.

Response

Video generation request accepted
idstring
polling_urlstring
statusenum
errorstring
generation_idstring
The generation ID associated with this video generation job. Available once the job has been processed.
unsigned_urlslist of strings
usageobject
Usage and cost information for the video generation. Available once the job has completed.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error