chore: sync Comfy API v2 specification and Comfy Router reference (cloud@2a369ae) - #1524
Closed
comfy-pr-bot wants to merge 1 commit into
Closed
chore: sync Comfy API v2 specification and Comfy Router reference (cloud@2a369ae)#1524comfy-pr-bot wants to merge 1 commit into
comfy-pr-bot wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
🌐 i18n translation sync reminder@comfyui-wiki English documentation was updated in this PR. Please complete or schedule translation updates for the following files: Japanese (
|
mattmillerai
added a commit
that referenced
this pull request
Aug 27, 2026
…the Router docs Bring the Comfy Router pages up to the latest comfy-pr-bot sync state so the superseded per-commit sync PRs (#1509 #1513 #1514 #1516 #1517 #1518 #1519 #1522 #1524) are all carried by this one branch. - reference.mdx: replaced verbatim with the generated file from cloud@2a369ae (GET /v1/models 403/503 rows, POST 429 committed-spend headers + 504 Retry-After, If-None-Match on the schema route, Retry-After and X-Committed-Spend-* header rows, deadline_exceeded retry guidance, no fal attributions, no planned queued endpoint). This drops the hand-edited "X-API-Key or Bearer" auth line: the file is generated upstream and must not carry local edits. - quickstart.mdx / limitations.mdx: 3-way merged the upstream changes onto this branch's edits (relocated links, cURL section, no em dashes): auth Note (comfyui- keys accepted in X-API-Key or Authorization: Bearer), new "Find a model" catalog section, new "Requests are rate limited per caller" section + at-a-glance row, queued-endpoint sentence removed, fal/FastAPI -> FastAPI. - ja/zh/ko: hand-translated the same deltas, un-glued the endpoint ### headings from the preceding table rows in reference.mdx (CodeRabbit finding), and re-stamped translationSourceHash/translationBlockHashes with the repo's chunked-translate helpers (getSectionSyncStatus reports up-to-date for all nine files). - openapi-v2.yaml already matched cloud@2a369ae; no change. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
comfyui-wiki
added a commit
that referenced
this pull request
Aug 28, 2026
…ting comfy-pr-bot sync PRs) (#1508) * docs: add Comfy Router API docs and register in navigation Adds the Comfy Router documentation set and the Comfy API v2 spec update that the comfy-pr-bot sync PRs have been carrying, consolidated into one branch: - comfy-router-quickstart.mdx: shortest path to a Router call (new) - comfy-router-reference.mdx: generated Router API reference (new) - comfy-router-limitations.mdx: Router limits and alternatives (new) - openapi-v2.yaml: job logs event + JobLogs schema (updated) - docs.json: register a Comfy Router group under API Development (en nav; zh/ja/ko left unregistered until translations exist) Source PRs (left open): #1483 #1487 #1488 #1489 #1490 #1492 #1497 #1500 #1505 Content taken from the latest state in #1505. * docs: move Comfy Router docs under api-reference/comfy-router Keep API documentation out of the repo root: move the three Router pages to api-reference/comfy-router/, update cross-page links and the docs.json nav paths accordingly. * docs: add cURL quickstart example, Router nav entry, and zh/ja/ko translations - quickstart: full cURL call example (aligns quickstart with the Python/TS/cURL split in BE-8327); the existing curl snippet only fetched a model schema - api-reference/v2/overview: short 'Comfy Router' pointer section so API v2 readers can discover the Router docs, translated to zh/ja/ko - translate comfy-router quickstart/reference/limitations to zh/ja/ko via translate-i18n.ts - docs.json: register Comfy Router group under API Development for all four locales (en/zh/ja/ko) * docs: fix anchor slugs in zh/ja/ko Router limitations translations * docs(router): address CodeRabbit review - em dashes, anchors, i18n, contract sync - Remove all em dashes from hand-written Router pages (EN) - quickstart: TypeScript COMFY_API_KEY fail-fast to match Python; fix response-handling comment (body parsed before response.ok check) - overview(v2): note Comfy Router is not yet generally available - ja/zh/ko: translate pending setup lines, limitations sections, reference auth sentence and new response rows - fixes broken heading/anchor merges in ja/zh/ko reference.mdx - ja/zh/ko limitations: fix anchor slugs + translate English sections - zh limitations: full-width quotation marks - reference.mdx: regenerate from cloud contract - X-API-Key auth + POST 401/429/500 responses (mirrors router-openapi.yaml) * docs(router): consolidate bot syncs #1509-#1524 (cloud@2a369ae) into the Router docs Bring the Comfy Router pages up to the latest comfy-pr-bot sync state so the superseded per-commit sync PRs (#1509 #1513 #1514 #1516 #1517 #1518 #1519 #1522 #1524) are all carried by this one branch. - reference.mdx: replaced verbatim with the generated file from cloud@2a369ae (GET /v1/models 403/503 rows, POST 429 committed-spend headers + 504 Retry-After, If-None-Match on the schema route, Retry-After and X-Committed-Spend-* header rows, deadline_exceeded retry guidance, no fal attributions, no planned queued endpoint). This drops the hand-edited "X-API-Key or Bearer" auth line: the file is generated upstream and must not carry local edits. - quickstart.mdx / limitations.mdx: 3-way merged the upstream changes onto this branch's edits (relocated links, cURL section, no em dashes): auth Note (comfyui- keys accepted in X-API-Key or Authorization: Bearer), new "Find a model" catalog section, new "Requests are rate limited per caller" section + at-a-glance row, queued-endpoint sentence removed, fal/FastAPI -> FastAPI. - ja/zh/ko: hand-translated the same deltas, un-glued the endpoint ### headings from the preceding table rows in reference.mdx (CodeRabbit finding), and re-stamped translationSourceHash/translationBlockHashes with the repo's chunked-translate helpers (getSectionSyncStatus reports up-to-date for all nine files). - openapi-v2.yaml already matched cloud@2a369ae; no change. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Matt Miller <mattmiller@comfy.org> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
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
2 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.
Automated sync of the public Comfy API v2 specification used by
the generated API reference, and of the Comfy Router API
reference generated from the Comfy API contract. Source:
cloud@2a369ae.comfy-router-reference.mdxis GENERATED - edit the upstreamcontract, not this copy. It is regenerated on every sync and an
edit made here is overwritten by the next one.
comfy-router-quickstart.mdxandcomfy-router-limitations.mdxare hand-written upstream and published verbatim. They are likewise
overwritten on every sync, so edit them upstream. If this is the
first sync that carries one of them, it also needs a navigation
entry in this repository before it renders.
This pull request is on its own per-source-commit branch
(
chore/sync-comfy-api-v2-spec-2a369ae).A later spec change opens a separate pull request and will not
rewrite this branch.
The projection strips internal operations and non-public source
annotations, and fails before this pull request can be created if
a known internal marker survives. This pull request is never
auto-merged and requires human review.