> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-matt-router-pricing-pika-and-guard.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# v1 Cloud API 概要

> 非推奨の v1 Cloud API の範囲: 認証と、Comfy API v2 がまだ公開していない Cloud 固有のエンドポイント

<Warning>
  **非推奨:** v1 Cloud API は [Comfy API v2](/ja/api-reference/v2/overview) に代わり非推奨となりました。既存の統合および v2 ではまだ公開されていない Cloud の機能のために引き続き利用できますが、エンドポイントと動作は予告なく変更される可能性があります。
</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）を使用してください。これは Comfy API のデプロイメントやセルフホスト型の ComfyUI に対しても機能します。その周辺にある Cloud 固有の機能には v1 を使用してください。

ワークフローを実行するには、まず [Comfy Cloud クイックスタート](/ja/development/deploy/cloud) と [Comfy SDKs](/ja/development/api-development/sdks) を参照してください。クレジットと同時実行の制限については[使用量と制限](/ja/development/deploy/cloud-usage)で説明しており、実行可能な 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
```

## 認証

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` | [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">
    Python または TypeScript からワークフローを実行します。
  </Card>

  <Card title="使用量と制限" icon="gauge" href="/ja/development/deploy/cloud-usage">
    Cloud クレジット、同時実行数、既存の v1 統合を確認します。
  </Card>

  <Card title="クラウド 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>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.