> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Usa Grok Imagine Image con Comfy Router

> Llama a xai/grok-imagine-image mediante Comfy Router: endpoint, forma de la solicitud y la respuesta que devuelve Router.

Referencia de API para `xai/grok-imagine-image`, servida por Comfy Router desde xAI.

**Entrada:** Texto · **Salida:** Imagen

## Inicio rápido

Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada por HTTP sin procesar.

**ID del modelo:** `xai/grok-imagine-image`

**Endpoint:** `POST https://api.comfy.org/v2/models/xai/grok-imagine-image`

**Esperar el resultado**

```python Python theme={null}
from comfy_sdk import Comfy

# Lee COMFY_API_KEY del entorno.
# El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos.
with Comfy() as client:
    result = client.models.run(
        "xai/grok-imagine-image",
        {
            "n": 1,
            "prompt": "A single red maple leaf on a plain white background.",
        },
    )

print(result)
```

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

// Lee COMFY_API_KEY del entorno.
// El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos.
const { data } = await comfy.models.run("xai/grok-imagine-image", {
  n: 1,
  prompt: "A single red maple leaf on a plain white background.",
});

console.log(data);
```

```bash cURL theme={null}
curl https://api.comfy.org/v2/models/xai/grok-imagine-image \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"n\": 1, \"prompt\": \"A single red maple leaf on a plain white background.\"}"
```

**Encolar y recoger más tarde**

El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/xai/grok-imagine-image/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recoge cuando está listo, desde este proceso o desde otro. [Entrega en cola](https://docs.comfy.org/es/development/comfy-router/queue.md) explica el estado, la cancelación y la recogida.

```python Python theme={null}
import asyncio
from comfy_sdk import AsyncComfy

# Lee COMFY_API_KEY del entorno.
# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos.
async def main():
    async with AsyncComfy() as client:
        handle = await client.models.submit(
            "xai/grok-imagine-image",
            {
                "n": 1,
                "prompt": "A single red maple leaf on a plain white background.",
            },
        )
        print("request_id:", handle.request_id)  # con el ID del modelo, es todo lo que necesita otro proceso

        # Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor.
        async for update in handle.iter_events():
            print(update.status, update.queue_position)

        # La carga propia del proveedor, el mismo valor que devuelve models.run().
        # Una solicitud que falló o se canceló lanza aquí el error tipado de Router.
        result = await handle.get()

    print(result)

asyncio.run(main())
```

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

// Lee COMFY_API_KEY del entorno.
// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos.
const handle = await comfy.models.submit("xai/grok-imagine-image", {
  n: 1,
  prompt: "A single red maple leaf on a plain white background.",
});
console.log("requestId:", handle.requestId); // con el ID del modelo, es todo lo que necesita otro proceso

// Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor.
for await (const update of handle.events()) {
  console.log(update.status, update.queuePosition);
}

// El mismo resultado que devuelve models.run(). Una solicitud que falló o se canceló se rechaza aquí.
const result = await handle.get();

console.log(result.data);
```

```bash cURL theme={null}
# 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url.
curl https://api.comfy.org/v2/models/xai/grok-imagine-image/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"n\": 1, \"prompt\": \"A single red maple leaf on a plain white background.\"}"

# 2. Consulta hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta.
REQUEST_ID="<request_id from the 201 body>"
curl -i https://api.comfy.org/v2/models/xai/grok-imagine-image/requests/$REQUEST_ID/status \
  -H "X-API-Key: $COMFY_API_KEY"

# 3. Recoge. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución.
curl https://api.comfy.org/v2/models/xai/grok-imagine-image/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"
```

## Esquema

### Entrada

**aspect\_ratio** `string` (default: "auto")

Relación de aspecto de la imagen generada. El valor predeterminado es auto para seleccionar automáticamente la mejor relación para el prompt.

Valores posibles: `1:1`, `3:4`, `4:3`, `9:16`, `16:9`, `2:3`, `3:2`, `9:19.5`, `19.5:9`, `9:20`, `20:9`, `1:2`, `2:1`, `auto`

**model** `string` (default: "grok-imagine-image")

Modelo a utilizar. Compatibles: grok-imagine-image (predeterminado), grok-imagine-image-pro, grok-imagine-image-quality, grok-imagine-image-2.0. Los ids -beta obsoletos se asignan como alias a su modelo GA.

**n** `integer` (default: 1)

Número de imágenes a generar

Rango: `1` a `10`

**prompt** `string` *required*

Prompt para la generación de imágenes

**quality** `string`

Calidad de la imagen de salida. Para grok-imagine-image-2.0 esto selecciona el nivel de precio (low/medium; medium es el predeterminado); los demás modelos actualmente lo ignoran.

Valores posibles: `low`, `medium`, `high`

**resolution** `string` (default: "1k")

Resolución de la imagen generada. El valor predeterminado es 1k.

Valores posibles: `1k`, `2k`

**response\_format** `string` (default: "url")

Formato de respuesta en el que se devuelve la imagen. Puede ser url o b64\_json. Comfy convierte esto a `url` en la solicitud saliente. Ocurre en el despacho de Comfy Router (`POST /v2/models/xai/{model}`) y también en esta ruta `/proxy/`, porque los resultados de imagen se sirven como URLs re-alojadas de cualquier manera. Por lo tanto, un valor DENTRO del enum se acepta y se ignora: envía `url` o `b64_json`, u omite el campo, y la respuesta es la misma. Un valor FUERA del enum, excluyendo las grafías UNSET que reconoce cada superficie y que se describen a continuación, se RECHAZA en AMBAS superficies en lugar de convertirse, y solo cambia la forma del rechazo: esta ruta `/proxy/` responde un `400` en la entrada, y el despacho del Router `POST /v2/models/xai/{model}` responde el `422` por campo que debe al enum publicado aquí, antes de que se haga cualquier llamada al socio. Las dos superficies difieren en qué cuenta como UNSET. En esta ruta `/proxy/`, un campo omitido, un `null` explícito y `""` significan todos no establecido y se convierten como cualquier valor aceptado. El despacho del Router aplica el enum exactamente como se publica, así que `null` y `""` no son miembros allí como cualquier otro: OMITE el campo para dejarlo sin establecer en esa superficie.

Valores posibles: `url`, `b64_json`

**size** `string`

Tamaño de la imagen (no compatible)

**style** `string`

Estilo de la imagen (no compatible)

**user** `string`

Un identificador único que representa a tu usuario final, que puede ayudar a xAI a monitorear y detectar abusos

Generado a partir del esquema que el Router sirve en `GET /v2/models/xai/grok-imagine-image/openapi.json`, el mismo documento contra el que valida una llamada antes de que la solicitud llegue al proveedor.

### Salida

**block\_reason** `string`

Si la solicitud fue bloqueada por la moderación de entrada, contiene el motivo del bloqueo

**data** `object[]`

Una lista de objetos de imagen generados

**data\[].b64\_json** `string`

Una representación en cadena codificada en base64 de la imagen generada con codificación jpeg (si response\_format es b64\_json)

**data\[].mime\_type** `string`

El tipo MIME de la imagen generada (p. ej. image/png, image/jpeg, image/webp).

**data\[].url** `string`

Una url a la imagen generada (si response\_format es url)

**usage** `object`

Información de uso de la solicitud de generación de imágenes

**usage.cost\_in\_usd\_ticks** `integer`

Costo exacto de esta solicitud en ticks de USD (10,000,000,000 ticks = 1 USD)

## Ejemplos

### Entrada

```json theme={null}
{
  "n": 1,
  "prompt": "A single red maple leaf on a plain white background."
}
```

### Salida

```json theme={null}
{
  "data": [
    {
      "mime_type": "image/jpeg",
      "url": "https://example.invalid/xai/grok-imagine-image/generated.jpg"
    },
    {
      "mime_type": "image/jpeg",
      "url": "https://example.invalid/xai/grok-imagine-image/generated-2.jpg"
    }
  ],
  "usage": {
    "cost_in_usd_ticks": 200000000
  }
}
```

## Antes de lanzar

Los SDK crean una `Idempotency-Key` y la reutilizan para los reintentos automáticos. Para los reintentos manuales, reutiliza la clave original. Router puede mantener la conexión abierta hasta 10 minutos.

Cuando una solicitud falla, Router envía un encabezado de respuesta `X-Comfy-Error-Type` que explica el motivo. Un `422` significa que Router rechazó la entrada antes de llamar al proveedor, y un `413` significa que el cuerpo de la solicitud era más grande de lo que Router acepta. Descarga los recursos generados de inmediato, porque [las URL de resultados pueden caducar](https://docs.comfy.org/es/development/comfy-router/reference.md#recursos-del-resultado).

Cualquier límite de tamaño mencionado en la descripción de un campo más arriba es el límite propio del proveedor para ese campo, citado de la especificación del proveedor. Router aplica un tope aparte al cuerpo completo de la solicitud, con el que cuentan los medios codificados en base64: consulta [tamaño del cuerpo de la solicitud](https://docs.comfy.org/es/development/comfy-router/limitations.md#los-cuerpos-de-las-solicitudes-tienen-un-límite).

Esta página documenta un modelo socio al que se llama a través de Comfy Router. El mismo paquete `comfy-sdk` / `@comfyorg/sdk` también incluye un segundo cliente, para ejecutar todo un gráfico de flujo de trabajo de ComfyUI en Comfy Cloud: `Comfy(api_key=...)` / `new Comfy({ apiKey })`, con `client.workflows`, `client.assets` y `client.jobs`. Consulta [SDK de Comfy](https://docs.comfy.org/es/development/api-development/sdks.md).

> **[Encabezados](https://docs.comfy.org/es/development/comfy-router/headers.md)**
>
> Autenticación, idempotencia, IDs de solicitud, agrupaciones de errores, ritmo de reintentos y límites de gasto.

> **[Uso de la API de Router](https://docs.comfy.org/es/development/comfy-router/api.md)**
>
> Descubrimiento de modelos, errores de validación, reintentos y facturación.

> **[Limitaciones](https://docs.comfy.org/es/development/comfy-router/limitations.md)**
>
> Lo que Router no hace hoy y qué usar en su lugar.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.