API文档

开放平台 API 文档 (v1)

本文档描述了音子AI开放平台 API 的使用方法。开发者可以通过 API 进行订单创建、查询等操作。

鉴权 (Authentication)

所有接口均需要通过 apiKey 进行鉴权。系统将根据 apiKey 识别用户，而不依赖 Session 或 Token。 您可以在"个人中心" -> "API Key" 中获取您的密钥。

鉴权方式支持以下两种：

1. Header 鉴权 (推荐)

   Authorization: Bearer <your_api_key>
   

2. Query 参数鉴权

   ?apiKey=<your_api_key>
   

基础 URL

https://api.yinziai.com

---

接口列表

1. 创建订单 (Create Order)

创建异步处理订单。系统会自动生成订单号并返回。

注意: 提交订单时会先预扣该订单类型的最低积分；订单完成后系统会按实际积分结算，多退少补。

• URL: /api/open/v1/order/create
• Method: POST
• Content-Type: application/json

请求参数

参数名	类型	必填	说明
orderType	string	是	订单类型，见下文枚举
stuff	object	是	素材信息
stuff.pathKey	string	是	资源地址（支持 HTTP 链接）

请求示例

音轨分离 (track-separation)

将音频分离为人声和伴奏两个轨道。

{
  "orderType": "track-separation",
  "stuff": {
    "pathKey": "https://example.com/audio.mp3"
  }
}

提取人声 (extract-voice)

从音频中提取人声部分。

{
  "orderType": "extract-voice",
  "stuff": {
    "pathKey": "https://example.com/audio.mp3"
  }
}

提取伴奏 (extract-music)

从音频中提取伴奏/背景音乐部分。

{
  "orderType": "extract-music",
  "stuff": {
    "pathKey": "https://example.com/audio.mp3"
  }
}

文案提取 (extract-text)

从视频或音频中提取文字内容。

{
  "orderType": "extract-text",
  "stuff": {
    "pathKey": "https://example.com/video.mp4"
  }
}

响应示例

{
  "code": 0,
  "data": {
    "orderNo": "abc123XYZ789defGHI",
    "orderType": "track-separation",
    "orderStatus": "processing",
    "payStatus": "waiting",
    "messageId": "task-id-123"
  },
  "msg": "success"
}

响应字段说明

字段	类型	说明
orderNo	string	订单号，用于后续查询
orderType	string	订单类型
orderStatus	string	订单状态
payStatus	string	支付状态
messageId	string	任务消息ID

---

2. 查询订单 (Query Order)

查询订单的处理状态和结果。订单处理完成后，会返回处理结果的下载链接。

• URL: /api/open/v1/order/query
• Method: GET

请求参数

参数名	类型	必填	说明
orderNo	string	是	订单号

请求示例

GET /api/open/v1/order/query?orderNo=abc123XYZ789defGHI
Authorization: Bearer <your_api_key>

响应示例 (处理中)

{
  "code": 0,
  "data": {
    "orderNo": "abc123XYZ789defGHI",
    "orderType": "track-separation",
    "status": "processing",
    "cost": 0,
    "reason": null,
    "stuffs": [],
    "balance": 1000
  },
  "msg": "success"
}

响应示例 (处理完成)

{
  "code": 0,
  "data": {
    "orderNo": "abc123XYZ789defGHI",
    "orderType": "track-separation",
    "status": "finish",
    "cost": 10,
    "reason": null,
    "stuffs": [
      {
        "name": "vocals.mp3",
        "business": "vocals",
        "url": "https://cdn.example.com/result/vocals.mp3"
      },
      {
        "name": "accompaniment.mp3",
        "business": "accompaniment",
        "url": "https://cdn.example.com/result/accompaniment.mp3"
      }
    ],
    "balance": 990
  },
  "msg": "success"
}

响应字段说明

字段	类型	说明
orderNo	string	订单号
orderType	string	订单类型
status	string	订单状态
cost	number	消耗积分
reason	string	失败原因（仅失败时有值）
stuffs	array	处理结果列表
stuffs[].name	string	文件名
stuffs[].business	string	业务类型 (vocals/accompaniment/caption等)
stuffs[].url	string	下载链接（有效期 1 小时）
balance	number	当前用户可用积分余额

---

3. 短视频解析 (Short Video Analyze)

实时解析短视频分享链接，获取视频信息和无水印下载地址。

注意: 此接口为实时接口，会立即扣费并返回结果。

• URL: /api/open/v1/short-video/analyze
• Method: POST
• Content-Type: application/json

请求参数

参数名	类型	必填	说明
link	string	是	短视频分享链接

请求示例

{
  "link": "https://v.douyin.com/ixxxxxx/"
}

响应示例

{
  "code": 0,
  "data": {
    "title": "视频标题",
    "author": "作者昵称",
    "cover": "https://cdn.example.com/cover.jpg",
    "videoUrl": "https://cdn.example.com/video.mp4",
    "musicUrl": "https://cdn.example.com/music.mp3",
    "balance": 990
  },
  "msg": "success"
}

响应字段说明

字段	类型	说明
title	string	视频标题
author	string	作者昵称
cover	string	封面图地址
videoUrl	string	无水印视频下载地址
musicUrl	string	背景音乐下载地址（如有）
balance	number	当前用户可用积分余额

---

错误码说明

错误码	说明
0	成功
400	请求参数错误
401	鉴权失败 (API Key 无效或缺失)
500	服务器内部错误

常见错误信息

错误信息	说明
API Key is required	缺少 API Key
Invalid API Key	API Key 无效
pathKey is required	缺少资源地址
Order not found	订单不存在或不属于当前用户
ErrorCode.USER_BLANCE_NOT_ENOUGH	积分余额不足

---

附录

OrderType (订单类型)

值	说明
track-separation	音轨分离（分离人声和伴奏）
extract-voice	提取人声
extract-music	提取伴奏
extract-text	文案提取

OrderStatus (订单状态)

值	说明
pending	排队中
processing	处理中
finish	完成
failed	失败
timeout	超时

支持的短视频平台

• 抖音
• 快手
• 小红书
• 微博
• 等主流短视频平台