Grok Imagine Video API Integration
Use Grok Imagine Video through Rivya Public API v1 with model id grok-imagine-video, supported inputs, parameters, Files API rules, credits, and response examples.
grok-imagine-video
text, file
Required for reference modes
10
Video
FIXED
5000 characters
Request contract
Send the model id at the top level. Model-specific controls belong in params.
| Key | Type | Required | Default | Description |
|---|---|---|---|---|
| model | string | Yes | grok-imagine-video | Use the grok-imagine-video API model id. |
| prompt | string | Yes | - | Maximum 5000 characters for this model. |
| params | object | No | - | Model-specific parameter object. Use the rows below for allowed keys. |
| client_request_id | string | No | - | Optional client-side id for tracing requests in your system. |
Model parameters
| Key | Type | Required | Default | Range | Options | Description |
|---|---|---|---|---|---|---|
| mode | select | No | normal | - | fun, normal, spicy | Generation mode |
| duration | number | No | 6 | min 6 / max 30 / step 1 | - | Duration |
| resolution | select | No | 480p | - | 480p, 720p | Resolution |
| aspect_ratio | select | No | 2:3 | - | 1:1, 16:9, 9:16, 2:3, 3:2 | Aspect ratio |
Upload policy
Upload reference files first, then place the returned URL and duration token inside params.referenceMediaItems.
Reference image: Upload up to 1 image file for image projects.
1
image
Video and audio references should carry durationToken from /api/v1/files when duration verification is required.
| kind | Max size | MIME types |
|---|---|---|
| image | 10 MB | image/jpeg, image/png, image/webp |
Minimal request
{
"model": "grok-imagine-video",
"prompt": "A cinematic product reveal with smooth camera movement",
"params": {
"mode": "normal",
"duration": 6,
"resolution": "480p",
"aspect_ratio": "2:3"
}
}Reference-file request
{
"model": "grok-imagine-video",
"prompt": "A cinematic product reveal with smooth camera movement",
"params": {
"mode": "normal",
"duration": 6,
"resolution": "480p",
"aspect_ratio": "2:3",
"referenceMediaItems": [
{
"url": "https://cdn.example.com/reference-image.png",
"kind": "image",
"name": "reference-image.png",
"mimeType": "image/png"
}
]
}
}Create response
The create endpoint returns a public task id. Poll the status endpoint until the task succeeds or fails.
{
"id": "task_grok_imagine_video_example",
"status": "queued",
"model": "grok-imagine-video",
"reserved_credits": 10,
"final_credits": 0,
"created_at": "2026-05-11T00:00:00.000Z",
"updated_at": "2026-05-11T00:00:00.000Z",
"result": null,
"error": null
}Common errors
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
Some modes require Files API reference uploads.