Skip to content

feat: rename Cloud & Partner APIs group to ComfyUI APIs, add Server API overview and quick start#1084

Closed
lin-bot23 wants to merge 20 commits into
Comfy-Org:mainfrom
lin-bot23:apis/rename-group-to-comfyui-apis
Closed

feat: rename Cloud & Partner APIs group to ComfyUI APIs, add Server API overview and quick start#1084
lin-bot23 wants to merge 20 commits into
Comfy-Org:mainfrom
lin-bot23:apis/rename-group-to-comfyui-apis

Conversation

@lin-bot23
Copy link
Copy Markdown
Contributor

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)

  • Renamed: "Cloud & Partner APIs" → "ComfyUI APIs"
  • Added: "ComfyUI Server API" group with 6 pages (server-guide, quick-start, and 4 existing server pages)
  • Removed: Redundant "ComfyUI Server" group from the Development tab (merged into APIs)
  • Reordered: Overview and Getting an API Key come first, Cloud API and Server API are parallel groups

New Files (EN/ZH/JA)

Page Description
development/apis/overview.mdx API comparison table (Cloud API vs ComfyUI Server API) with navigation cards
development/comfyui-server/server-guide.mdx Entry point explaining how to start ComfyUI as a server
development/comfyui-server/quick-start.mdx Three code patterns: HTTP only, WebSocket + History, SaveImageWebSocket

Existing Files Modified

  • development/overview.mdx — Updated references from old comms_overview to new server-guide, added link to APIs overview

Quick Start Content

The quick-start page demonstrates three patterns based on the official script_examples:

  1. HTTP Only — fire-and-forget submission (basic_api_example.py)
  2. WebSocket + History — wait for completion, download via /history (websockets_api_example.py)
  3. SaveImageWebsocket — real-time image delivery via binary frames (websockets_api_example_ws_images.py)

All examples use Python to match the original repo scripts, with notes pointing to the Cloud API Reference for TypeScript/curl equivalents.

…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 lin-bot23 force-pushed the apis/rename-group-to-comfyui-apis branch from ad41d8f to 967845d Compare June 2, 2026 18:09
comfyui-wiki and others added 19 commits June 3, 2026 02:15
- 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
@manuelsherbin82-rgb
Copy link
Copy Markdown

WhatsApp number hack

@manuelsherbin82-rgb
Copy link
Copy Markdown

WhatsApp hack app

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants