> ## 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 Eleven V3 with Comfy Router

> Call elevenlabs/eleven_v3 through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `elevenlabs/eleven_v3`, served by Comfy Router from Elevenlabs.

## 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:** `elevenlabs/eleven_v3`

**Endpoint:** `POST https://api.comfy.org/v2/models/elevenlabs/eleven_v3`

<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(
              "elevenlabs/eleven_v3",
              {
                  "inputs": [
                      {
                          "text": "Hello from Comfy Router.",
                          "voice_id": "21m00Tcm4TlvDq8ikWAM",
                      },
                  ],
              },
          )

      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("elevenlabs/eleven_v3", {
        inputs: [
          {
            text: "Hello from Comfy Router.",
            voice_id: "21m00Tcm4TlvDq8ikWAM",
          },
        ],
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/elevenlabs/eleven_v3 \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"inputs\": [{\"text\":\"Hello from Comfy Router.\",\"voice_id\":\"21m00Tcm4TlvDq8ikWAM\"}]}"
      ```
    </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/elevenlabs/eleven_v3/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(
              "elevenlabs/eleven_v3",
              {
                  "inputs": [
                      {
                          "text": "Hello from Comfy Router.",
                          "voice_id": "21m00Tcm4TlvDq8ikWAM",
                      },
                  ],
              },
          )
          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("elevenlabs/eleven_v3", {
        inputs: [
          {
            text: "Hello from Comfy Router.",
            voice_id: "21m00Tcm4TlvDq8ikWAM",
          },
        ],
      });
      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/elevenlabs/eleven_v3/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"inputs\": [{\"text\":\"Hello from Comfy Router.\",\"voice_id\":\"21m00Tcm4TlvDq8ikWAM\"}]}"

      # 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/elevenlabs/eleven_v3/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/elevenlabs/eleven_v3/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### Input

<ParamField body="apply_text_normalization" type="string" default="&#x22;auto&#x22;">
  Controls text normalization with three modes:
  'auto' - system automatically decides whether to apply text normalization
  'on' - text normalization will always be applied
  'off' - text normalization will be skipped

  Possible values: `auto`, `on`, `off`
</ParamField>

<ParamField body="inputs" type="object[]" required>
  A list of dialogue inputs, each containing text and a voice ID which will be converted into speech.
  The maximum number of unique voice IDs is 10.
</ParamField>

<ParamField body="inputs[].text" type="string" required>
  The text to be converted into speech.
</ParamField>

<ParamField body="inputs[].voice_id" type="string" required>
  The ID of the voice to be used for the generation.
</ParamField>

<ParamField body="language_code" type="string">
  Language code (ISO 639-1) used to enforce a language for the model and text normalization.
  If the model does not support provided language code, an error will be returned.
</ParamField>

<ParamField body="model_id" type="string">
  Identifier of the model that will be used. This route admits
  'eleven\_v3' and nothing else; any other value is rejected with 400
  before the request reaches ElevenLabs.
  The upstream ElevenLabs advice to query GET /v1/models for the
  available set does NOT describe this route, which serves one model.
  It is NOT in this schema's `required` list because Comfy Router
  fills it from the `{model}` path segment of
  /v2/models/elevenlabs/\{model}, so a Router caller omits it.
</ParamField>

<ParamField body="pronunciation_dictionary_locators" type="object[]">
  A list of pronunciation dictionary locators (id, version\_id) to be applied to the text.
  They will be applied in order. You may have up to 3 locators per request.
</ParamField>

<ParamField body="pronunciation_dictionary_locators[].pronunciation_dictionary_id" type="string" required>
  The ID of the pronunciation dictionary
</ParamField>

<ParamField body="pronunciation_dictionary_locators[].version_id" type="string" required>
  The version ID of the pronunciation dictionary
</ParamField>

<ParamField body="seed" type="integer">
  If specified, our system will make a best effort to sample deterministically.
  Repeated requests with the same seed and parameters should return the same result.
  Must be integer between 0 and 4294967295.

  Range: `0` to `4294967295`
</ParamField>

<ParamField body="settings" type="object">
  Settings controlling the dialogue generation
</ParamField>

<ParamField body="settings.stability" type="number" default="0.5">
  Determines how stable the voice is and the randomness between each generation.
  Lower values introduce broader emotional range for the voice.
  Higher values can result in a monotonous voice with limited emotion.

  Format: `double`
</ParamField>

Generated from the schema Router serves at `GET /v2/models/elevenlabs/eleven_v3/openapi.json`, the same document it validates a call against before the request reaches the provider.

### Output

<ResponseField name="*/*" type="string (binary)">
  Raw audio bytes. The Content-Type and encoding follow the requested output\_format and are forwarded from ElevenLabs. The example is a placeholder for the binary body, not JSON or base64.
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "inputs": [
    {
      "text": "Hello from Comfy Router.",
      "voice_id": "21m00Tcm4TlvDq8ikWAM"
    }
  ]
}
```

### Output

Binary body: raw bytes rather than a JSON document, returned as `*/*`, so there is no JSON example to show. The response `Content-Type` and encoding follow the request, as the Output schema above describes.

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