Skip to main content
POST
/
api
/
v1
/
runs
Execute Workflow
curl --request POST \
  --url https://your-deployment-api-url.pod.flowscale.ai/api/v1/runs \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-KEY: <api-key>' \
  --form custom_field_1=your_value_here \
  --form custom_field_2=7.5 \
  --form custom_field_3=20 \
  --form custom_file_upload=@example-file
{
  "status": "<string>",
  "data": [
    {
      "run_id": "<string>",
      "workflow_id": "<string>"
    }
  ],
  "errors": "<string>",
  "meta": {}
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
workflow_id
string
required
​
group_id
string | null

Body

multipart/form-data

⚠️ IMPORTANT: The field names shown below are placeholders. You must replace them with the actual parameter names required by your specific workflow.

To find your workflow's parameter names:

  1. API Docs: Check your deployment's auto-generated API Deployment Dashboard
  2. ComfyUI Workflow: Look at the input nodes in your workflow

Note: Different workflows have completely different parameter names and types.

​
custom_field_1
string

Replace 'custom_field_1' with your actual parameter name. Example: 'prompt', 'style', 'model_name'

Example:

"your_value_here"

​
custom_field_2
number

Replace 'custom_field_2' with your numeric parameter name. Example: 'strength', 'cfg_scale', 'temperature'

Example:

7.5

​
custom_field_3
integer

Replace 'custom_field_3' with your integer parameter name. Example: 'steps', 'seed', 'width', 'height'

Example:

20

​
custom_file_upload
file

Replace 'custom_file_upload' with your file parameter name. Example: 'input_image', 'reference_image', 'mask'

​
{key}

Response

Successful Response

​
status
string
required
​
data
ComfyRunResponse · object[]
required
​
errors
​
meta
object | null
⌘I