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

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

**Input:** Text · **Output:** Audio

## Quick start

Create a key in [your Comfy workspace](https://platform.comfy.org/profile/api-keys?onboarding=router) and export it as `COMFY_API_KEY`. The Python and TypeScript snippets use the Comfy SDKs (`pip install comfy-sdk` and `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`

**Wait for the result**

```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": "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
            "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: "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
  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\": \"Hello from Comfy. This voice is generated with the HeyGen Starfish engine.\", \"voice_id\": \"d2f4f24783d04e22ab49ee8fdc3715e0\"}"
```

**Queue and collect later**

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](https://docs.comfy.org/development/comfy-router/queue.md) walks through status, cancellation and collection.

```python Python theme={null}
import asyncio
from comfy_sdk import AsyncComfy

# Reads COMFY_API_KEY from the environment.
# Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
async def main():
    async with AsyncComfy() as client:
        handle = await client.models.submit(
            "heygen/starfish",
            {
                "text": "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
                "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.
        async 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 = await handle.get()

    print(result)

asyncio.run(main())
```

```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: "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
  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\": \"Hello from Comfy. This voice is generated with the HeyGen Starfish engine.\", \"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"
```

## Schema

### Input

**input\_type** `string`

Type of the input: 'text' for plain text, 'ssml' for SSML markup. Defaults to 'text'

**language** `string`

Base language code (e.g. 'en'). Auto-detected from text when omitted

**locale** `string`

BCP-47 locale tag (e.g. 'en-US'). When set, language is inferred from locale

**speed** `number`

Speed multiplier (0.5-2.0)

Range: `0.5` to `2`

Format: `double`

**text** `string` *required*

Text to synthesize (1-5000 characters)

**voice\_id** `string` *required*

Voice ID to use. The voice must support the starfish engine

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

**data** `object` *required*

Payload of a successful HeyGen text-to-speech response

**data.audio\_url** `string` *required*

URL of the generated audio file

**data.duration** `number`

Duration of the audio in seconds

Format: `double`

**data.request\_id** `string`

Unique identifier for this generation request

**data.word\_timestamps** `object[]`

Word-level timing data

**data.word\_timestamps\[].end** `number`

End time in seconds

Format: `double`

**data.word\_timestamps\[].start** `number`

Start time in seconds

Format: `double`

**data.word\_timestamps\[].word** `string`

The word

## Examples

### Input

```json theme={null}
{
  "text": "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
  "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, and a `413` means the request body was larger than Router accepts. Download generated assets promptly because [result URLs can expire](https://docs.comfy.org/development/comfy-router/reference.md#result-assets).

Any size limit named in a field description above is the provider's own bound on that field, quoted from the provider's specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see [request body size](https://docs.comfy.org/development/comfy-router/limitations.md#request-bodies-are-capped).

This page documents one partner model called through Comfy Router. The same `comfy-sdk` / `@comfyorg/sdk` package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: `Comfy(api_key=...)` / `new Comfy({ apiKey })`, with `client.workflows`, `client.assets` and `client.jobs`. See [Comfy SDKs](https://docs.comfy.org/development/api-development/sdks.md).

> **[Headers](https://docs.comfy.org/development/comfy-router/headers.md)**
>
> Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

> **[Using the Router API](https://docs.comfy.org/development/comfy-router/api.md)**
>
> Model discovery, validation errors, retries, and billing.

> **[Limitations](https://docs.comfy.org/development/comfy-router/limitations.md)**
>
> What Router does not do today, and what to use instead.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.