生成动画
从真实 generate_animation 工具生成输入、输出、OAuth 权限与安全注解,与经过核实的 MCP 契约保持一致。
本页目录
工具
generate_animation
启动付费异步动画,必须有用户批准的 quote_id 或 max_credits,并保存幂等键。两个支出字段与 request 同级;生成开始后可能扣费。
权限与安全
OAuth 权限:animations:write
| 信号 | 值 |
|---|---|
destructiveHint |
true |
idempotentHint |
true |
openWorldHint |
true |
readOnlyHint |
false |
| spendsCredits | true |
| requiresUserConfirmation | true |
| sideEffects | generation_started, credits_reserved_or_charged |
注解用于描述安全属性,不能替代用户批准、OAuth 授权或服务端校验。
输入参数
| 字段 | 类型 | 必填 | 默认值 | 约束 | 含义 |
|---|---|---|---|---|---|
idempotency_key |
string |
是 | — | minLength: 8; maxLength: 200 |
每次逻辑生成保存一个键;超时后以同一用户及 OAuth 客户端复用。 |
max_credits |
integer / null |
否 | null |
minimum: 0 |
用户批准的单次积分上限,不得擅自提高,也不是多任务总预算。 |
quote_id |
string / null |
否 | null |
format: uuid |
新鲜且已批准的报价;quote_id 与 max_credits 至少一个,可同时提供。 |
request |
AnimationCreateRequest | 是 | — | — | 用户批准的完整请求,重试时保持不变。 |
参数示例
{
"idempotency_key": "example-operation-001",
"max_credits": 0,
"quote_id": "00000000-0000-4000-8000-000000000006",
"request": {
"export": {
"frame_count": 24,
"output_formats": [
"frames_zip"
],
"output_height": 512,
"output_width": 512
},
"input": {
"first_frame": {
"file_id": "00000000-0000-4000-8000-000000000001",
"type": "file"
}
},
"prompt": "A character runs in place, side view, fixed camera.",
"selection": {
"mode": "full"
}
}
}
结构化返回
| 字段 | 类型 | 必填 | 默认值 | 约束 | 含义 |
|---|---|---|---|---|---|
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 不代表已保存文件。
这篇文档有帮助吗?
不收集搜索词、代码或自由文本。此开关只控制文档交互事件;站点通用分析仍遵循隐私政策。 隐私政策