ワークフローを実行のために送信

バックエンドで実行されるワークフローを送信します。 ワークフローはノードとその接続を記述する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

プロンプトのノード内のエラー