docs(drift): draft from internal source

[pedromcunha]

Drafted from an internal source repo, requested by @ipeleg.

This PR was auto-generated by the reusable-docs-draft-pr workflow from a Claude-drafted update in the source repo. It is opened as a draft — please review, edit as needed, and mark ready for review before merging.

Review checklist

• Content matches the behavior shipped in the source PR
• No internal-only details (service names, file paths, unreleased names, security internals) leaked into the draft
• Conforms to CLAUDE.md style rules
• Cross-references and internal links resolve
• Any Needs human input items from the source comment are addressed

---

Generated by reusable-docs-draft-pr.yml in relayprotocol/agents-config.

[github-actions]

Claude finished @ipeleg's task in 1m 53s —— View job

---

Code review — PR #373 (docs drift: supersededByRequestId → root)

• Read changed files and surrounding context
• Check against CLAUDE.md style rules
• Verify cross-references and factual accuracy
• Post review

This is a clean, small drift update reflecting that supersededByRequestId moved from data.supersededByRequestId (v2) to the response root in GET /requests/v3. I verified the substantive claims against the rest of the docs and it holds up well.

✅ Verified correct

• x-api-key on the v3 curl — The migration guide confirms GET /requests/v3 requires x-api-key (migrating-to-requests-v3.mdx:272, :484), so adding the header to the v3 example is right. Placeholder YOUR_API_KEY matches the §2.8 convention.
• ?id=<ORIGINAL_REQUEST_ID> is valid v3 syntax — id is a documented v3 top-level search parameter (migrating-to-requests-v3.mdx:283), so this doesn't need filters=[…].
• "Bitcoin/BVM" is not internal leakage — BVM is already used publicly in quickstart.mdx:130 and references/relay-kit/sdk/adapters.mdx:12. Safe.
• Response envelope + field shape — The JSON example correctly uses the requests[] envelope (matches the other example at deposit-addresses.mdx:984) and moves supersededByRequestId to the item root, matching the v3 change.
• Style/consistency — The new bullet's "promoted to the root" phrasing mirrors the existing sender entry, and listing the field in both the "Moved, added & nulled fields" bullet and the "Renamed & restructured" table matches how sender / moonpayId / depositAddress are handled. Conforms to §4.5-adjacent bolded-lead patterns.

💡 One suggestion (non-blocking)

Mixed v2/v3 in the same section. The first curl in Handling Quote Regeneration still targets v2 without auth:

# deposit-addresses.mdx:1257
curl -X GET "https://api.relay.link/requests/v2?depositAddress=<DEPOSIT_ADDRESS>&includeChildRequests=true"

…while the second example just moved to v3-with-key. Both depositAddress and includeChildRequests are valid v3 parameters (migrating-to-requests-v3.mdx:285, :289), so for consistency you could promote this first call to v3 as well:

curl -X GET "https://api.relay.link/requests/v3?depositAddress=<DEPOSIT_ADDRESS>&includeChildRequests=true" -H "x-api-key: YOUR_API_KEY"

The prose deliberately references both versions ("…in GET /requests/v3 (or … the legacy GET /requests/v2)"), so keeping the contrast is defensible — but leading a reader through one v2 call and one v3 call back-to-back reads slightly inconsistently now that v3 is the recommended path.

Align the first regeneration curl to v3 →

Verdict

Accurate, on-style, no broken links, no internal details leaked. Approving in spirit — just the optional consistency tweak above before marking ready for review.

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
unevenlabs	🔴 Failed	–	Jul 22, 2026, 7:06 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.