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

# Use Seed Audio 1.0 with Comfy Router

> Call byteplus/seed-audio-1.0 through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `byteplus/seed-audio-1.0`, served by Comfy Router from BytePlus.

## Quick start

Create a key in [your Comfy workspace](https://platform.comfy.org/profile/api-keys) and export it as `COMFY_API_KEY`. The Python and TypeScript snippets use the Comfy SDKs (`pip install comfy-sdk`, `npm install @comfyorg/sdk`); the cURL snippet is the same call over raw HTTP.

**Model ID:** `byteplus/seed-audio-1.0`

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

<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(
              "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";

      // 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("byteplus/seed-audio-1.0", {
        audio_config: {
          format: "wav",
          sample_rate: 24000,
        },
        text_prompt: "Hello from Comfy Router.",
      });

      console.log(data);
      ```

      ```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="Queue and collect later">
    <Note>
      Queued delivery is rolling out per workspace. Until yours is enabled, the submit route answers `403` with `X-Comfy-Error-Type: not_enabled`. Nothing about the request is wrong, and the same body works through the synchronous route in the meantime.
    </Note>

    The same body, sent to `POST https://api.comfy.org/v2/models/byteplus/seed-audio-1.0/requests`. Router answers `201` with a `request_id` as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. [Queued delivery](/development/comfy-router/queue) walks through status, cancellation and collection.

    <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(
              "byteplus/seed-audio-1.0",
              {
                  "audio_config": {
                      "format": "wav",
                      "sample_rate": 24000,
                  },
                  "text_prompt": "Hello from Comfy Router.",
              },
          )
          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("byteplus/seed-audio-1.0", {
        audio_config: {
          format: "wav",
          sample_rate: 24000,
        },
        text_prompt: "Hello from Comfy Router.",
      });
      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/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. 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/byteplus/seed-audio-1.0/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/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">
  Output audio configuration.
</ParamField>

<ParamField body="audio_config.enable_subtitle" type="boolean">
  Whether to enable the subtitle service. When enabled, the response includes utterance- and word-level timestamps (default: false).
</ParamField>

<ParamField body="audio_config.format" type="string">
  Output audio format: wav (default), mp3, pcm or ogg\_opus.

  Possible values: `wav`, `mp3`, `pcm`, `ogg_opus`
</ParamField>

<ParamField body="audio_config.loudness_rate" type="integer">
  -50 to 100; 100 means 2.0x volume, -50 means 0.5x volume (default: 0).

  Range: `-50` to `100`
</ParamField>

<ParamField body="audio_config.pitch_rate" type="integer">
  -12 to 12 (default: 0).

  Range: `-12` to `12`
</ParamField>

<ParamField body="audio_config.sample_rate" type="integer">
  Output sample rate: 8000, 16000, 24000 (default), 32000, 44100 or 48000.

  Possible values: `8000`, `16000`, `24000`, `32000`, `44100`, `48000`
</ParamField>

<ParamField body="audio_config.speech_rate" type="integer">
  -50 to 100; 100 means 2.0x speed, -50 means 0.5x speed (default: 0).

  Range: `-50` to `100`
</ParamField>

<ParamField body="model" type="string">
  Model identifier. Supported models: seed-audio-1.0 and seed-audio-1.0-multilingual. A direct v1 call to POST /proxy/byteplus/api/v3/tts/create MUST supply it — the proxy refuses any other value, and an omitted one, with a 400. It is NOT in this schema's `required` list because Comfy Router fills it from the `{model}` path segment of /v2/models/byteplus/\{model}, so a Router caller omits it.
</ParamField>

<ParamField body="references" type="object[]">
  Reference resources. Omit for text-only generation. Up to 3 audio references (each up to 30 seconds and 10 MB decoded; wav, mp3, pcm or ogg\_opus) or exactly 1 image reference (up to 10 MB decoded; jpeg, png or webp). Image references cannot be mixed with audio references. Those ceilings are BytePlus's and are stated in DECODED bytes: base64 inflates an asset by about 4/3, and a Comfy Router call is capped at 10 MiB for the whole JSON document, so an inline `audio_data`/`image_data` reference sent to /v2/models/byteplus/\{model} has to stay under roughly 7.5 MB decoded. Use `audio_url`/`image_url` for anything larger — a reference at BytePlus's own 10 MB maximum is refused 413 before validation runs if it is inlined.
</ParamField>

<ParamField body="references[].audio_data" type="string">
  Base64-encoded reference audio.
</ParamField>

<ParamField body="references[].audio_url" type="string">
  URL of a remote reference audio file.
</ParamField>

<ParamField body="references[].image_data" type="string">
  Base64-encoded reference image.
</ParamField>

<ParamField body="references[].image_url" type="string">
  URL of a remote reference image.
</ParamField>

<ParamField body="references[].speaker" type="string">
  Voice ID. Can be a supported Doubao TTS voice or a voice-clone voice ID.
</ParamField>

<ParamField body="text_prompt" type="string" required>
  Prompt or text to synthesize (1 to 3,000 characters; an empty string is refused). When audio references are provided, reference them by order using @Audio1, @Audio2 and @Audio3.
</ParamField>

<ParamField body="watermark" type="object">
  Watermark configuration object. An empty object is accepted.
</ParamField>

<ParamField body="watermark.aigc_metadata" type="object">
  Implicit watermark. Adds metadata to the synthesized audio header.
</ParamField>

<ParamField body="watermark.aigc_metadata.content_producer" type="string">
  Name or code of the synthesis service provider.
</ParamField>

<ParamField body="watermark.aigc_metadata.content_propagator" type="string">
  Name or code of the content distribution service provider.
</ParamField>

<ParamField body="watermark.aigc_metadata.enable" type="boolean">
  Whether to enable the implicit watermark (default: false).
</ParamField>

<ParamField body="watermark.aigc_metadata.produce_id" type="string">
  Content production ID.
</ParamField>

<ParamField body="watermark.aigc_metadata.propagate_id" type="string">
  Content distribution ID.
</ParamField>

<ParamField body="watermark.aigc_watermark" type="boolean">
  Explicit watermark switch. Adds an audio rhythm marker at the end of the synthesized audio (default: false).
</ParamField>

Generated from the schema Router serves at `GET /v2/models/byteplus/seed-audio-1.0/openapi.json`, the same document it validates a call against before the request reaches the provider.

### Output

<ResponseField name="audio" type="string">
  Generated audio data, Base64-encoded.
</ResponseField>

<ResponseField name="code" type="integer">
  Status code. Refer to the official error-code document for details.
</ResponseField>

<ResponseField name="duration" type="number">
  Duration after speed or post-processing, in seconds.

  Format: `double`
</ResponseField>

<ResponseField name="message" type="string">
  Status details.
</ResponseField>

<ResponseField name="original_duration" type="number">
  Original model output duration in seconds. Used for billing and capped at 120 seconds.

  Format: `double`
</ResponseField>

<ResponseField name="subtitle" type="object">
  Subtitle information for the audio. Present only when audio\_config.enable\_subtitle is set to true in the request.
</ResponseField>

<ResponseField name="subtitle.sentences" type="object[]">
  Utterance-level subtitle information.
</ResponseField>

<ResponseField name="subtitle.sentences[].end_time" type="integer">
  Segment end time, in milliseconds from the beginning of the audio.
</ResponseField>

<ResponseField name="subtitle.sentences[].start_time" type="integer">
  Segment start time, in milliseconds from the beginning of the audio.
</ResponseField>

<ResponseField name="subtitle.sentences[].text" type="string">
  The complete text of the segment.
</ResponseField>

<ResponseField name="subtitle.text" type="string">
  Subtitle text corresponding to the audio.
</ResponseField>

<ResponseField name="subtitle.words" type="object[]">
  Word-level subtitle information.
</ResponseField>

<ResponseField name="subtitle.words[].end_time" type="integer">
  Segment end time, in milliseconds from the beginning of the audio.
</ResponseField>

<ResponseField name="subtitle.words[].start_time" type="integer">
  Segment start time, in milliseconds from the beginning of the audio.
</ResponseField>

<ResponseField name="subtitle.words[].text" type="string">
  The complete text of the segment.
</ResponseField>

<ResponseField name="url" type="string">
  Temporary audio URL, valid for 2 hours.
</ResponseField>

## Examples

### Input

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

### Output

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

## Before you ship

The SDKs create an `Idempotency-Key` and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an `X-Comfy-Error-Type` response header explaining why. A `422` means Router rejected the input before calling the provider. Download generated assets promptly because [result URLs can expire](/development/comfy-router/reference#result-assets).

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Using the Router API" icon="code" href="/development/comfy-router/api">
    Model discovery, validation errors, retries, and billing.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>