メインコンテンツへスキップ
実験的 API: この API は実験的であり、変更される可能性があります。エンドポイント、リクエスト/レスポンス形式、および動作は、通知なしに変更される場合があります。

Comfy Cloud API 仕様

このページでは、Comfy Cloud API の完全な OpenAPI 3.0 仕様を提供します。
サブスクリプションが必要: API を介してワークフローを実行するには、有効な Comfy Cloud サブスクリプションが必要です。詳細は 料金プラン を参照してください。

対話型 API リファレンス

対話型ドキュメントで完全な API を探索します:

Cloud API リファレンス

エンドポイントを閲覧し、スキーマを確認し、リクエストを試す

仕様の使用

OpenAPI 仕様は以下の目的に使用できます:
  • クライアントライブラリの生成 - OpenAPI Generator などのツールを使用して、任意の言語でクライアントライブラリを生成
  • API ツールへのインポート - Postman、Insomnia、Paw などの API ツールへインポート
  • ドキュメントの生成 - Redoc や Swagger UI などのツールを使用してドキュメントを生成
  • リクエストの検証 - アプリケーション内でリクエストを検証

ダウンロード

生の OpenAPI 仕様ファイルをダウンロードできます:

openapi-cloud.yaml

OpenAPI 3.0 仕様をダウンロード

認証

すべての API リクエストには、X-API-Key ヘッダーで渡された API キーが必要です。

API キーの取得

スクリーンショット付きの段階的な手順については、Cloud API 概要 を参照してください。

API キーの使用

X-API-Key: your-api-key

ベース URL

環境URL
本番環境https://cloud.comfy.org

WebSocket 接続

リアルタイム更新については、WebSocket エンドポイントに接続します:
wss://cloud.comfy.org/ws?clientId={uuid}&token={api_key}
メッセージタイプと処理については、API リファレンス を参照してください。