heygen/starfish の API リファレンス。HeyGen から Comfy Router が提供します。
クイックスタート
Comfy ワークスペースでキーを作成し、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
- Wait for the result
- Queue and collect later
スキーマ
入力
string
入力の種類: プレーンテキストの場合は ‘text’、SSML マークアップの場合は ‘ssml’。デフォルトは ‘text’
string
ベース言語コード (例: ‘en’)。省略時はテキストから自動検出されます
string
BCP-47 ロケールタグ (例: ‘en-US’)。設定されている場合、言語はロケールから推定されます
number
速度の倍率 (0.5~2.0)範囲:
0.5 ~ 2形式: doublestring
必須
合成するテキスト (1~5000 文字)
string
必須
使用するボイス ID。ボイスは starfish エンジンをサポートしている必要があります
GET /v2/models/heygen/starfish/openapi.json で提供するスキーマから生成されます。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する対象となるドキュメントと同じものです。
出力
object
必須
成功した HeyGen テキスト読み上げレスポンスのペイロード
string
必須
生成されたオーディオファイルの URL
number
オーディオの再生時間 (秒)形式:
doublestring
この生成リクエストの一意の識別子
object[]
単語単位のタイミングデータ
number
終了時間 (秒)形式:
doublenumber
開始時間 (秒)形式:
doublestring
単語
例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を示す X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。