Documentation Index
Fetch the complete documentation index at: https://docs.vmeg.ai/llms.txt
Use this file to discover all available pages before exploring further.
Webhook 是什么
异步任务完成时（TTS、文本翻译、声音克隆、音视频翻译），VMEG 向你配置的 URL 发送 HTTP POST。这是接收 任务结果 的方式 —create-async 的 HTTP 响应只确认受理（taskId 等）。
Webhook 是异步结果的 投递机制，不是独立产品。
为什么需要
| 未配置 Webhook | 已配置 Webhook |
|---|---|
create-async 只返回 taskId | POST 请求体含完整交付物 |
需轮询 GET /openapi/v1/tasks/detail | 任务完成时主动通知你的服务 |
*-create-async 前配置 Webhook。
配置
在 vmeg.ai 的 API 配置 页（登录）：- 设置 Webhook URL（建议使用 HTTPS）。
- 保存 URL 后，VMEG 会自动生成 Webhook Secret 并在同一页面展示。复制该 Secret 用于 签名校验 — 无需自行设置。
接收端要求
你的接口必须：- 快速返回 2xx（数秒内）。重逻辑放入队列或后台 worker。
- 校验签名（对原始请求体）— 见 Webhook 签名校验。
- 按 JSON 中的
pipelineKey去重。同一异步完成的重试会携带相同的pipelineKey— 见 Webhook 请求体。若该键已处理过，仍应返回 2xx，但不要重复执行业务副作用。
Webhook 请求体
任务完成时 POST JSON 带有event 字段（如 openapi-tts），表示哪类产品结束。事件表与公共结构见 Webhook 请求体。
各产品字段定义见 API 参考 中对应 create-async 的 Callbacks。