使用 Comfy Router 调用 Crystal Upscaler
通过 Comfy Router 调用 fal/crystal-upscaler:端点、请求形状以及 Router 返回的响应。
使用 Comfy Router 调用 Crystal Upscaler
通过 Comfy Router 调用 fal/crystal-upscaler:端点、请求形状以及 Router 返回的响应。
fal/crystal-upscaler 的 API 参考,由 Comfy Router 从 fal 提供。
输入: 图像 · 输出: 图像
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段是通过原生 HTTP 发出的同一调用。
Model ID: fal/crystal-upscaler
Endpoint: POST https://api.comfy.org/v2/models/fal/crystal-upscaler
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "fal/crystal-upscaler", { "image_url": "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png", "scale_factor": 2, }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 const { data } = await comfy.models.run("fal/crystal-upscaler", { image_url: "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png", scale_factor: 2, }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/fal/crystal-upscaler \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"image_url\": \"https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png\", \"scale_factor\": 2}"``
[tab] 排队并稍后收集 相同的请求体,发送到POST https://api.comfy.org/v2/models/fal/crystal-upscaler/requests。只要运行被接纳,Router 就会立即返回201和request_id,结果准备就绪后再进行收集,可以从当前进程收集,也可以从另一个进程收集。排队投递 介绍了状态、取消和收集的完整流程。 ``python Python theme={null} import asyncio from comfy_sdk import AsyncComfy # 从环境变量中读取 COMFY_API_KEY。 # 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用它。 async def main(): async with AsyncComfy() as client: handle = await client.models.submit( "fal/crystal-upscaler", { "image_url": "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png", "scale_factor": 2, }, ) print("request_id:", handle.request_id) # 配合模型 ID,就是另一个进程所需的全部信息 # 轮询直到请求完成,按服务器指定的 Retry-After 等待。 async for update in handle.iter_events(): print(update.status, update.queue_position) # 提供商自身的响应负载,与 models.run() 返回的值相同。 # 失败或已取消的请求会在此处抛出类型化的 Router 错误。 result = await handle.get() print(result) asyncio.run(main())``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用它。 const handle = await comfy.models.submit("fal/crystal-upscaler", { image_url: "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png", scale_factor: 2, }); console.log("requestId:", handle.requestId); // 配合模型 ID,就是另一个进程所需的全部信息 // 轮询直到请求完成,按服务器指定的 Retry-After 等待。 for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } // 与 models.run() 返回的结果相同。失败或已取消的请求会在此处被拒绝。 const result = await handle.get(); console.log(result.data);``bash cURL theme={null} # 1. 提交。Router 返回 201,并带有 request_id、status_url、response_url 和 cancel_url。 curl https://api.comfy.org/v2/models/fal/crystal-upscaler/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"image_url\": \"https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png\", \"scale_factor\": 2}" # 2. 轮询直到状态为 COMPLETED,并按每次响应指定的 Retry-After 秒数等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/fal/crystal-upscaler/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 时带有模型的原生输出;任务仍在运行时返回 202 和状态响应体。 curl https://api.comfy.org/v2/models/fal/crystal-upscaler/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
creativity number (default: 0)
模型可以自行创造多少新细节。0 表示最接近输入图像。
范围:0 到 10
image\_url string required
输入图像的 URL(JPEG、PNG、WebP、GIF 或 AVIF,最大 100 MB)。
output\_format string (default: "jpg")
输出图像格式:png 或 jpg。
scale\_factor number (default: 2)
应用于输入图像每一边的倍数。fal 按输出百万像素计费,因此价格随该值的平方增长。
范围:1 到 200
根据 Router 在 GET /v2/models/fal/crystal-upscaler/openapi.json 提供的 schema 生成,请求到达提供商之前,Router 也用同一份文档校验调用。
输出
images object[] required
放大后的图像。
images\[].content\_type string
图像文件的 MIME 类型。
images\[].file\_name string
图像文件的名称。
images\[].file\_size integer
图像文件的大小,单位为字节。
images\[].height integer
图像的高度,单位为像素。fal 返回 null。
images\[].url string required
放大后图像的 URL。
images\[].width integer
图像的宽度,单位为像素。fal 返回 null。
示例
输入
{
"image_url": "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png",
"scale_factor": 2
}
输出
{
"images": [
{
"content_type": "image/png",
"file_name": "upscaled.png",
"file_size": 1412332,
"height": null,
"url": "https://example.invalid/fal/crystal-upscaler/upscaled.png",
"width": null
}
]
}
发布前须知
SDK 会生成 Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。
请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入,413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载,因为结果 URL 会过期。
上文任何字段描述中提到的尺寸限制,都是提供商对该字段自身的限定,引自提供商的规范。Router 会对整个请求体另行设置上限,base64 编码的媒体内容也计入其中:参见请求体大小。
本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 comfy-sdk / @comfyorg/sdk 包还提供第二个客户端,用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图:Comfy(api_key=...) / new Comfy({ apiKey }),并带有 client.workflows、client.assets 和 client.jobs。请参阅 Comfy SDKs。
[card] 请求头 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
[card] 使用 Router API 模型发现、验证错误、重试与计费。
[card] 限制 Router 目前不支持的功能,以及替代方案。