Sign in

v12

OpenAPI 3.1.02026-08-031000506.8 KB
Video

Grok Imagine

Fast, high-quality video generation by xAI.

post/generate/video/xai/grok-video

Headers

X-Webhook-URLstring uri

URL to receive a POST request when the job completes. The webhook will receive the job data including results.

Request body

promptstring required
start_imagestring uri nullable

Can be an external URL, base64 data URI, or uploaded asset URL.

start_videostring uri nullable

Can be an external URL, base64 data URI, or uploaded asset URL.

durationnumber
resolution'480p' | '720p'
aspect_ratio'16:9' | '9:16' | '1:1' | '4:3' | '3:4' | '3:2' | '2:3'
reference_imagesstring[]
edit_videostring uri

Can be an external URL, base64 data URI, or uploaded asset URL.

Response

The resulting job data. This will be returned in a pending state until the job is completed. See /jobs/{id} for retrieving the results.

job_idstring uuid required
status'backlogged' | 'queued' | 'scheduled' | 'processing' | 'sampling' | 'intermediate-complete' | 'completed' | 'failed' | 'cancelled' required
created_atstring date-time required
{"stackTrail":"paths:/generate/video/xai/grok-video:post:responses:200:content:application/json:schema:properties:completed_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/generate/video/xai/grok-video:post:responses:200:content:application/json:schema:properties:result","oasType":"schema","type":"unknown"}