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

# OpenAPI 仕様

> Comfy Cloud API の機械可読な OpenAPI 仕様

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

# Comfy Cloud API 仕様

このページでは、Comfy Cloud API の完全な OpenAPI 3.0 仕様を提供します。

<Note>
  **サブスクリプションが必要:** API を介してワークフローを実行するには、有効な Comfy Cloud サブスクリプションが必要です。詳細は [料金プラン](https://www.comfy.org/cloud/pricing?utm_source=docs\&utm_campaign=cloud-api) を参照してください。
</Note>

## 対話型 API リファレンス

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

<Card title="Cloud API リファレンス" icon="code" href="/ja/api-reference/cloud/overview">
  エンドポイントを閲覧し、スキーマを確認し、リクエストを試す
</Card>

## 仕様の使用

OpenAPI 仕様は以下の目的に使用できます:

* **クライアントライブラリの生成** - [OpenAPI Generator](https://openapi-generator.tech/) などのツールを使用して、任意の言語でクライアントライブラリを生成
* **API ツールへのインポート** - Postman、Insomnia、Paw などの API ツールへインポート
* **ドキュメントの生成** - Redoc や Swagger UI などのツールを使用してドキュメントを生成
* **リクエストの検証** - アプリケーション内でリクエストを検証

## ダウンロード

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

<Card title="openapi-cloud.yaml" icon="download" href="https://raw.githubusercontent.com/Comfy-Org/docs/main/openapi-cloud.yaml">
  OpenAPI 3.0 仕様をダウンロード
</Card>

## 認証

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

### API キーの取得

スクリーンショット付きの段階的な手順については、[Cloud API 概要](/development/cloud/overview#getting-an-api-key) を参照してください。

### API キーの使用

```yaml theme={null}
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 リファレンス](/development/cloud/api-reference#websocket-for-real-time-progress) を参照してください。