> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-chore-sync-comfy-api-v2-spec-12fd5b4.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Cloud API 概要

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

<Warning>
  **実験的 API:** この API は実験的であり、変更される可能性があります。エンドポイント、リクエスト/レスポンス形式、および動作は予告なく変更される場合があります。
</Warning>

# Comfy Cloud API

Comfy Cloud API は、Comfy Cloud インフラストラクチャ上でワークフローを実行するためのプログラムによるアクセスを提供します。この API はローカルの ComfyUI の API と互換性があり、既存の統合を簡単に移行できます。

Python または TypeScript で作業している場合は、[Comfy SDKs](/ja/development/api-development/sdks) を使用してください。これらの SDK はこの API をラップしており、ワークフローを実行するための最短の方法です。このページでは、Comfy Cloud に固有の内容（APIキー、クレジット、同時実行制限）について説明します。その他の内容は[Cloud API リファレンス](/ja/development/cloud/api-reference)に記載されています。

<Note>
  **サブスクリプションが必要:** API へのアクセスは **Standard**、**Creator** および **Pro** ティアで利用可能です。Free ティアには API アクセスは含まれません。詳細は[料金ページ](https://www.comfy.org/cloud/pricing?utm_source=docs\&utm_campaign=cloud-api)をご覧ください。
</Note>

## クレジットと使用量

API リクエストは、Comfy Cloud のウェブ UI と同じ月間クレジット枠から消費されます。API 専用のクレジットプールはありません。各ティアに含まれるクレジット、追加購入オプション、ワークフロー単位のランタイム上限は、API ジョブにも UI ジョブと同じ条件で適用されます。Standard、Creator、Pro の各ティアの月間クレジット数については、[料金ページ](https://www.comfy.org/cloud/pricing?utm_source=docs\&utm_campaign=cloud-api)を参照してください。月の途中でクレジットが不足した場合、アカウントダッシュボードから追加購入できます。

## ベース URL

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

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

## 認証

すべての API リクエストには API キーが必須です。生の HTTP では `X-API-Key` ヘッダーで渡します。SDK では、API キーをクライアントに一度渡すだけで、クライアントがすべてのリクエストを認証します。

### API キーの取得

クラウド API キーの作成と管理方法については、[API キーの取得](/ja/development/api-development/getting-an-api-key)を参照してください。

### API キーの使用

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

  ```python Python theme={null}
  import os
  from comfy_sdk import Comfy

  client = Comfy(api_key=os.environ["COMFY_CLOUD_API_KEY"])
  ```

  ```typescript TypeScript theme={null}
  import { Comfy } from "@comfyorg/sdk";

  const client = new Comfy({ apiKey: process.env.COMFY_CLOUD_API_KEY! });
  ```
</CodeGroup>

無効なキーまたは不足しているキーは `401` を返し、SDK では `Unauthorized` としてスローされます。アクティブでないサブスクリプションのキーは `429` を返します。

同じキーが[パートナーノード](/ja/tutorials/partner-nodes/overview)でも使用されます。HTTP では、`extra_data.api_key_comfy_org` に再度渡します。SDK では、`submit()` に `api_key` を渡すと自動的に処理されます。

## ワークフローの実行

ワークフローは [API 形式](/ja/development/api-development/workflow-api-format)（ComfyUI フロントエンドの「ワークフローをエクスポート（API）」オプションが生成する JSON）で送信されます。ワークフローを送信すると、ジョブは非同期で実行され、完了時に出力をダウンロードします。

<Card title="Comfy SDKs" icon="code" href="/ja/development/api-development/sdks">
  Python または TypeScript で、SDK のインストール、ワークフローの送信、進捗状況のリアルタイム追跡、出力の保存ができます。ここから始めましょう。
</Card>

HTTP エンドポイントを直接呼び出す場合、別の言語から、または以下の機能を使用する場合は、[Cloud API リファレンス](/ja/development/cloud/api-reference) を参照してください。そこには、送信、ポーリング、WebSocket プロトコル、および curl、Python、TypeScript の例による出力ダウンロードが記載されています。

### 並列実行（同時ジョブ）

API ユーザーは、前のジョブの完了を待たずに複数のワークフローを同時に送信できます。ジョブが受け入れられるとすぐに送信が返されるため、複数のジョブを進行中に保つことができます。ディスパッチャは、サブスクリプション階層の上限までそれらを並列に実行します。

| サブスクリプション階層 | 同時ジョブ数 |
| ----------- | ------ |
| Standard    | 1      |
| Creator     | 3      |
| Pro         | 5      |

同時実行制限を超えて送信されたジョブは、通常どおりキューに入り、スロットが空き次第自動的に実行されます。キュー自体が満杯の場合、SDK は `QueueFull` を発生させる前に、限られた回数だけ再試行します。

<Info>
  並列実行は現在、API 経由でのみ利用可能です。サブスクリプションの詳細については、[料金ページ](https://www.comfy.org/cloud/pricing?utm_source=docs\&utm_campaign=cloud-api) を参照してください。
</Info>

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

SDKが行うことは1つだけです。ワークフローを実行し、結果を取得することです。クラウドのその他の機能には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#オブジェクト情報)   |
| 利用可能なモデルのブラウズ           | モデルエンドポイント              | [Cloud API リファレンス](/ja/development/cloud/api-reference)    |
| アカウントとユーザー情報            | `GET /api/user`         | [Cloud API リファレンス](/ja/development/cloud/api-reference)    |
| 既存の画像を参照するマスクのアップロード    | `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 SDKs" icon="code" href="/ja/development/api-development/sdks">
    Python または TypeScript からワークフローを実行できます。アセット、ライブイベント、型付きエラーに対応しています。
  </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>