Skip to content

chore: sync Comfy API v2 specification and Comfy Router reference (cloud@18cb4d7) - #1540

Open
comfy-pr-bot wants to merge 1 commit into
mainfrom
chore/sync-comfy-api-v2-spec
Open

chore: sync Comfy API v2 specification and Comfy Router reference (cloud@18cb4d7)#1540
comfy-pr-bot wants to merge 1 commit into
mainfrom
chore/sync-comfy-api-v2-spec

Conversation

@comfy-pr-bot

@comfy-pr-bot comfy-pr-bot commented Aug 27, 2026

Copy link
Copy Markdown
Member

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@18cb4d7.

comfy-router-reference.mdx is GENERATED - edit the upstream
contract, not this copy. It is regenerated on every sync and an
edit made here is overwritten by the next one.

comfy-router-quickstart.mdx and comfy-router-limitations.mdx
are 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.

router-schemas/<provider>/<model>.json are the exact
GET /v2/models/{id}/openapi.json documents for every model with an
authored schema; the docs generator
(.github/scripts/snippets/gen-code-pages.ts) reads them. They are
GENERATED and the directory is MIRRORED on every sync, so a document
removed upstream is removed here too - edit the upstream contract,
not these copies.

This is the single rolling sync pull request for the published
Comfy API v2 specification and Comfy Router pages. It lives on
chore/sync-comfy-api-v2-spec, and every later upstream change
force-updates that branch and refreshes this description with the
new source commit — so there is only ever one open sync pull request
here, and its diff is always the current one. Please do not push
commits to this branch; the next sync would overwrite them (it
checks first and fails rather than doing so silently).

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.

@mintlify

mintlify Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
comfy 🟢 Ready View Preview Aug 27, 2026, 11:27 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@github-actions

Copy link
Copy Markdown

🌐 i18n translation sync reminder

@comfyui-wiki English documentation was updated in this PR. Please complete or schedule translation updates for the following files:

Japanese (ja)

  • ja/comfy-router-limitations.mdx
  • ja/comfy-router-quickstart.mdx
  • ja/comfy-router-reference.mdx
  • ja/comfy-router-limitations.mdx
  • ja/comfy-router-quickstart.mdx
  • ja/comfy-router-reference.mdx

Simplified Chinese (zh)

  • zh/comfy-router-limitations.mdx
  • zh/comfy-router-quickstart.mdx
  • zh/comfy-router-reference.mdx
  • zh/comfy-router-limitations.mdx
  • zh/comfy-router-quickstart.mdx
  • zh/comfy-router-reference.mdx

Korean (ko)

  • ko/comfy-router-limitations.mdx
  • ko/comfy-router-quickstart.mdx
  • ko/comfy-router-reference.mdx
  • ko/comfy-router-limitations.mdx
  • ko/comfy-router-quickstart.mdx
  • ko/comfy-router-reference.mdx

Local sync: npm run translate (see README — Automated translation)

@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from b954e34 to 12f3f39 Compare August 28, 2026 13:55
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@f2cb906) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@941d631) Aug 28, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 12f3f39 to 4eb7ccb Compare August 28, 2026 18:46
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@941d631) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@b04ca65) Aug 28, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 4eb7ccb to d9595e4 Compare August 28, 2026 20:19
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@b04ca65) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@2aaaf9b) Aug 28, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from d9595e4 to 652faf8 Compare August 28, 2026 21:02
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@2aaaf9b) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@2f46977) Aug 28, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 652faf8 to 60e6896 Compare August 28, 2026 22:19
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@2f46977) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@5b75ffc) Aug 28, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 60e6896 to e2afe80 Compare August 29, 2026 01:36
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@5b75ffc) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@6d95bf8) Aug 29, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from e2afe80 to e9bbb22 Compare August 29, 2026 02:20
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@6d95bf8) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@f7a536c) Aug 29, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from e9bbb22 to f1b5c73 Compare August 29, 2026 02:41
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@f7a536c) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@3775a61) Aug 29, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from f1b5c73 to 0912182 Compare August 29, 2026 03:33
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@3775a61) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@377e904) Aug 29, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 74f4f2f to a7e85ca Compare August 31, 2026 20:26
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from a7e85ca to 086715e Compare August 31, 2026 20:41
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@b7481bb) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@b0b3396) Aug 31, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 086715e to 5cd9f23 Compare September 1, 2026 01:46
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@b0b3396) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@1549b1b) Sep 1, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@1549b1b) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@c457916) Sep 1, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 5cd9f23 to f3bba05 Compare September 1, 2026 05:33
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from f3bba05 to 345cf83 Compare September 1, 2026 06:25
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@c457916) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@f9529c0) Sep 1, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 345cf83 to 3618a5e Compare September 1, 2026 07:15
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@f9529c0) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@d1b9259) Sep 1, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 3618a5e to 5ed2e41 Compare September 1, 2026 07:36
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@d1b9259) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@d8661dd) Sep 1, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 5ed2e41 to 1b2d4b4 Compare September 1, 2026 08:28
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@d8661dd) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@2841e6c) Sep 1, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from 1b2d4b4 to e4b42d1 Compare September 1, 2026 15:52
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@2841e6c) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@2e7d4e0) Sep 1, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-comfy-api-v2-spec branch from e4b42d1 to e116177 Compare September 1, 2026 16:12
@comfy-pr-bot comfy-pr-bot changed the title chore: sync Comfy API v2 specification and Comfy Router reference (cloud@2e7d4e0) chore: sync Comfy API v2 specification and Comfy Router reference (cloud@0499481) Sep 1, 2026
@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Important

Review skipped

Too many files!

This PR contains 120 files, which is 20 over the limit of 100.

To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch.

Upgrade to a paid plan to raise the limit.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 9de458f4-1f8e-491b-b5c4-4232a4daf4c3

📥 Commits

Reviewing files that changed from the base of the PR and between 98b8d7e and e116177.

📒 Files selected for processing (120)
  • comfy-router-limitations.mdx
  • comfy-router-quickstart.mdx
  • comfy-router-reference.mdx
  • openapi-v2.yaml
  • router-schemas/anthropic/claude-fable-5.json
  • router-schemas/anthropic/claude-haiku-4-5-20251001.json
  • router-schemas/anthropic/claude-opus-4-6.json
  • router-schemas/anthropic/claude-opus-4-7.json
  • router-schemas/anthropic/claude-opus-4-8.json
  • router-schemas/anthropic/claude-opus-5.json
  • router-schemas/anthropic/claude-sonnet-4-5-20250929.json
  • router-schemas/anthropic/claude-sonnet-4-6.json
  • router-schemas/anthropic/claude-sonnet-5.json
  • router-schemas/beeble/switchx.json
  • router-schemas/bfl/erase-v1.json
  • router-schemas/bfl/flux-2-max.json
  • router-schemas/bfl/flux-2-pro.json
  • router-schemas/bfl/flux-3-video.json
  • router-schemas/bfl/flux-kontext-max.json
  • router-schemas/bfl/flux-kontext-pro.json
  • router-schemas/bfl/flux-pro-1.0-canny.json
  • router-schemas/bfl/flux-pro-1.0-depth.json
  • router-schemas/bfl/flux-pro-1.0-expand.json
  • router-schemas/bfl/flux-pro-1.0-fill.json
  • router-schemas/bfl/flux-pro-1.1-ultra.json
  • router-schemas/bfl/flux-pro-1.1.json
  • router-schemas/bfl/video-upscale-v1.json
  • router-schemas/bfl/vto-v1.json
  • router-schemas/bria/fibo.json
  • router-schemas/bria/image-edit-erase.json
  • router-schemas/bria/image-edit-expand.json
  • router-schemas/bria/image-edit-gen-fill.json
  • router-schemas/bria/image-edit-remove-background.json
  • router-schemas/byteplus/dreamina-seedance-2-0-260128.json
  • router-schemas/byteplus/dreamina-seedance-2-0-fast-260128.json
  • router-schemas/byteplus/dreamina-seedance-2-0-mini.json
  • router-schemas/byteplus/dreamina-seedance-2-5-260628.json
  • router-schemas/byteplus/seedance-1-0-lite-i2v-250428.json
  • router-schemas/byteplus/seedance-1-0-lite-t2v-250428.json
  • router-schemas/byteplus/seedance-1-0-pro-250528.json
  • router-schemas/byteplus/seedance-1-0-pro-fast-251015.json
  • router-schemas/byteplus/seedance-1-5-pro-251215.json
  • router-schemas/byteplus/seededit-3-0-i2i-250628.json
  • router-schemas/byteplus/seedream-3-0-t2i-250415.json
  • router-schemas/byteplus/seedream-4-0-250828.json
  • router-schemas/byteplus/seedream-4-5-251128.json
  • router-schemas/byteplus/seedream-5-0-260128.json
  • router-schemas/byteplus/seedream-5-0-pro-260628.json
  • router-schemas/gemini-interactions/gemini-omni-1.1-flash.json
  • router-schemas/gemini-interactions/gemini-omni-flash-preview.json
  • router-schemas/ideogram/ideogram-v4.json
  • router-schemas/ltx/ltx-2-5-fast.json
  • router-schemas/ltx/ltx-2-5-pro.json
  • router-schemas/ltx/ltx-2-fast.json
  • router-schemas/ltx/ltx-2-pro.json
  • router-schemas/minimax/minimax-h3.json
  • router-schemas/openai/dall-e-2.json
  • router-schemas/openai/dall-e-3.json
  • router-schemas/openai/gpt-4.1-mini.json
  • router-schemas/openai/gpt-4.1-nano.json
  • router-schemas/openai/gpt-4.1.json
  • router-schemas/openai/gpt-4o.json
  • router-schemas/openai/gpt-5-mini.json
  • router-schemas/openai/gpt-5-nano.json
  • router-schemas/openai/gpt-5.5-pro.json
  • router-schemas/openai/gpt-5.5.json
  • router-schemas/openai/gpt-5.6-luna.json
  • router-schemas/openai/gpt-5.6-sol.json
  • router-schemas/openai/gpt-5.6-terra.json
  • router-schemas/openai/gpt-5.json
  • router-schemas/openai/gpt-image-1.5.json
  • router-schemas/openai/gpt-image-1.json
  • router-schemas/openai/gpt-image-2.json
  • router-schemas/openai/o1-pro.json
  • router-schemas/openai/o1.json
  • router-schemas/openai/o3.json
  • router-schemas/openai/o4-mini.json
  • router-schemas/recraft/recraftv2.json
  • router-schemas/recraft/recraftv3.json
  • router-schemas/recraft/recraftv4.json
  • router-schemas/recraft/recraftv4_1.json
  • router-schemas/recraft/recraftv4_1_pro.json
  • router-schemas/recraft/recraftv4_1_pro_vector.json
  • router-schemas/recraft/recraftv4_1_utility.json
  • router-schemas/recraft/recraftv4_1_utility_pro.json
  • router-schemas/recraft/recraftv4_1_utility_pro_vector.json
  • router-schemas/recraft/recraftv4_1_utility_vector.json
  • router-schemas/recraft/recraftv4_1_vector.json
  • router-schemas/recraft/recraftv4_pro.json
  • router-schemas/recraft/recraftv4_styles.json
  • router-schemas/recraft/recraftv4_styles_pro.json
  • router-schemas/recraft/recraftv4_styles_pro_vector.json
  • router-schemas/recraft/recraftv4_styles_vector.json
  • router-schemas/runway/aleph2.json
  • router-schemas/runway/gen3a_turbo.json
  • router-schemas/runway/gen4_image.json
  • router-schemas/runway/gen4_turbo.json
  • router-schemas/veo/veo-2.0-generate-001.json
  • router-schemas/veo/veo-3.0-fast-generate-001.json
  • router-schemas/veo/veo-3.0-generate-001.json
  • router-schemas/veo/veo-3.1-fast-generate-001.json
  • router-schemas/veo/veo-3.1-generate-001.json
  • router-schemas/veo/veo-3.1-lite-generate-001.json
  • router-schemas/vertexai/gemini-2.5-flash-image.json
  • router-schemas/vertexai/gemini-2.5-flash.json
  • router-schemas/vertexai/gemini-2.5-pro.json
  • router-schemas/vertexai/gemini-3-pro-image.json
  • router-schemas/vertexai/gemini-3.1-flash-image.json
  • router-schemas/vertexai/gemini-3.1-flash-lite-image.json
  • router-schemas/vertexai/gemini-3.1-flash-lite.json
  • router-schemas/vertexai/gemini-3.1-pro-preview.json
  • router-schemas/vertexai/gemini-3.5-flash.json
  • router-schemas/vertexai/gemini-3.7-flash.json
  • router-schemas/xai/grok-imagine-image-2.0.json
  • router-schemas/xai/grok-imagine-image-pro.json
  • router-schemas/xai/grok-imagine-image-quality.json
  • router-schemas/xai/grok-imagine-image.json
  • router-schemas/xai/grok-imagine-video-1.5-preview.json
  • router-schemas/xai/grok-imagine-video-1.5.json
  • router-schemas/xai/grok-imagine-video.json

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Review on demand using usage pricing

Comment @coderabbitai help to get the list of available commands.

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.

2 participants