↑↓ Navigate enter Open esc Close
Dashboard
MODEL ID xai:grok-imagine@video
live

Grok Imagine Video

xAI
by xAI

Grok Imagine Video is a multimodal generative video model that produces short video clips with native audio from text descriptions or static images. It supports text-to-video and image-to-video generation with synchronized sound effects and dialogue, enabling developers to animate scenes with motion, camera dynamics, and audio in a single API workflow.

Grok Imagine Video

API Options

Platform-level options for task execution and delivery.

taskType

string required value: videoInference

Identifier for the type of task being performed

taskUUID

string required UUID v4

UUID v4 identifier for tracking tasks and matching async responses. Must be unique per task.

outputType

string default: URL

Video output type.

Allowed values 1 value

outputFormat

string default: MP4

Specifies the file format of the generated output. The available values depend on the task type and the specific model's capabilities.

  • `MP4`: Widely supported video container (H.264), recommended for general use.
  • `WEBM`: Optimized for web delivery.
  • `MOV`: QuickTime format, common in professional workflows (Apple ecosystem).
Allowed values 3 values

outputQuality

integer min: 20 max: 99 default: 95

Compression quality of the output. Higher values preserve quality but increase file size.

webhookURL

string URI

Specifies a webhook URL where JSON responses will be sent via HTTP POST when generation tasks complete. For batch requests with multiple results, each completed item triggers a separate webhook call as it becomes available.

Learn more 1 resource

deliveryMethod

string default: async

Determines how the API delivers task results.

Allowed values 1 value
Returns an immediate acknowledgment with the task UUID. Poll for results using getResponse. Required for long-running tasks like video generation.
Learn more 1 resource

uploadEndpoint

string URI

Specifies a URL where the generated content will be automatically uploaded using the HTTP PUT method. The raw binary data of the media file is sent directly as the request body. For secure uploads to cloud storage, use presigned URLs that include temporary authentication credentials.

Common use cases:

  • Cloud storage: Upload directly to S3 buckets, Google Cloud Storage, or Azure Blob Storage using presigned URLs.
  • CDN integration: Upload to content delivery networks for immediate distribution. 
// S3 presigned URL for secure upload
https://your-bucket.s3.amazonaws.com/generated/content.mp4?X-Amz-Signature=abc123&X-Amz-Expires=3600

// Google Cloud Storage presigned URL
https://storage.googleapis.com/your-bucket/content.jpg?X-Goog-Signature=xyz789

// Custom storage endpoint
https://storage.example.com/uploads/generated-image.jpg

The content data will be sent as the request body to the specified URL when generation is complete.

safety

object

Content safety checking configuration for video generation.

Properties 2 properties
safety » checkContent

checkContent

boolean default: false

Enable or disable content safety checking. When enabled, defaults to fast mode.

safety » mode

mode

string default: none

Safety checking mode for video generation.

Allowed values 3 values
Disables checking.
Checks key frames.
Checks all frames.

ttl

integer min: 60

Time-to-live (TTL) in seconds for generated content. Only applies when outputType is URL.

includeCost

boolean default: false

Include task cost in the response.

numberResults

integer min: 1 max: 4 default: 1

Number of results to generate. Each result uses a different seed, producing variations of the same parameters.

Inputs

Input resources for the task (images, audio, etc). These must be nested inside the inputs object.
inputs » referenceImages

referenceImages

array of strings min items: 1max items: 7

List of reference images (UUID, URL, Data URI, or Base64).

inputs » frameImages

frameImages

array of strings or objects items: 1

An array of frame-specific image inputs to guide video generation. Each item can be either a plain image input (UUID, URL, Data URI, or Base64) or an object that pairs an image with a target frame position.

The frameImages parameter allows you to constrain specific frames within the video sequence, ensuring that particular visual content appears at designated points. This is different from referenceImages, which provide overall visual guidance without constraining specific timeline positions.

When the frame parameter is omitted, automatic distribution rules apply:

  • 1 image: Used as the first frame.
Examples 2 examples

Shorthand format: When you don't need to specify a frame position, you can pass a plain image input directly.

"frameImages": [
  "aac49721-1964-481a-ae78-8a4e29b91402"
]

Object format: When you need to specify a frame position, use an object with image and frame.

"frameImages": [
  {
    "image": "aac49721-1964-481a-ae78-8a4e29b91402",
    "frame": "first"
  }
]
Format 1: string[]
string

Image input (UUID, URL, Data URI, or Base64).

Format 2: object[] 2 properties
inputs » frameImages » image

image

string required

Image input (UUID, URL, Data URI, or Base64).

inputs » frameImages » frame

frame

object

Target frame position for the image. This model only supports the first frame.

Allowed values 2 values
First frame of the video.
Frame index 0 (first frame).
inputs » video

video

string

Video input (UUID or URL).

Generation Parameters

Core parameters for controlling the generated content.

model

string required value: xai:grok-imagine@video

Identifier of the model to use for generation.

Learn more 3 resources

positivePrompt

string required min: 1

Text prompt describing elements to include in the generated output.

Learn more 2 resources

width

integer required* paired with height

Width of the generated media in pixels.

Learn more 2 resources

height

integer required* paired with width

Height of the generated media in pixels.

Learn more 2 resources

resolution

string default: 480p

Resolution preset for the output. When used with input media, automatically matches the aspect ratio from the input.

Allowed values 2 values

duration

integer min: 1 max: 15 default: 6

Length of the generated video in seconds. The total number of frames produced is determined by duration multiplied by the model's frame rate (fps).

Ask AI
Send feedback