feat: rename Cloud & Partner APIs group to ComfyUI APIs, add Server API overview and quick start#3
Open
lin-bot23 wants to merge 115 commits into
Open
feat: rename Cloud & Partner APIs group to ComfyUI APIs, add Server API overview and quick start#3lin-bot23 wants to merge 115 commits into
lin-bot23 wants to merge 115 commits into
Conversation
* Add HappyHorse 1.0 pricing under WAN Generated-By: mintlify-agent * Move HappyHorse 1.0 to its own section Generated-By: mintlify-agent --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
* Add/update changelog/index.mdx * Add/update zh-CN/changelog/index.mdx * Fix zh changelog path for v0.20.0 Made-with: Cursor * docs(ja): add changelog v0.20.0 Made-with: Cursor --------- Co-authored-by: ComfyUI Wiki <contact@comfyui-wiki.com>
* Add/update changelog/index.mdx * Add/update zh-CN/changelog/index.mdx * Fix i18n changelog paths for v0.20.1 Made-with: Cursor --------- Co-authored-by: ComfyUI Wiki <contact@comfyui-wiki.com>
* docs: add HappyHorse 1.0 partner node page (en/zh/ja) * docs: add HappyHorse 1.0 partner node page (en/zh/ja) * chore: remove accidentally committed .pr-body.md * docs: add example output videos to HappyHorse 1.0 page --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
* docs: add OpenAI GPT-Image-2 partner node tutorial * docs: add GPT-Image-2 workflow links (T2I and image edit) * Remove FAQ section from GPT-Image-2 pages (EN, ZH, JA) Made-with: Cursor * Add example images to GPT-Image-2 pages (EN, ZH, JA) Made-with: Cursor * Remove .pr-body.md Made-with: Cursor --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: ComfyUI Wiki <contact@comfyui-wiki.com>
…ges (Comfy-Org#950) * Remove ComfyUI Manager installation section from the first generation guide. * Update images for loading workflows and model installation steps. * Add detailed instructions for finding the models folder in both desktop and portable versions. * Revise model download warnings to improve clarity and guidance. * Ensure consistency in image references across English, Japanese, and Chinese versions.
…on guide in Japanese and Chinese versions
* docs: clarify first generation guide is for local users and add cloud card * docs: update Comfy Cloud card link Point the Comfy Cloud intro card to the cloud template URL and add utm_source=docs. Made-with: Cursor --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: ComfyUI Wiki <contact@comfyui-wiki.com>
…rg#953) * chore: revert theme to default and re-enable light/dark toggle * Update theme --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: ComfyUI Wiki <contact@comfyui-wiki.com>
…fy-Org#954) * docs: add Virtual Portrait vs Real Human section to Seedance 2.0 * docs: reword real human section as Q&A with full verification steps * docs: remove Virtual Portrait vs Real Human section and update related workflows in Seedance 2.0 documentation --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: ComfyUI Wiki <contact@comfyui-wiki.com>
…ty (Comfy-Org#955) Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
- EN: 1.688 credits/frame (1080p), 2.813 credits/frame (4K) - ZH: same values in Chinese - JA: same values in Japanese Co-authored-by: linmoumou <linmoumou@linmoumoudeMac-mini.local>
Co-authored-by: linmoumou <linmoumou@linmoumoudeMac-mini.local>
…omfy-Org#974) The GPU Hours Product credit column incorrectly used '/ run' as the unit. This product is billed per GPU-second, so the unit is corrected to '/ sec' (English), '/ 秒' (Chinese), and '/ 秒' (Japanese). Co-authored-by: linmoumou <linmoumou@linmoumoudeMac-mini.local>
Co-authored-by: 너이름 <너이메일>
… clip2 (Comfy-Org#979) The ratio parameter works the same as ModelMergeSimple's ratio — when ratio=1.0 the output is 100% clip1, and when ratio=0.0 the output is 100% clip2. The docs previously described it backwards. Fixes Comfy-Org#918 Co-authored-by: linmoumou <linmoumou@linmoumoudeMac-mini.local>
* docs: add Tripo H3.1 dedicated page (en/zh/ja) * Rewrite Tripo H3.1 docs in documentation style (en/zh/ja) Replaced the blog-style tone with a more concise documentation format: removed promotional language, trimmed verbose section intros, simplified headings, and tightened descriptions. No content changes — same information, cleaner presentation. * Add workflow Cloud/download cards for Tripo H3.1 (en/zh/ja) Each of the three workflows (text-to-model, image-to-model, multiview-to-model) now has a CardGroup with a Cloud link and a source download link, following the same pattern as other partner node docs (e.g. Seedance 2.0, Luma UNI-1). * Fix syntax error in import line: removed errant slash * Remove How It Works/Getting Started sections, use ## Available Workflows for cards * Preview 3D → Save 3D in Preview and Export section * Remove Pricing and Preview & Export sections * Rename Tripo H3.1 → Tripo 3.1 and update filenames + docs.json --------- Co-authored-by: linmoumou <linmoumou@linmoumoudeMac-mini.local>
* Clarify Cloud API tier availability (Creator/Pro only) Surface that the Cloud API is gated to Creator and Pro subscription tiers, and that API requests consume the same monthly credits as UI usage. Updates the en/ja/zh cloud overview docs and the api-reference overview note. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * Drop redundant Credits and Usage table in cloud API overview The introduced table used checkmark glyphs that don't match any other table in the cloud docs (which use plain text or numbers). The prose already conveys the same information, so the table was redundant. Mirrored in ja/zh. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
* docs: add Topaz Astra 2 model reference page * refactor: move Astra 2 doc under partner-nodes/topaz * docs: trim astra-2 partner node page to overview only * Remove .pr-body.md * docs(topaz): flesh out Astra 2 overview and add workflow cards (EN/JA/ZH) Co-authored-by: Cursor <cursoragent@cursor.com> * docs(topaz): add beginner intro for Astra 2; drop built-in node links Co-authored-by: Cursor <cursoragent@cursor.com> * docs(topaz): update Astra 2 documentation with clearer descriptions and usage instructions across English, Japanese, and Chinese versions --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: ComfyUI Wiki <contact@comfyui-wiki.com> Co-authored-by: Cursor <cursoragent@cursor.com>
* docs: add Luma Uni-1 guide (EN/ZH/JA) * docs: update Luma Uni-1 guide for ComfyUI integration Revised descriptions to clarify the use of Luma Uni-1 partner nodes in ComfyUI for image creation and editing workflows. Enhanced focus on practical usage, including node connections and workflow options, while removing outdated sections. Updated content in English, Japanese, and Chinese for consistency across languages. --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: ComfyUI Wiki <contact@comfyui-wiki.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: lin-bot23 <lin-bot23@users.noreply.github.com>
…omfy-Org#1059) * docs(cloud-mcp): reflect partner_generate workflow path and OAuth auth Update EN/ZH/JA Comfy Cloud MCP docs for v0.11.x behavior: partner_generate defaults to library workflow runs with automatic proxy fallback, OAuth bearer support alongside API keys, and run_saved_workflow/save_workflow improvements. * docs(cloud-mcp): add OAuth sign-in path and prod rollout caveat Quick Start now explains Authenticate vs API key and warns that OAuth may not work end-to-end until the next cloud prod deploy.
…Comfy-Org#1066) The Can credits go negative? FAQ in credits.mdx had incorrect wording that only said no. Replaced with the accurate explanation from partner-nodes FAQ snippet, covering race conditions, temporary negative balance, and the need to top up before running Partner Nodes. Synced EN/ZH/JA. Co-authored-by: lin-bot23 <lin-bot23@users.noreply.github.com>
* Add PixelDiT text-to-image tutorial (EN/ZH/JA) * Remove Cloud links from PixelDiT tutorial (NSCLv1 license, non-commercial) --------- Co-authored-by: lin-bot23 <lin-bot23@users.noreply.github.com>
Co-authored-by: lin-bot23 <lin-bot23@users.noreply.github.com>
Co-authored-by: lin-bot23 <lin-bot23@users.noreply.github.com>
…1079) * Add Flux Erase and Flux Virtual Try-On pricing to pricing page (EN/ZH/JA) * Simplify BFL pricing table: remove redundant Product Name column, keep model names only --------- Co-authored-by: lin-bot23 <lin-bot23@users.noreply.github.com>
…omfy-Org#1083) Add the API Reference overview page to the Registry section of the sidebar, positioned after 'registry/specifications' in all three language navs. Co-authored-by: lin-bot23 <lin-bot23@users.noreply.github.com>
Comfy-Org#1081) * Update API key references across documentation to link to the "Getting an API Key" guide. This includes updates in the API reference, MCP server, OpenAPI, and various localized versions (EN, ZH, JA) to enhance clarity and accessibility for users seeking API key information. * Update API key references in documentation to improve clarity and accessibility. Changes include specifying the generation of API keys at platform.comfy.org, removing redundant links, and enhancing instructions across various sections and localized versions (EN, ZH, JA).
…PI overview and quick start - Rename side navigation group 'Cloud & Partner APIs' → 'ComfyUI APIs' - Remove redundant 'ComfyUI Server' group from Development tab (merged into APIs) - Add new development/apis/overview.mdx with API comparison table (EN/ZH/JA) - Add new development/comfyui-server/server-guide.mdx as entry point (EN/ZH/JA) - Add new development/comfyui-server/quick-start.mdx with 3 code patterns (EN/ZH/JA) - HTTP only (basic_api_example) - WebSocket + History (websockets_api_example) - SaveImageWebsocket real-time images (websockets_api_example_ws_images) - Update development/overview.mdx references and links - Update docs.json for all 3 languages
lin-bot23
force-pushed
the
apis/rename-group-to-comfyui-apis
branch
from
ad41d8f to
967845d
Compare
- Merge server startup guide and navigation cards into comms_overview - Rename comms_overview title to 'Server Overview' with full entry content - Delete server-guide.mdx (EN/ZH/JA) - Reorder sidebar: Overview → Routes → API Examples → Messages → Inversion - Update links in api-development/overview
…entralized getting-an-api-key page
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames the side navigation group from "Cloud & Partner APIs" to "ComfyUI APIs" and adds a new ComfyUI Server API section with both an overview page and a quick-start guide.
Changes
Navigation (docs.json, all 3 languages)
New Files (EN/ZH/JA)
development/apis/overview.mdxdevelopment/comfyui-server/server-guide.mdxdevelopment/comfyui-server/quick-start.mdxExisting Files Modified
development/overview.mdx— Updated references from oldcomms_overviewto newserver-guide, added link to APIs overviewQuick Start Content
The quick-start page demonstrates three patterns based on the official script_examples:
basic_api_example.py)websockets_api_example.py)websockets_api_example_ws_images.py)All examples are Python-focused (matching the original repo scripts), with notes pointing to the existing Cloud API Reference for TypeScript/curl equivalents.