跳转到主要内容
GET
/
api
/
queue
Get queue information
curl --request GET \
  --url https://cloud.comfy.org/api/queue \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://cloud.comfy.org/api/queue"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://cloud.comfy.org/api/queue', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.comfy.org/api/queue",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://cloud.comfy.org/api/queue"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://cloud.comfy.org/api/queue")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://cloud.comfy.org/api/queue")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "queue_running": [
    [
      123
    ]
  ],
  "queue_pending": [
    [
      123
    ]
  ]
}
{
"code": "<string>",
"message": "<string>"
}
{
"code": "<string>",
"message": "<string>"
}

授权

X-API-Key
string
header
必填

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.

响应

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)