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

# Comfy Router で Starfish を使う

> Comfy Router 経由で heygen/starfish を呼び出します: エンドポイント、リクエスト形状、および Router が返すレスポンスについて説明します。

`heygen/starfish` の API リファレンス。HeyGen から Comfy Router が提供します。

**入力：** テキスト · **出力：** オーディオ

## クイックスタート

[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK（`pip install comfy-sdk`、`npm install @comfyorg/sdk`）を使用しています。cURL のスニペットは、生の HTTP で同じ呼び出しを行います。

**モデル ID:** `heygen/starfish`

**エンドポイント:** `POST https://api.comfy.org/v2/models/heygen/starfish`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は冪等キーを自動的に作成し、自動リトライのために再利用します。
> 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";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は冪等キーを自動的に作成し、自動リトライのために再利用します。
> 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\"}"
> ```

> [tab] キューに送信して後で収集する
>
> 同じボディを `POST https://api.comfy.org/v2/models/heygen/starfish/requests` に送信します。Router は実行が受け付けられるとすぐに `201` と `request_id` を返し、結果は準備ができた時点で、このプロセスからでも別のプロセスからでも収集できます。[キュー配信](https://docs.comfy.org/ja/development/comfy-router/queue.md)では、ステータス、キャンセル、収集について説明します。
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
> 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)  # モデル ID と合わせれば、別のプロセスに必要なものはこれだけです
>
>         # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
>         async for update in handle.iter_events():
>             print(update.status, update.queue_position)
>
>         # プロバイダー自身のペイロードで、models.run() が返す値と同じです。
>         # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを送出します。
>         result = await handle.get()
>
>     print(result)
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
> 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); // モデル ID と合わせれば、別のプロセスに必要なものはこれだけです
>
> // リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで reject されます。
> const result = await handle.get();
>
> console.log(result.data);
> ```
>
> ```bash cURL theme={null}
> # 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
> 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. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> 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. 収集。モデルのネイティブ出力とともに 200、まだ実行中はステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/heygen/starfish/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**input\_type** `string`

入力の種類: プレーンテキストの場合は 'text'、SSML マークアップの場合は 'ssml'。デフォルトは 'text'

**language** `string`

ベース言語コード (例: 'en')。省略時はテキストから自動検出されます

**locale** `string`

BCP-47 ロケールタグ (例: 'en-US')。設定されている場合、言語はロケールから推定されます

**speed** `number`

速度の倍率 (0.5～2.0)

範囲: `0.5` ～ `2`

形式: `double`

**text** `string` *required*

合成するテキスト (1～5000 文字)

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

使用するボイス ID。ボイスは starfish エンジンをサポートしている必要があります

Router が `GET /v2/models/heygen/starfish/openapi.json` で提供するスキーマから生成されます。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する対象となるドキュメントと同じものです。

### 出力

**data** `object` *required*

成功した HeyGen テキスト読み上げレスポンスのペイロード

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

生成されたオーディオファイルの URL

**data.duration** `number`

オーディオの再生時間 (秒)

形式: `double`

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

この生成リクエストの一意の識別子

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

単語単位のタイミングデータ

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

終了時間 (秒)

形式: `double`

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

開始時間 (秒)

形式: `double`

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

単語

## 例

### 入力

```json theme={null}
{
  "text": "Hello from Comfy. This voice is generated with the HeyGen Starfish engine.",
  "voice_id": "d2f4f24783d04e22ab49ee8fdc3715e0"
}
```

### 出力

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

## 出荷前の確認

SDK は `Idempotency-Key` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。

リクエストが失敗すると、Router は理由を説明する `X-Comfy-Error-Type` レスポンスヘッダーを送信します。`422` は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、`413` はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは [結果 URL の有効期限](https://docs.comfy.org/ja/development/comfy-router/reference.md#結果アセット) があるため、早めにダウンロードしてください。

上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。[リクエスト本文のサイズ](https://docs.comfy.org/ja/development/comfy-router/limitations.md) を参照してください。

このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ `comfy-sdk` / `@comfyorg/sdk` パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: `Comfy(api_key=...)` / `new Comfy({ apiKey })`、および `client.workflows`、`client.assets`、`client.jobs`。[Comfy SDKs](https://docs.comfy.org/ja/development/api-development/sdks.md) を参照してください。

> [card] [ヘッダー](https://docs.comfy.org/ja/development/comfy-router/headers.md)
>
> 認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

> [card] [Router API の利用](https://docs.comfy.org/ja/development/comfy-router/api.md)
>
> モデルの検出、バリデーションエラー、リトライ、課金。

> [card] [制限事項](https://docs.comfy.org/ja/development/comfy-router/limitations.md)
>
> Router が現在対応していないことと、代替手段。


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