Sign in
prompt

Submit a workflow for execution

Submits a workflow for execution. The server validates the graph, assigns a prompt_id, and enqueues it. Clients listen on /ws for execution progress and output messages.

post/api/prompt

Request body

promptobject required

The workflow graph to execute. Keys are node IDs (strings); values are objects with class_type and inputs.

numbernumber

Priority number for the queue (lower numbers have higher priority)

frontboolean

If true, adds the prompt to the front of the queue

extra_dataobject

Extra data associated with the prompt (e.g. extra_pnginfo)

client_idstring

WebSocket client ID to receive progress updates

prompt_idstring uuid

Client-supplied prompt ID. Server generates a UUID if omitted.

partial_execution_targetsstring[]

List of node IDs to execute (partial graph execution)

workflow_idstring uuid nullable

[cloud-only] Cloud workflow entity ID for tracking and gallery association. Ignored by local ComfyUI.

workflow_version_idstring uuid nullable

[cloud-only] Cloud workflow version ID for pinning execution to a specific version. Ignored by local ComfyUI.

Response

Prompt accepted

prompt_idstring uuid

Unique identifier for the prompt execution

numbernumber

Priority number in the queue

node_errorsobject

Validation errors keyed by node ID

Changes