Skip to main content

Overview

Grok Video is an xAI video model for text-to-video generation and image-to-video workflows. Use this page when you are ready to call the API after trying the model in the APIXO playground.

Endpoint and authentication

Base URL:
All requests require your APIXO API key:
Submit requests also require:

Copy-paste async quickstart

This minimal request submits a text-to-video task and returns a taskId.
Successful response:
Save the taskId; you need it to poll for the final result.

Poll for result

Processing response:
Success response:
Failed response:
Parse resultJson after state becomes success:

Request body

Text-to-video

Image-to-video with an image URL

Image-to-video from a Grok Image task

Parameters

string
default:"async"
Result delivery mode. Omit this field or use async for polling with statusTask, or use callback for webhook delivery.
string
Required when request_type is callback. Provide a public HTTPS URL that can receive the final task payload. See Webhooks.
object
required
Grok Video input parameters.

Response format

Submit task response

POST /generateTask/grok-video returns a task ID when the task is accepted:
integer
API status code. 200 means the task was accepted.
string
Human-readable status message.
string
Unique task identifier used with the status endpoint.

Status response fields

string
Unique task identifier.
string
Current task state: processing, success, or failed.
string
JSON string containing the generated video URLs in resultUrls. Present when state is success.
string
Machine-readable failure code. Present when state is failed.
string
Human-readable failure message. Present when state is failed.
integer
Task creation timestamp in Unix milliseconds.
integer
Task completion timestamp in Unix milliseconds. Present after completion.
integer
Processing duration in milliseconds. Present after completion.

Webhook callback mode

Use callback mode when your backend should receive the final result automatically instead of polling.
Callback delivery uses the same final payload shape as the status response. See Webhooks for delivery requirements and retry behavior.

Billing

Grok Video is billed per second. The selected resolution determines the per-second unit price, and the submitted duration determines the billable seconds. Formula:
For current route and market comparison pricing, see Pricing.

Latency and polling

The user manual lists typical Grok Video generation time at about 40s-60s. Actual latency may vary by prompt complexity, duration, resolution, provider queue load, and storage transfer time.
For production workloads, use callback mode to avoid frequent polling while video tasks run.
Result URLs are valid for 15 days. Download and store important outputs promptly. For image-to-video, use exactly one source method: either image_urls, or task_id with index. Public image URLs should point directly to JPG, PNG, or WebP files and should be accessible by APIXO. Prompts can be written in English or Chinese. More specific camera motion, scene timing, subject action, lighting, and style details usually produce better results. Rate limits and concurrency can vary by account, API key, and route. If you receive 429, slow down requests and retry with backoff. For account-level details, see System APIs.

Errors and troubleshooting

HTTP errors

Validation notes

Task failure codes

failCode is generated from APIXO’s mapped provider error. Common values include: See Error Codes for the full error reference.