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

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

API Reference for `heygen/starfish`, served by Comfy Router from HeyGen.

## 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:** `heygen/starfish`

**Endpoint:** `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">
    <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/heygen/starfish/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(
              "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

### Input

<ParamField body="input_type" type="string">
  Type of the input: 'text' for plain text, 'ssml' for SSML markup. Defaults to 'text'
</ParamField>

<ParamField body="language" type="string">
  Base language code (e.g. 'en'). Auto-detected from text when omitted
</ParamField>

<ParamField body="locale" type="string">
  BCP-47 locale tag (e.g. 'en-US'). When set, language is inferred from locale
</ParamField>

<ParamField body="speed" type="number">
  Speed multiplier (0.5-2.0)

  Range: `0.5` to `2`

  Format: `double`
</ParamField>

<ParamField body="text" type="string" required>
  Text to synthesize (1-5000 characters)
</ParamField>

<ParamField body="voice_id" type="string" required>
  Voice ID to use. The voice must support the starfish engine
</ParamField>

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

### Output

<ResponseField name="data" type="object" required>
  Payload of a successful HeyGen text-to-speech response
</ResponseField>

<ResponseField name="data.audio_url" type="string" required>
  URL of the generated audio file
</ResponseField>

<ResponseField name="data.duration" type="number">
  Duration of the audio in seconds

  Format: `double`
</ResponseField>

<ResponseField name="data.request_id" type="string">
  Unique identifier for this generation request
</ResponseField>

<ResponseField name="data.word_timestamps" type="object[]">
  Word-level timing data
</ResponseField>

<ResponseField name="data.word_timestamps[].end" type="number">
  End time in seconds

  Format: `double`
</ResponseField>

<ResponseField name="data.word_timestamps[].start" type="number">
  Start time in seconds

  Format: `double`
</ResponseField>

<ResponseField name="data.word_timestamps[].word" type="string">
  The word
</ResponseField>

## Examples

### Input

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

### Output

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

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