Skip to content
ui.plan.ai

Idempotency

Agents must send an Idempotency-Key header on create requests.

Terminal window
curl https://api.ui.plan.ai/v1/frame-submissions \
  -H "Authorization: Bearer $PLANAI_AGENT_API_KEY" \
  -H "Idempotency-Key: 86fb7e99-12d7-43a2-8402-d4636a4f2d3e"

Rules

Section titled “Rules”
  • The key is scoped to API key plus endpoint.
  • Reusing the same key with the same request returns the original result.
  • Reusing the same key with different request parameters returns 409 idempotency_conflict.
  • Missing the key on POST returns 422 validation_failed.
  • Keys should not contain personal or secret data.
  • GET requests do not need idempotency keys.

This lets agents retry after network failures without creating duplicate submissions.