generate_video
Create or edit videos from text prompts, images, or source videos. Supports text-to-video, image animation, and video editing with reference images for style guidance.
Instructions
Generate or edit videos with Grok Imagine.
Text-to-video by default. Provide an image to animate (image-to-video), or
a source video to edit. Only one mode per call. Reference images can be
added to guide style and subjects. Generation polls synchronously (xAI's
default timeout is 10 minutes).
Args:
prompt: Video description, or the edit instruction for video editing.
model: Video model (default `grok-imagine-video`).
image_path: Local image to use as the starting frame.
image_url: Public image URL to use as the starting frame.
video_path: Local video to edit (max 20 MB, .mp4, ≤ 8.7s).
video_url: Public video URL to edit (.mp4, ≤ 8.7s).
reference_image_paths: Local images used as style/subject references.
reference_image_urls: Public image URLs used as style/subject references.
duration: Video length in seconds (1–15, ignored when editing).
aspect_ratio: Aspect ratio like `"16:9"` or `"9:16"` (ignored when editing).
resolution: `"480p"` or `"720p"` (ignored when editing).
show_usage: Append a token usage and cost footer to the result (default False).
Returns:
Markdown block with the generated video URL and actual duration.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| model | No | grok-imagine-video | |
| prompt | Yes | ||
| duration | No | ||
| image_url | No | ||
| video_url | No | ||
| image_path | No | ||
| resolution | No | ||
| show_usage | No | ||
| video_path | No | ||
| aspect_ratio | No | ||
| reference_image_urls | No | ||
| reference_image_paths | No |