开发者接口 · 第一版

一套接口
连接多平台媒体能力

提交公开分享链接，统一获取视频、图片、音频和结构化元数据，快速接入你的工具与工作流。

获取 API Key 查看 OpenAPI 3.1

快速开始

三步完成首次调用

正式工具应使用 API Key 调用版本化接口，完整 Key 只显示一次。

注册并进入控制台

自主注册或登录客户账号；新账号可先使用每日免费额度，需要更高用量时在控制台选择套餐。

创建 API Key

选择允许平台和到期时间。完整 Key 只显示一次，请立即复制保存。

发起请求

把 Key 放入 Bearer 请求头，将公开分享链接作为 JSON 提交。

POST /v1/music

音乐解析与查询

provider 可选 netease、qqmusic、kuwo、qishui、aggregate；不同 provider 只接受下表列出的 action。

provider	action	主要参数
`netease`	`parse/search/song/url/lyric/playlist/album`	公开链接或 ID、keyword、level、limit、offset
`qqmusic`	`parse/song/mv/search`	公开链接；搜索使用 keyword；可选 n/page/count
`kuwo`	`parse`	酷我公开歌曲链接
`qishui`	`parse`	汽水公开分享链接
`aggregate`	`song/mv/url`	音乐 ID + media（tencent/netease）；Key 需勾选“音乐聚合”权限

curl -X POST "https://你的域名/v1/music" \
  -H "Authorization: Bearer wm_live_替换成你的密钥" \
  -H "Content-Type: application/json" \
  -d '{"provider":"netease","action":"parse","url":"https://music.163.com/song?id=865632948","level":"lossless"}'

可播放或下载的资源仍在 data.assets；搜索、歌词、歌单和专辑属于元数据操作，结果在 data.result，此时 assets 可以为空。

POST /v1/parse

url 必填；platform 建议保持 auto，系统会按链接域名识别平台。

curl -X POST "https://你的域名/v1/parse" \
  -H "Authorization: Bearer wm_live_替换成你的密钥" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://平台公开分享链接","platform":"auto"}'

const response = await fetch("https://你的域名/v1/parse", {
  method: "POST",
  headers: {
    "Authorization": "Bearer wm_live_替换成你的密钥",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    url: "https://平台公开分享链接",
    platform: "auto"
  })
});

const result = await response.json();
if (!response.ok) throw new Error(`${result.code}: ${result.message}`);
console.log(result.data.assets);

import requests

response = requests.post(
    "https://你的域名/v1/parse",
    headers={"Authorization": "Bearer wm_live_替换成你的密钥"},
    json={
        "url": "https://平台公开分享链接",
        "platform": "auto",
    },
    timeout=40,
)
result = response.json()
response.raise_for_status()
print(result["data"]["assets"])

请求字段

url：平台公开分享链接，必填。
platform：省略或填 auto；手动填写时必须与链接匹配。

平台标识

douyinkuaishouxiaohongshutoutiaodoubaopipixpipigxjimengzuiyoubilibiliyoutubetiktokxiguahaokanweishipearvideoacfunzhihuoasismeipaiquanminhuyatwitterinstagramwxchannelsweiboqianwenneteaseqqmusickuwoqishui

部分新增平台由外部聚合服务提供，实际可用性受第三方接口和原平台链接状态影响。

认证与配额

请求头格式：Authorization: Bearer <API_KEY>。
Key 不得放在 URL、前端网页源码、日志或公开仓库中。
响应头 RateLimit-* 表示分钟额度；429 时按 Retry-After 重试。
usage.remaining 是当前日配额的估算剩余量。

成功响应

{
  "request_id": "req_xxx",
  "code": "OK",
  "message": "解析成功",
  "data": {
    "platform": "doubao",
    "content_type": "video",
    "title": "",
    "author": null,
    "assets": [{"type": "video", "url": "https://..."}]
  },
  "usage": {"cost": 1, "remaining": 99}
}

真正需要下载的资源位于 data.assets。每个元素的 type 是 video、image 或 audio，url 是资源地址。

常见错误

HTTP	code	处理方式
401	`INVALID_API_KEY`	检查 Key 是否复制完整、已吊销或客户已停用
401	`API_KEY_EXPIRED`	在客户控制台创建新的 API Key
402	`INSUFFICIENT_CREDITS`	前往客户控制台查看额度并升级或续费套餐
403	`PLATFORM_FORBIDDEN`	为 Key 增加该平台权限
403	`SUBSCRIPTION_EXPIRED`	客户订阅已到期或取消，确认续费订单后恢复
422	`UNSUPPORTED_URL`	检查链接是否来自支持的平台及公开域名
422	`PLATFORM_MISMATCH`	改用 `auto` 或填写正确的平台标识
422	`INVALID_MUSIC_REQUEST`	检查音乐 provider、action 与必填参数组合
429	`RATE_LIMITED`	读取 `Retry-After`，稍后重试
429	`QUOTA_EXCEEDED`	日/月额度已用完，前往客户控制台升级或续费套餐
502/503	`PARSE_FAILED` / `MUSIC_FAILED` 等	保留 `request_id`，稍后重试或交给管理员排查

不要在浏览器公开页面中直接调用并暴露 API Key。浏览器扩展、桌面程序或服务器端工具应把 Key 存在安全配置中。

机器可读契约：OpenAPI 3.1

一套接口连接多平台媒体能力