> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-stale2000-router-model-pages.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Grok Imagine Video with Comfy Router

> Call xai/grok-imagine-video through Comfy Router: endpoint, request shape and the response Router returns.

Use `xai/grok-imagine-video` with the Comfy Router API. xAI provides the model; Router gives it the shared authentication and request route below.

## Quick start

Create a key at [platform.comfy.org/profile/api-keys](https://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`

<CodeGroup>
  ```python Python theme={null}
  import uuid
  from comfy_sdk import Comfy

  # Reads COMFY_API_KEY from the environment. Save this key and reuse it if you
  # retry this request after the SDK returns an error.
  idempotency_key = str(uuid.uuid4())
  with Comfy() as client:
      result = client.models.run(
          "xai/grok-imagine-video",
          {
              # Request fields are the provider's own — see Input below.
          },
          idempotency_key=idempotency_key,
      )

  print(result)
  ```

  ```typescript TypeScript theme={null}
  import { comfy } from "@comfyorg/sdk";

  // Reads COMFY_API_KEY from the environment. Save this key and reuse it if you
  // retry this request after the SDK returns an error.
  const idempotencyKey = crypto.randomUUID();
  const { data } = await comfy.models.run("xai/grok-imagine-video", {
    // Request fields are the provider's own — see Input below.
  }, { idempotencyKey });

  console.log(data);
  ```

  ```bash cURL theme={null}
  # Request fields are the provider's own — see Input below.
  # Run this line once. Reuse ROUTER_REQUEST_KEY if you retry the curl command.
  ROUTER_REQUEST_KEY=$(uuidgen)
  curl https://api.comfy.org/v2/models/xai/grok-imagine-video \
    -H "X-API-Key: $COMFY_API_KEY" \
    -H "Idempotency-Key: $ROUTER_REQUEST_KEY" \
    -H "Content-Type: application/json" \
    -d '{}'
  ```
</CodeGroup>

## Schema

### Input

<Note>
  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](https://docs.x.ai/docs/api-reference) is authoritative for the request fields, and nothing is validated server side.
</Note>

### Output

<ResponseField name="block_reason" type="string">
  If the request was blocked by input moderation, contains the block reason
</ResponseField>

<ResponseField name="model" type="string">
  The model used to generate the video
</ResponseField>

<ResponseField name="status" type="string">
  Status of the deferred request: "pending" or "done"

  Possible values: `pending`, `done`
</ResponseField>

<ResponseField name="usage" type="object">
  Usage information for the video generation request
</ResponseField>

<ResponseField name="usage.cost_in_usd_ticks" type="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.
</ResponseField>

<ResponseField name="video" type="object">
  A generated video from xAI
</ResponseField>

<ResponseField name="video.duration" type="integer">
  Duration of the generated video in seconds
</ResponseField>

<ResponseField name="video.respect_moderation" type="boolean">
  Whether the video generated by the model respects moderation rules
</ResponseField>

<ResponseField name="video.url" type="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.
</ResponseField>

## Examples

### Output

```json theme={null}
{
  "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

Save one `Idempotency-Key` for each call and reuse it for retries. Router can hold the connection for up to 10 minutes. The SDKs handle authentication; raw HTTP clients send the headers themselves.

Use `X-Comfy-Error-Type` to classify a failure. A `422` means Router rejected the input before calling the provider. Download generated assets promptly because [result URLs can expire](/development/comfy-router/reference#result-assets).

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Using the Router API" icon="code" href="/development/comfy-router/models">
    Find models, inspect schemas, and retry safely.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>