Subscribe to Workflow Updates

curl --request GET \
  --url https://api.comfycontrol.app/v1/workflow/{id}/subscribe \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.comfycontrol.app/v1/workflow/{id}/subscribe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.comfycontrol.app/v1/workflow/{id}/subscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.comfycontrol.app/v1/workflow/{id}/subscribe"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.comfycontrol.app/v1/workflow/{id}/subscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "401": {},
  "404": {},
  "status": "<string>",
  "prompt": {},
  "queue_number": 123,
  "outputs": [
    {}
  ],
  "outputs[].id": "<string>",
  "outputs[].workflow_id": "<string>",
  "outputs[].src": "<string>",
  "cause": {},
  "cause.node_type": "<string>",
  "cause.exception_type": "<string>",
  "cause.exception_message": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>"
}

GET

workflow

{id}

Subscribe to Workflow Updates

curl --request GET \
  --url https://api.comfycontrol.app/v1/workflow/{id}/subscribe \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.comfycontrol.app/v1/workflow/{id}/subscribe', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.comfycontrol.app/v1/workflow/{id}/subscribe",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.comfycontrol.app/v1/workflow/{id}/subscribe"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.comfycontrol.app/v1/workflow/{id}/subscribe")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "401": {},
  "404": {},
  "status": "<string>",
  "prompt": {},
  "queue_number": 123,
  "outputs": [
    {}
  ],
  "outputs[].id": "<string>",
  "outputs[].workflow_id": "<string>",
  "outputs[].src": "<string>",
  "cause": {},
  "cause.node_type": "<string>",
  "cause.exception_type": "<string>",
  "cause.exception_message": "<string>",
  "started_at": "<string>",
  "completed_at": "<string>"
}

Overview

Subscribe to real-time updates for a workflow execution using Server-Sent Events (SSE). This provides live progress updates, status changes, and output information as the workflow executes.

This endpoint uses Server-Sent Events (SSE) for real-time updates. The connection remains open until the workflow reaches a terminal state or the maximum update limit is reached.

Path Parameters

string

required

The unique identifier (UUID) of the workflow to monitor.

Response

This endpoint streams events in Server-Sent Events format. Each event contains a JSON payload with workflow status information.

Event Data Format

string

Current status of the workflow.Possible values: accepted, uploaded, queued, running, completed, cancelled, invalid, failed

object

ComfyUI prompt information (structure varies based on workflow).

integer

Current position in the execution queue (null if not queued).

array

Array of output media objects (populated when status is completed).

string

Output file identifier.

string

Workflow UUID.

string

Signed URL to the output file.

object

Error information (only present if status is failed).

string

The ComfyUI node that caused the failure.

string

Type of exception.

string

Detailed error message.

string

ISO 8601 timestamp when execution started.

string

ISO 8601 timestamp when execution completed.

Example Event Stream

data: {"status":"queued","prompt":null,"queue_number":3,"outputs":[],"cause":null,"started_at":null,"completed_at":null}

data: {"status":"running","prompt":{"prompt_id":"abc123"},"queue_number":1,"outputs":[],"cause":null,"started_at":"2024-01-15T14:30:05Z","completed_at":null}

data: {"status":"completed","prompt":{"prompt_id":"abc123"},"queue_number":null,"outputs":[{"id":"output-1","workflow_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","src":"https://storage.comfycontrol.app/outputs/..."}],"cause":null,"started_at":"2024-01-15T14:30:05Z","completed_at":"2024-01-15T14:32:15Z"}

Connection Behavior

Update Interval: ~2 seconds between updates
Maximum Updates: 120 updates (~4 minutes)
Auto-Close: Connection automatically closes when workflow reaches a terminal state (completed, failed, cancelled)
Reconnection: Client should reconnect if connection drops unexpectedly

Error Responses

error

Unauthorized - invalid or missing authentication token.

error

Not Found - workflow with the specified ID does not exist or does not belong to your account.

Notes

Use this endpoint instead of polling for real-time updates
Connection closes automatically when workflow completes
Maximum connection time is ~4 minutes (120 updates × 2 seconds)
For long-running workflows, reconnect if max updates is reached
Outputs are included in the final event when status becomes completed
SSE is supported by most modern HTTP clients and browsers
Connection may be closed by network timeouts or proxies - implement reconnection logic
Each event is a complete status snapshot, not a delta

Example Client Code

import requests
import json

def monitor_workflow(workflow_id, token):
    url = f"https://api.comfycontrol.app/v1/workflow/{workflow_id}/subscribe"
    headers = {"Authorization": f"Bearer {token}"}
    
    with requests.get(url, headers=headers, stream=True) as response:
        for line in response.iter_lines():
            if line and line.startswith(b'data: '):
                data = json.loads(line[6:])
                print(f"Status: {data['status']}")
                
                if data['status'] in ['completed', 'failed', 'cancelled']:
                    print("Workflow finished")
                    break

API Overview

Runners

Managed Runners

Workflows

Templates

User

Subscribe to Workflow Updates

Overview

Path Parameters

Response

Event Data Format

Example Event Stream

Connection Behavior

Error Responses

Notes

Example Client Code

​Overview

​Path Parameters

​Response

​Event Data Format

​Example Event Stream

​Connection Behavior

​Error Responses

​Notes

​Example Client Code

Overview

Path Parameters

Response

Event Data Format

Example Event Stream

Connection Behavior

Error Responses

Notes

Example Client Code