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

AI MediaKit

复制全文
下载 pdf
视频工具 API
提交视频人脸打码任务 API
复制全文
下载 pdf
提交视频人脸打码任务 API
POST https://mediakit.cn-beijing.volces.com/api/v1/tools/face-blur-video​
本 API 用于提交一个异步的视频人脸打码任务,自动并精准地识别视频画面中的人脸区域,并对所有人脸进行模糊或马赛克处理。此功能适用于需要保护人物五官隐私的场景,例如短剧内容脱敏、生成式视频的参考素材处理等。​
说明​
如需了解完整的使用流程和应用示例,请参阅视频人脸打码。​
请求参数​
Header 参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Authorization​
String​
是​
Bearer {Your_API_Key}​
格式为 Bearer {Your_API_Key}。请参考基础概念及准备工作获取 API Key。​
​
Body 参数​
​
参数​
类型​
是否必选​
示例值​
描述​
video_url​
String​
是​
https://example.com/full_video.mp4​
待打码的视频 URL。​
  • 视频来源:支持公网 HTTP/HTTPS URL、本地上传 (mediakit://)、来源于火山引擎视频点播 (vod://) 和火山引擎对象存储 (tos://) 四种输入协议。关于各协议的具体说明和使用示例,请参阅多源媒体输入与本地上传。​
  • 支持格式:mp4, flv, ts, avi, mov, wmv, mkv 等主流视频格式。​
  • 分辨率限制:最高支持 4K,推荐使用 1080P 以获得最佳处理效果。​
  • 时长限制:不得超过 10 分钟。​
  • 帧率限制:帧率需在 25~60 范围内。​
face_confidence​
Number​
否​
0.35​
人脸检测置信度阈值。取值范围 [0.1, 1.0]。低于此值的检测结果将被丢弃,值越高,检测结果越保守(即要求更高的人脸相似度)。默认值为 0.35。​
mask_mode​
String​
否​
mosaic​
人脸打码方式。​
  • mosaic:(默认)马赛克。​
  • blur:高斯模糊。​
mask_strength​
String​
否​
medium​
人脸打码强度。​
• low:低强度。​
• medium:(默认)中强度。​
• high:高强度。​
face_box_expand​
Number​
否​
0.2​
人脸边界框扩展比例。取值范围 (0.0, 1.0]。系统将根据此比例,在检测到的人脸区域基础上向外扩展打码范围。例如,0.2 表示在原边界框的每条边上向外扩展 20%。默认值为 0.2。​
media_output_destination​
String​
否​
vod://my-space​
指定处理产物的目标存储位置。AI MediaKit 支持将处理产物存储至您的火山引擎视频点播(VOD)空间或对象存储(TOS)桶。​
  • 存储至 VOD:设为 vod://<您的空间名>​
  • 存储至 TOS:设为 tos://<您的桶名>​
设置本参数后,任务结果中的 url 相关字段将返回形如 vod:// 或 tos:// 格式的资源地址,不再返回临时下载地址。​
说明​
首次使用此功能前,您需要先前往 AI MediaKit 控制台基础配置 > 授权管理页面,授权 AI MediaKit 将文件写入您的 VOD 空间或 TOS 桶。更多信息,请参阅开发指南处理产物存储至 VOD 或 TOS。
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/face-blur-video' \​
-H 'Authorization: Bearer {Your_Media_Kit_API_Key}' \​
-H 'Content-Type: application/json' \​
-d '{​
"video_url": "https://example.com/sensitive_video.mp4",​
"mask_mode": "blur",​
"mask_strength": "high"​
}'​
​
响应说明​
调用 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-face-blur-video-1703201",​
"request_id": "20260415160000F6DE4C24A6A0D94B8AB2"​
}​
​
错误响应​
​
{​
"success": false,​
"task_id": "",​
"request_id": "20240522110500XYZW54321",​
"error": {​
"code": "InvalidParameter",​
"message": "Parameter `video_url` is required.",​
"param": "video_url",​
"type": "BadRequest"​
}​
}​
​
异步任务结果​
视频人脸打码是一个异步任务,任务的执行状态和最终结果不会在提交时同步返回。您可以通过以下两种方式获取任务结果:​
  • 方法一(轮询查询):使用提交任务时获取的 task_id,定期调用查询任务信息 API,直到 status 字段变为 completed 或 failed。​
  • 方法二(事件回调):在 AI MediaKit 控制台预先配置一个接收回调的 URL,或在提交任务时通过 callback_url 参数为单次任务指定回调地址。任务完成后,系统会将包含最终结果的详细信息 POST 到您指定的地址。详情请参阅事件回调。​
当任务成功完成后,您获取到的任务信息中的 result 字段将包含以下内容。​
​
参数​
类型​
示例​
描述​
video_url​
String​
https://example.volcvideo.com/output.mp4?auth_key=...​
已完成人脸打码的视频文件地址。地址类型根据请求时是否设置 media_output_destination 而不同:​
  • 默认情况(未设置 media_output_destination):返回一个 HTTPS 临时下载链接,有效期为 24 小时,请及时下载保存。​
  • 设置 media_output_destination 后:返回存储地址,格式为 vod://<空间名>/<媒资ID> 或 tos://<桶名>/<对象Key>。​
duration​
Number​
180.5​
输出视频的总时长(单位:秒),可用于计量计费。​
​
以下是一个任务执行完成后的完整任务信息示例:​
​
{​
"success": true,​
"task_id": "amk-tool-face-blur-video-1703201",​
"request_id": "20260415160000F6DE4C24A6A0D94B8AB2",​
"result": {​
"video_url": "https://example.volcvideo.com/blurred_video.mp4?auth_key=1775271661-...",​
"duration": 180.5​
},​
"expires_at": 1777464650,​
"created_at": 1777291767,​
"finished_at": 1777291851​
}​
​
最近更新时间:2026.07.29 19:03:53
这个页面对您有帮助吗?
有用
有用
无用
无用