From 0b5bce35ee63de5310ae9c1557eb7f2b4fff9248 Mon Sep 17 00:00:00 2001 From: aj fernandez Date: Fri, 17 Jul 2026 17:17:42 -0400 Subject: [PATCH 1/3] docs(api-keys): revise rate limit copy 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 --- references/api/api-keys.mdx | 16 +++++++--------- references/api/api_guides/websockets.mdx | 4 +--- references/api/quickstart.mdx | 2 +- snippets/GetAnApiKey.mdx | 2 +- 4 files changed, 10 insertions(+), 14 deletions(-) diff --git a/references/api/api-keys.mdx b/references/api/api-keys.mdx index c5c308f8..108ce413 100644 --- a/references/api/api-keys.mdx +++ b/references/api/api-keys.mdx @@ -1,11 +1,9 @@ --- title: "API keys and Rate Limits" -description: "Create API keys in the Relay Dashboard to authenticate requests and raise your rate limits" +description: "Create API keys in the Relay Dashboard to authenticate requests and manage your rate limits" --- -Relay enforces rate limits to keep the platform reliable for every integrator. Default limits apply to unauthenticated traffic; an API key raises those limits and attributes each request to your account. - -You manage keys in the [Relay Dashboard](https://dashboard.relay.link) — create new keys, rotate existing ones, and inspect individual requests. +Relay enforces rate limits to keep the platform reliable for every integrator. You manage API keys in the [Relay Dashboard](https://dashboard.relay.link) — create new API keys, rotate existing ones, and inspect individual requests. Default limits listed below apply to self-minted API keys. ## Creating an API key @@ -30,9 +28,9 @@ The [Relay Dashboard](https://dashboard.relay.link) is also where you observe wh When debugging a specific transaction, paste the `requestId` from your application into the dashboard's search to jump straight to the matching record. -## Default Rate Limits (no API key) +## Default Rate Limits -The following limits apply to unauthenticated requests: +The following limits apply per API key: | Endpoint | Limit | | ---------------------- | ----------------------- | @@ -41,9 +39,9 @@ The following limits apply to unauthenticated requests: | `/transactions/status` | 200 requests per minute | | Other endpoints | 200 requests per minute | -## API key Rate Limits +## Elevated Rate Limits -Authenticated requests get higher limits, applied per key: +Higher limits are available on request, applied per key: | Endpoint | Limit | | ---------------------- | ----------------------- | @@ -52,7 +50,7 @@ Authenticated requests get higher limits, applied per key: | `/transactions/status` | 10 requests per second | | Other endpoints | 200 requests per minute | -API keys are recommended for server-side production integrations and higher-throughput use cases. +To request higher limits, get in touch through the support widget in the [Relay Dashboard](https://dashboard.relay.link). ## How to Use an API key diff --git a/references/api/api_guides/websockets.mdx b/references/api/api_guides/websockets.mdx index 1db3ef8f..a067f23f 100644 --- a/references/api/api_guides/websockets.mdx +++ b/references/api/api_guides/websockets.mdx @@ -31,7 +31,7 @@ Refer to the guide below on how to integrate the websocket into your application ## **Authentication** -The Websocket Service is available for anyone with strict rate limits. For customers with an API key it can be used for authentication for higher rate limits, the service is available at the following URL `wss://ws.relay.link` +The Websocket Service uses an API key for authentication and is available at the following URL `wss://ws.relay.link` To connect using an API key, provide your API key as a query param in the connection url: @@ -39,8 +39,6 @@ To connect using an API key, provide your API key as a query param in the connec const wss = new ws(`wss://ws.relay.link?apiKey=${YOUR_API_KEY}`); ``` -Authentication is generally not required in client-side applications. - **The websocket server needs to restart to deploy updates** diff --git a/references/api/quickstart.mdx b/references/api/quickstart.mdx index b7d34fb4..67f642e1 100644 --- a/references/api/quickstart.mdx +++ b/references/api/quickstart.mdx @@ -23,7 +23,7 @@ Follow this 5-step flow to integrate Relay into your application: ### API key Provisioning - Create an API key in the [Relay Dashboard](https://dashboard.relay.link) to raise your rate limits.
+ Create an API key in the [Relay Dashboard](https://dashboard.relay.link).
See [API keys and Rate Limits](/references/api/api-keys) for usage and limits. diff --git a/snippets/GetAnApiKey.mdx b/snippets/GetAnApiKey.mdx index ae565b54..2b72e26b 100644 --- a/snippets/GetAnApiKey.mdx +++ b/snippets/GetAnApiKey.mdx @@ -1,3 +1,3 @@ -Create an API key in the [Relay Dashboard](https://dashboard.relay.link) to raise your rate limits. +Create an API key in the [Relay Dashboard](https://dashboard.relay.link). From aaa7fb59ff66c6c67859496c7cc43a151b9be725 Mon Sep 17 00:00:00 2001 From: aj fernandez Date: Fri, 17 Jul 2026 17:29:21 -0400 Subject: [PATCH 2/3] docs(api-keys): drop residual elevated-limits wording 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 --- references/api/api-keys.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/references/api/api-keys.mdx b/references/api/api-keys.mdx index 108ce413..d7a681af 100644 --- a/references/api/api-keys.mdx +++ b/references/api/api-keys.mdx @@ -56,7 +56,7 @@ To request higher limits, get in touch through the support widget in the [Relay ### HTTP requests -Pass the key in the request headers on every call where you want elevated limits: +Pass the key in the request headers on every request: ``` x-api-key: YOUR_API_KEY @@ -95,7 +95,7 @@ const quote = await getClient()?.actions.getQuote(quoteParams, undefined, { ### Proxy API -If you're calling the SDK from the browser, stand up a proxy that appends the key server-side and point `baseApiUrl` at it. This keeps the key out of client bundles while preserving elevated limits. +If you're calling the SDK from the browser, stand up a proxy that appends the key server-side and point `baseApiUrl` at it. This keeps the key out of client bundles while preserving your key's rate limits. ```typescript import { From 82a41ec15a55e3f4232d21076fe56c46af4be401 Mon Sep 17 00:00:00 2001 From: aj fernandez Date: Fri, 17 Jul 2026 17:32:51 -0400 Subject: [PATCH 3/3] docs(api-keys): use "self-serve" over "self-minted" 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 --- references/api/api-keys.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/references/api/api-keys.mdx b/references/api/api-keys.mdx index d7a681af..cec822d4 100644 --- a/references/api/api-keys.mdx +++ b/references/api/api-keys.mdx @@ -3,7 +3,7 @@ title: "API keys and Rate Limits" description: "Create API keys in the Relay Dashboard to authenticate requests and manage your rate limits" --- -Relay enforces rate limits to keep the platform reliable for every integrator. You manage API keys in the [Relay Dashboard](https://dashboard.relay.link) — create new API keys, rotate existing ones, and inspect individual requests. Default limits listed below apply to self-minted API keys. +Relay enforces rate limits to keep the platform reliable for every integrator. You manage API keys in the [Relay Dashboard](https://dashboard.relay.link) — create new API keys, rotate existing ones, and inspect individual requests. Default limits listed below apply to self-serve API keys. ## Creating an API key