Skip to content

docs: improve ComfyAPI search discovery #1699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
stale2000 wants to merge 1 commit into from
Closed

docs: improve ComfyAPI search discovery #1699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions api-reference/v2/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Comfy API v2 Overview"
sidebarTitle: "Overview"
description: "Reference for the official Comfy API v2: run ComfyUI workflows from external applications by uploading inputs, submitting jobs, and polling for results."
keywords: ["ComfyAPI", "Comfy API"]
---

<Warning>
Expand All @@ -27,7 +28,7 @@
comfy-api-proxy
```

By default it proxies the ComfyUI on `127.0.0.1:8188` and serves the v2 API on `127.0.0.1:8189`, binding to loopback only. Authentication is off by default, with an optional static bearer token. The proxy is a stopgap: once v2 stabilizes it moves into ComfyUI core and the proxy is no longer needed. See [Your own ComfyUI](/development/api-development/sdks#your-own-comfyui) in the SDK guide for configuration details.

Check warning on line 31 in api-reference/v2/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

api-reference/v2/overview.mdx#L31 

Did you really mean 'loopback'?

## Design Principles

Expand All @@ -51,7 +52,7 @@
| Category | Description |
|----------|-------------|
| Assets | UUID-identified records over content-addressed blobs. Upload inputs, download outputs. |
| Jobs | One execution of a workflow. Durable, pollable, and cancelable. |

Check warning on line 55 in api-reference/v2/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (dripart) - vale-spellcheck

api-reference/v2/overview.mdx#L55 

Did you really mean 'pollable'?

## Comfy Router

Expand Down
Loading