Sign in
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"}

Changes

Changed in 1 of the 81 revisions of this API.1

  • 27a8a554d4fd1See the full diff
    • ○

      the response's property pattern was changed from ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status

      response-property-pattern-changed