Inicio rápido
Crea una clave en tu espacio de trabajo de Comfy y expórtala comoCOMFY_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 sobre HTTP sin procesar.
ID del modelo: ideogram/ideogram-v4
Endpoint: POST https://api.comfy.org/v2/models/ideogram/ideogram-v4
- Esperar el resultado
- Enviar y recoger más tarde
El mismo cuerpo, enviado a
POST https://api.comfy.org/v2/models/ideogram/ideogram-v4/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 explica el estado, la cancelación y la recogida.Esquema
Entrada
boolean
Activa la detección de derechos de autor posterior a la generación (comprobaciones de semejanza y logotipos de Hive).
object
prompt estructurado de V4. Desactiva Magic Prompt; se consume directamente. Proporciona exactamente uno de text_prompt o json_prompt.
string
predeterminado:"\"DEFAULT\""
El ajuste de velocidad de renderizado que controla el equilibrio entre la velocidad de generación y la calidadValores posibles:
DEFAULT, TURBO, QUALITYstring
Resolución de salida en WIDTHxHEIGHT. Omítela para dejar que el modelo elija una relación de aspecto. Valores 2K admitidos: 2048x2048, 1440x2880, 2880x1440, 1664x2496, 2496x1664, 1792x2240, 2240x1792, 1440x2560, 2560x1440, 1600x2560, 2560x1600, 1728x2304, 2304x1728, 1296x3168, 3168x1296, 1152x2944, 2944x1152, 1248x3328, 3328x1248, 1280x3072, 3072x1280.
string
prompt en lenguaje natural. Activa Magic Prompt automáticamente. Proporciona exactamente uno de text_prompt o json_prompt.
GET /v2/models/ideogram/ideogram-v4/openapi.json, el mismo documento contra el que valida una llamada antes de que la solicitud llegue al proveedor.
Salida
string (date-time)
Marca de tiempo en la que se creó la generación.Formato:
date-timeobject[]
Arreglo con la información de las imágenes generadas.
boolean
Indica si la imagen se considera segura.
string
El prompt utilizado para generar esta imagen.
string
La resolución de la imagen generada (p. ej., ‘1024x1024’).
integer
El valor de semilla utilizado para esta generación.
string
El tipo de estilo utilizado para la generación (p. ej., ‘REALISTIC’, ‘ANIME’).
string
URL de la imagen generada.
Ejemplos
Entrada
Salida
Antes de lanzar
Los SDK crean unaIdempotency-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.
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.
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.
Encabezados
Autenticación, idempotencia, IDs de solicitud, agrupaciones de errores, ritmo de reintentos y límites de gasto.
Uso de la API de Router
Descubrimiento de modelos, errores de validación, reintentos y facturación.
Limitaciones
Lo que Router no hace hoy y qué usar en su lugar.