メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.qoder.com/llms.txt

Use this file to discover all available pages before exploring further.

Idempotency-Key ヘッダーにより書き込み操作の安全なリトライを保証し、ネットワークタイムアウトによるリソースの重複作成を回避します。

ヘッダー形式

書き込み操作(POST / PUT / DELETE)リクエストに Idempotency-Key ヘッダーを追加します:
Idempotency-Key: <UUID v4>
グローバルな一意性を保証するため UUID v4 の使用を推奨します。GET リクエストは本質的に冪等であり、このヘッダーは不要です。

重複リクエストの動作

シナリオサーバーの応答
同じ key + 同じ body初回リクエストのレスポンスを直接返す(重複実行しない)
同じ key + 異なる body409 conflict_error"Idempotency key reused with a different request body."
冪等キーなし毎回実行され、リソースが重複作成される可能性あり

ライフサイクル

特性説明
有効期間初回使用後 24 時間保持
期限切れ後同じ key は新規リクエストとして扱われる
適用範囲PAT(アカウント)ごとに分離

# 冪等キー付きで Agent を作成(タイムアウト時も安全にリトライ可能)
curl -X POST "https://api.qoder.com/api/v1/cloud/agents" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen | tr '[:upper:]' '[:lower:]')" \
  -d '{"name": "my-agent", "model": "ultimate"}'
重要なリソース(Agent、Session、Environment)の作成時は冪等キーの使用を強く推奨します。自動化スクリプトでのバッチ書き込み操作でも、毎回独立した key を生成してください。