docs(api-keys): revise rate limit copy#371
Conversation
The rate-limit docs implied the API was usable unauthenticated at a baseline limit and that a key merely "raised" it. Keys are self-minted in the Dashboard and the default limits apply to those keys, so state that directly and route higher-limit requests to the Dashboard support widget. Also scrubs the same "raise your rate limits" / "available to anyone" framing from the quickstart, the shared GetAnApiKey snippet, and the websockets guide. Limit values are unchanged; two section headings and their anchors are renamed. Refs: INT2-929 Refs: https://relayprotocol.slack.com/archives/C04EBEGJV2M/p1784297558289219 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Claude finished @n-xlkt's task in 1m 22s —— View job Review:
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The "How to Use" and "Proxy API" sections still told readers that passing their key gets them elevated limits. Under the new model a self-minted key carries the default limits and elevated limits are a separate tier granted on request, so this overpromised the exact thing the reframe corrected. Reword to refer to the key's own limits. Refs: INT2-929
|
Claude finished @n-xlkt's task in 1m 25s —— View job Code Review:
|
Match the "API keys are self-serve" phrasing already on the page; "self-minted" wasn't used anywhere else in the docs. Refs: INT2-929
|
Claude finished @n-xlkt's task in 56s —— View job Code Review:
|
What Changed
Reframes the API key rate-limit docs so a key reads as self-minted in the Relay Dashboard, with the default limits applying to those keys and higher limits available on request through the Dashboard support widget. Renames the two rate-limit sections on
references/api/api-keys.mdxto Default Rate Limits and Elevated Rate Limits (limit values unchanged), and drops the same "raise your rate limits" / "available to anyone" framing from the quickstart, the sharedGetAnApiKeysnippet, and the websockets guide.Why
The copy implied any API key inherently grants higher limits, and that the API is usable unauthenticated at a baseline rate. In reality a newly self-minted key starts on the default limits — the same numbers previously labeled "no API key" — and higher limits are granted on request. Pedro flagged this after the developer-dashboard docs shipped in #369.
Impact
Documentation only — no API or SDK behavior changes. Anchor slugs on the API keys page change (
#default-rate-limits-no-api-key→#default-rate-limits,#api-key-rate-limits→#elevated-rate-limits); a repo-wide check found no internal links to the old anchors.Related Context
Testing
Static review plus a
grepsweep confirming no residual "to raise your rate limits" / "available for anyone" / "(no API key)" / "generally not required" phrasing remains. The Mintlify CLI isn't installed in this environment, so the rendered page was not previewed live; MDX structure (tables,<Tip>/<Warning>/<Callout>tags, frontmatter) was verified by inspection.