Manage queue operations

Cancel specific PENDING jobs by ID or clear all pending jobs in the queue. Note: This endpoint only affects pending jobs. To cancel running jobs, use /api/interrupt.

POST /api/queue

Manage queue operations

cURL

curl --request POST \
  --url https://cloud.comfy.org/api/queue \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "delete": [
    "<string>"
  ],
  "clear": true
}
'

200

{
  "deleted": [
    "<string>"
  ],
  "cleared": true
}

Authorizations

X-API-Key · string · header · required

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

Body

application/json

Request to manage queue operations

delete · string[]

Array of PENDING job IDs to cancel

clear · boolean

If true, clear all pending jobs from the queue

Response

200

application/json

Success

deleted · string[]

Array of job IDs that were successfully cancelled

cleared · boolean

Whether the queue was cleared