快速开始

本指南将帮助你在 5 分钟内完成第一次 API 调用。

API 地址说明
以下示例中的 $API_HOST 为 API 服务地址，请替换为以下地址。

前置条件

已获取 app-key（如未获取，请参考开通服务）

可发送 HTTP 请求的工具（如 curl、Postman、Apifox）

第 1 步：获取 API Key

联系管理员获取 app-key，该密钥用于所有 API 请求的身份认证。

app-key: your_app_key_here

第 2 步：上传素材文件

文件上传采用 预签名 URL 方式，分 3 步完成：

2.1 申请上传地址

返回示例：

{
  "code": 10000,
  "message": "Success",
  "data": {
    "file_id": "abc123",
    "upload_url": "https://oss.example.com/presigned-url...",
    "oss_key": "uploads/abc123/demo.mp4"
  }
}

2.2 上传文件到 OSS

使用返回的 upload_url 直接上传文件：

2.3 确认上传完成

上传完成后，OSS 会自动回调平台确认。你也可以通过文件详情接口确认文件状态：

第 3 步：创建第一个任务

以 语音合成（TTS） 为例，创建一个文本转语音任务：

返回示例：

{
  "code": 10000,
  "message": "Success",
  "data": {
    "task_id": "task_xyz789",
    "status": 1,
    "status_name": "processing",
    "estimated_points": 7.2
  }
}

第 4 步：获取任务结果

有 3 种方式获取任务结果：

方式一：回调通知（推荐）

在创建任务时传入 callback_url，任务完成后平台会自动向该地址发送 POST 请求，携带任务结果数据。

方式二：主动轮询

返回示例：

{
  "code": 10000,
  "message": "Success",
  "data": {
    "task_id": "task_xyz789",
    "status": 2,
    "status_name": "completed",
    "estimated_points": 7.2,
    "consumed_points": 7.2,
    "results": {
      "audio_file_id": "file_abc",
      "audio_url": "https://..."
    }
  }
}

方式三：SSE 实时推送

SSE 会推送以下事件：

事件类型	说明
`connected`	连接建立
`heartbeat`	心跳保活
`progress`	任务进度更新
`complete`	任务完成
`error`	任务失败

前置条件#

第 1 步：获取 API Key#

第 2 步：上传素材文件#

2.1 申请上传地址#

2.2 上传文件到 OSS#

2.3 确认上传完成#

第 3 步：创建第一个任务#

第 4 步：获取任务结果#

方式一：回调通知（推荐）#

方式二：主动轮询#

方式三：SSE 实时推送#

完整示例：TTS 全流程#

前置条件

第 1 步：获取 API Key

第 2 步：上传素材文件

2.1 申请上传地址

2.2 上传文件到 OSS

2.3 确认上传完成

第 3 步：创建第一个任务

第 4 步：获取任务结果

方式一：回调通知（推荐）

方式二：主动轮询

方式三：SSE 实时推送

完整示例：TTS 全流程