Skip to main content
POST
Create a video job

Authorizations

Authorization
string
header
required

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

Body

application/json

Video generation request. model and prompt are required. The remaining fields are optional and model-specific; a model ignores any field it does not support. Call GET /v1/models for the parameters each model accepts. Additional model-specific parameters not listed here may also be sent and are forwarded to the model.

model
string
required

The video model id. See GET /v1/models.

Example:

"grok-imagine-video"

prompt
string
required

Text description of the video to generate.

Example:

"a paper boat drifting down a rain-soaked street"

input_reference
string

A public image URL or data: URI. Switches the model to image-to-video mode. Only supported models accept it.

resolution
string

Model-specific. Resolution tier such as 480p, 720p, 1080p, or 4k. Allowed values are per model and set the billed price on resolution-priced models.

Example:

"480p"

duration
integer

Model-specific. Clip length in seconds (the billed length). An enum for some models, a range for others.

Example:

4

aspect_ratio
string

Model-specific. Aspect ratio such as 16:9 or 9:16. Some models add auto in image-to-video mode.

Example:

"16:9"

generate_audio
boolean

Model-specific. Generate a soundtrack, on models that support audio. The audio tier costs more per second, and each model sets its own default.

negative_prompt
string

Model-specific. What to avoid in the output, on models that support it.

seed
integer

Model-specific. Seed for reproducible output. Omit for a random seed.

Response

The created 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.