Use Grok Imagine Video with Comfy Router

API Reference for xai/grok-imagine-video, served by Comfy Router from xAI.

Quick start

Create a key at platform.comfy.org/profile/api-keys and export it as COMFY_API_KEY. The Python and TypeScript snippets use the Comfy SDKs (pip install comfy-sdk, npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP. Model ID: xai/grok-imagine-video Endpoint: POST https://api.comfy.org/v2/models/xai/grok-imagine-video

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment. Each call sends a fresh
# Idempotency-Key and waits up to 10 minutes for the finished result.
with Comfy() as client:
    result = client.models.run(
        "xai/grok-imagine-video",
        {
            # Request fields are the provider's own — see Input below.
        },
    )

print(result)

import { comfy } from "@comfyorg/sdk";

// Reads COMFY_API_KEY from the environment. Each call sends a fresh
// Idempotency-Key and waits up to 10 minutes for the finished result.
const { data } = await comfy.models.run("xai/grok-imagine-video", {
  // Request fields are the provider's own — see Input below.
});

console.log(data);

# Request fields are the provider's own — see Input below.
curl https://api.comfy.org/v2/models/xai/grok-imagine-video \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Schema

Input

Router has not published an authored input schema for this model yet: GET /v2/models/xai/grok-imagine-video/openapi.json returns an open object with x-comfy-input-schema-authored: false. Router forwards the body to xAI unchanged, so xAI’s own API reference is authoritative for the request fields, and nothing is validated server side.

Output

string

If the request was blocked by input moderation, contains the block reason

string

The model used to generate the video

string

Status of the deferred request: “pending” or “done”Possible values: pending, done

object

Usage information for the video generation request

integer

The cost of this request expressed in USD ticks. One USD cent equals 100,000,000 ticks, so one US dollar equals 10,000,000,000 ticks.

object

A generated video from xAI

integer

Duration of the generated video in seconds

boolean

Whether the video generated by the model respects moderation rules

string

Download URL for the generated video. Router re-hosts the video onto Comfy storage and rewrites this field, so it is normally a Comfy-signed URL valid for up to 24 hours - signed for 24 hours when minted and replayed from a 23-hour memo, so a later poll can hand back one with as little as an hour left. When the re-host could not be performed the field keeps xAI’s own short-lived URL instead. NULLABLE: a success whose url is empty is not a completed generation. Either way the link expires, so download the video rather than storing the URL.

Examples

Output

{
  "model": "grok-imagine-video",
  "status": "done",
  "usage": {
    "cost_in_usd_ticks": 3500000000
  },
  "video": {
    "duration": 4,
    "respect_moderation": true,
    "url": "https://example.invalid/xai/grok-imagine-video/generated.mp4"
  }
}

Before you ship

The snippets above are the shortest working call. Three things are the same for every model and are documented once on the Comfy Router headers page: send an Idempotency-Key on every paid call and reuse it when you retry, expect the connection to be held up to Router’s 10 minute deadline, and keep X-Comfy-Request-Id from every response. The SDKs do all three for you; the cURL tab does none of them. On failure, X-Comfy-Error-Type names the bucket, and a 422 means the body failed the model’s schema and was never billed.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Quick Start

Typed error handling in Python and TypeScript, reading the 422, walking the catalog.

Limitations

What Router does not do today, and what to use instead.

Develop with Comfy

Deploy ComfyUI

Run Workflows

Comfy Router

Comfy CLI

Specifications

Use Grok Imagine Video with Comfy Router

Quick start

Schema

Input

Output

Examples

Output

Before you ship

Headers

Quick Start

Limitations

​Quick start

​Schema

​Input

​Output

​Examples

​Output

​Before you ship

Headers

Quick Start

Limitations

Quick start

Schema

Input

Output

Examples

Output

Before you ship