Saltar al contenido principal
Referencia de API para ideogram/ideogram-4-5, servida por Comfy Router de Ideogram. Entrada: Texto, Imagen · Salida: Imagen

Inicio rápido

Crea una clave en tu espacio de trabajo de Comfy 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 directo. ID del modelo: ideogram/ideogram-4-5 Endpoint: POST https://api.comfy.org/v2/models/ideogram/ideogram-4-5
El mismo cuerpo, enviado a POST https://api.comfy.org/v2/models/ideogram/ideogram-4-5/requests. Router responde 201 con un request_id en cuanto admite la ejecución, y puedes recoger el resultado cuando esté listo, desde este proceso u otro. Entrega en cola explica el estado, la cancelación y la recogida.

Esquema

Entrada

string
Solo Precise Edit; requiere image. La región de la imagen de origen sobre la que trabaja la edición, de modo que una imagen muy grande se puede editar en una zona y devolver a tamaño completo con el resto intacto. none (el valor predeterminado) edita la imagen entera. auto ajusta una región alrededor de mask y requiere una. En caso contrario, envía y_min,x_min,y_max,x_max como cuatro bordes de píxel enteros no negativos, con y_max mayor que y_min y x_max mayor que x_min, al menos 256 píxeles por lado, una relación de aspecto entre 1:6 y 6:1, y como máximo 4,194,304 píxeles de área. Un valor distinto de none en una solicitud sin image se rechaza. context_window solo se acepta donde la puerta de la ventana de contexto está habilitada; donde no lo está, cualquier valor distinto de none se rechaza con 422.
Activa la detección de derechos de autor posterior a la generación.
string
Una imagen, ya sea una URL https que Router descarga en nombre de quien llama, o un URI data:image/<format>;base64,<payload> que lleva los bytes en línea. Los tipos de imagen aceptados son png, webp y jpeg, y ese conjunto se APLICA al resolver la solicitud en lugar de dejarlo al proveedor: un svg, gif, avif o tiff se rechaza aquí, indicando la imagen enviada, en vez de convertirse en un error del socio a dos saltos de la causa. Prefiere la forma de URL. Un payload base64 se infla aproximadamente 4/3 y el cuerpo completo de la solicitud está limitado a 100 MiB, así que la forma en línea se agota cerca de una imagen de origen de 75 MB; una URL evita ese problema por completo. Los límites de multimedia por imagen y por solicitud que se indican al final de esta descripción son más estrictos que el límite del cuerpo, así que para una imagen de tamaño real son los que encuentras primero. LA URL DEBE RESOLVERSE SIN TUS CREDENCIALES. Router la descarga en el servidor y no envía ninguna credencial de quien llama con la solicitud, así que la forma admitida es una URL prefirmada, es decir, una cuya firma está en la cadena de consulta. Un endpoint autenticado como /api/assets/{id}/content responde a Router con 401 en lugar de la imagen; solicita esa URL tú mismo y pasa la URL firmada a la que redirige. LA DESCARGA ESTÁ LIMITADA A UN CONJUNTO NOMBRADO DE HOSTS y no a internet abierto, y la misma lista se vuelve a aplicar a cada salto de redirección además de a la URL enviada: por eso una URL en cualquier otro host, o una que redirija fuera de la lista, se rechaza antes de contactar con ningún proveedor. Hoy esa lista es solo el reparto de assets de Comfy: una URL firmada de storage.googleapis.com bajo un bucket de assets de Comfy, que es la forma a la que te redirige /api/assets/{id}/content. Un CDN de un socio o un host https normal NO está en la lista. HAY DOS AMPLIACIONES EN DESPLIEGUE Y AMBAS ESTÁN DESACTIVADAS POR DEFECTO HOY. Se publican tras UN solo interruptor y se habilitan juntas, así que considera todo lo siguiente como algo futuro y no como algo sobre lo que construir todavía: pregunta antes de basarte en cualquiera de las dos. La PRIMERA es el bucket en el que POST /customers/storage firma tu subida. Hasta que el despliegue llegue a tu entorno, una URL de subida de ese endpoint se rechaza aquí, aunque el bucket sea de Comfy y el host el mismo: así que “subir a Comfy y luego pasar la URL” NO funciona todavía, y la forma que sí funciona es la URL firmada a la que redirige /api/assets/{id}/content. La SEGUNDA se HABILITA POR CUENTA y no para todos a la vez, porque el bucket que hay detrás de estos hosts es tuyo y no nuestro: incluso con el interruptor anterior activado, una cuenta que no tenga habilitada la multimedia entrante de terceros recibe un rechazo, y se le indica con esas mismas palabras en lugar de decirle que el host no es compatible. Pide a tu contacto de Comfy que la habilite para tu cuenta. Además admite estos hosts de almacenamiento de objetos de terceros, donde el bucket es tuyo y Router no reclama su propiedad: Cloudflare R2 (<account>.r2.cloudflarestorage.com, pub-<hash>.r2.dev), Amazon S3 (s3.amazonaws.com y s3.<region>.amazonaws.com, tanto en la forma de estilo de ruta como en la prefijada con <bucket>.), Azure Blob Storage (<account>.blob.core.windows.net) y Alibaba Cloud OSS (<bucket>.oss-<region>.aliyuncs.com, incluido el endpoint oss-accelerate). Son endpoints de almacenamiento de objetos específicamente: un endpoint de propósito general en el mismo dominio del proveedor, como un trigger de Alibaba Function Compute, no está en la lista y se rechaza. LO QUE SE COMPARA ES LA FORMA DEL NOMBRE DE HOST Y NO EL PROVEEDOR: por eso nombrar arriba un proveedor NO significa que se acepte cualquier URL que ese proveedor pueda emitir, y conviene enumerar tres casos casi válidos porque quien llama puede llegar razonablemente con cada uno de ellos. Un DOMINIO PERSONALIZADO de R2 (cdn.example.com) NO se acepta: Cloudflare documenta pub-<hash>.r2.dev como un nombre de host de depuración con límite de tasa y dirige el tráfico de producción a un dominio personalizado, pero un dominio personalizado no lleva nada en su nombre de host que lo identifique como R2, así que Router no puede distinguirlo de cualquier otro host y lo rechaza: prefirma el endpoint <account>.r2.cloudflarestorage.com o usa la forma pub-<hash>.r2.dev. El endpoint dualstack IPv6 de S3 (s3.dualstack.<region>.amazonaws.com) tampoco se acepta; usa el endpoint regional simple. Tampoco la zona DNS alternativa de Azure Blob (<account>.z<N>.blob.storage.azure.net); usa <account>.blob.core.windows.net. El rechazo que recibes nombra estas mismas formas, así que no tienes que venir aquí a leerlas. Los marcadores <account> y pub-<hash> de arriba muestran la forma con la que llegarás normalmente; no son una restricción de profundidad. La comparación es sobre el sufijo de dominio del almacenamiento de objetos, así que también se acepta un nombre más profundo bajo el mismo espacio de nombres (a.b.pub-<hash>.r2.dev). Lo que NO se amplía con eso es el espacio de nombres en sí: el sufijo todavía tiene que ser uno de los listados. El ejemplo siguiente muestra solo la forma: un valor real además lleva los parámetros de consulta de firma, que aquí se omiten deliberadamente porque un ejemplo publicado permanece en la especificación para siempre y una firma real es a la vez una credencial filtrada y un enlace que deja de funcionar. Cada imagen está limitada a 25 MiB y las imágenes de una solicitud a 64 MiB en total. La única excepción es Precise Edit de ideogram/ideogram-4-5 (una llamada que envía image) cuando context_window está disponible: ahí cada imagen puede llegar a 50 MB (50,000,000 bytes) y 67,108,864 píxeles, y las imágenes de una solicitud a 128 MiB en total.
string[]
Imágenes de origen opcionales para la operación de generar. La primera es la fuente principal y el resto son referencias. Hasta cinco, o cuatro con una máscara.
string
Solo para generar. Reescritura de prompts para texto a imagen. Los valores admitidos son auto, on y off. El valor predeterminado es auto.
string
Una imagen, ya sea una URL https que Router descarga en nombre de quien llama, o un URI data:image/<format>;base64,<payload> que lleva los bytes en línea. Los tipos de imagen aceptados son png, webp y jpeg, y ese conjunto se APLICA al resolver la solicitud en lugar de dejarlo al proveedor: un svg, gif, avif o tiff se rechaza aquí, indicando la imagen enviada, en vez de convertirse en un error del socio a dos saltos de la causa. Prefiere la forma de URL. Un payload base64 se infla aproximadamente 4/3 y el cuerpo completo de la solicitud está limitado a 100 MiB, así que la forma en línea se agota cerca de una imagen de origen de 75 MB; una URL evita ese problema por completo. Los límites de multimedia por imagen y por solicitud que se indican al final de esta descripción son más estrictos que el límite del cuerpo, así que para una imagen de tamaño real son los que encuentras primero. LA URL DEBE RESOLVERSE SIN TUS CREDENCIALES. Router la descarga en el servidor y no envía ninguna credencial de quien llama con la solicitud, así que la forma admitida es una URL prefirmada, es decir, una cuya firma está en la cadena de consulta. Un endpoint autenticado como /api/assets/{id}/content responde a Router con 401 en lugar de la imagen; solicita esa URL tú mismo y pasa la URL firmada a la que redirige. LA DESCARGA ESTÁ LIMITADA A UN CONJUNTO NOMBRADO DE HOSTS y no a internet abierto, y la misma lista se vuelve a aplicar a cada salto de redirección además de a la URL enviada: por eso una URL en cualquier otro host, o una que redirija fuera de la lista, se rechaza antes de contactar con ningún proveedor. Hoy esa lista es solo el reparto de assets de Comfy: una URL firmada de storage.googleapis.com bajo un bucket de assets de Comfy, que es la forma a la que te redirige /api/assets/{id}/content. Un CDN de un socio o un host https normal NO está en la lista. HAY DOS AMPLIACIONES EN DESPLIEGUE Y AMBAS ESTÁN DESACTIVADAS POR DEFECTO HOY. Se publican tras UN solo interruptor y se habilitan juntas, así que considera todo lo siguiente como algo futuro y no como algo sobre lo que construir todavía: pregunta antes de basarte en cualquiera de las dos. La PRIMERA es el bucket en el que POST /customers/storage firma tu subida. Hasta que el despliegue llegue a tu entorno, una URL de subida de ese endpoint se rechaza aquí, aunque el bucket sea de Comfy y el host el mismo: así que “subir a Comfy y luego pasar la URL” NO funciona todavía, y la forma que sí funciona es la URL firmada a la que redirige /api/assets/{id}/content. La SEGUNDA se HABILITA POR CUENTA y no para todos a la vez, porque el bucket que hay detrás de estos hosts es tuyo y no nuestro: incluso con el interruptor anterior activado, una cuenta que no tenga habilitada la multimedia entrante de terceros recibe un rechazo, y se le indica con esas mismas palabras en lugar de decirle que el host no es compatible. Pide a tu contacto de Comfy que la habilite para tu cuenta. Además admite estos hosts de almacenamiento de objetos de terceros, donde el bucket es tuyo y Router no reclama su propiedad: Cloudflare R2 (<account>.r2.cloudflarestorage.com, pub-<hash>.r2.dev), Amazon S3 (s3.amazonaws.com y s3.<region>.amazonaws.com, tanto en la forma de estilo de ruta como en la prefijada con <bucket>.), Azure Blob Storage (<account>.blob.core.windows.net) y Alibaba Cloud OSS (<bucket>.oss-<region>.aliyuncs.com, incluido el endpoint oss-accelerate). Son endpoints de almacenamiento de objetos específicamente: un endpoint de propósito general en el mismo dominio del proveedor, como un trigger de Alibaba Function Compute, no está en la lista y se rechaza. LO QUE SE COMPARA ES LA FORMA DEL NOMBRE DE HOST Y NO EL PROVEEDOR: por eso nombrar arriba un proveedor NO significa que se acepte cualquier URL que ese proveedor pueda emitir, y conviene enumerar tres casos casi válidos porque quien llama puede llegar razonablemente con cada uno de ellos. Un DOMINIO PERSONALIZADO de R2 (cdn.example.com) NO se acepta: Cloudflare documenta pub-<hash>.r2.dev como un nombre de host de depuración con límite de tasa y dirige el tráfico de producción a un dominio personalizado, pero un dominio personalizado no lleva nada en su nombre de host que lo identifique como R2, así que Router no puede distinguirlo de cualquier otro host y lo rechaza: prefirma el endpoint <account>.r2.cloudflarestorage.com o usa la forma pub-<hash>.r2.dev. El endpoint dualstack IPv6 de S3 (s3.dualstack.<region>.amazonaws.com) tampoco se acepta; usa el endpoint regional simple. Tampoco la zona DNS alternativa de Azure Blob (<account>.z<N>.blob.storage.azure.net); usa <account>.blob.core.windows.net. El rechazo que recibes nombra estas mismas formas, así que no tienes que venir aquí a leerlas. Los marcadores <account> y pub-<hash> de arriba muestran la forma con la que llegarás normalmente; no son una restricción de profundidad. La comparación es sobre el sufijo de dominio del almacenamiento de objetos, así que también se acepta un nombre más profundo bajo el mismo espacio de nombres (a.b.pub-<hash>.r2.dev). Lo que NO se amplía con eso es el espacio de nombres en sí: el sufijo todavía tiene que ser uno de los listados. El ejemplo siguiente muestra solo la forma: un valor real además lleva los parámetros de consulta de firma, que aquí se omiten deliberadamente porque un ejemplo publicado permanece en la especificación para siempre y una firma real es a la vez una credencial filtrada y un enlace que deja de funcionar. Cada imagen está limitada a 25 MiB y las imágenes de una solicitud a 64 MiB en total. La única excepción es Precise Edit de ideogram/ideogram-4-5 (una llamada que envía image) cuando context_window está disponible: ahí cada imagen puede llegar a 50 MB (50,000,000 bytes) y 67,108,864 píxeles, y las imágenes de una solicitud a 128 MiB en total.
integer
predeterminado:"1"
Número de imágenes a devolver. Cada una se factura.Rango: 1 a 8
string
requerido
La instrucción o descripción de la imagen, de 1 a 10,000 caracteres.
string
Nivel de calidad, que también es la tarifa facturada. Con imágenes de origen: very_low, low, medium o high (predeterminado medium). Sin imágenes de origen: low, medium o high (predeterminado high); very_low en una solicitud de texto a imagen se rechaza.Valores posibles: very_low, low, medium, high
string[]
Imágenes de referencia opcionales para Precise Edit; requiere image. Hasta cuatro, o tres con una máscara.
integer
Semilla para obtener resultados reproducibles.Rango: 0 a 2147483647
string
Solo para generar. Tamaño de salida: auto (predeterminado), source (requiere images) o WIDTHxHEIGHT. Omítelo cuando envíes una máscara; se rechaza una solicitud que especifique ambos.
Generado a partir del esquema que Router publica en GET /v2/models/ideogram/ideogram-4-5/openapi.json, el mismo documento contra el que valida una llamada antes de que la solicitud llegue al proveedor.

Salida

object[]
Las imágenes generadas.
boolean
Indica si la imagen se considera segura. Usa solo las imágenes en las que este valor sea verdadero.
string
El prompt usado para generar esta imagen.
string
La resolución de la imagen generada.
integer
La semilla usada para esta imagen.
string
URL de la imagen generada.
string
El identificador de la generación.
integer
La semilla usada para la generación.

Ejemplos

Entrada

Salida

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. 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.