POST
/
run

Authorizations

​
Authorization
string
headerrequired

Create your token in Comfy Deploy

Body

application/json

Run options

​
deployment_id
string

Deployment ID to run

​
workflow_api
any

Workflow API JSON to run

​
workflow_api_json
string

Workflow API JSON to run

​
workflow_id
string

Workflow ID to run

​
machine_id
string
​
gpu
enum<string>
Available options:
T4,
L4,
A10G,
A100,
A100-80GB,
H100
​
concurrency_limit
number
​
private_volume_name
string
​
timeout
number
​
run_origin
enum<string>
Available options:
manual,
api,
public-share,
public-template,
workspace
​
inputs
object

External inputs to the workflow

​
inputs_json
string

External inputs to the workflow in JSON format

​
webhook
string

Webhook URL to receive workflow updates

​
webhook_intermediate_status
boolean

Whether to send webhook on intermediate status

​
stream
boolean

Whether to return a streaming url

​
batch_number
number
default: 1

Batch number to run

Response

200 - application/json
​
run_id
string
required

Was this page helpful?

Get workflow run outputUpload any files to the storage