提交工作流以执行

提交一个工作流供后端执行。 工作流是一个JSON对象，描述节点及其连接。

POST /api/prompt

提交工作流以执行

cURL

curl --request POST \
  --url https://cloud.comfy.org/api/prompt \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "prompt": {},
  "number": 123,
  "front": true,
  "extra_data": {},
  "partial_execution_targets": [
    "<string>"
  ]
}
'

import requests

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

payload = {
    "prompt": {},
    "number": 123,
    "front": True,
    "extra_data": {},
    "partial_execution_targets": ["<string>"]
}
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({
    prompt: {},
    number: 123,
    front: true,
    extra_data: {},
    partial_execution_targets: ['<string>']
  })
};

fetch('https://cloud.comfy.org/api/prompt', 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/prompt",
  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([
    'prompt' => [
        
    ],
    'number' => 123,
    'front' => true,
    'extra_data' => [
        
    ],
    'partial_execution_targets' => [
        '<string>'
    ]
  ]),
  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/prompt"

	payload := strings.NewReader("{\n  \"prompt\": {},\n  \"number\": 123,\n  \"front\": true,\n  \"extra_data\": {},\n  \"partial_execution_targets\": [\n    \"<string>\"\n  ]\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/prompt")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": {},\n  \"number\": 123,\n  \"front\": true,\n  \"extra_data\": {},\n  \"partial_execution_targets\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"prompt\": {},\n  \"number\": 123,\n  \"front\": true,\n  \"extra_data\": {},\n  \"partial_execution_targets\": [\n    \"<string>\"\n  ]\n}"

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

200

{
  "prompt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "number": 123,
  "node_errors": {}
}

{}

{}

{}

{}

{}

授权

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

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

请求体

application/json

prompt · object · 必填

要执行的工作流画面

number · number

队列的优先级编号（数字越小优先级越高）。 注意： 为兼容ComfyUI API而接受，但在云端忽略。 云端使用自己的队列管理，包含按用户排序和公平调度。

front · boolean

如果为true，则将提示添加到队列前端。 注意： 为兼容ComfyUI API而接受，但在云端忽略。 云端基于任务提交时间和公平调度在内部管理队列排序。

extra_data · object

要与提示关联的额外数据

partial_execution_targets · string[]

要执行的节点名称列表

响应

200

application/json

成功: 提示已接受

prompt_id · string<uuid>

提示执行的唯一标识符

number · number

队列中的优先级编号

node_errors · object

提示节点中的任何错误