Use Starfish with Comfy Router

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

Quick start

Create a key at 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

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment. Each call sends a fresh
# Idempotency-Key and waits up to 10 minutes for the finished result.
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)

import { comfy } from "@comfyorg/sdk";

// Reads COMFY_API_KEY from the environment. Each call sends a fresh
// Idempotency-Key and waits up to 10 minutes for the finished result.
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);

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\"}"

Schema

Input

string

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

string

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

string

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

number

Speed multiplier (0.5-2.0)Range: 0.5 to 2Format: double

string

required

Text to synthesize (1-5000 characters)

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

object

required

Payload of a successful HeyGen text-to-speech response

string

required

URL of the generated audio file

number

Duration of the audio in secondsFormat: double

string

Unique identifier for this generation request

object[]

Word-level timing data

number

End time in secondsFormat: double

number

Start time in secondsFormat: double

string

The word

Examples

Input

{
  "text": "This is a billing verification test for HeyGen speech generation.",
  "voice_id": "d2f4f24783d04e22ab49ee8fdc3715e0"
}

Output

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

Before you ship

The snippets above are the shortest working call. Three things are the same for every model and are documented once on the Comfy Router headers page: send an Idempotency-Key on every paid call and reuse it when you retry, expect the connection to be held up to Router’s 10 minute deadline, and keep X-Comfy-Request-Id from every response. The SDKs do all three for you; the cURL tab does none of them. On failure, X-Comfy-Error-Type names the bucket, and a 422 means the body failed the model’s schema and was never billed.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Quick Start

Typed error handling in Python and TypeScript, reading the 422, walking the catalog.

Limitations

What Router does not do today, and what to use instead.

Develop with Comfy

Deploy ComfyUI

Run Workflows

Comfy Router

Comfy CLI

Specifications

Use Starfish with Comfy Router

Quick start

Schema

Input

Output

Examples

Input

Output

Before you ship

Headers

Quick Start

Limitations

​Quick start

​Schema

​Input

​Output

​Examples

​Input

​Output

​Before you ship

Headers

Quick Start

Limitations

Quick start

Schema

Input

Output

Examples

Input

Output

Before you ship