Zum Hauptinhalt springen

Idempotenz

Alle POST- und PATCH-Mutationsendpunkte akzeptieren einen optionalen Idempotency-Key-Header.

Wann du ihn senden solltest

Verwende einen Idempotency-Key, wenn:
  • Ein Client nach einem Transportfehler erneut versuchen könnte.
  • Ein Queue-Worker dieselbe logische Operation mehr als einmal ausführen könnte.
  • Ein KI-Agent eine Mutation nach teilweisem Fortschritt oder Tool-Retries erneut ausführen könnte.

Empfohlenes Muster

  • Generiere einen stabilen Key pro logischer Mutation.
  • Verwende für Wiederholungsversuche dieser Mutation denselben Key erneut.
  • Ändere den Key, wenn sich die beabsichtigte Mutation ändert.

Beispiele

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

Gute Abgrenzungen

  • Ein Key zum Erstellen eines Projekts.
  • Ein anderer Key zum Exportieren dieses Projekts.
  • Noch ein anderer Key zum Aktualisieren der Projekteinstellungen.
So bleiben Wiederholungsversuche sicher, ohne dass unbeabsichtigt nicht zusammenhängende Arbeiten dedupliziert werden.