> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-docs-robin-i18n-sync.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Cloud API 概要

> Comfy Cloud へのプログラムによるアクセス。ワークフローの実行、ファイル管理、実行状況の監視が可能です

<Warning>
  **非推奨:** v1 Cloud API は、[Comfy API v2](/ja/api-reference/v2/overview) を優先するため非推奨となりました。既存の統合や、v2 がまだ公開していないクラウド機能向けには引き続き利用可能ですが、エンドポイントや動作は予告なく変更される場合があります。
</Warning>

v1 Cloud API は、クラウドインフラストラクチャ上でワークフローを実行するための Comfy のマネージドサービスである [Comfy Cloud](/ja/development/deploy/cloud) へのプログラムによるアクセスを提供します。

Comfy Cloud はステートフルなアプリケーションです。アカウントには、ジョブをまたいで永続する状態（クレジット、サブスクリプションティア、アップロード済みのアセット、生成済みの出力、ジョブキュー、インストール済みのモデルとノードのセット）が保持されます。v1 API はそのアプリケーション全体のインターフェースであり、キュー管理、モデルブラウジング、ノード定義、アカウントエンドポイントなど、ポータブルな [Comfy API v2](/ja/api-reference/v2/overview) ではサポートされていない機能を含みます。ワークフローの送信と結果の取得には、v2（またはそれをラップする SDK）を使用してください。この方法は、サーバーレスデプロイやセルフホスト型 ComfyUI でも機能します。その周辺のクラウド固有の機能には v1 を使用してください。

ワークフローを実行するには、[Comfy Cloud クイックスタート](/ja/development/deploy/cloud#クイックスタート) と [Comfy SDKs](/ja/development/api-development/sdks) から始めてください。クレジットと同時実行制限については [Comfy Cloud ページ](/ja/development/deploy/cloud) で説明しています。実行可能な v1 の例は [Cloud API リファレンス](/ja/development/cloud/api-reference) にあります。このページでは、v1 に固有のインターフェース（認証と、v2 が公開していないエンドポイント）について説明します。

<Note>
  **サブスクリプションが必要です:** API アクセスには有料の Comfy Cloud サブスクリプションが必須です。無料ティアには含まれません。[料金ページ](https://www.comfy.org/cloud/pricing?utm_source=docs\&utm_campaign=cloud-api)をご覧ください。
</Note>

## ベース URL

```
https://cloud.comfy.org
```

これは SDK のデフォルトのターゲットでもあるため、Comfy Cloud 用に設定する必要はありません。同じコードをサーバーレスデプロイメントやご自身の ComfyUI に向けるには、`COMFY_BASE_URL` を設定してください。[ベース URL の選択](/ja/development/api-development/sdks#ベースurlの選択) を参照してください。

## 認証

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

```bash theme={null}
curl -X GET "https://cloud.comfy.org/api/user" \
  -H "X-API-Key: $COMFY_CLOUD_API_KEY"
```

キーの作成と管理方法については、[API キーの取得](/ja/development/api-development/getting-an-api-key)を参照してください。無効なキーまたは不足しているキーは `401` を返します。アクティブでないサブスクリプションのキーは `429` を返します。

同じキーが[パートナーノード](/ja/tutorials/partner-nodes/overview)でも使用されます。HTTP では、`extra_data.api_key_comfy_org` に再度渡します。例については、[パートナーノードの使用](/ja/development/cloud/api-reference#パートナーノードの使用)を参照してください。

## SDKがまだカバーしていない機能

SDKは、ワークフローの実行、結果の取得、およびジョブのキャンセルをカバーしています。クラウドのその他の機能にはHTTP経由でしかアクセスできないため、実行にSDKを使用する場合でも、これらのエンドポイントを直接呼び出してください。

| 機能                      | エンドポイント                 | 参照                                                         |
| ----------------------- | ----------------------- | ---------------------------------------------------------- |
| キューのステータス、実行中および保留中のジョブ | `GET /api/queue`        | [キューの管理](/ja/development/cloud/api-reference#キュー管理)        |
| 現在の実行を中断                | `POST /api/interrupt`   | [キューの管理](/ja/development/cloud/api-reference#キュー管理)        |
| ノード定義と入力仕様              | `GET /api/object_info`  | [オブジェクト情報](/ja/development/cloud/api-reference#オブジェクト情報)   |
| 利用可能なモデルのブラウズ           | モデルエンドポイント              | [OpenAPI仕様](/ja/development/cloud/openapi)                 |
| アカウントとユーザー情報            | `GET /api/user`         | [OpenAPI仕様](/ja/development/cloud/openapi)                 |
| 既存の画像を参照するマスクのアップロード    | `POST /api/upload/mask` | [入力のアップロード](/ja/development/cloud/api-reference#入力のアップロード) |

ジョブのキャンセルは、両方の方法でカバーされています。SDKはハンドルを保持しているジョブをキャンセルでき、`POST /api/queue` はIDでキャンセルします。

## 利用可能なエンドポイント

| カテゴリ                                                                    | 説明                   |
| ----------------------------------------------------------------------- | -------------------- |
| [ワークフロー](/ja/development/cloud/api-reference#ワークフローの実行)                 | ワークフローの送信、ステータスの確認   |
| [ジョブ](/ja/development/cloud/api-reference#ジョブステータスの確認)                  | ジョブのステータスとキューの監視     |
| [入力](/ja/development/cloud/api-reference#入力のアップロード)                     | 画像、マスク、その他の入力のアップロード |
| [出力](/ja/development/cloud/api-reference#出力のダウンロード)                     | 生成されたコンテンツのダウンロード    |
| [WebSocket](/ja/development/cloud/api-reference#リアルタイム進捗のための-websocket) | リアルタイムの進捗更新          |
| [オブジェクト情報](/ja/development/cloud/api-reference#オブジェクト情報)                | 利用可能なノードとその定義        |

## エラーハンドリング

RESTエンドポイントは、標準的なHTTPステータスコードを返します：

| ステータス | 説明                              |
| ----- | ------------------------------- |
| `400` | 無効なリクエスト（不正なワークフロー、不足しているフィールド） |
| `401` | 認証されていません（無効または不足しているAPIキー）     |
| `402` | クレジット不足                         |
| `429` | サブスクリプションが無効                    |
| `500` | 内部サーバーエラー                       |

SDKは、代わりにこれらを型付き例外としてスローします。`Unauthorized`、`InvalidWorkflow`、`InsufficientCredits`、`QueueFull`、`JobFailed`などが含まれ、すべて`ComfyError`を継承しています。

実行の失敗はHTTPエラーとは別です。実行中に返される`exception_type`の値については、[エラーハンドリング](/ja/development/cloud/api-reference#エラーハンドリング)を参照してください。

## 次のステップ

<CardGroup cols={2}>
  <Card title="Comfy Cloud" icon="cloud" href="/ja/development/deploy/cloud">
    クイックスタート、クレジット、および同時実行制限。
  </Card>

  <Card title="Cloud API リファレンス" icon="book" href="/ja/development/cloud/api-reference">
    curl、Python、TypeScript の例を含む、完全なエンドポイントドキュメント。
  </Card>

  <Card title="Comfy API v2 リファレンス" icon="cloud" href="/ja/api-reference/v2/overview">
    両方の SDK の基盤となるバージョン付き HTTP API。任意の言語から使用できます。
  </Card>

  <Card title="OpenAPI 仕様" icon="file-code" href="/ja/development/cloud/openapi">
    コード生成用の機械可読 API 仕様。
  </Card>
</CardGroup>