Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api-reference/cloud/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: "Cloud API Overview"
The Comfy Cloud API provides programmatic access to run workflows on Comfy Cloud infrastructure.

<Note>
**Subscription Required:** Running workflows via the API requires an active Comfy Cloud subscription. See [pricing plans](https://www.comfy.org/cloud/pricing?utm_source=docs) for details.
**Creator or Pro subscription required:** API access is only available on the **Creator** and **Pro** tiers. The Free and Standard tiers do not include API access. See [pricing plans](https://www.comfy.org/cloud/pricing?utm_source=docs) for details.
</Note>

## Getting Started
Expand Down
8 changes: 5 additions & 3 deletions development/cloud/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@
The Comfy Cloud API provides programmatic access to run workflows on Comfy Cloud infrastructure. The API is compatible with local ComfyUI's API, making it easy to migrate existing integrations.

<Note>
**Subscription Required:** Running workflows via the API requires an active Comfy Cloud subscription. See [pricing plans](https://www.comfy.org/cloud/pricing?utm_source=docs&utm_campaign=cloud-api) for details.
**Creator or Pro subscription required:** API access is only available on the **Creator** and **Pro** tiers. The Free and Standard tiers do not include API access. See [pricing plans](https://www.comfy.org/cloud/pricing?utm_source=docs&utm_campaign=cloud-api) for details.
</Note>

## Credits and Usage

API requests draw from the same monthly credit allocation as the Comfy Cloud web UI — there is no separate API credit pool. Each tier's included credits, top-up options, and per-workflow runtime caps apply to API jobs in exactly the same way as UI jobs. See the [pricing page](https://www.comfy.org/cloud/pricing?utm_source=docs&utm_campaign=cloud-api) for the monthly credit amounts on the Creator and Pro tiers. If you run out of credits mid-month, top-ups can be purchased from your account dashboard.

## Base URL

```
Expand Down Expand Up @@ -76,7 +80,7 @@

### Workflows

ComfyUI workflows are JSON objects describing a graph of nodes. The API accepts workflows in the "API format" (node IDs as keys with class_type, inputs, etc.) as produced by the ComfyUI frontend's "Save (API Format)" option.

Check warning on line 83 in development/cloud/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/overview.mdx#L83

Did you really mean 'class_type'?

Check warning on line 83 in development/cloud/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/overview.mdx#L83

Did you really mean 'frontend's'?

### Jobs

Expand All @@ -92,8 +96,6 @@

| Subscription Tier | Concurrent Jobs |
|-------------------|-----------------|
| Free | 1 |
| Standard | 1 |
| Creator | 3 |
| Pro | 5 |

Expand All @@ -116,7 +118,7 @@
API_KEY = os.environ["COMFY_CLOUD_API_KEY"]

async def submit_workflow(session, workflow):
"""Submit a single workflow and return the prompt_id."""

Check warning on line 121 in development/cloud/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/overview.mdx#L121

Did you really mean 'prompt_id'?
async with session.post(
f"{BASE_URL}/api/prompt",
headers={"X-API-Key": API_KEY, "Content-Type": "application/json"},
Expand All @@ -127,7 +129,7 @@

async def main():
with open("workflow_api.json") as f:
base_workflow = json.load(f)

Check warning on line 132 in development/cloud/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

development/cloud/overview.mdx#L132

Did you really mean 'base_workflow'?

# Create variations by changing the seed
workflows = []
Expand Down
8 changes: 5 additions & 3 deletions ja/development/cloud/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,13 @@
Comfy Cloud API は、Comfy Cloud インフラストラクチャ上でワークフローを実行するためのプログラムによるアクセスを提供します。この API はローカルの ComfyUI の API と互換性があり、既存の統合を簡単に移行できます。

<Note>
**サブスクリプションが必要:** API を介してワークフローを実行するには、有効な Comfy Cloud サブスクリプションが必要です。詳細は[料金プラン](https://www.comfy.org/cloud/pricing?utm_source=docs&utm_campaign=cloud-api)をご覧ください。
**Creator または Pro サブスクリプションが必要:** API へのアクセスは **Creator** および **Pro** ティアでのみ利用可能です。Free および Standard ティアには API アクセスは含まれません。詳細は[料金プラン](https://www.comfy.org/cloud/pricing?utm_source=docs&utm_campaign=cloud-api)をご覧ください。
</Note>

## クレジットと使用量

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

## ベース URL

```
Expand Down Expand Up @@ -94,8 +98,6 @@

| サブスクリプションティア | 同時ジョブ数 |
|-------------------|-----------------|
| Free | 1 |
| Standard | 1 |
| Creator | 3 |
| Pro | 5 |

Expand Down Expand Up @@ -129,7 +131,7 @@

async def main():
with open("workflow_api.json") as f:
base_workflow = json.load(f)

Check warning on line 134 in ja/development/cloud/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

ja/development/cloud/overview.mdx#L134

Did you really mean 'base_workflow'?

# シードを変更してバリエーションを作成
workflows = []
Expand Down
8 changes: 5 additions & 3 deletions zh/development/cloud/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@
Comfy Cloud API 提供以编程方式访问 Comfy Cloud 的能力,可在云端基础设施上运行工作流。该 API 与本地 ComfyUI 的 API 兼容,便于迁移现有集成。

<Note>
**需要订阅:** 通过 API 运行工作流需要有效的 Comfy Cloud 订阅。详情请参阅[定价方案](https://www.comfy.org/cloud/pricing?utm_source=docs&utm_campaign=cloud-api)。
**需要 Creator 或 Pro 订阅:** API 访问权限仅在 **Creator** 和 **Pro** 等级提供。Free 和 Standard 等级不包含 API 访问权限。详情请参阅[定价方案](https://www.comfy.org/cloud/pricing?utm_source=docs&utm_campaign=cloud-api)。
</Note>

## 积分与用量

API 请求消耗的是与 Comfy Cloud 网页端相同的每月积分配额——不存在单独的 API 积分池。每个等级的包含积分、加购选项以及单次工作流运行时长上限对 API 任务和网页端任务完全相同。Creator 和 Pro 等级的每月积分数量请参阅[定价方案](https://www.comfy.org/cloud/pricing?utm_source=docs&utm_campaign=cloud-api)。如果在月中用尽积分,可在账户面板中购买加购包。

## 基础 URL

```
Expand Down Expand Up @@ -92,8 +96,6 @@

| 订阅等级 | 并发任务数 |
|----------|-----------|
| Free | 1 |
| Standard | 1 |
| Creator | 3 |
| Pro | 5 |

Expand Down Expand Up @@ -127,7 +129,7 @@

async def main():
with open("workflow_api.json") as f:
base_workflow = json.load(f)

Check warning on line 132 in zh/development/cloud/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

zh/development/cloud/overview.mdx#L132

Did you really mean 'base_workflow'?

# 通过更改种子创建变体
workflows = []
Expand Down
Loading