Skip to main content
Referencia de API para openai/gpt-image-1, servida por Comfy Router desde OpenAI. 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: openai/gpt-image-1 Endpoint: POST https://api.comfy.org/v2/models/openai/gpt-image-1
El mismo cuerpo, enviado a POST https://api.comfy.org/v2/models/openai/gpt-image-1/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
Transparencia del fondo. auto deja que el modelo elija.Valores posibles: transparent, opaque, auto
string | string[]
La imagen o imágenes fuente que se van a editar. LA PRESENCIA DE ESTE CAMPO SELECCIONA LA OPERACIÓN DE EDICIÓN: omítelo por completo para la generación de texto a imagen. El ejemplo publicado del modelo es la llamada de GENERACIÓN, que omite este campo. Agregar image es toda la diferencia entre los dos modos: mismo endpoint, mismo id de modelo; salvo que un prompt de edición describe el CAMBIO que quieres, no la escena, así que el cuerpo de edición de abajo se lee distinto del ejemplo de generación aunque solo este campo sea estructuralmente nuevo. Puedes copiarlo exactamente como se muestra: {"prompt": "give the rocketship rainbow coloring", "image": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="], "size": "1024x1024"}. La carga útil es un PNG 1x1 completo, no una abreviatura, y este cuerpo está fijado como un caso aceptado en las pruebas de validación de solicitudes del propio Router. Sustituye los bytes por los de tu propia imagen. Acepta una imagen o un arreglo de ellas; gpt-image-1 y versiones posteriores aceptan hasta 16, y Router lo aplica desde este esquema antes de despachar.
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 aceptados son png, webp y jpeg, y ese conjunto se APLICA en el momento de resolver, en lugar de dejarlo al proveedor: un svg, gif, avif o tiff se rechaza aquí, nombrando la imagen que enviaste, en vez de convertirse en un error del socio a dos saltos de la causa. Prefiere la forma de URL. Una carga útil en base64 se infla aproximadamente 4/3 y todo el cuerpo de la solicitud tiene un límite de 100 MiB, así que la forma en línea llega como máximo a una imagen fuente de unos 75 MB; una URL evita eso por completo. Los techos 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 lo primero que encuentras. 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, cuya firma está en la cadena de consulta, es la forma admitida. Un endpoint autenticado como /api/assets/{id}/content le 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 nombrado de hosts en lugar de a la internet abierta, y la misma lista se vuelve a aplicar a cada salto de redirección, así como a la URL que envías: por eso, 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 dentro de un bucket de recursos de Comfy, que es la forma a la que te redirige /api/assets/{id}/content. Un CDN de un socio o un host https simple NO está en la lista. Dos ampliaciones se están implementando y ambas están desactivadas por defecto hoy. Se lanzan detrás de UN interruptor y se habilitan juntas, así que trata todo lo que sigue como algo próximo, no como algo sobre lo que construir todavía: pregunta antes de depender de cualquiera de las dos. La PRIMERA es el bucket en el que POST /customers/storage firma tu carga. Hasta que la implementación llegue a tu entorno, una URL de carga de ese endpoint se rechaza aquí, aunque el bucket sea propio de Comfy y el host sea 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, no para todos a la vez, porque el bucket detrás de estos hosts es tuyo, no nuestro: incluso una vez que el interruptor anterior está activado, una cuenta a la que no se le han habilitado los medios entrantes de terceros se rechaza, 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 de estilo de ruta 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 disparador 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: por eso, 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 es razonable que quien llama llegue 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 velocidad 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 se acepta 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í para leerlas. Los marcadores de posición <account> y pub-<hash> de arriba muestran la forma con la que normalmente llegarás; no son una restricción de profundidad. La coincidencia se hace sobre el sufijo de dominio del almacenamiento de objetos, así que un nombre más profundo bajo el mismo espacio de nombres (a.b.pub-<hash>.r2.dev) también es válido. Lo que NO se amplía con eso es el propio espacio de nombres: el sufijo debe seguir siendo uno de los listados. El ejemplo de abajo muestra solo la forma: un valor real también incluye los parámetros de consulta de firma, que se omiten aquí a propósito 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 tiene un límite de 25 MiB y las imágenes de una misma solicitud, de 64 MiB en total.
string
El modelo gpt-image que se va a ejecutar. Router inserta el id del modelo direccionado, así que quien llama a /v2/models/openai/gpt-image-2 no envía este campo.
string
Ajuste de moderación de contenidoValores posibles: low, auto
integer
El número de imágenes a generar (1-10).Rango: de 1 a 10
integer
Nivel de compresión para JPEG o WebP (0-100)Rango: de 0 a 100
string
Formato de la imagen de salidaValores posibles: png, webp, jpeg
integer
Solo tiene sentido junto a un flujo en vivo, que esta superficie no puede servir: stream se fija en false incluso cuando lo envías. En una generación, cualquier valor distinto de 0 o null se rechaza con un 400, tanto si la solicitud también envía stream: true como si no; en una solicitud que lleva image, el campo se descarta en lugar de reenviarse. Omítelo.Rango: de 0 a 3
string
requerido
Una descripción de texto de la imagen que se va a generar, o de la edición que se va a hacer en image.
string
La calidad de la imagen generada o editada. xhigh y max son los dos niveles para los que se añadieron gpt-image-2.5-flare y gpt-image-2.5-sunburst; standard y hd son grafías de la época de dall-e que ningún modelo admitido lee.Valores posibles: auto, low, medium, high, xhigh, max, standard, hd
string
Tamaño de la imagen (p. ej., 1024x1024, 1536x1024, auto)
boolean
Se declara para que a quien lo envíe no se le rechace, pero es INERTE en esta superficie: Router lo FIJA en false antes del despacho, porque captura la respuesta del proveedor en lugar de retransmitir un text/event-stream (una solicitud que lleva image descarta el campo, ya que la edición se recodifica sin él). Ninguna superficie de Comfy sirve el streaming de imágenes parciales de gpt-image: la entrada v1 POST /proxy/openai/images/generations rechaza stream: true con un 400 y nunca reenvía la solicitud al proveedor, así que omite el campo y lee la respuesta completada como un único cuerpo JSON. Como el stream nunca se abre, la restricción de OpenAI sobre combinar stream: true con n mayor que 1 no aplica aquí; n se reenvía tal como se envía.
string
Un identificador único para el monitoreo de usuarios finales
Generado a partir del esquema que Router sirve en GET /v2/models/openai/gpt-image-1/openapi.json, el mismo documento contra el que valida una llamada antes de que la solicitud llegue al proveedor.

Salida

object[]
string
Datos de la imagen codificados en Base64
string
Prompt revisado
string
URL de la imagen
object
integer
object
integer
integer
integer
object
integer
integer
integer
string
Indica si el fondo de la imagen generada es opaque o transparent, tal como OpenAI lo resolvió para esta generación. El parámetro de la solicitud tiene como valor predeterminado auto, así que aquí es donde quien llama y no lo fijó se entera de cuál se produjo.
integer
Marca de tiempo Unix, en segundos, de cuándo se completó la generación. Es el único miembro que OpenAI declara como REQUIRED en una respuesta de generación de imágenes, así que está presente siempre que OpenAI es el productor; una respuesta servida por fal, pika, wavespeed o runware en cualquiera de los ids respaldados por alternativas lo omite por completo, igual que los otros cuatro miembros de parámetros resueltos. Se declara int64 porque un valor de época actual está lo bastante cerca de 2^31 como para que un integer sin formato genere un campo de 32 bits en muchos generadores de SDK.Formato: int64
string
La codificación de los bytes en data[].b64_json: png, webp o jpeg. Es el formato que OpenAI realmente codificó, que es el output_format de la solicitud cuando se envió uno y png cuando no se envió ninguno, de modo que un decodificador puede basarse en él en lugar de volver a deducir el formato a partir de la solicitud.
string
El nivel de calidad con el que realmente se ejecutó la generación. OpenAI informa uno de low, medium, high, xhigh o max. Es el nivel RESUELTO, no un eco de la solicitud, cuyo propio quality tiene como valor predeterminado auto.
string
Las dimensiones en píxeles con las que realmente se ejecutó la generación, como <width>x<height>. Es el tamaño RESUELTO: el size de la solicitud tiene como valor predeterminado auto y admite explícitamente auto, así que este es el único lugar donde se informan las dimensiones realmente usadas.

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.