跳到主要内容

视频文件同步接口

1. 接口介绍​

该接口对视频内容进行检测识别，并同步返回识别结果。

  • 视频文件大小：不超过 100M；
  • 支持的格式：flv、mkv、mp4、rmvb、avi、wmv、3gp、ts、mov、gif、m3u8、mpg/mpeg、mxf。

截图分辨率​

如果视频的短边分辨率超过 1024 像素，则截取的图片以 1024/短边 等比例截取。例如：视频分辨率为 1920x1080， 截图的分辨率为 1820x1024。

2. 请求​

2.1 请求地址​

区域请求地址
国内https://api.video.tuputech.com/v3/recognition/video/syncscan/<secretId>
国外https://api-oversea.video.tuputech.com/v3/recognition/video/syncscan/<secretId>
提示

<secretId> 需替换为您的应用 SID，请联系客户经理为您开通及配置。关于 SID 详见 常见问题（FAQ）。

2.2 请求方法​

POST

2.3 请求头​

Content-Type: multipart/form-data 或 application/json

2.4 超时时间及异常处理​

建议配置超时时间 60 秒，在 HTTP 响应状态码非 200 或业务状态码不为 0 时进行重试。

危险

由于模型基于请求流量动态伸缩，在空闲一定时间后会关闭（部分专用模型空闲一定时间后会关闭全部实例）。 由于模型冷启动耗时较长，部分请求可能无法处理，最终返回非 200 HTTP 状态码或业务状态码 101。该现象可能在以下情况下出现：

  • 初次请求
  • 长时间未调用后再次请求
  • 请求流量突增
  • 请求存在规律性的流量波动（例如每隔超过 5 分钟请求一批数据，或仅在工作日期间有大量请求）

针对以上情况，我们分别建议您：

  • 间隔 2~3 分钟后重试
  • 间隔 2~3 分钟后重试，并且后续保持至少每分钟 1 次调用
  • 提前进行预热，或及时联系我们扩容
  • 调整业务请求时间间隔到 5 分钟内，或联系我们调整实例保持策略。若您的业务仅在工作日期间有大量请求，节假日期间较少，请务必联系我们

2.5 请求参数说明​

参数名称类型是否必填说明
videoString 或 File是视频文件内容或文件地址。

1. 提交视频文件时，指定 ContentType: multipart/form-data；
2. 提交视频链接时，指定 ContentType: application/json；
3. 支持的容器格式：flv、mkv、mp4、rmvb、avi、wmv、3gp、ts、mov、gif、m3u8、mpg/mpeg、mxf；
4. 出于安全考虑，视频链接端口除 80, 443 端口外，应在 1025-65535 范围内
timestampNumber是当前服务器的 Unix 时间戳
nonceNumber是随机数
signatureString是

RSA-SHA256 算法签名。签名步骤：

  1. 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString；
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例
intervalNumber否视频截图间隔，单位秒。取值范围 [0.5, 10]，默认 1 秒
maxFramesNumber否最大截图张数（达到最大截图张数则结束截图），取值范围 [5, 200]，默认 200 张
tagString否自定义信息，如房间 ID、文件 ID（指定时可在控制台根据此字段搜索识别结果）
taskArray<String>否指定的任务 ID。通常单个应用（接口）下会配置多个识别任务，可根据业务需要指定其中的部分任务进行识别

2.5 请求示例​

{
  "video": "<url>",
  "interval": 1,
  "maxFrames": 20,
  "tag": "<tag>",
  "task": [
    "<taskId>"
  ],
  "timestamp": 1685000000,
  "nonce": 1685000000,
  "signature": "<signature>"
}

3. 同步响应​

3.1 响应参数说明​

参数名称类型说明
signatureString

同步响应或回调请求签名，由图普使用私钥签名，在需要时，您可以通过 图普公钥 进行验签以确保此响应内容来自图普（与您调用接口时使用的公私钥不同）。验签步骤：

  1. 取 json 字段内容为 SignString；
  2. 将 signature 字段内容进行 Base64 解码，得到 RawSignature；
  3. 使用图普公钥以 SHA256 算法验证 RawSignature 及 SignString
jsonString

同步响应或回调请求经过 JSON 转义后的字符串，需进一步解析得到业务数据。

  • 字段内容示例：{\"code\":0,\"message\":\"success\"}；
  • 字段详见下述 json 参数说明；
  • 为方便展示，同步响应及回调请求的示例中，均为解析后的 JSON

json 参数说明​

参数名称类型是否必有说明
codeNumber是状态码，详见 业务状态码
messageString是状态信息
<任务 ID>Object是识别任务结果，不同任务数据结构不同，详见 任务识别结果
nonceNumber是随机数
timestampNumber是当前服务器的 Unix 时间戳

3.2 响应示例​

TODO

3.3 任务识别结果​

图片类任务返回结果与图片接口任务结果相同，详见 具体任务识别结果。

语音类任务返回结果详见 具体任务识别结果。