docs(comfy-router): queued delivery preview page with a Nano Banana 2 example - #1648
Draft
mattmillerai wants to merge 1 commit into
Draft
mattmillerai wants to merge 1 commit into
mattmillerai wants to merge 1 commit into
Conversation
…Banana 2 example Adds development/comfy-router/queue.mdx documenting the queued delivery mode (submit, status, result, cancel) with copy-paste Python, TypeScript and cURL snippets against vertexai/gemini-3.1-flash-image, wires it into the Comfy Router nav, and points the limitations page's 'No queued submission' section at it. The page carries a gated-preview banner: a workspace that is not enabled receives 403 not_enabled.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueComment |
🌐 i18n translation sync reminder@comfyui-wiki English documentation was updated in this PR. Please complete or schedule translation updates for the following files: Japanese (
|
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
1 participant
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.
ELI-5
Comfy Router today makes you hold the phone line open until the picture is done. The queue lets you hang up, keep a ticket number, and come back for the picture later. This page shows exactly what that looks like in Python, TypeScript and cURL, using Nano Banana 2, so we can agree on the shape by reading real snippets in the preview before it goes live.
What this is
A new page,
development/comfy-router/queue, in the Comfy Router nav between "Using the Router API" and "Headers", plus a one-sentence pointer from the limitations page's "No queued submission" section.It documents the queued delivery mode as a gated preview:
POST /v2/models/{provider}/{model}/requestsreturns201withrequest_id,status,queue_positionand three URLs.GET .../requests/{request_id}/statusreturns the current state with aRetry-Afterhint.GET .../requests/{request_id}returns the model's native output once finished,202with the status body while not.PUT .../requests/{request_id}/cancelreturns202CANCELLATION_REQUESTEDor400ALREADY_COMPLETED.The Python snippets use
client.models.submit/subscribe/handle(the handle carriesstatus(),get(),cancel(),iter_events()). TypeScript is rawfetchbecause the SDK methods have not landed there yet. The page states plainly that a workspace outside the preview receives403 not_enabled.Why a draft
The routes are not live on
api.comfy.orgyet. This PR exists for the Mintlify preview so the copy-paste shape can be reviewed and agreed. The "Preview notes" section at the bottom names the two contract points still under review (cancel-after-complete as400vs409, and the status the result read gives a cancelled or timed-out request). It should stay a draft until the server answers these routes with403 not_enabledin production, at which point the banner is already correct.How this was tested
python3 .github/scripts/validate-links.py: all link validations passed.bun run code-pages:check: 198 code pages fresh,docs.jsonaccepted.