Kitta Audio 文档
API 文档

迁移指南

从历史 Open API 路径迁移到 Open API v1。

迁移指南

新接入统一使用 /api/open/v1。历史路径仅用于兼容已有客户端,不应继续用于新开发。

路径映射

历史路径Open API v1 路径
POST /api/open/create-modelPOST /api/open/v1/voices
POST /api/open/delete-modelDELETE /api/open/v1/voices/{voiceId}
POST /api/open/list-modelsGET /api/open/v1/voices
POST /api/open/lip-sync/createPOST /api/open/v1/media/lip-sync/jobs
GET /api/open/lip-sync/listGET /api/open/v1/media/lip-sync/jobs
GET /api/open/lip-sync/queryGET /api/open/v1/media/lip-sync/jobs/{jobId}

最终请求和响应结构以机器可读定义为准:

GET /api/openapi.json

建议迁移顺序

  1. 先迁移账户、音色列表和任务查询等只读接口。
  2. 为请求和响应解析补充测试后,再迁移创建类接口。
  3. 发布期间记录旧路径、新路径、HTTP 状态码和 requestId
  4. 确认产线流量不再依赖旧路径后,再从客户端移除兼容代码。

V1 请求统一使用 Bearer API Key。TTS 的音色 ID 使用 voiceId,引擎模型使用 modelIdreference_id 仅作为历史音色字段别名保留。

首次联通测试可以使用系统测试音色 00a1b221-6137-4b73-ad62-b0cbce134167;验证成功后再替换为通过 GET /api/open/v1/voices 查询到的目标音色 ID。

异步接口创建成功后应立即保存任务 ID。网络中断、轮询和支持排查都应继续使用这个 ID,不要重新创建任务。