取消动画任务
从真实 cancel_animation 工具生成输入、输出、OAuth 权限与安全注解，与经过核实的 MCP 契约保持一致。
本页目录
工具
cancel_animation
尽力取消所属任务，可能仍需轮询；已扣积分不自动退回，先前产物可能保留。
权限与安全
OAuth 权限：animations:write
| 信号 | 值 |
|---|---|
destructiveHint |
true |
idempotentHint |
true |
openWorldHint |
false |
readOnlyHint |
false |
| spendsCredits | false |
| requiresUserConfirmation | true |
| sideEffects | cancellation_requested |
注解用于描述安全属性，不能替代用户批准、OAuth 授权或服务端校验。
输入参数
| 字段 | 类型 | 必填 | 默认值 | 约束 | 含义 |
|---|---|---|---|---|---|
animation_id |
string |
是 | — | format: uuid |
用户要求取消的所属任务 ID。 |
参数示例
{
"animation_id": "00000000-0000-4000-8000-000000000002"
}
结构化返回
| 字段 | 类型 | 必填 | 默认值 | 约束 | 含义 |
|---|---|---|---|---|---|
created_at |
string |
是 | — | format: date-time |
任务被接受的 UTC 时间。 |
credits |
CreditUsage | 是 | — | — | 报价、预占及已扣积分状态。 |
error |
TaskError / null |
否 | null |
— | 任务失败信息，与是否存在可用产物分别判断。 |
finished_at |
string / null |
否 | null |
format: date-time |
已知时返回 UTC 终态时间。 |
id |
string |
是 | — | format: uuid |
创建后立即保存任务 ID，通过它轮询，不要再次创建。 |
metadata |
object |
否 | {} |
— | 调用方提供的元数据。 |
normalized_input |
object |
否 | {} |
— | 规范化公共输入，可能含私有提示词或图片引用，不要整体写入日志。 |
object |
string |
是 | — | enum: "video_generation", "animation_export", "animation" |
公共任务资源类型。 |
outputs |
array<AssetResponse> | 否 | [] |
— | 可用资产，失败或取消也可能有部分产物；所有终态都应检查。 |
progress |
number |
是 | — | minimum: 0; maximum: 1 |
0 至 1 的进度值，不代表精确完成时间。 |
stage |
string / null |
否 | null |
enum: "queued", "video_generation", "animation_export", "completed" |
可用时显示当前流水线阶段。 |
started_at |
string / null |
否 | null |
format: date-time |
已知时返回 UTC 生产开始时间。 |
status |
string |
是 | — | enum: "queued", "running", "cancelling", "succeeded", "failed", "cancelled" |
succeeded、failed、cancelled 为终态；cancelling 不是终态。 |
错误与后续步骤
工具错误包含 error 对象，内有 code、message、retryable、request_id 和 details。不要依赖消息文本分支或泄露私有输入。终态失败也要检查部分产物；返回签名 URL 不代表已保存文件。
这篇文档有帮助吗？
不收集搜索词、代码或自由文本。此开关只控制文档交互事件；站点通用分析仍遵循隐私政策。 隐私政策