Grok Video Generator API documentation
Generate videos with Grok Video Generator (xAI). Supports both text and image input modes.
Endpoints
| Contract item | Value |
|---|---|
| Capability | grok-video-generator |
| Submit | POST https://vidmage.ai/api/v1/grok-video-generator/submit |
| Query | POST https://vidmage.ai/api/v1/grok-video-generator/query |
| Task identifier | taskId |
| Result field | videoUrl |
Authenticate with Authorization: Bearer YOUR_API_KEY. Save the task identifier and query the same capability. Use a stable Idempotency-Key for submission retries.
Product guide: Grok Video API
Parameters and input rules
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
prompt | string | Yes | Not specified | Text prompt describing the video to generate (max 20000 chars). Minimum characters: 1Maximum characters: 20000 |
imageUrl | string | No | Not specified | Optional input image URL. When provided, the task runs in image-to-video mode. |
imageUrls | string[] | No | Not specified | Ordered input image URLs for reference-to-video mode. The prompt can reference them by their one-based order. Minimum items: 1Maximum items: 7 |
duration | string | No | "6" | Video duration in seconds. Values: "6", "10", "7", "8", "9", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30" |
aspectRatio | string | No | "16:9" | Output aspect ratio. Values: "16:9", "9:16", "1:1", "2:3", "3:2" |
resolution | string | No | "720p" | Output resolution tier. Values: "480p", "720p" |
text to video
These are public VidMage field names. The server maps them to provider fields. Input media selects the mode; use its limits together with the parameter table.
| Control | Mode-specific rule |
|---|---|
prompt | Required; 5–800 characters. |
duration | JSON string. Values: "6", "10". Default: 6. |
aspectRatio | Values: "16:9", "9:16", "1:1". Default: 16:9. |
resolution | Values: "480p", "720p". Default: 720p. |
image to video
These are public VidMage field names. The server maps them to provider fields. Input media selects the mode; use its limits together with the parameter table.
| Control | Mode-specific rule |
|---|---|
prompt | Required; 1–20000 characters. |
duration | JSON string. Values: "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30". Default: 6. |
aspectRatio | Values: "2:3", "3:2", "1:1", "16:9", "9:16". Default: 16:9. |
resolution | Values: "480p", "720p". Default: 480p. |
imageUrls | Up to 7 files. Formats: jpg, png. |
Example request
{
"prompt": "A handheld documentary shot of street musicians performing in a busy evening plaza",
"duration": "6",
"aspectRatio": "16:9",
"resolution": "720p"
}# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/grok-video-generator/submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
-H "Content-Type: application/json" \
-d '{"prompt":"A handheld documentary shot of street musicians performing in a busy evening plaza","duration":"6","aspectRatio":"16:9","resolution":"720p"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }Task results and recovery
URL of the generated video. Read videoUrl from the completed query response. Preserve taskId while the task is running.
curl -X POST "https://vidmage.ai/api/v1/grok-video-generator/query" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "videoUrl": "https://..." } }Submission and task queries report the available task and usage information. A timeout is not a confirmed failure. Recover the existing task instead of resubmitting.
For face selection and error recovery, follow Task lifecycle. MCP uses the normalized taskId argument in get_task_result, including capabilities whose REST identifier is requestId.
Credits
| Component / option | Rate | Minimum |
|---|---|---|
| 480p | 10 credits / second | — |
| 720p | 10 credits / second | — |
Base charge = duration × the selected resolution rate.
Use the Playground or the MCP credit estimator for your exact inputs. Credits and billing.