Comfy Router is not generally available yet.
POST /v2/models/{provider}/{model} and its catalog and schema siblings are not serving requests yet: an authenticated call answers 404 today. The snippets on this page document the contract those routes will serve, published ahead of the rollout so your integration is ready to write against.Quick start
Create a key at platform.comfy.org/profile/api-keys and export it asCOMFY_API_KEY. The Python and TypeScript snippets use the Comfy SDKs (pip install comfy-sdk, npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP.
Model ID: bfl/video-upscale-v1
Endpoint: POST https://api.comfy.org/v2/models/bfl/video-upscale-v1
Schema
Input
integer
default:"1"
0 preserves the source precisely and sharpens it; 1 allows creative detail enhancement, which does not strictly preserve faces or products.Range:
0 to 1string
required
Video to upscale, either an HTTP(S) URL or a base64-encoded MP4. At most 20 seconds of source footage and 50MB.
string
Optional description of the clip’s content, steering the enhanced detail. Leave empty for a neutral upscale.
integer
default:"2"
Tolerance level for prompt and output frame moderation, 0 being most strict.Range:
0 to 4number
default:"2"
Output scaling relative to the source resolution. The output preserves the source aspect ratio and is capped at roughly 14.4 megapixels per frame, so very large sources scale by less than the requested factor.Range:
1.5 to 3Format: floatstring
Optional secret for webhook signature verification.
string (uri)
URL to receive webhook notifications.Format:
uriGET /v2/models/bfl/video-upscale-v1/openapi.json, the same document it validates a call against before the request reaches the provider.
Output
number
Provider-reported cost in credits, populated once the task is Ready.Format:
floatstring
required
BFL task identifier.
number
Optional generation progress reported by BFL.Range:
0 to 1Format: floatobject
required
The finished generation. Not nullable here: this component’s
required entry is a promise that a 200 carries the result, and a nullable result would reduce it to a key-presence check.number
Provider-reported cost of the generation. This is BFL’s number, not the Comfy charge.Format:
doublenumber
Provider-reported generation duration in seconds.Format:
doublenumber
Provider-reported completion time of the generation, in seconds since the Unix epoch.
double for the same reason as start_time.Format: doublestring
The prompt the generation actually ran, after any prompt upsampling.
string (uri)
Signed URL for the generated asset. Router re-hosts the asset onto Comfy storage and rewrites this field, so it is normally a Comfy-hosted URL valid for up to 24 hours - signed for 24 hours when minted, and replayed from a 23-hour memo, so a later poll can hand back one with as little as an hour left; a leaf whose re-host could not be performed keeps BFL’s own short-lived delivery URL instead - roughly two hours for video, roughly ten minutes for images. Either way the link expires, so download the asset rather than storing the URL.Format:
uriinteger
The seed the generation used, whether supplied or chosen by the provider. Declared
int64 because BFL returns seeds above 2^31 (e.g. 2784347701), which an unformatted integer generates as a 32-bit field in many SDK generators.Format: int64number
Provider-reported start time of the generation, in seconds since the Unix epoch.
double, not float: float32 spacing near a present-day epoch value is ~128 seconds, which collapses a whole generation’s span to a single decoded value.Format: doublestring
required
Task status: Pending, Reasoning, Generating, Ready, Request Moderated, Content Moderated, Error, or Task not found.
Examples
Input
Output
result.sample is a signed URL that expires roughly two hours after the result is ready. Download the MP4 promptly.
Before you ship
The snippets above are the shortest working call. Three things are the same for every model and are documented once on the Comfy Router headers page: send anIdempotency-Key on every paid call and reuse it when you retry, expect the connection to be held up to Router’s 10 minute deadline, and keep X-Comfy-Request-Id from every response. The SDKs do all three for you; the cURL tab does none of them. On failure, X-Comfy-Error-Type names the bucket, and a 422 means the body failed the model’s schema and was never billed.
Headers
Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
Quick Start
Typed error handling in Python and TypeScript, reading the 422, walking the catalog.
Limitations
What Router does not do today, and what to use instead.