Skip to content
Common Ridge
Sign in
Documentation menu

Idempotency

Retry writes without duplicating them.

Preview documentation. Details may change before the API is released.

A network error leaves you unsure whether a write happened. An idempotency key makes a retry safe.

How it works

  • Send an Idempotency-Key header with a unique value, such as a UUID, on every POST.
  • If the key has been seen, the API returns the original response instead of performing the write again.
  • If the same key is sent with a different body, the API returns 409.

Guidance

  • Generate the key once per logical operation and reuse it for every retry of that operation.
  • Do not reuse a key for a different operation.
Book demoStart trial