> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-chore-sync-comfy-api-v2-spec.mintlify.site/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)でキーを作成し、`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`

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

## スキーマ

### 入力

<ParamField body="input_type" type="string">
  入力の種類: プレーンテキストの場合は 'text'、SSML マークアップの場合は 'ssml'。デフォルトは 'text'
</ParamField>

<ParamField body="language" type="string">
  ベース言語コード (例: 'en')。省略時はテキストから自動検出されます
</ParamField>

<ParamField body="locale" type="string">
  BCP-47 ロケールタグ (例: 'en-US')。設定されている場合、言語はロケールから推定されます
</ParamField>

<ParamField body="speed" type="number">
  速度の倍率 (0.5～2.0)

  範囲: `0.5` ～ `2`

  形式: `double`
</ParamField>

<ParamField body="text" type="string" required>
  合成するテキスト (1～5000 文字)
</ParamField>

<ParamField body="voice_id" type="string" required>
  使用するボイス ID。ボイスは starfish エンジンをサポートしている必要があります
</ParamField>

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

### 出力

<ResponseField name="data" type="object" required>
  成功した HeyGen テキスト読み上げレスポンスのペイロード
</ResponseField>

<ResponseField name="data.audio_url" type="string" required>
  生成されたオーディオファイルの URL
</ResponseField>

<ResponseField name="data.duration" type="number">
  オーディオの再生時間 (秒)

  形式: `double`
</ResponseField>

<ResponseField name="data.request_id" type="string">
  この生成リクエストの一意の識別子
</ResponseField>

<ResponseField name="data.word_timestamps" type="object[]">
  単語単位のタイミングデータ
</ResponseField>

<ResponseField name="data.word_timestamps[].end" type="number">
  終了時間 (秒)

  形式: `double`
</ResponseField>

<ResponseField name="data.word_timestamps[].start" type="number">
  開始時間 (秒)

  形式: `double`
</ResponseField>

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

## 例

### 入力

```json theme={null}
{
  "text": "This is a billing verification test for HeyGen speech generation.",
  "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 が入力を拒否したことを意味します。生成されたアセットは [結果 URL の有効期限](/ja/development/comfy-router/reference#結果アセット) があるため、早めにダウンロードしてください。

<CardGroup cols={3}>
  <Card title="ヘッダー" icon="list" href="/ja/development/comfy-router/quickstart">
    認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
  </Card>

  <Card title="Router API の利用" icon="code" href="/ja/development/comfy-router/quickstart">
    モデルの検出、バリデーションエラー、リトライ、課金。
  </Card>

  <Card title="制限事項" icon="triangle-exclamation" href="/ja/development/comfy-router/limitations">
    Router が現在対応していないことと、代替手段。
  </Card>
</CardGroup>