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

# 将 Starfish 与 Comfy Router 配合使用

> 通过 Comfy Router 调用 heygen/starfish：端点、请求形状以及 Router 返回的响应。

`heygen/starfish` 的 API 参考，由 Comfy Router 提供，模型来自 HeyGen。

## 快速开始

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

**模型 ID：** `heygen/starfish`

**端点：** `POST https://api.comfy.org/v2/models/heygen/starfish`

<Tabs>
  <Tab title="Wait for the result">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # The SDK automatically creates an idempotency key and reuses it for automatic retries.
      with Comfy() as client:
          result = client.models.run(
              "heygen/starfish",
              {
                  "text": "This is a billing verification test for HeyGen speech generation.",
                  "voice_id": "d2f4f24783d04e22ab49ee8fdc3715e0",
              },
          )

      print(result)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // Reads COMFY_API_KEY from the environment.
      // The SDK automatically creates an idempotency key and reuses it for automatic retries.
      const { data } = await comfy.models.run("heygen/starfish", {
        text: "This is a billing verification test for HeyGen speech generation.",
        voice_id: "d2f4f24783d04e22ab49ee8fdc3715e0",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/heygen/starfish \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"text\": \"This is a billing verification test for HeyGen speech generation.\", \"voice_id\": \"d2f4f24783d04e22ab49ee8fdc3715e0\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      with Comfy() as client:
          handle = client.models.submit(
              "heygen/starfish",
              {
                  "text": "This is a billing verification test for HeyGen speech generation.",
                  "voice_id": "d2f4f24783d04e22ab49ee8fdc3715e0",
              },
          )
          print("request_id:", handle.request_id)  # with the model ID, all another process needs

          # Poll until the request completes, waiting the Retry-After the server names.
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # The provider's own payload, the same value models.run() returns.
          # A request that failed or was cancelled raises the typed Router error here.
          result = handle.get()

      print(result)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      const handle = await comfy.models.submit("heygen/starfish", {
        text: "This is a billing verification test for HeyGen speech generation.",
        voice_id: "d2f4f24783d04e22ab49ee8fdc3715e0",
      });
      console.log("requestId:", handle.requestId); // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // The same result models.run() returns. A request that failed or was cancelled rejects here.
      const result = await handle.get();

      console.log(result.data);
      ```

      ```bash cURL theme={null}
      # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
      curl https://api.comfy.org/v2/models/heygen/starfish/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"text\": \"This is a billing verification test for HeyGen speech generation.\", \"voice_id\": \"d2f4f24783d04e22ab49ee8fdc3715e0\"}"

      # 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/heygen/starfish/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
      curl https://api.comfy.org/v2/models/heygen/starfish/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### 输入

<ParamField body="input_type" type="string">
  输入的类型：纯文本使用 'text'，SSML 标记使用 'ssml'。默认为 'text'
</ParamField>

<ParamField body="language" type="string">
  基础语言代码（例如 'en'）。省略时会从文本中自动检测
</ParamField>

<ParamField body="locale" type="string">
  BCP-47 区域设置标签（例如 'en-US'）。设置后，语言将根据区域设置推断
</ParamField>

<ParamField body="speed" type="number">
  速度倍数（0.5-2.0）

  范围：`0.5` 到 `2`

  格式：`double`
</ParamField>

<ParamField body="text" type="string" required>
  要合成的文本（1-5000 个字符）
</ParamField>

<ParamField body="voice_id" type="string" required>
  要使用的语音 ID。该语音必须支持 starfish 引擎
</ParamField>

本内容根据 Router 在 `GET /v2/models/heygen/starfish/openapi.json` 提供的 schema 生成，该文档也是请求到达提供商之前 Router 用来校验调用的同一份文档。

### 输出

<ResponseField name="data" type="object" required>
  成功的 HeyGen 文本转语音响应的载荷
</ResponseField>

<ResponseField name="data.audio_url" type="string" required>
  已生成音频文件的 URL
</ResponseField>

<ResponseField name="data.duration" type="number">
  音频的时长，单位为秒

  格式：`double`
</ResponseField>

<ResponseField name="data.request_id" type="string">
  此生成请求的唯一标识符
</ResponseField>

<ResponseField name="data.word_timestamps" type="object[]">
  词级时间数据
</ResponseField>

<ResponseField name="data.word_timestamps[].end" type="number">
  结束时间，单位为秒

  格式：`double`
</ResponseField>

<ResponseField name="data.word_timestamps[].start" type="number">
  开始时间，单位为秒

  格式：`double`
</ResponseField>

<ResponseField name="data.word_timestamps[].word" type="string">
  该单词
</ResponseField>

## 示例

### 输入

```json theme={null}
{
  "text": "This is a billing verification test for HeyGen speech generation.",
  "voice_id": "d2f4f24783d04e22ab49ee8fdc3715e0"
}
```

### 输出

```json theme={null}
{
  "data": {
    "audio_url": "https://example.invalid/heygen/starfish/speech.mp3",
    "duration": 12.5,
    "request_id": "018f2c7a-4b1e-7c3d-9a05-6e2f8b41d0c9"
  }
}
```

## 发布前须知

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

请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载，因为[结果链接会过期](/zh/development/comfy-router/reference#结果资产)。

<CardGroup cols={3}>
  <Card title="请求头" icon="list" href="/zh/development/comfy-router/quickstart">
    身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
  </Card>

  <Card title="使用 Router API" icon="code" href="/zh/development/comfy-router/quickstart">
    模型发现、校验错误、重试与计费。
  </Card>

  <Card title="限制" icon="triangle-exclamation" href="/zh/development/comfy-router/limitations">
    Router 目前不支持的功能，以及替代方案。
  </Card>
</CardGroup>