POST https://mediakit.cn-beijing.volces.com/api/v1/tools/add-aigc-metadata

本 API 用于提交一个异步的添加 AIGC 元数据标识任务，将 AI 生成属性、服务提供者信息、内容唯一编号等标识信息写入视频、音频或图片的文件元数据。

请求参数

参数	类型	是否必选	示例值	描述
Authorization	String	是	Bearer {Your_API_Key}	格式为 Bearer {Your_API_Key}。请参考基础概念及准备工作获取 API Key。

Body 参数

参数	类型	是否必选	示例值	描述
video_url	String	否	https://example.com/video.mp4	待写入 AIGC 元数据标识的视频 URL。与 image_url、audio_url 三者必须且只能指定一个。视频来源：支持公网 HTTP/HTTPS URL、本地上传 (mediakit://)、来源于火山引擎视频点播 (vod://) 和火山引擎对象存储 (tos://) 四种输入协议。关于各协议的具体说明和使用示例，请参阅多源媒体输入与本地上传。支持格式：mp4、mov。
audio_url	String	否	https://example.com/audio.mp3	待写入 AIGC 元数据标识的音频 URL。与 video_url、image_url 三者必须且只能指定一个。音频来源：支持公网 HTTP/HTTPS URL、本地上传 (mediakit://)、来源于火山引擎视频点播 (vod://) 和火山引擎对象存储 (tos://) 四种输入协议。支持格式：mp3、ogg、wav。
image_url	String	否	https://example.com/image.png	待写入 AIGC 元数据标识的图片 URL。与 video_url、audio_url 三者必须且只能指定一个。图片来源：支持公网 HTTP/HTTPS URL、本地上传 (mediakit://)、来源于火山引擎视频点播 (vod://) 和火山引擎对象存储 (tos://) 四种输入协议。关于各协议的具体说明和使用示例，请参阅多源媒体输入与本地上传。支持格式：jpeg、png、webp。
aigc_metadata_content	Object	是	{"label": "1", "content_producer": "your_company"}	需要写入的 AIGC 元数据标识内容。为必填对象，且至少指定其中一个字段。系统将遵循以下更新逻辑：覆盖：如果字段已存在，新值将覆盖旧值。新增：如果字段不存在，将新增该字段与值。保留：如果未在请求中提供某字段，元数据中的原始值将保持不变。字段说明详见下文 AIGC metadata content 对象。所有字段值的长度均无限制，且支持数字、大小写英文及可见字符。
media_output_destination	String	否	vod://my-space	指定处理产物的目标存储位置。AI MediaKit 支持将处理产物存储至您的火山引擎视频点播（VOD）空间或对象存储（TOS）桶。存储至 VOD：设为 vod://<您的空间名> 存储至 TOS：设为 tos://<您的桶名> 设置本参数后，任务结果中的 url 相关字段将返回形如 vod:// 或 tos:// 格式的资源地址，不再返回临时下载地址。说明首次使用此功能前，您需要先授权 AI MediaKit 将文件写入您的 VOD 空间或 TOS 桶。请前往 AI MediaKit 控制台基础配置 > 授权管理页面，根据您的需要，为 AI MediaKit 服务授予相应的权限。更多信息，请参阅开发指南处理产物存储至 VOD 或 TOS。
client_token	String	否	your_unique_request_id_135	用户请求凭证，用于幂等控制。大小写敏感，不超过 64 个 ASCII 码可打印字符。详情请参考幂等性控制。
callback_args	String	否	your_custom_callback_args	自定义回调参数。您提供的内容将在任务完成时，通过事件回调原样返回，方便您关联业务。字段长度最大为 512 字节。
callback_url	String	否	https://example.com/callback	用于接收该任务结果回调的 URL 地址。如果提供此参数，其优先级将高于在控制台配置的全局回调地址。地址必须以 http:// 或 https:// 开头。请参考事件回调了解回调接收机制和回调消息结构。
queue_id	String	否	q00a9731598092652e4a95292434198	任务提交的目标队列 ID。如不传，默认会使用系统自动创建的队列 ID。您可以将不同业务或优先级的任务提交到不同的队列，以实现按队列对应的项目进行分账。您可以在 AI MediaKit 控制台队列管理页面创建和管理队列，系统会自动分配一个队列 ID。详情请参考项目与队列管理。

AIGC metadata content 对象

参数	类型	是否必选	示例值	描述
label	String	否	1	生成合成标签： 1 表示属于人工智能合成内容 2 表示可能为人工智能合成内容 3 表示疑似人工智能合成内容
content_producer	String	否	your_company_name	生成合成服务提供者名称或编码。
produce_id	String	否	your_unique_content_id_001	生成合成服务提供者对内容生成过程或内容的唯一编号。
reserved_code1	String	否	your_reserved_code_1	生成合成服务提供者预留字段，用于自主开展安全防护。
content_propagator	String	否	your_platform_name	内容传播服务提供者名称或编码。
propagate_id	String	否	your_unique_propagate_id_001	内容传播服务提供者对传播过程或内容的唯一编号。
reserved_code2	String	否	your_reserved_code_2	内容传播服务提供者预留字段，用于自主开展安全防护。

请求示例

以下示例演示了如何为一段视频写入生成合成标签、服务提供者名称与内容唯一编号。

响应说明

调用 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	（可选）指出导致错误的具体参数。

响应示例

成功响应

失败响应

异步任务结果

添加 AIGC 元数据标识是一个异步任务，任务的执行状态和最终结果不会在提交时同步返回。您可以通过以下两种方式获取任务结果：

方法一（轮询查询）：使用提交任务时获取的 task_id，定期调用查询任务信息 API，直到 status 字段变为 completed 或 failed。

方法二（事件回调）：在 AI MediaKit 控制台预先配置一个接收回调的 URL，或在提交任务时通过 callback_url 参数为单次任务指定回调地址。任务完成后，系统会将包含最终结果的详细信息 POST 到您指定的地址。详情请参阅事件回调。

当任务成功完成后，您获取到的任务信息中的 result 字段将包含以下内容。

参数	类型	示例值	描述
video_url	String	https://example.volcvideo.com/output.mp4?auth_key=...	处理后的视频文件地址。仅当输入为 video_url 时返回。地址类型根据请求时是否设置 media_output_destination 而不同：默认情况（未设置 media_output_destination）：返回一个 HTTPS 临时下载链接，有效期为 24 小时，请及时下载保存。设置 media_output_destination 后：返回存储地址，格式为 vod://<空间名>/<媒资ID> 或 tos://<桶名>/<对象Key>。
audio_url	String	https://example.volcvideo.com/output.mp3?auth_key=...	处理后的音频文件地址。仅当输入为 audio_url 时返回。地址类型根据请求时是否设置 media_output_destination 而不同：默认情况（未设置 media_output_destination）：返回一个 HTTPS 临时下载链接，有效期为 24 小时，请及时下载保存。设置 media_output_destination 后：返回存储地址，格式为 vod://<空间名>/<媒资ID> 或 tos://<桶名>/<对象Key>。
image_url	String	https://example.volcvideo.com/output.png?auth_key=...	处理后的图片文件地址。仅当输入为 image_url 时返回。地址类型根据请求时是否设置 media_output_destination 而不同：默认情况（未设置 media_output_destination）：返回一个 HTTPS 临时下载链接，有效期为 24 小时，请及时下载保存。设置 media_output_destination 后：返回存储地址，格式为 vod://<空间名>/<媒资ID> 或 tos://<桶名>/<对象Key>。
aigc_metadata_content	Object	{"label": "1", "content_producer": "your_company_name"}	处理后的 AIGC 元数据标识内容。子字段与请求参数 aigc_metadata_content 一致。

最终的完整任务信息示例（以视频输入为例）：

AI MediaKit