Skip to main content
POST
/
run
Error
A valid request URL is required to generate request examples
{
  "run_id": "<string>"
}

​
Description

This endpoint allows you to run a workflow by providing a deployment ID and optional input parameters.

​
Request Body

Content-Type: application/json 
{
  "deployment_id": "string",  // The ID of the deployment to run (required)
  "inputs": {  // Optional inputs for the workflow
    "key": "string or number"
  }
}`

​
Responses

​
200 OK


`{
  "run_id": "string"  // The ID of the run that has been queued
}`

​
401 Invalid or Expired Token

`Invalid or expired token`

​
500 Error Creating Run


`{
  "error": "string"  // Error message detailing why the run creation failed
}`

Authorizations

​
Authorization
string
header
required

API token created in Comfy Deploy /api-keys

Body

application/json
​
deployment_id
string
required
​
inputs
object

Response

Workflow queued

​
run_id
string
required