POST https://mediakit.cn-beijing.volces.com/api/v1/tasks/terminate

本接口用于主动取消指定的异步任务。在提交异步任务后，若不再需要任务结果或为了节省计算资源，您可以使用此接口批量终止正在排队（Pending）或准备阶段（Preparing）的任务。

使用限制

仅支持取消处于排队中（Pending）或准备阶段（Preparing）的任务。已完成（Completed）或已失败（Failed）的任务无法通过此接口更改执行结果。

支持取消 AI MediaKit 下视频工具、剪辑工具、音频工具等绝大多数异步任务，不支持智能剪辑 (VCreative)、剧本还原、解说视频生成、Chat API 等任务。

请求参数

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

Body 参数

参数	类型	是否必选	示例值	描述
task_ids	String[]	是	["amk-tool-enhance-video-36603392", "amk-tool-enhance-video-fast-987654"]	待处理的任务 ID 列表。单次请求最多支持 10 个。

请求示例

响应参数

接口的响应体为一个 JSON 对象。请求标识符 request_id 从 HTTP 响应 Header 中获取，可用于问题排查。

参数	类型	描述
success	Boolean	标识本次 API 请求是否成功： true：请求成功。 false：请求失败，具体原因请查看 error 字段。
result	Object	API 请求成功时返回的结果对象。仅当 success 为 true 时返回。详见 Result 对象。
error	Object	API 请求失败时返回的错误详情对象。仅当 success 为 false 时返回。详见 Error 对象。

Result 对象

参数	类型	描述
terminated_tasks	Object[]	取消成功的任务列表。包含原本已处于取消状态的任务。每个元素详见 TerminatedTask 对象。
terminate_failed_tasks	Object[]	任务取消失败的列表。包含任务不存在、无权限、任务状态不支持取消等情况。每个元素详见 TerminateFailedTask 对象。

TerminatedTask 对象

参数	类型	描述
task_id	String	任务 ID。

TerminateFailedTask 对象

Error 对象

参数	类型	描述
code	String	错误码。详见错误码。
message	String	错误描述信息，用于展示或记录日志。
type	String	错误类型，如 TaskError 表示任务执行出错，ApiError 表示 API 调用出错。

响应示例

示例 1：批量取消成功

示例 2：部分取消成功，部分失败