> ## 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.

# 搭配 Comfy Router 使用 Arrow 2

> 通过 Comfy Router 调用 quiver/arrow-2：端点、请求结构以及 Router 返回的响应。

`quiver/arrow-2` 的 API 参考，该模型由 Comfy Router 从 Quiver 提供。

**输入：** 文本、图像 · **输出：** 图像

## 快速开始

在 [你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router) 中创建密钥，并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK（`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`）；cURL 代码片段是通过原始 HTTP 发起的相同调用。

**模型 ID：** `quiver/arrow-2`

**端点：** `POST https://api.comfy.org/v2/models/quiver/arrow-2`

> [tab] 等待结果
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 从环境变量中读取 COMFY_API_KEY。
> # SDK 会自动创建幂等键，并在自动重试时复用它。
> with Comfy() as client:
>     result = client.models.run(
>         "quiver/arrow-2",
>         {
>             "n": 1,
>             "prompt": "A single red maple leaf on a plain white background.",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 从环境变量中读取 COMFY_API_KEY。
> // SDK 会自动创建幂等键，并在自动重试时复用它。
> const { data } = await comfy.models.run("quiver/arrow-2", {
>   n: 1,
>   prompt: "A single red maple leaf on a plain white background.",
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/quiver/arrow-2 \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"n\": 1, \"prompt\": \"A single red maple leaf on a plain white background.\"}"
> ```

> [tab] 排队并稍后收集
>
> 相同的请求体，发送到 `POST https://api.comfy.org/v2/models/quiver/arrow-2/requests`。运行一旦被接纳，Router 就会返回 `201` 和 `request_id`；结果准备就绪后，可从当前进程或其他进程收集。[队列投递](https://docs.comfy.org/zh/development/comfy-router/queue.md) 会介绍状态、取消和收集流程。
>
> ```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(
>             "quiver/arrow-2",
>             {
>                 "n": 1,
>                 "prompt": "A single red maple leaf on a plain white background.",
>             },
>         )
>         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("quiver/arrow-2", {
>   n: 1,
>   prompt: "A single red maple leaf on a plain white background.",
> });
> 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/quiver/arrow-2/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"n\": 1, \"prompt\": \"A single red maple leaf on a plain white background.\"}"
>
> # 2. 轮询直到状态为 COMPLETED，并按每个响应指定的 Retry-After 秒数等待。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/quiver/arrow-2/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 收集。200 表示模型的原始输出，202 表示仍在运行时返回的状态响应体。
> curl https://api.comfy.org/v2/models/quiver/arrow-2/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## Schema

### 输入

**instructions** `string`

额外的风格或格式引导

**max\_output\_tokens** `integer`

输出 token 的最大数量

范围：`1` 到 `131072`

**model** `string`

用于生成 SVG 的模型标识符

**n** `integer` (default: 1)

要生成的 SVG 数量

范围：`1` 到 `16`

**presence\_penalty** `number` (default: 0)

对已出现在先前输出中的 token 进行惩罚。`arrow-2-telos` 会忽略此参数，因为它不接受采样参数；该字段会在请求被转发之前移除，且不会报错。

范围：`-2` 到 `2`

**prompt** `string` *required*

所需 SVG 输出的文本描述

**references** `object | string (uri)[]`

可选的参考图像，用于引导风格/构图。接受 URL 对象、base64 对象或 URL 字符串简写。运行时限制因模型而异。

**temperature** `number` (default: 1)

采样温度。`arrow-2-telos` 会忽略此参数，因为它不接受采样参数；该字段会在请求被转发之前移除，且不会报错。

范围：`0` 到 `2`

**top\_p** `number` (default: 1)

核采样概率。`arrow-2-telos` 会忽略此参数，因为它不接受采样参数；该字段会在请求被转发之前移除，且不会报错。

范围：`0` 到 `1`

根据 Router 在 `GET /v2/models/quiver/arrow-2/openapi.json` 提供的 schema 生成，该 schema 也是它在请求到达提供商之前用于校验调用的同一份文档。

### 输出

**created** `integer` *required*

创建时间的 Unix 时间戳

**credits** `integer`

固定积分模型（如 arrow-1.1）的积分费用。对于按 token 计价的模型（如 arrow-2）会省略此字段，这类模型会在 usage 中报告实际测量的 token 总数。

范围：`0` 到 `…`

**data** `object[]` *required*

**data\[].mime\_type** `string` *required*

输出的 MIME 类型

可能的值：`image/svg+xml`

**data\[].svg** `string` *required*

原始 SVG 标记

**id** `string` *required*

生成的唯一标识符

**usage** `object`

按 token 计价的模型（如 arrow-2）的 token 总数。固定积分模型在此处可能报告为零。

**usage.input\_tokens** `integer`

按 token 计价的模型的输入 token 数。

范围：`0` 到 `…`

**usage.output\_tokens** `integer`

按 token 计价的模型的输出 token 数。

范围：`0` 到 `…`

**usage.total\_tokens** `integer`

按 token 计价的模型的 token 总数。

范围：`0` 到 `…`

## 示例

### 输入

```json theme={null}
{
  "n": 1,
  "prompt": "A single red maple leaf on a plain white background."
}
```

### 输出

```json theme={null}
{
  "created": 1767225600,
  "data": [
    {
      "mime_type": "image/svg+xml",
      "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 64 64\"><path d=\"M32 4 44 28 60 30 48 42 52 60 32 50 12 60 16 42 4 30 20 28Z\"/></svg>"
    }
  ],
  "id": "svg_018f2c7a4b1e7c3d9a056e2f8b41d0c9",
  "usage": {
    "input_tokens": 180,
    "output_tokens": 240,
    "total_tokens": 420
  }
}
```

## 发布前须知

SDK 会生成 `Idempotency-Key` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。

请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入，`413` 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为[结果 URL 会过期](https://docs.comfy.org/zh/development/comfy-router/reference.md#结果资产)。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](https://docs.comfy.org/zh/development/comfy-router/limitations.md)。

本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](https://docs.comfy.org/zh/development/api-development/sdks.md)。

> [card] [请求头](https://docs.comfy.org/zh/development/comfy-router/headers.md)
>
> 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

> [card] [使用 Router API](https://docs.comfy.org/zh/development/comfy-router/api.md)
>
> 模型发现、验证错误、重试与计费。

> [card] [限制](https://docs.comfy.org/zh/development/comfy-router/limitations.md)
>
> Router 目前不支持的功能，以及替代方案。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.