开放接口 - 媒体解析开发文档

01 · 快速开始

发起解析请求

在请求头中加入 API Key，并在 JSON 请求体中提交一个公开媒体链接。

curl -X POST https://api.videotool.cc/openapi/parse \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://..."}'

02 · 身份验证

使用 API Key 鉴权

接口通过 X-API-Key 请求头认证，每个账号可在控制台查看或更新密钥。

X-API-KeyYOUR_API_KEY

API Key 应只保存在服务端，不要写入网页 JavaScript、移动端安装包或公开仓库。

03 · 接口说明

当前可用接口

POST/openapi/parse单链接解析

解析一个公开媒体链接

提交一个公开帖子或视频链接。成功获得可用资源后扣减一次额度，其他结果不扣费。

url string · required 公开帖子或视频链接

04 · 响应结构

成功响应

成功时返回 AjaxResult 包装的 ParseResult，资源按视频、图片、音频和文本分类。

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "resultCode": 0,
    "hasResource": true,
    "resourceType": 200,
    "descList": ["..."],
    "imgList": [],
    "videoList": [],
    "audioList": []
  }
}

05 · 错误处理

业务错误码

code	含义	扣费
`400`	url 参数为空或格式无效	不扣费
`401`	API Key 缺失、无效或已停用	不扣费
`403`	剩余调用次数不足	不扣费
`422`	解析完成但没有可用资源	不扣费
`500`	解析服务异常	不扣费

06 · 计费规则

按成功结果计费

1成功并返回可用资源时扣减次数

0失败、异常或无资源时扣减次数

当前能力范围

开放接口仅提供 POST /openapi/parse 单链接解析，不提供批量、能力查询、幂等缓存或限流端点。

通过一个接口接入媒体解析