Submit a workflow for execution

Submit a workflow to be executed by the backend. The workflow is a JSON object describing the nodes and their connections.

POST /api/prompt

Submit a workflow for execution

cURL

curl --request POST \
  --url https://cloud.comfy.org/api/prompt \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "prompt": {},
  "number": 123,
  "front": true,
  "extra_data": {},
  "partial_execution_targets": [
    "<string>"
  ]
}
'

200

{
  "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "number": 123,
  "node_errors": {}
}

授权

X-API-Key · string · header · 必填

API key authentication. Generate an API key from your account settings at https://comfy.org/account. Pass the key in the X-API-Key header.

请求体

application/json

prompt · object · 必填

The workflow graph to execute

number · number

Priority number for the queue (lower numbers have higher priority). Note: Accepted for ComfyUI API compatibility but ignored in cloud. Cloud uses its own queue management with per-user ordering and fair scheduling.

front · boolean

If true, adds the prompt to the front of the queue. Note: Accepted for ComfyUI API compatibility but ignored in cloud. Cloud manages queue ordering internally based on job submission time and fair scheduling.

extra_data · object

Extra data to be associated with the prompt

partial_execution_targets · string[]

List of node names to execute

响应

200

application/json

Success - Prompt accepted

prompt_id · string<uuid>

Unique identifier for the prompt execution

number · number

Priority number in the queue

node_errors · object

Any errors in the nodes of the prompt