docs: document 429 polling backoff - #418
Conversation
Document the standard production upgrade, required capacity intake, and whole-key scope so integrators know what to include in a review request. Note that requests above the elevated limits need additional review. Linear: INT2-1253
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Narrow the rate-limit guidance to the retry behavior clients need when polling receives a 429 response. Linear: INT2-1253 Co-authored-by: Pedro Cunha <6723339+pedromcunha@users.noreply.github.com>
|
| Validation belongs on the client too. Amounts below Relay's minimum come back as [`AMOUNT_TOO_LOW`](/references/api/api_core_concepts/handling-errors), so a sub-cent value a user types should fail your own check before it turns into a quote call. Where your interface already knows the user's balance, apply the same treatment to amounts they can't cover. | ||
|
|
||
| If you poll for status, widen the interval and stop polling once a request reaches a terminal status (`success`, `failure`, or `refund`). When you need many records at once, [`GET /requests/v3`](/references/api/get-requests) retrieves them in a single filtered call instead of one call per request ID. | ||
| If a polling request returns a `429` response, retry with exponential backoff instead of retrying immediately. |
There was a problem hiding this comment.
Proactive polling guidance is missing
This replacement leaves integrations that still poll with advice only for after they have already received a 429. Retain the complementary guidance to widen normal polling intervals, stop polling after success, failure, or refund, and use GET /requests/v3 to retrieve multiple records in one filtered call. Those measures prevent avoidable traffic and rate-limit responses rather than only slowing retries after one occurs.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Artifacts
Executed rate-limit guidance comparison script
- The authored executable script reads both revisions and asserts that each removed polling and batch-retrieval instruction is present in base and absent in HEAD, showing the tested comparison.
Rate-limit guidance check result
- The executed check exited 0 and reports that base contains while HEAD omits all four tested polling and batch-retrieval instruction fragments, confirming the omission.
Base documentation guidance capture
- The base-revision capture records all tested fragments as present and prints line 22 containing interval widening, terminal-status stopping, and GET /requests/v3 batching guidance, establishing the prior reader-facing behavior.
HEAD documentation guidance capture
- The HEAD capture records every tested prior instruction fragment as absent and prints the replacement backoff-only line 22, establishing the final reader-facing omission.
Implements INT2-1253: Document 429 polling retry backoff
What this changes
429response with exponential backoff instead of retrying immediately.How I verified
git diff origin/main --checkpasses.Open questions
🤖 Opened by Scout (autonomous). Ready for human review.
Linear: https://linear.app/relayprotocol/issue/INT2-1253/document-routine-api-rate-limit-upgrades