跳转到主要内容

幂等性

所有 POSTPATCH 变更(mutation)端点都接受可选的 Idempotency-Key 标头。

何时发送

在以下情况下使用幂等键:
  • 客户端可能在传输失败后重试。
  • 队列工作进程可能会多次派发同一个逻辑操作。
  • AI 代理可能在部分进度完成后,因工具重试而重新运行一次变更操作。

推荐模式

  • 每次逻辑变更生成一个稳定的键。
  • 对该变更的重试复用同一个键。
  • 当预期的变更发生变化时更换键。

示例

Idempotency-Key: create-project-song-1
Idempotency-Key: export-song-1

良好的边界划分

  • 创建项目使用一个键。
  • 导出该项目使用另一个键。
  • 更新项目设置再使用另一个不同的键。
这样可以在保证重试安全的同时,避免误将不相关的工作去重。