管理队列操作

通过ID取消特定的待定任务，或全部清除队列中的待定任务。 注意：此端点仅影响待定任务。要取消正在运行的任务，请使用 /api/interrupt。

POST /api/queue

管理队列操作

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
}
'

import requests

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

payload = {
    "delete": ["<string>"],
    "clear": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({delete: ['<string>'], clear: true})
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'delete' => [
        '<string>'
    ],
    'clear' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"delete\": [\n    \"<string>\"\n  ],\n  \"clear\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://cloud.comfy.org/api/queue")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"delete\": [\n    \"<string>\"\n  ],\n  \"clear\": true\n}")
  .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::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"delete\": [\n    \"<string>\"\n  ],\n  \"clear\": true\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

授权

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

API密钥认证。从您的用户设置中生成API密钥 位于https://platform.comfy.org/profile/api-keys。在X-API-Key头中传递密钥。

请求体

application/json

管理队列操作的请求

delete · string[]

要取消的待定任务ID数组

clear · boolean

如果为true，从队列中全部清除待定任务

响应

200

application/json

成功

deleted · string[]

已成功取消的任务ID数组

cleared · boolean

队列是否已清除