Skip to main content
GET
Get queue information

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.

Response

Success

Queue information with pending and running jobs

queue_running
integer · string · object · string[] · object[][]

Array of currently running job items

Queue item tuple format: [job_number, prompt_id, workflow_json, output_node_ids, metadata]

  • [0] job_number (integer): Position in queue (1-based)
  • [1] prompt_id (string): Job UUID
  • [2] workflow_json (object): Full ComfyUI workflow
  • [3] output_node_ids (array): Node IDs to return results from
  • [4] metadata (object): Contains {create_time: }

Job number (position in queue)

queue_pending
integer · string · object · string[] · object[][]

Array of pending job items (ordered by creation time, oldest first)

Queue item tuple format: [job_number, prompt_id, workflow_json, output_node_ids, metadata]

  • [0] job_number (integer): Position in queue (1-based)
  • [1] prompt_id (string): Job UUID
  • [2] workflow_json (object): Full ComfyUI workflow
  • [3] output_node_ids (array): Node IDs to return results from
  • [4] metadata (object): Contains {create_time: }

Job number (position in queue)