API reference · xAI

xai/grok-imagine-video/reference-to-video

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

VIDEOAsyncOpen model
Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run
Model IDxai/grok-imagine-video/reference-to-video
01

Input Schema

5 parameters · 1 required · 4 optional

ParameterTypeRequiredDescription
promptstringRequiredText prompt describing the video to generate. Use @Image1, @Image2, etc. to reference specific images from reference_image_urls in order. · Max length: 4096
durationintegerOptionalVideo duration in seconds. · Min: 1 · Max: 10 · Default: 8
resolutionstringOptionalResolution of the output video. · Options: 480p, 720p · Default: "480p"
480p720p
aspect_ratiostringOptionalThe aspect ratio of the generated image. · Options: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16
21:916:93:24:35:41:14:53:42:39:16
reference_image_urlsstring[]OptionalOne or more reference image URLs to guide the video generation as style and content references. Reference in prompt as @Image1, @Image2, etc. Maximum 7 images.
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

  1. Submit — POST to /v1/run, receive an id
  2. Poll — GET /v1/run/{id} until status is completed, failed, or timeout
  3. Retrieve — Read outputs from the completed response
03

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "xai/grok-imagine-video/reference-to-video",
  "prompt": "A @Image1 running through a sunlit meadow, cinematic slow motion",
  "duration": 8,
  "resolution": "480p",
  "reference_image_urls": [
    "https://static.sandbase.ai/examples/xai/grok-imagine-video/reference-to-video/input_reference_image_urls_0.png"
  ]
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"