Skip to content

docs: document 429 polling backoff #418

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
scout-relayprotocol wants to merge 2 commits into from
Closed

docs: document 429 polling backoff #418

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e60b19
docs: explain API rate-limit upgrades (INT2-1253)
Aug 17, 2026
2efd937
docs: document 429 polling backoff (INT2-1253)
Aug 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion references/api/api_core_concepts/handling-rate-limits.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Quote traffic is the next place to look. `/quote` carries the tightest default l

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.

@greptile-apps greptile-apps Bot Aug 17, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 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.

View artifacts

T-Rex Ran code and verified through T-Rex


---

Expand Down
Loading