You need to enable JavaScript to run this app.
文档中心
AI MediaKit

AI MediaKit

复制全文
下载 pdf
视频工具 API
提交视频画质检测 VQScore 任务 API
复制全文
下载 pdf
提交视频画质检测 VQScore 任务 API
POST https://mediakit.cn-beijing.volces.com/api/v1/tools/assess-video-quality​
本 API 用于提交一个异步的视频画质检测任务。VQScore(Video Quality Score)是火山引擎自研的无参考视频质量评价算法,可对视频和图像的视觉质量进行客观打分。区别于 PSNR、SSIM、VMAF 等需要原始参考源的传统算法,VQScore 无需参考视频即可独立完成评估,直接模拟人眼主观感受输出贴近真实观感的质量分数。​
说明​
如需了解完整的使用流程和应用示例,请参阅视频画质检测 VQScore。​
请求参数​
Header 参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Authorization​
String​
是​
Bearer {Your_API_Key}​
格式为 Bearer {Your_API_Key}。请参考基础概念及准备工作获取 API Key。​
​
Body 参数​
​
参数​
类型​
是否必选​
示例值​
描述​
video_url​
String​
是​
https://example.com/source.mp4​
待检测的视频 URL。​
  • 视频来源:支持公网 HTTP/HTTPS URL、本地上传 (mediakit://)、来源于火山引擎视频点播 (vod://) 和火山引擎对象存储 (tos://) 四种输入协议。关于各协议的具体说明和使用示例,请参阅多源媒体输入与本地上传。​
  • 支持格式:mp4, flv, ts, avi, mov, wmv, mkv 等主流视频格式。​
  • 分辨率限制:输入视频最高支持 4K (3840×2160) 分辨率。​
client_token​
String​
否​
your_unique_request_id_131​
用户请求凭证,用于幂等控制。大小写敏感,不超过 64 个 ASCII 码可打印字符。详情请参考幂等性控制。​
callback_args​
String​
否​
your_unique_callback_args​
自定义回调参数。您提供的内容将在任务完成时,通过事件回调原样返回,方便您关联业务。字段长度最大为 512 字节。​
callback_url​
String​
否​
https://example.com/callback​
用于接收该任务结果回调的 URL 地址。如果提供此参数,其优先级将高于在控制台配置的全局回调地址。地址必须以 http:// 或 https:// 开头。请参考事件回调了解回调接收机制和回调消息结构。​
queue_id​
String​
否​
q00a9731598092652e4a95292434198​
任务提交的目标队列 ID。如不传,默认会使用系统自动创建的队列 ID。您可以将不同业务或优先级的任务提交到不同的队列,以实现按队列对应的项目进行分账。您可以在 AI MediaKit 控制台队列管理页面创建和管理队列,系统会自动分配一个队列 ID。详情请参考项目与队列管理。​
​
请求示例​
以下示例演示了如何提交一个视频画质检测任务。​
​
curl -X POST 'https://mediakit.cn-beijing.volces.com/api/v1/tools/assess-video-quality' \​
-H 'Authorization: Bearer {Your_API_Key}' \​
-H 'Content-Type: application/json' \​
-d '{ ​
"video_url": "https://example.com/your_video.mp4"​
}'​
​
响应说明​
调用 API 提交任务后,接口会立即返回一个同步响应,表明任务是否成功进入后台处理队列。​
响应参数​
​
参数​
类型​
描述​
success​
Boolean​
任务是否成功提交。​
  • true:任务已成功提交到后台处理队列。​
  • false:请求存在错误,任务提交失败。请检查 error 字段以获取详细信息。​
task_id​
String​
任务的唯一标识符。仅在 success 为 true 时返回有效值。您可以使用此 ID 来查询任务状态和结果。​
request_id​
String​
本次 API 请求的唯一标识符,可用于问题排查。​
error​
Object​
错误详情对象,仅在 success 为 false 时返回。详见下文 Error 对象。​
​
Error 对象​
​
参数​
类型​
描述​
code​
String​
具体的错误码。关于各错误码的详细信息,请参阅错误码。​
type​
String​
错误的宏观类型。例如 BadRequest。​
message​
String​
对错误的详细描述,可用于开发调试。​
param​
String​
(可选)指出导致错误的具体参数。​
​
响应示例​
成功响应​
​
{​
"success": true,​
"task_id": "amk-tool-assess-video-quality-12345",​
"request_id": "20240523110000ABCDEFG98765"​
}​
​
失败响应​
​
{​
"success": false,​
"task_id": "",​
"request_id": "20240523110500XYZW54321",​
"error": {​
"code": "InvalidParameter",​
"message": "The parameter 'video_url' is missing or invalid.",​
"type": "BadRequest"​
}​
}​
​
异步任务结果​
视频画质检测 VQScore 是一个异步任务,任务的执行状态和最终结果不会在提交时同步返回。您可以通过以下两种方式获取任务结果:​
  • 方法一(轮询查询):​使用提交任务时获取的 task_id,定期调用查询任务信息 API,直到 status 字段变为 completed 或 failed。​
  • 方法二(事件回调):​在 AI MediaKit 控制台预先配置一个接收回调的 URL,或在提交任务时通过 callback_url 参数为单次任务指定回调地址。任务完成后,系统会将包含最终结果的详细信息 POST 到您指定的地址。详情请参阅事件回调。​
当任务成功完成后,您获取到的任务信息中的 result 字段将包含以下内容。​
​
参数​
类型​
示例值​
描述​
vq_score​
Number​
88.5​
VQScore 画质评分,取值范围 [0,100],分数越高画质越好。​
  • [0, 60):主观感受较差​
  • [60, 70):主观感受良好​
  • [70, 100]:主观感受清晰​
duration​
Number​
91.2​
输入视频时长,单位:秒。​
​
最终的完整任务信息示例:​
​
{​
"success": true,​
"task_id": "amk-tool-assess-video-quality-12345",​
"request_id": "20240523110000ABCDEFG98765",​
"status": "completed",​
"result": {​
"vq_score": 88.5,​
"duration": 91.2​
},​
"expires_at": 1777534898,​
"created_at": 1777362013,​
"finished_at": 1777362599​
}​
​
最近更新时间:2026.10.27 17:14:12
这个页面对您有帮助吗?
有用
有用
无用
无用