POST
/
run
/
stream
curl --request POST \
  --url https://api.comfydeploy.com/api/run/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inputs": {
    "prompt": "A beautiful landscape",
    "seed": 42
  },
  "webhook": "<string>",
  "webhook_intermediate_status": true,
  "gpu": "T4",
  "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "event": "log_update",
  "data": {
    "logs": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
workflow_version_id
string
required
​
inputs
object

The inputs to the workflow

Example:
{
  "prompt": "A beautiful landscape",
  "seed": 42
}
​
webhook
string
​
webhook_intermediate_status
boolean
default:false
Example:

true

​
gpu
enum<string>

The GPU to override the machine's default GPU

Available options:
T4,
L4,
A10G,
A100,
A100-80GB,
H100
​
machine_id
string | null

Response

200
text/event-stream
Stream of workflow run events
​
data
object
required
​
event
enum<string>
default:log_update
Available options:
log_update

Was this page helpful?

Suggest editsRaise issue
Run a workflow in syncGet Session