使用 Comfy Router 调用 Sdxl 1.0 文生图
通过 Comfy Router 调用 stability/sdxl-1.0-text-to-image:endpoint、请求形状以及 Router 返回的响应。
使用 Comfy Router 调用 Sdxl 1.0 文生图
通过 Comfy Router 调用 stability/sdxl-1.0-text-to-image:endpoint、请求形状以及 Router 返回的响应。
stability/sdxl-1.0-text-to-image 的 API 参考,由 Comfy Router 提供 Stability 的模型服务。
输入: 文本 · 输出: 图像
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 进行的同一调用。
模型 ID: stability/sdxl-1.0-text-to-image
端点: POST https://api.comfy.org/v2/models/stability/sdxl-1.0-text-to-image
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用该键。 with Comfy() as client: result = client.models.run( "stability/sdxl-1.0-text-to-image", { "samples": 1, "seed": 12345, "steps": 30, "text_prompts": [ { "text": "a lighthouse on a cliff at sunset, oil painting", }, ], }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用该键。 const { data } = await comfy.models.run("stability/sdxl-1.0-text-to-image", { samples: 1, seed: 12345, steps: 30, text_prompts: [ { text: "a lighthouse on a cliff at sunset, oil painting", }, ], }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/stability/sdxl-1.0-text-to-image \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"samples\": 1, \"seed\": 12345, \"steps\": 30, \"text_prompts\": [{\"text\":\"a lighthouse on a cliff at sunset, oil painting\"}]}"``
[tab] 加入队列并稍后收集 相同的请求体,发送到POST https://api.comfy.org/v2/models/stability/sdxl-1.0-text-to-image/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( "stability/sdxl-1.0-text-to-image", { "samples": 1, "seed": 12345, "steps": 30, "text_prompts": [ { "text": "a lighthouse on a cliff at sunset, oil painting", }, ], }, ) 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("stability/sdxl-1.0-text-to-image", { samples: 1, seed: 12345, steps: 30, text_prompts: [ { text: "a lighthouse on a cliff at sunset, oil painting", }, ], }); 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/stability/sdxl-1.0-text-to-image/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"samples\": 1, \"seed\": 12345, \"steps\": 30, \"text_prompts\": [{\"text\":\"a lighthouse on a cliff at sunset, oil painting\"}]}" # 2. 轮询直到状态为 COMPLETED,并按照每个响应指定的 Retry-After 秒数等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/stability/sdxl-1.0-text-to-image/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。仍在运行时,200 返回模型的原始输出,202 返回状态响应体。 curl https://api.comfy.org/v2/models/stability/sdxl-1.0-text-to-image/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
cfg\_scale number
图像遵循提示词的严格程度。默认值为 7。
范围:0 到 35
clip\_guidance\_preset string
Stability 的 CLIP 引导预设,例如 NONE。
extras object
仅为兼容性而接受,会被忽略。
height integer
仅限文生图。输出高度;必须与 width 组合成 SDXL 1.0 支持的尺寸之一。默认值为 1024。
image\_strength number
仅限图生图。保留多少来源图像的内容。
范围:0 到 1
init\_image string (uri)
仅限图生图,且在该模式下必填。来源图像的 Comfy 签名资源 URL。
Format: uri
init\_image\_mode string
仅限图生图。指定由 image_strength 还是步数计划来控制保留多少来源图像的内容。默认值为 IMAGE\_STRENGTH。
可能的值:IMAGE_STRENGTH、STEP_SCHEDULE
sampler string
Stability 的采样器名称,例如 K_DPMPP_2M。
samples integer
要生成的图像数量。默认值为 1。每张返回的图像都会计费。
范围:1 到 10
seed integer
整个批处理使用的种子。取 0 或省略时随机选取一个种子。
范围:0 到 …
step\_schedule\_end number
仅限图生图,且 init_image_mode 为 STEP\_SCHEDULE 时使用。
范围:0 到 1
step\_schedule\_start number
仅限图生图,且 init_image_mode 为 STEP\_SCHEDULE 时使用。
范围:0 到 1
steps integer
扩散步数。默认值为 30。
范围:10 到 30
style\_preset string
Stability 风格预设,例如 photographic。
text\_prompts object[] required
提示词,每个都可带有可选权重。权重为负时,该提示词即为负面提示词。
text\_prompts\[].text string required
text\_prompts\[].weight number
width integer
仅限文生图。输出宽度;必须与 height 组合成 SDXL 1.0 支持的尺寸之一。默认值为 1024。
本文档由 Router 在 GET /v2/models/stability/sdxl-1.0-text-to-image/openapi.json 提供的 schema 生成,它与 Router 在请求到达提供商之前校验调用时所使用的是同一份文档。
输出
finish\_reason string required
返回 200 时始终为 SUCCESS。
image string (uri) required
(第一张)PNG 图像的 Comfy 签名 URL,有效期最长 24 小时。
Format: uri
images string (uri)[]
仅 SDXL,且返回不止一张图像时存在。按输出顺序列出每一个 Comfy 签名的图片网址,每个有效期最长 24 小时。
seed integer required
生成该图像所用的种子。
示例
输入
{
"samples": 1,
"seed": 12345,
"steps": 30,
"text_prompts": [
{
"text": "a lighthouse on a cliff at sunset, oil painting"
}
]
}
输出
{
"finish_reason": "SUCCESS",
"image": "https://example.invalid/stability/image.png",
"seed": 12345
}
发布前须知
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 目前不支持的功能,以及替代方案。