> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-chore-mintlify-theme-mint.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 结合 Comfy Router 使用 Seed Audio 1.0

> 通过 Comfy Router 调用 byteplus/seed-audio-1.0：端点、请求形状以及 Router 返回的响应。

`byteplus/seed-audio-1.0` 的 API 参考，由 Comfy Router 从 BytePlus 提供。

## 快速开始

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

**模型 ID：** `byteplus/seed-audio-1.0`

**端点：** `POST https://api.comfy.org/v2/models/byteplus/seed-audio-1.0`

<Tabs>
  <Tab title="等待结果">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # 从环境变量中读取 COMFY_API_KEY。
      # SDK 会自动创建幂等键，并在自动重试时复用它。
      with Comfy() as client:
          result = client.models.run(
              "byteplus/seed-audio-1.0",
              {
                  "audio_config": {
                      "format": "wav",
                      "sample_rate": 24000,
                  },
                  "text_prompt": "Hello from Comfy Router.",
              },
          )

      print(result)
      ```

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

      // 从环境变量中读取 COMFY_API_KEY。
      // SDK 会自动创建幂等键，并在自动重试时复用它。
      const { data } = await comfy.models.run("byteplus/seed-audio-1.0", {
        audio_config: {
          format: "wav",
          sample_rate: 24000,
        },
        text_prompt: "Hello from Comfy Router.",
      });

      console.log(data);
      ```

      ```swift Swift theme={null}
      import Foundation
      import ComfySwiftSDK

      // 从环境变量中读取 COMFY_API_KEY。
      // SDK 会为每次调用生成一个幂等键，并在自动重试时复用它。
      let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
      let result = try await client.models.run(
          "byteplus/seed-audio-1.0",
          input: [
              "audio_config": [
                  "format": "wav",
                  "sample_rate": 24000,
              ],
              "text_prompt": "Hello from Comfy Router.",
          ]
      )

      print(result.output)
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/byteplus/seed-audio-1.0 \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"audio_config\": {\"format\":\"wav\",\"sample_rate\":24000}, \"text_prompt\": \"Hello from Comfy Router.\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="入队并稍后收集">
    同样的请求体，发送到 `POST https://api.comfy.org/v2/models/byteplus/seed-audio-1.0/requests`。只要运行被接受，Router 就会立即返回 `201` 和一个 `request_id`；结果就绪后，可从当前进程或其他进程收集。[队列投递](/zh/development/comfy-router/queue)会介绍状态查询、取消与结果收集。

    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # 从环境变量中读取 COMFY_API_KEY。
      # 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      with Comfy() as client:
          handle = client.models.submit(
              "byteplus/seed-audio-1.0",
              {
                  "audio_config": {
                      "format": "wav",
                      "sample_rate": 24000,
                  },
                  "text_prompt": "Hello from Comfy Router.",
              },
          )
          print("request_id:", handle.request_id)  # 加上模型 ID，就是另一个进程所需的全部信息

          # 轮询直到请求完成，按服务器给出的 Retry-After 等待。
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # 提供商自身的响应体，与 models.run() 返回的值相同。
          # 失败或已取消的请求会在此处抛出类型化的 Router 错误。
          result = handle.get()

      print(result)
      ```

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

      // 从环境变量中读取 COMFY_API_KEY。
      // 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      const handle = await comfy.models.submit("byteplus/seed-audio-1.0", {
        audio_config: {
          format: "wav",
          sample_rate: 24000,
        },
        text_prompt: "Hello from Comfy Router.",
      });
      console.log("requestId:", handle.requestId); // 加上模型 ID，就是另一个进程所需的全部信息

      // 轮询直到请求完成，按服务器给出的 Retry-After 等待。
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // 与 models.run() 返回的结果相同。失败或已取消的请求会在此处 reject。
      const result = await handle.get();

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

      ```swift Swift theme={null}
      import Foundation
      import ComfySwiftSDK

      // 从环境变量中读取 COMFY_API_KEY。
      // 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
      let handle = try await client.models.submit(
          "byteplus/seed-audio-1.0",
          input: [
              "audio_config": [
                  "format": "wav",
                  "sample_rate": 24000,
              ],
              "text_prompt": "Hello from Comfy Router.",
          ]
      )
      print("requestId:", handle.requestId)  // 加上模型 ID，就是另一个进程所需的全部信息

      // 轮询直到请求完成，按服务器给出的 Retry-After 等待。
      for try await update in handle.events() {
          print(update.state.rawValue, update.queuePosition.map(String.init) ?? "unknown")
      }

      // 提供商自身的响应体，与 models.run() 返回的值相同。
      // 失败或已取消的请求会在此处抛出类型化的 Router 错误。
      let result = try await handle.result()

      print(result.output)
      ```

      ```bash cURL theme={null}
      # 1. 提交。Router 返回 201，并带上 request_id、status_url、response_url 和 cancel_url。
      curl https://api.comfy.org/v2/models/byteplus/seed-audio-1.0/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"audio_config\": {\"format\":\"wav\",\"sample_rate\":24000}, \"text_prompt\": \"Hello from Comfy Router.\"}"

      # 2. 轮询直到状态为 COMPLETED，按每个响应给出的 Retry-After 秒数等待。
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/byteplus/seed-audio-1.0/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. 收集结果。返回 200 时是模型的原生输出，仍在运行时返回 202 及状态响应体。
      curl https://api.comfy.org/v2/models/byteplus/seed-audio-1.0/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### Input

<ParamField body="audio_config" type="object">
  输出音频配置。
</ParamField>

<ParamField body="audio_config.enable_subtitle" type="boolean">
  是否启用字幕服务。启用后，响应会包含语句级和词级时间戳（默认：false）。
</ParamField>

<ParamField body="audio_config.format" type="string">
  输出音频格式：wav（默认）、mp3、pcm 或 ogg\_opus。

  可能的值：`wav`、`mp3`、`pcm`、`ogg_opus`
</ParamField>

<ParamField body="audio_config.loudness_rate" type="integer">
  -50 到 100；100 表示 2.0 倍音量，-50 表示 0.5 倍音量（默认：0）。

  范围：`-50` 到 `100`
</ParamField>

<ParamField body="audio_config.pitch_rate" type="integer">
  -12 到 12（默认：0）。

  范围：`-12` 到 `12`
</ParamField>

<ParamField body="audio_config.sample_rate" type="integer">
  输出采样率：8000、16000、24000（默认）、32000、44100 或 48000。

  可能的值：`8000`、`16000`、`24000`、`32000`、`44100`、`48000`
</ParamField>

<ParamField body="audio_config.speech_rate" type="integer">
  -50 到 100；100 表示 2.0 倍语速，-50 表示 0.5 倍语速（默认：0）。

  范围：`-50` 到 `100`
</ParamField>

<ParamField body="model" type="string">
  模型标识符。支持的模型：seed-audio-1.0 和 seed-audio-1.0-multilingual。对 POST /proxy/byteplus/api/v3/tts/create 的直接 v1 调用必须提供它：代理会以 400 拒绝任何其他值，省略它同样会被拒绝。它并不在本 schema 的 `required` 列表中，因为 Comfy Router 会从 /v2/models/byteplus/\{model} 的 `{model}` 路径段填充该值，所以 Router 调用方会省略它。
</ParamField>

<ParamField body="references" type="object[]">
  参考资源。仅进行文本生成时可省略。最多 3 个音频参考（每个最长 30 秒、解码后 10 MB；wav、mp3、pcm 或 ogg\_opus）或恰好 1 个图像参考（解码后最大 10 MB；jpeg、png 或 webp）。图像参考不能与音频参考混用。这些上限由 BytePlus 设定，且以解码后的字节数计：base64 会令资产膨胀约 4/3，而 Comfy Router 调用对整个 JSON 文档的限制为 100 MiB，因此发送到 /v2/models/byteplus/\{model} 的内联 `audio_data`/`image_data` 参考在传输限制拒绝之前大约可承载 75 MB 解码后的数据。所以，对于任何单个内联参考，真正首先生效的是 BytePlus 自身每参考 10 MB 的上限，而三个达到该上限的音频参考现在可以放入同一个请求体；请使用 `audio_url`/`image_url` 让大型资产完全不必进入请求。
</ParamField>

<ParamField body="references[].audio_data" type="string">
  Base64 编码的参考音频。
</ParamField>

<ParamField body="references[].audio_url" type="string">
  远程参考音频文件的 URL。
</ParamField>

<ParamField body="references[].image_data" type="string">
  Base64 编码的参考图像。
</ParamField>

<ParamField body="references[].image_url" type="string">
  远程参考图像的 URL。
</ParamField>

<ParamField body="references[].speaker" type="string">
  音色 ID。可以是受支持的 Doubao TTS 音色，也可以是音色克隆的音色 ID。
</ParamField>

<ParamField body="text_prompt" type="string" required>
  要合成的提示词或文本（1 到 3,000 个字符；空字符串会被拒绝）。提供了音频参考时，按顺序使用 @Audio1、@Audio2 和 @Audio3 引用它们。
</ParamField>

<ParamField body="watermark" type="object">
  水印配置对象。接受空对象。
</ParamField>

<ParamField body="watermark.aigc_metadata" type="object">
  隐式水印。向合成音频的头部添加元数据。
</ParamField>

<ParamField body="watermark.aigc_metadata.content_producer" type="string">
  合成服务提供商的名称或代码。
</ParamField>

<ParamField body="watermark.aigc_metadata.content_propagator" type="string">
  内容分发服务提供商的名称或代码。
</ParamField>

<ParamField body="watermark.aigc_metadata.enable" type="boolean">
  是否启用隐式水印（默认：false）。
</ParamField>

<ParamField body="watermark.aigc_metadata.produce_id" type="string">
  内容生产 ID。
</ParamField>

<ParamField body="watermark.aigc_metadata.propagate_id" type="string">
  内容分发 ID。
</ParamField>

<ParamField body="watermark.aigc_watermark" type="boolean">
  显式水印开关。在合成音频的末尾添加音频节奏标记（默认：false）。
</ParamField>

由 Router 在 `GET /v2/models/byteplus/seed-audio-1.0/openapi.json` 提供的 schema 生成，这也是它在请求到达提供商之前用于校验调用的同一份文档。

### 输出

<ResponseField name="audio" type="string">
  已生成的音频数据，采用 Base64 编码。
</ResponseField>

<ResponseField name="code" type="integer">
  状态码。详情请参阅官方错误码文档。
</ResponseField>

<ResponseField name="duration" type="number">
  变速或后处理之后的时长，单位为秒。

  格式：`double`
</ResponseField>

<ResponseField name="message" type="string">
  状态详情。
</ResponseField>

<ResponseField name="original_duration" type="number">
  模型原始输出时长，单位为秒。用于计费，上限为 120 秒。

  格式：`double`
</ResponseField>

<ResponseField name="subtitle" type="object">
  音频的字幕信息。仅在请求中 audio\_config.enable\_subtitle 设置为 true 时才会出现。
</ResponseField>

<ResponseField name="subtitle.sentences" type="object[]">
  句子级字幕信息。
</ResponseField>

<ResponseField name="subtitle.sentences[].end_time" type="integer">
  片段结束时间，单位为毫秒，从音频开始处算起。
</ResponseField>

<ResponseField name="subtitle.sentences[].start_time" type="integer">
  片段开始时间，单位为毫秒，从音频开始处算起。
</ResponseField>

<ResponseField name="subtitle.sentences[].text" type="string">
  该片段的完整文本。
</ResponseField>

<ResponseField name="subtitle.text" type="string">
  与音频对应的字幕文本。
</ResponseField>

<ResponseField name="subtitle.words" type="object[]">
  单词级字幕信息。
</ResponseField>

<ResponseField name="subtitle.words[].end_time" type="integer">
  片段结束时间，单位为毫秒，从音频开始处算起。
</ResponseField>

<ResponseField name="subtitle.words[].start_time" type="integer">
  片段开始时间，单位为毫秒，从音频开始处算起。
</ResponseField>

<ResponseField name="subtitle.words[].text" type="string">
  该片段的完整文本。
</ResponseField>

<ResponseField name="url" type="string">
  临时音频 URL，有效期为 2 小时。
</ResponseField>

## 示例

### 输入

```json theme={null}
{
  "audio_config": {
    "format": "wav",
    "sample_rate": 24000
  },
  "text_prompt": "Hello from Comfy Router."
}
```

### 输出

```json theme={null}
{
  "audio": "PGJhc2U2ND4=",
  "duration": 1.2,
  "original_duration": 1.2,
  "url": "https://example.invalid/byteplus/seed-audio/generated.wav"
}
```

## 发布前须知

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

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

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

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

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

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

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