heygen/starfish 的 API 参考,由 Comfy Router 提供,模型来自 HeyGen。
快速开始
在你的 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
- 等待结果
- 入队并稍后收集
同一个请求体,发送到
POST https://api.comfy.org/v2/models/heygen/starfish/requests。只要运行被接纳,Router 就会立即以 201 返回一个 request_id;结果准备就绪后即可收集,无论是从当前进程还是其他进程。队列投递 介绍了状态查询、取消与结果收集。Schema
输入
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 提供的 schema 生成,该文档也是请求到达提供商之前 Router 用来校验调用的同一份文档。
输出
object
必填
成功的 HeyGen 文本转语音响应的载荷
string
必填
已生成音频文件的 URL
number
音频的时长,单位为秒格式:
doublestring
此生成请求的唯一标识符
object[]
词级时间数据
number
结束时间,单位为秒格式:
doublenumber
开始时间,单位为秒格式:
doublestring
该单词
示例
输入
输出
发布前须知
SDK 会生成Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。
请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入,413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载,因为结果 URL 会过期。
上文任何字段描述中提到的尺寸限制,都是提供商对该字段自身的限定,引自提供商的规范。Router 会对整个请求体另行设置上限,base64 编码的媒体内容也计入其中:参见请求体大小。
本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 comfy-sdk / @comfyorg/sdk 包还提供第二个客户端,用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图:Comfy(api_key=...) / new Comfy({ apiKey }),并带有 client.workflows、client.assets 和 client.jobs。请参阅 Comfy SDKs。
请求头
身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
使用 Router API
模型发现、验证错误、重试与计费。
限制
Router 目前不支持的功能,以及替代方案。