Skip to main content
An idempotency key identifies one request. Send it with the first attempt and reuse it if you need to retry, so Sail can return the existing request instead of starting another generation or batch.

​
Supported endpoints

For example:

​
Using a key

  • Generate a unique key, such as a UUID, for each new request.
  • Keys must be at most 255 bytes; a UUID fits within this limit.
  • Keep the same key, body, endpoint, and Sail API key for every retry.
  • Reusing a key with a different body returns HTTP 400.
  • Keys are scoped to your organization and API key. Switching API keys does not reuse the original submission.
A completed result is returned again when it is still available. An ASAP request without an available completion can return HTTP 409 with Retry-After. Wait before retrying with the same key; using a new key would submit new work. For background requests, save the response ID and poll it for completion. See Retrying requests for retry delays, timeouts, and streaming errors.