Saltar al contenido principal
Referencia de API para ideogram/ideogram-4-6, servido por Comfy Router desde 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 sobre HTTP directo. ID del modelo: ideogram/ideogram-4-6 Endpoint: POST https://api.comfy.org/v2/models/ideogram/ideogram-4-6
El mismo cuerpo, enviado a POST https://api.comfy.org/v2/models/ideogram/ideogram-4-6/requests. Router responde 201 con un request_id en cuanto se admite la ejecución, y puedes recoger el resultado cuando esté listo, desde este proceso o desde otro. Entrega en cola explica el estado, la cancelación y la recogida.

Esquema

Entrada

string
Solo para Generate. transparent devuelve un canal alfa. opaque fuerza un fondo sólido.
string
Solo para Precise Edit; requiere image. auto (predeterminado), una región con la forma y,x,y,x para editar parte de una imagen 4K u 8K a resolución completa, o none para enviar la imagen completa.
string
Una imagen, ya sea como una URL https que Router obtiene en nombre de quien llama, o como 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 en el momento de la resolución en lugar de dejarlo al proveedor: un svg, gif, avif o tiff se rechaza aquí, nombrando la imagen que enviaste, en lugar de convertirse en un error del socio a dos saltos de la causa. Prefiere la forma de URL. Una carga 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 llega como máximo a una imagen de origen de unos 75 MB; una URL evita eso por completo. Los límites de medios por imagen y por solicitud indicados al final de esta descripción son más estrictos que el límite del cuerpo, así que para una imagen de cualquier tamaño real son los que encuentras primero. LA URL DEBE RESOLVERSE SIN TUS CREDENCIALES. Router la obtiene del lado del servidor y no envía ninguna credencial de quien llama con la solicitud, así que una URL prefirmada, es decir, aquella cuya firma está en la cadena de consulta, es la forma admitida. 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 OBTENCIÓN ESTÁ LIMITADA A UN CONJUNTO DEFINIDO DE HOSTS en lugar de a la internet abierta, y la misma lista se vuelve a aplicar a cada salto de redirección y también a la URL que envías, así que una URL en cualquier otro host, o una que redirige fuera de la lista, se rechaza antes de contactar a cualquier proveedor. Hoy esa lista es solo la entrega de recursos de Comfy: una URL firmada de storage.googleapis.com bajo un bucket de recursos de Comfy, que es la forma a la que te redirige /api/assets/{id}/content. Una CDN de un socio o un host https simple NO está en la lista. DOS AMPLIACIONES SE ESTÁN DESPLEGANDO Y AMBAS ESTÁN DESACTIVADAS HOY DE FORMA PREDETERMINADA. Se publican detrás de UN solo interruptor y se habilitan juntas, así que trata todo lo que sigue como algo futuro y no como algo sobre lo que construir todavía: pregunta antes de depender de cualquiera de las dos. La PRIMERA es el bucket al que POST /customers/storage firma tu carga. Hasta que el despliegue llegue a tu entorno, una URL de carga de ese endpoint se rechaza aquí, aunque el bucket sea de Comfy y el host sea el mismo, así que “sube a Comfy y luego pasa la URL” TODAVÍA NO funciona, y la forma que sí funciona es la URL firmada a la que redirige /api/assets/{id}/content. La SEGUNDA SE HABILITA POR CUENTA en lugar de para todos a la vez, porque el bucket detrás de estos hosts es tuyo y no nuestro: incluso con el interruptor anterior ya activo, se rechaza una cuenta a la que no se le han habilitado los medios entrantes de terceros, y se le dice con esas palabras en lugar de decirle que el host no es compatible. Pide a tu contacto de Comfy que lo 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, ya sea en la forma path-style o con el prefijo <bucket>.), Azure Blob Storage (<account>.blob.core.windows.net) y Alibaba Cloud OSS (<bucket>.oss-<region>.aliyuncs.com, incluido el endpoint oss-accelerate). Esos 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, NO EL PROVEEDOR, así que nombrar un proveedor arriba NO significa que se acepte toda URL que ese proveedor pueda emitir, y vale la pena enunciar directamente tres casos que se le parecen mucho, 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 IPv6 dualstack 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 normalmente llegarás; no son una restricción de profundidad. La comparación se hace sobre el sufijo del dominio de almacenamiento de objetos, así que un nombre más profundo bajo el mismo espacio de nombres (a.b.pub-<hash>.r2.dev) también se acepta. 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 de abajo muestra solo la forma: un valor real también lleva los parámetros de consulta de firma, que aquí se omiten deliberadamente porque un ejemplo publicado vive 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 ideogram/ideogram-4-5 Precise Edit (una llamada que envía image) donde context_window está disponible: ahí cada imagen puede ser de hasta 50 MB (50,000,000 bytes) y 67,108,864 píxeles, y las imágenes de una solicitud hasta 128 MiB en total.
string[]
Imágenes de origen opcionales para la operación Generate. La primera se edita y el resto son referencias. Hasta cinco.
string
Solo para generar. Reescritura del prompt. Los valores admitidos son auto, on y off. Las solicitudes con imágenes siempre usan auto.
string
Una imagen, ya sea una URL https que Router obtiene en nombre de quien llama o un URI data:image/<format>;base64,<payload> que lleva los bytes en línea. Los tipos de imagen admitidos son png, webp y jpeg, y ese conjunto se APLICA en el momento de la resolución en lugar de dejarse al proveedor: un svg, gif, avif o tiff se rechaza aquí, nombrando la imagen que enviaste, en lugar de convertirse en un error del socio a dos saltos de la causa. Prefiere la forma de URL. Una carga 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 llega como máximo a una imagen de origen de unos 75 MB; una URL evita eso por completo. Los límites de medios por imagen y por solicitud indicados al final de esta descripción son más estrictos que el límite del cuerpo, así que para una imagen de cualquier tamaño real son los que encuentras primero. LA URL DEBE RESOLVERSE SIN TUS CREDENCIALES. Router la obtiene del lado del servidor y no envía ninguna credencial de quien llama con la solicitud, así que una URL prefirmada, es decir, una cuya firma está en la cadena de consulta, es la forma admitida. 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 OBTENCIÓN ESTÁ CONFINADA A UN CONJUNTO NOMBRADO DE HOSTS en lugar de a la internet abierta, y la misma lista se vuelve a aplicar a cada salto de redirección además de a la URL que envías, así que una URL en cualquier otro host, o una que redirija fuera de la lista, se rechaza antes de contactar a cualquier proveedor. Hoy esa lista es solo la entrega de recursos propia de Comfy: una URL firmada de storage.googleapis.com bajo un bucket de recursos de Comfy, que es la forma a la que /api/assets/{id}/content te redirige. Un CDN de un socio o un host https simple NO está en la lista. DOS AMPLIACIONES SE ESTÁN DESPLEGANDO Y HOY AMBAS ESTÁN DESACTIVADAS DE FORMA PREDETERMINADA. Se lanzan detrás de UN interruptor y se habilitan juntas, así que trata todo lo que sigue como algo futuro en lugar de 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 carga. Hasta que el despliegue llegue a tu entorno, una URL de carga de ese endpoint se rechaza aquí, aunque el bucket sea de Comfy y el host sea el mismo, así que “sube a Comfy y luego pasa la URL” TODAVÍA no funciona, y la forma que sí funciona es la URL firmada a la que /api/assets/{id}/content redirige. La SEGUNDA SE HABILITA POR CUENTA en lugar de para todos a la vez, porque el bucket detrás de estos hosts es tuyo y no nuestro: incluso con el interruptor anterior activado, una cuenta a la que no se le han habilitado los medios entrantes de terceros se rechaza, y se le dice así con esas 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 ninguna propiedad sobre él: Cloudflare R2 (<account>.r2.cloudflarestorage.com, pub-<hash>.r2.dev), Amazon S3 (s3.amazonaws.com y s3.<region>.amazonaws.com, ya sea en la forma de estilo de ruta o en la forma con el prefijo <bucket>.), Azure Blob Storage (<account>.blob.core.windows.net) y Alibaba Cloud OSS (<bucket>.oss-<region>.aliyuncs.com, incluido el endpoint oss-accelerate). Esos 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, NO EL PROVEEDOR, así que nombrar un proveedor arriba NO significa que se acepte cada URL que ese proveedor pueda emitir, y vale la pena enunciar directamente tres casos que casi encajan, porque quien llama puede llegar razonablemente con cualquiera 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 normalmente llegarás; no son una restricción de profundidad. La comparación se hace sobre el sufijo del dominio de almacenamiento de objetos, así que un nombre más profundo bajo el mismo espacio de nombres (a.b.pub-<hash>.r2.dev) también se acepta. Lo que eso NO amplía es el espacio de nombres en sí: el sufijo todavía tiene que ser uno de los enumerados. El ejemplo siguiente muestra solo la forma: un valor real también incluye los parámetros de consulta de firma, que aquí se omiten deliberadamente porque un ejemplo publicado vive 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 ideogram/ideogram-4-5 Precise Edit (una llamada que envía image) donde context_window está disponible: allí cada imagen puede ser de hasta 50 MB (50,000,000 bytes) y 67,108,864 píxeles, y las imágenes de una solicitud de hasta 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 descripción de la imagen o, con imágenes, la instrucción de edición. De 1 a 10,000 caracteres.
string
Nivel de calidad. El valor predeterminado es medium. very_low genera hasta 2K. La tarifa facturada depende de la calidad, de si la solicitud edita y de si la salida supera los 2K.Valores posibles: very_low, low, medium, high
string[]
Solo para Precise Edit; requiere image. Imágenes opcionales que guían la edición. Hasta cuatro, o tres con una máscara.
integer
Semilla para obtener resultados reproducibles.Rango: 0 a 2147483647
string
Solo para generar. auto (predeterminado) elige alrededor de 2K. WIDTHxHEIGHT en una cuadrícula de 32 píxeles, hasta 16,777,216 píxeles con lados de hasta 8192 y una relación de 6:1, o source para coincidir con la primera de images.
Generado a partir del esquema que Router publica en GET /v2/models/ideogram/ideogram-4-6/openapi.json, el mismo documento con 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.
string
El tamaño de la imagen como WIDTHxHEIGHT, por ejemplo 1600x1280.
integer
La semilla usada para esta imagen.
string
URL temporal de la imagen. Copia la imagen en tu propio almacenamiento.
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.