Skip to main content
Obsoleto: La API de Cloud v1 está obsoleta en favor de Comfy API v2. Los endpoints, los formatos de solicitud y respuesta, y el comportamiento pueden modificarse sin previo aviso. Algunos endpoints se mantienen por compatibilidad con ComfyUI local, pero pueden tener una semántica distinta (por ejemplo, campos ignorados).
Esta página ofrece ejemplos completos de las operaciones más habituales de la API de Comfy Cloud.
Suscripción requerida: Ejecutar flujos de trabajo mediante la API requiere una suscripción activa a Comfy Cloud. Consulta los planes de precios para más detalles.

Configuración

Todos los ejemplos usan estas importaciones y esta configuración comunes:

Información de objetos

Recupera las definiciones de nodos disponibles. Esto es útil para entender qué nodos están disponibles y sus especificaciones de entrada y salida.

Subir entradas

Sube imágenes, máscaras u otros archivos para usarlos en flujos de trabajo.

Subir directamente (multipart)

Subir una máscara

La API acepta el parámetro subfolder por compatibilidad, pero el almacenamiento en la nube lo ignora. Todos los archivos se guardan en un espacio de nombres plano con direccionamiento por contenido.

Ejecutar flujos de trabajo

Envía un flujo de trabajo para ejecutarlo.
Envíos simultáneos admitidos: Según tu nivel de suscripción, puedes enviar varios flujos de trabajo sin esperar a que terminen las tareas anteriores. Las tareas se ejecutan en paralelo hasta el límite de tu nivel. Las tareas adicionales se ponen en cola automáticamente. Consulta Tareas simultáneas para ver los detalles y los límites de simultaneidad.

Enviar flujo de trabajo

Usar nodos asociados

Si tu flujo de trabajo contiene nodos asociados (nodos que llaman a servicios de IA externos como Flux Pro, Ideogram, etc.), debes incluir tu clave API de Comfy en el campo extra_data de la carga útil de la solicitud.
El frontend de ComfyUI incluye automáticamente tu clave API en extra_data cuando ejecutas flujos de trabajo en el navegador. Esta sección solo es relevante cuando llamas a la API directamente.
Genera tu clave API en platform.comfy.org. Es la misma clave que se usa para la autenticación de la API de Comfy Cloud (encabezado X-API-Key). Consulta Obtener una clave API para ver las instrucciones paso a paso.

Modificar las entradas del flujo de trabajo


Comprobar el estado de la tarea

Consulta periódicamente hasta que la tarea finalice. Valores del estado de la tarea: La API devuelve uno de los siguientes valores de estado: Esos cinco son los estados terminales. Todo lo demás significa que la tarea aún está en curso, incluidos submitted, queued_waiting, preparing, executing y estados de transición como cancel_requested. Consulta periódicamente hasta que veas un valor terminal en lugar de buscar coincidencias con los nombres de los estados en curso.

WebSocket para el progreso en tiempo real

Conéctate al WebSocket para recibir actualizaciones de ejecución en tiempo real.
El parámetro clientId se ignora actualmente: todas las conexiones de un mismo usuario reciben los mismos mensajes. Pasa un clientId único para mantener la compatibilidad a futuro.

Tipos de mensajes de WebSocket

Los mensajes se envían como tramas de texto JSON, a menos que se indique lo contrario.

Mensajes binarios (vistas previas de imagen)

Durante la generación de imágenes, ComfyUI envía tramas binarias de WebSocket que contienen vistas previas de imagen. Son datos binarios sin procesar (no JSON): Formatos de las tramas binarias (todos los enteros son big-endian):
Consulta la especificación OpenAPI para ver las definiciones completas del esquema de cada tipo de mensaje JSON.

Descargar las salidas

Recupera los archivos generados cuando la tarea haya finalizado.

Ejemplo completo de extremo a extremo

Aquí tienes un ejemplo completo que integra todo:

Gestión de la cola

Obtener el estado de la cola

Cancelar una tarea

Interrumpir la ejecución actual


Manejo de errores

Errores HTTP

Los endpoints de la API REST devuelven códigos de estado HTTP estándar:

Errores de ejecución

Durante la ejecución de un flujo de trabajo, los errores llegan mediante el mensaje WebSocket execution_error. El campo exception_type identifica la categoría del error: