> ## Documentation Index > Fetch the complete documentation index at: https://docs.comfy.org/llms.txt > Use this file to discover all available pages before exploring further. # Ask for one submitted request to be cancelled. > Asks Comfy to stop a request that has not finished. It is a request, not a guarantee, and the `202` says exactly that: `CANCELLATION_REQUESTED` means the ask was accepted, not that the run has stopped. A run already on the wire at a partner may complete anyway - and a partner generation that completes is charged, whether or not anyone collected it - so a caller who needs to know what actually happened reads the status endpoint afterwards, where a cancellation that took effect is `COMPLETED` carrying an `error_type` like every other terminal outcome. `PUT` rather than `POST`, and a sub-resource rather than a verb on the request itself: the ask is idempotent. Cancelling twice is the same ask, and the second one is answered exactly like the first while the run is still cancellable, so a client's retry needs no special case. THE ASK HAS THREE OUTCOMES and the status code carries all three, so a client may branch on the status alone: `202` for `CANCELLATION_REQUESTED`, the ask accepted for a request that had not yet finished; `409` for `ALREADY_COMPLETED`, a request that had already reached a terminal state - success, failure or an earlier cancellation; and `404` for an id that names no request of the caller's under this model. "Branch on the status alone" is a promise this route keeps rather than a simplification, which is why `ALREADY_COMPLETED` is `409` and not `400`. A cancel carrying a malformed or duplicated `Idempotency-Key` is refused `400 invalid_input` by `RouterIdempotencyMiddleware` in the Router error envelope, so a `400` that also meant `ALREADY_COMPLETED` would put two incompatible bodies behind one status and break exactly the branch this paragraph invites. Every status on this route now maps to one body shape. The first two are ALSO named in the body, as a `RouterQueueCancelStatus`. It is a closed `enum` and not one of the coarse `RouterErrorType` buckets, because it is not the same kind of thing: `RouterErrorType` classifies why a CALL failed, whereas these name what CANCELLING found, and it has no member meaning "already finished". THE `404` IS THE EXCEPTION AND IT IS DELIBERATE: it answers in the shared Router request-level error body, like every other `404` on this surface, because the status carries two conditions here rather than one. A `{provider}/{model}` that resolves to no partner model is `model_not_found` on this route exactly as on the others, and a cancel-shaped body would swallow it - telling a caller who mistyped the MODEL that their REQUEST does not exist, without the fuzzy suggestions that would have corrected them. So `RouterQueueCancelStatus` carries no `NOT_FOUND` member; the status code is where that outcome is read. This operation is deliberately tagged `Comfy Router` and NOT `API Nodes`, for the reason given on the synchronous route. ## OpenAPI ````yaml https://api.comfy.org/openapi put /v2/models/{provider}/{model}/requests/{request_id}/cancel openapi: 3.0.2 info: title: Comfy API version: '1.0' servers: - url: https://api.comfy.org security: [] tags: - description: Comfy Router's canonical, model-ID-addressed routes. name: Comfy Router - description: >- Signed-in users running Comfy-owned serverless apps with free runs and flat or per-second pricing (FE-2737). name: App Proxy paths: /v2/models/{provider}/{model}/requests/{request_id}/cancel: put: tags: - Comfy Router summary: Ask for one submitted request to be cancelled. description: >- Asks Comfy to stop a request that has not finished. It is a request, not a guarantee, and the `202` says exactly that: `CANCELLATION_REQUESTED` means the ask was accepted, not that the run has stopped. A run already on the wire at a partner may complete anyway - and a partner generation that completes is charged, whether or not anyone collected it - so a caller who needs to know what actually happened reads the status endpoint afterwards, where a cancellation that took effect is `COMPLETED` carrying an `error_type` like every other terminal outcome. `PUT` rather than `POST`, and a sub-resource rather than a verb on the request itself: the ask is idempotent. Cancelling twice is the same ask, and the second one is answered exactly like the first while the run is still cancellable, so a client's retry needs no special case. THE ASK HAS THREE OUTCOMES and the status code carries all three, so a client may branch on the status alone: `202` for `CANCELLATION_REQUESTED`, the ask accepted for a request that had not yet finished; `409` for `ALREADY_COMPLETED`, a request that had already reached a terminal state - success, failure or an earlier cancellation; and `404` for an id that names no request of the caller's under this model. "Branch on the status alone" is a promise this route keeps rather than a simplification, which is why `ALREADY_COMPLETED` is `409` and not `400`. A cancel carrying a malformed or duplicated `Idempotency-Key` is refused `400 invalid_input` by `RouterIdempotencyMiddleware` in the Router error envelope, so a `400` that also meant `ALREADY_COMPLETED` would put two incompatible bodies behind one status and break exactly the branch this paragraph invites. Every status on this route now maps to one body shape. The first two are ALSO named in the body, as a `RouterQueueCancelStatus`. It is a closed `enum` and not one of the coarse `RouterErrorType` buckets, because it is not the same kind of thing: `RouterErrorType` classifies why a CALL failed, whereas these name what CANCELLING found, and it has no member meaning "already finished". THE `404` IS THE EXCEPTION AND IT IS DELIBERATE: it answers in the shared Router request-level error body, like every other `404` on this surface, because the status carries two conditions here rather than one. A `{provider}/{model}` that resolves to no partner model is `model_not_found` on this route exactly as on the others, and a cancel-shaped body would swallow it - telling a caller who mistyped the MODEL that their REQUEST does not exist, without the fuzzy suggestions that would have corrected them. So `RouterQueueCancelStatus` carries no `NOT_FOUND` member; the status code is where that outcome is read. This operation is deliberately tagged `Comfy Router` and NOT `API Nodes`, for the reason given on the synchronous route. operationId: CancelRouterModelRequest parameters: - $ref: '#/components/parameters/RouterProvider' - $ref: '#/components/parameters/RouterModel' - $ref: '#/components/parameters/RouterQueueRequestId' responses: '202': content: application/json: schema: $ref: '#/components/schemas/RouterQueueCancelResponse' description: >- Accepted - `CANCELLATION_REQUESTED`. The ask was accepted for a request that had not yet reached a terminal state. It is not a statement that the run has stopped; read the status endpoint to learn what it did. headers: X-Comfy-Request-Id: $ref: '#/components/headers/RouterRequestIdHeader' '400': $ref: '#/components/responses/RouterRequestError' '401': $ref: '#/components/responses/RouterRequestError' '403': $ref: '#/components/responses/RouterRequestError' '404': $ref: '#/components/responses/RouterRequestError' '409': content: application/json: schema: $ref: '#/components/schemas/RouterQueueCancelResponse' description: >- Conflict - `ALREADY_COMPLETED`. The request had already reached a terminal state, so there was nothing to cancel. It is terminal for the ask: retrying it will return the same answer. Whether that terminal state was a success, a failure or an earlier cancellation is not carried here - the status endpoint answers that. This outcome is `409` and NOT `400`, because `400` on this route already means something else and cannot mean both. `RouterIdempotencyMiddleware` filters on POST/PUT/PATCH, so a cancel carrying a malformed or duplicated `Idempotency-Key` is answered `400 invalid_input` in the Router error envelope - `{detail, error_type}`, with no `request_id` and no `status`. A client told it "may branch on the status alone" would read that body as a `RouterQueueCancelResponse` and find neither field. Giving each body its own status restores that promise rather than qualifying it, and `409` is what the condition actually is: the request is in a state that conflicts with the operation. `409` is also what a queued request's own `cancelled` bucket answers on the result read, so one status means one thing across this contract. headers: X-Comfy-Request-Id: $ref: '#/components/headers/RouterRequestIdHeader' '503': $ref: '#/components/responses/RouterRequestError' default: $ref: '#/components/responses/RouterRequestError' security: - BearerAuth: [] - ApiKeyAuth: [] components: parameters: RouterProvider: description: >- Lowercase provider segment of the canonical `{provider}/{model}` model ID - the partner whose model is being run. The schema is `RouterProviderSegment`, the SAME component a catalog entry's `provider` field references, so an ID `GET /v2/models` lists cannot drift from the ids this route accepts. Its `pattern` is a CONTRACT statement, not enforcement: comfy-api installs no OpenAPI request validator and oapi-codegen binds path parameters as plain strings, so the handler must re-validate this segment itself before using it to select a provider or compose an upstream URL. in: path name: provider required: true schema: $ref: '#/components/schemas/RouterProviderSegment' RouterModel: description: >- Lowercase model segment of the canonical `{provider}/{model}` model ID - the model to run within that provider. As with `provider`, the schema is the shared `RouterModelSegment` component and its `pattern` documents the contract rather than enforcing it - see `RouterProvider`. in: path name: model required: true schema: $ref: '#/components/schemas/RouterModelSegment' RouterQueueRequestId: description: >- The queued request to address - the `request_id` the submission returned in its body. It is not the submission's `X-Comfy-Request-Id`: that header carries the id of one HTTP call and addresses nothing, as the `RouterQueueRequestId` schema spells out. It is scoped to the caller and to the `{provider}/{model}` in the same URL. An id that is real but was submitted to a different model is a `404` on every read here, not a redirect and not a silent success on the row the id names: the path parameters are redundant with the queued row, and this contract resolves that redundancy strictly so that one id has exactly one address. As with `provider` and `model`, the `format` documents the contract rather than enforcing it - comfy-api installs no OpenAPI request validator and oapi-codegen binds path parameters as plain strings, so a handler must re-validate this segment itself before using it to look a request up. in: path name: request_id required: true schema: $ref: '#/components/schemas/RouterQueueRequestId' schemas: RouterQueueCancelResponse: description: >- The answer to a cancellation ask on the two statuses that describe a request this route resolved - the `202` and the `400`. One body shape across both rather than a success envelope plus an error envelope, because both are the same statement - what cancelling found - and a client that has to parse a different type per status code gains nothing from the split. The `404` is NOT this shape. It answers in the shared Router request-level error body, because it also carries the `model_not_found` miss every route on this surface shares; see `RouterQueueCancelStatus` for why that outcome is read off the status code rather than off this body. properties: request_id: $ref: '#/components/schemas/RouterQueueRequestId' status: $ref: '#/components/schemas/RouterQueueCancelStatus' required: - request_id - status type: object RouterProviderSegment: description: >- Lowercase `provider` segment of the canonical `{provider}/{model}` model ID - the partner whose model is being addressed. The invocation route's `provider` path parameter and a catalog entry's `provider` field both reference this one schema, which is what keeps the listed IDs and the accepted IDs from drifting apart. The `pattern` is a CONTRACT statement, not enforcement: comfy-api installs no OpenAPI request validator and oapi-codegen binds path parameters as plain strings, so a handler must re-validate the segment itself before using it to select a provider or compose an upstream URL. The alphabet deliberately admits no `/`, no percent-encoding, and no repeated separator, so no accepted value can contain a `.` or `..` path segment. example: bfl maxLength: 64 pattern: ^[a-z0-9]+([._-][a-z0-9]+)*$ type: string RouterModelSegment: description: >- Lowercase `model` segment of the canonical `{provider}/{model}` model ID - the model to run within that provider. Shared by the invocation route's `model` path parameter and a catalog entry's `model` field, for the same no-drift reason as `RouterProviderSegment`. As with the provider segment, the `pattern` documents the contract and does not enforce it. Dots are permitted inside the segment because partner model IDs use them for versions (`flux-pro-1.1`), but a repeated separator is not, so `..` cannot appear. example: flux-2-pro maxLength: 128 pattern: ^[a-z0-9]+([._-][a-z0-9]+)*$ type: string RouterQueueRequestId: description: >- Identifier of one queued Router request - the handle a caller polls, cancels and collects a result by. IT IS NOT THE VALUE OF `X-Comfy-Request-Id`, and the two must not be confused. This id is DURABLE: one value for the whole life of the queued request, returned in the submit response's `request_id` and embedded in every URL that response hands back. `X-Comfy-Request-Id` is the per-CALL id the server mints and re-asserts on every response - the one on that call's usage and audit event and on every log line for it - so a poll loop making twenty calls against one queued request sees twenty different header values and one unchanging `request_id`. READ THE HANDLE FROM THE BODY, never from the header. A client that keeps only the header polls a request that does not exist. The two ids are the two halves of an audit join rather than one value: quote the header to ask about ONE call and the charge it raised, quote `request_id` to ask about the QUEUED REQUEST across every call made against it. It is server-minted and is never read from a request. A caller-supplied handle would let two unrelated calls collide in the audit trail, which is worse than having no join at all. Use `Idempotency-Key` to make a re-submission safe; that is the caller-controlled identifier on this surface, and it is a different job. example: 6f1a1a6e-6a53-4a5f-9d3a-2b3b0a1f9c21 format: uuid maxLength: 36 pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ type: string RouterQueueCancelStatus: description: >- What a cancellation ask found, for the two outcomes that describe a request this route actually resolved. Both are mirrored by the HTTP status, so a client may branch on either. It is deliberately NOT a `RouterErrorType`. That vocabulary classifies why a CALL failed and has no member meaning "already finished"; these two say what cancelling FOUND, which is a different question with a different, genuinely closed answer set - and unlike `RouterErrorType`, which is expected to grow, this one is closed for good, because a request this route resolved was either still cancellable or it was not. A published `RouterErrorType` bucket is never withdrawn, so minting one belongs in the change that raises it. `CANCELLATION_REQUESTED` means the ask was accepted for a request that had not yet reached a terminal state. It does NOT mean the run has stopped: a generation already on the wire at a partner may complete anyway, and a partner generation that completes is charged. Read the status endpoint to learn what actually happened. `ALREADY_COMPLETED` means the request had already reached a terminal state - success, failure, or an earlier cancellation, and this answer does not say which. THE THIRD OUTCOME - no such request - IS THE `404`, and it is deliberately NOT a member here. It is answered in the SHARED Router request-level error body, the same one the two queue reads answer a miss with, because this route's `404` carries TWO conditions and only one of them is about the queue: a `{provider}/{model}` that resolves to no partner model is `model_not_found` here exactly as everywhere else on this surface, and a cancel-shaped `NOT_FOUND` would silently swallow it - telling a caller who mistyped the MODEL that their REQUEST does not exist, and dropping the fuzzy suggestions that would have corrected them. One shape for one condition, and the condition is "this ID resolved to nothing". Branch on the `404`. enum: - CANCELLATION_REQUESTED - ALREADY_COMPLETED example: CANCELLATION_REQUESTED type: string RouterErrorResponse: description: >- Router's request-level error body: what is returned when the request never reached the model, or failed for a reason the model itself did not report - auth, quota, an unknown model ID, or provider transport. A model-level validation failure has its own shape, `RouterValidationErrorResponse`, because flattening a FastAPI `detail[]` array into this `detail` string would destroy the per-field granularity an SDK branches on. properties: detail: description: >- Human-readable description of the failure, safe to surface to an end user. Not machine-parsed - branch on `error_type` instead. For `model_not_found` on a retired model, `detail` reads ` was retired on ; use ` when a successor is recorded and visible to the caller, or just ` was retired on ` when it is not, instead of the usual suggestion list. A successor named here is always a live catalog ID the call can be re-pointed at. A model whose sunset date is still in the future is not retired: it stays listed by `GET /v2/models` and stays runnable until that date. Like the rest of `detail`, this retirement wording is for display and carries no compatibility guarantee. Two documented exceptions to the not-machine-parsed rule, because `error_type` cannot express either: on `POST /v2/models/{provider}/{model}` the `409` is answered for three unrelated conditions that share the `invalid_input` bucket, and only `detail` separates them. A `detail` beginning `this request resolved a BYOK credential` is the BYOK `model_provider` refusal; a `detail` beginning "this request's `image` selects the edit operation" is the multipart `model_provider` refusal; neither clears with a new `Idempotency-Key`. Any other `invalid_input` `409` on that route is the key conflict. Both prefixes are stable contract terms and may be matched. Nowhere else does branching on `detail` carry a compatibility guarantee. type: string error_type: $ref: '#/components/schemas/RouterErrorType' refusal_subject: description: >- Which input or output a content-policy refusal was about, as a Router-level closed vocabulary: `input`, `output`, `input_text`, `input_image`, `input_video`, `input_audio`, `output_text`, `output_image`, `output_video`, `output_audio`. The bare `input` / `output` values name the side when the provider did not name a modality. Present only when `error_type` is `content_policy_violation` and the provider named the refused subject with a machine-readable code; absent otherwise. Never provider text. Named today for BytePlus, Runway, BFL, Gemini, Veo, Vertex, xAI and Wan refusals, and for the MiniMax Router's Nano Banana legs' Gemini refusals; a provider whose refusal does not say which side it was about leaves it absent. It mirrors the `X-Comfy-Refusal-Subject` header. type: string upstream_detail: description: >- A bounded, sanitized reason the model provider gave for rejecting the request, present only when `error_type` is `invalid_input` and `X-Comfy-Upstream-Status` is a provider `4xx` or `2xx` - i.e. the provider refused the request as malformed and said why. Usually that status is a `4xx`; it is a `2xx` for a provider that reports a rejected generation inside a success envelope (a BytePlus failed-task poll is HTTP `200` with the reason in its body). Absent on every other failure, including provider `5xx`, transport failures, content-policy refusals and any refusal Router raised about itself. It mirrors the `X-Comfy-Upstream-Detail` header. Unlike `detail`, this is provider-authored text, so it is length-capped and stripped of URLs, hostnames, emails, tokens and id-shaped values before it is surfaced; it is never the raw provider body. It is a human-readable hint, not machine-parsed - branch on `error_type` instead. type: string required: - detail - error_type type: object RouterErrorType: description: >- Coarse, machine-readable bucket for a Router failure, mirrored on the `X-Comfy-Error-Type` response header so a caller can branch without parsing the body. The set is closed at nineteen values: the six request-level buckets `invalid_input`, `content_policy_violation`, `provider_error`, `provider_timeout`, `insufficient_credits` and `model_not_found`, plus the transport-level `unauthorized`, `forbidden`, `concurrency_limit_exceeded`, `client_disconnected`, `internal_error`, `deadline_exceeded`, `not_enabled`, `service_unavailable`, `rate_limited`, `cancelled`, `queue_timeout`, `request_not_found` and `queue_backlog_full`. Closed describes the set as documented today, not a bound that holds forever: the set is expected to grow, which is why this is deliberately a plain string and not an `enum`, so a client must treat an unrecognised value as `internal_error` rather than switch exhaustively over the list above and break on the next addition. RETRY SEMANTICS. `not_enabled` is TERMINAL - the same request will be refused the same way, so a client must not retry it - while `service_unavailable` is TRANSIENT and SHOULD be retried with backoff. That opposition is the whole reason they are two buckets rather than one: a retry policy keys off the status/`error_type` pair, and a single shared bucket would make retry wrong in one direction or the other. `not_enabled` and `forbidden` both return `403` and, like the `504` pair below, the difference between them is the one the status cannot carry. `forbidden` means the credential is valid but is not entitled to this model or operation - a decision about the caller. `not_enabled` means Comfy Router is not switched on for the caller yet - a state of the product rollout, not a judgement about them, and one that changes without the caller doing anything. `404` would have claimed the model does not exist when it does, and a `5xx` would have blamed the server for a deliberate state, so neither was available as a way to separate the two by status instead. HOW OFTEN `not_enabled` IS SEEN CHANGES OVER TIME, AND IT NEVER STOPS BEING VALID. While Comfy Router is rolling out, most callers are not on the ramp yet and this is the ordinary answer for them. Once Router is fully rolled out it becomes rare. It does not become impossible: the deploy-time switch that turns Router off for an environment is a permanent operational lever, so `not_enabled` is still the correct answer the day it is pulled. It is therefore a value Comfy expects to STOP EMITTING often rather than one that is ever withdrawn - a published bucket is never removed, because removing it would delete the generated exception class an SDK built from it and break any client branching on it. `service_unavailable` has no such arc at all: a dependency can always fault. `deadline_exceeded` and `provider_timeout` both return `504` and the difference between them is which SIDE ran out of time, which is not cosmetic: `provider_timeout` means the upstream model provider ran out of time, while `deadline_exceeded` means COMFY stopped holding the connection at its own configured bound. A client that collapses the two onto the status alone loses that distinction, and with it the difference between "the partner is failing" and "the call is longer than the connection Comfy will hold". NEITHER BUCKET IS A STATEMENT ABOUT THE CHARGE. Comfy's charges settle on COMPLETION: a generation the provider completed is billed whether or not the caller was still connected to receive the response, and a generation that failed or never completed is not billed. Reaching `deadline_exceeded` or `client_disconnected` therefore does not tell a caller they were not charged. `cancelled` IS THE SAME KIND OF VALUE and it is the one most often read as a refund. Cancelling asks Comfy to stop waiting; it does not stop a partner that has already accepted the generation, so a request cancelled while it was still `IN_QUEUE` was never dispatched and cannot be charged, whereas one cancelled after it was admitted may still settle a charge. The bucket names what happened to the REQUEST, never what happened to the bill. It is deliberately a plain string rather than an `enum`: the set is expected to grow -- it already has, most recently with the queued-delivery buckets `cancelled`, `queue_timeout` and `request_not_found`, and `file_download_error` is named as a further addition -- and a generated client that hard-rejects an unrecognized bucket would fail hardest exactly when something has already gone wrong. Treat an unknown value as `internal_error`. Bucketing loses no granularity - the specific provider-level reason survives in `RouterValidationErrorDetail.type` and its `ctx`. example: invalid_input type: string x-comfy-error-types: - meaning: >- The request was rejected before it reached the model - a malformed body, a malformed or expired pagination cursor, an input the model's own schema does not accept, or an `Idempotency-Key` that cannot serve this request (already used for a different request - the method, the path and query, or the body differ - or already consumed by a call whose response cannot be replayed). Sent with `409` in the key cases and with `400`/`422` in the others; the status says which, and the key cases are the ones answered by using a new key rather than by editing the request. tier: request value: invalid_input - meaning: >- The provider refused the request on content-policy grounds. The refusal is deterministic: re-sending the same input will be refused again. tier: request value: content_policy_violation - meaning: >- The partner provider reported a failure of its own, or returned a response Router could not interpret as a result. tier: request value: provider_error - meaning: >- The partner provider did not answer within its deadline. This bucket is the provider timing out and never Router's own server deadline, which is reported as `deadline_exceeded` - the two share `504` and are separated because they name different causes: this one says the partner failed, that one says Comfy stopped holding the connection. tier: request value: provider_timeout - meaning: The calling workspace does not have enough credits to run the model. tier: request value: insufficient_credits - meaning: >- The `{provider}/{model}` ID names no model Router can run: an unknown provider, an unenrolled id, one the catalog has retired past its sunset date, or a catalogued ID the provider does not currently serve for Comfy. A retired id's `detail` reads ` was retired on ; use ` when a successor is recorded and not withheld, or just ` was retired on ` when it is not, instead of a suggestion list; the successor named for a retired id is always a live catalog ID you can re-point the call at, and a successor is dropped from `detail` either because the table records none, or because the recorded one is currently withheld behind an embargo the caller cannot see. A model whose sunset is still in the future is not withdrawn: it stays listed by `GET /v2/models` and stays runnable until the date, so a listing taken today remains the answer to what runs today. Otherwise `detail` carries up to three suggestions drawn from the models the caller is entitled to see, except for a catalogued ID the provider does not currently serve for Comfy, whose response carries no suggestions. tier: request value: model_not_found - meaning: The request carried no usable credential. tier: transport value: unauthorized - meaning: >- The credential is valid but is not entitled to this model or this operation. tier: transport value: forbidden - meaning: >- The workspace already has as many calls in flight as it is allowed; retry once one of them finishes. It carries one further condition on the run route, on a `409` rather than the `429` above: another call is already in flight for the `Idempotency-Key` this request presented. Re-send the same key after `Retry-After` seconds to collect that call's result. tier: transport value: concurrency_limit_exceeded - meaning: >- The caller closed the connection before Router could return a result. It is logged rather than delivered - there is no socket left to write it to - and it is an attribution, not a billing outcome: a provider generation that completed is billed regardless of whether the caller received the response. tier: transport value: client_disconnected - meaning: >- Router itself failed. It is also the value a client should treat any unrecognized bucket as, so a later addition to the set does not break a client generated before it. tier: transport value: internal_error - meaning: >- Comfy stopped holding the connection at its own configured bound before an answer arrived. It shares `504` with `provider_timeout` and the pair says which side ran out of time; this one is Comfy's own bound, so nothing about the request was rejected and the same request may be retried. It says nothing about the charge: a provider generation that completed is billed regardless of whether the caller received the response. Retry it with the same `Idempotency-Key`: when the provider had already accepted the generation, the retry collects that generation rather than dispatching another, and a `Retry-After` on the `504` says when to ask. tier: transport value: deadline_exceeded - meaning: >- Comfy Router is not switched on for this caller yet. Nothing about the request is wrong and the model exists, which is why this is not `model_not_found`; it shares `403` with `forbidden` and is not the same thing, because `forbidden` is an entitlement decision about the caller while this is a state of the rollout. It is terminal: do not retry, and do not treat it as an outage. The one exception to "about the caller" is the queued submit, which also answers `not_enabled` for a model whose partner answers a generation directly as bytes: that model cannot yet be queued, so it is the model and not the caller that is refused, nothing is queued or charged, and the synchronous route `POST /v2/models/{provider}/{model}` runs it instead. tier: transport value: not_enabled - meaning: >- A service Comfy Router depends on is temporarily unavailable and the caller did nothing wrong. Retry it with backoff: it is the one bucket here whose condition clears on its own, without the caller changing the request and without a concurrency slot freeing, which is what distinguishes it from the other retryable answers (`concurrency_limit_exceeded`, `deadline_exceeded`). It is separate from `internal_error` - which is a `500` and means Router itself failed - so a client can tell "come back shortly" from "this call is not going to work". tier: transport value: service_unavailable - meaning: >- The caller has spent an allowance measured over a window and must wait for that window to roll. It shares `429` with `concurrency_limit_exceeded` and is not the same thing: that one clears the moment one of the caller's own in-flight calls finishes, so retrying in seconds is right, whereas nothing the caller does drains this one early. `detail` names the window. tier: transport value: rate_limited - meaning: >- A queued request was withdrawn — through the cancel route, or by an operator — before it produced a result; it is terminal, and it is not by itself a statement about the charge. Cancelling stops Comfy waiting and it does not always stop the partner working, so a request cancelled while it was still `IN_QUEUE` was never dispatched and cannot be charged, whereas one cancelled after it was admitted may still be charged — a partner generation that completes is charged whether or not anyone collected it, which is why the cancel route calls the ask a request rather than a guarantee. It is not `client_disconnected`: that one says nobody is listening any more while a generation may still be running and billable, whereas this says the request itself was withdrawn. A caller polling the status read sees `200` with this in the body, because the request ended and so the read succeeded. Collecting the result of such a request answers `409` in Router's error envelope: that read also worked, and what it found is a request whose terminal state - the caller's own decision - leaves nothing to return. It is deliberately not `410`, which on that route means the result aged out of its retention window, and not a `5xx`, which would report the caller's own cancellation as a Router fault and read to a polling client as worth retrying. tier: transport value: cancelled - meaning: >- A queued request waited past its queue timeout without ever being admitted. Terminal, unbilled, and it never took a concurrency slot — the job never reached a provider. Deliberately not `deadline_exceeded`, which is the synchronous route's connection bound: a `deadline_exceeded` generation may be running and billable, whereas this one provably never started. It is returned under `504`, which it shares with `provider_timeout` and `deadline_exceeded` because a status can only say that a clock ran out; which clock - the partner's, Comfy's connection bound, or the queue's admission bound - is what `error_type` carries. The request itself is terminal, so submit a new one rather than re-reading this one. tier: transport value: queue_timeout - meaning: >- The `request_id` names no request of the caller's under this model. It is the second of the two conditions the queued reads' `404` covers; the first is the `{provider}/{model}` ID resolving to no partner model, which is `model_not_found` and carries fuzzy model suggestions. It also covers the right-id / wrong-model URL the path shape refuses, and it is deliberately indistinguishable from a request in another workspace, so a probe with a guessed id learns nothing. A request that has merely aged out of its retention window is `410`, not this. tier: transport value: request_not_found - meaning: >- The caller already has too many queued requests waiting to run, so this submit was refused. It shares `429` with `concurrency_limit_exceeded` and is not the same thing: that one is the synchronous route's answer for too many calls in flight at once, whereas the queue accepts a submit at that limit and parks it, and this bucket is the separate bound on how many a caller may leave waiting so that parking cannot mean enqueuing without end. It clears as the caller's own queued requests finish, so retry once some of them complete. tier: transport value: queue_backlog_full headers: RouterRequestIdHeader: description: >- Server-generated identifier for this call, present on every Router response - success, 4xx and 5xx alike, because an error response is exactly when a user needs an id to quote in a support request. The same value is written into the call's usage/audit event, which is what lets a complaint about a charge be joined to the charge itself instead of searched for by timestamp. It is minted by the server and is never read from a request header of the same name: a caller-controlled id would let two unrelated calls collide in the audit trail, which would make the join actively misleading rather than merely absent. Sending this header on a request has no effect. required: true schema: example: 6f1a1a6e-6a53-4a5f-9d3a-2b3b0a1f9c21 format: uuid type: string RouterErrorTypeHeader: description: >- Coarse, machine-readable bucket for the failure, set by Router on every error response. It carries the same value as `RouterErrorResponse.error_type`, and on the `422` it is the only machine-readable bucket, because that body is the FastAPI `detail[]` shape and has no `error_type` field of its own. A client can therefore branch on this header alone, before deciding which of the two Router error bodies it received. required: true schema: $ref: '#/components/schemas/RouterErrorType' responses: RouterRequestError: content: application/json: schema: $ref: '#/components/schemas/RouterErrorResponse' description: >- A Router request-level failure - the request never reached the model, or failed for a reason the model itself did not report. The body is `RouterErrorResponse` and the bucket is repeated on `X-Comfy-Error-Type`. headers: X-Comfy-Error-Type: $ref: '#/components/headers/RouterErrorTypeHeader' X-Comfy-Request-Id: $ref: '#/components/headers/RouterRequestIdHeader' securitySchemes: BearerAuth: bearerFormat: JWT description: >- Bearer token authentication. Normally a Firebase or Cloud JWT. A 'comfyui-' prefixed API key is also accepted in this header: the prefix classifies the value as an API key and it is validated exactly as if it had been sent in X-API-Key. Accepted on the operations served by the comfyFirebase auth middleware (BE-9720, parity with ingest). scheme: bearer type: http ApiKeyAuth: description: >- API key authentication. Send the key in the X-API-Key header; keys are prefixed with 'comfyui-' and are generated from user account settings. The same 'comfyui-' key is also accepted in Authorization: Bearer (see BearerAuth), and when both headers carry a key, X-API-Key wins. The comfyFirebase auth middleware checks this header before falling back to the Authorization bearer token, and it backs both the /customers and the /proxy authset entries. in: header name: X-API-Key type: apiKey ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.