Skip to content

Add global.rt.speechmatics.com to Realtime endpoints docs#263

Open
jimmypsm wants to merge 7 commits into
mainfrom
global-rt-endpoint
Open

Add global.rt.speechmatics.com to Realtime endpoints docs#263
jimmypsm wants to merge 7 commits into
mainfrom
global-rt-endpoint

Conversation

@jimmypsm

Copy link
Copy Markdown

What

Documents the new global real-time endpoint global.rt.speechmatics.com (lowest-latency routing across regions, additive — the existing eu.rt / us.rt regional endpoints are unchanged).

  • docs/get-started/authentication.mdx — adds a global.rt.speechmatics.com row to the Realtime SaaS "Supported endpoints" table, a one-line description, and a :::warning data-residency caveat (residency-sensitive customers should use a regional endpoint).
  • docs/api-ref/realtime-transcription-websocket.mdx — adds a :::info note that you can connect to wss://global.rt.speechmatics.com/v2/, linking back to Supported endpoints.

Validation

  • npm run build passes; the new #supported-endpoints anchor resolves.
  • npm run spellcheck clean.

@vercel

vercel Bot commented Jun 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 3, 2026 2:15pm

Request Review

Comment thread docs/get-started/authentication.mdx Outdated
| All | US1 (USA) | us.rt.speechmatics.com |
| Customer type | Region | Endpoint |
| ------------- | ----------------------- | -------------------------- |
| All | Global (lowest-latency) | global.rt.speechmatics.com |

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Region column label consistency. Every other row in this table follows a CODE (Place) pattern — EU1 (Europe), US1 (USA) — whereas Global (lowest-latency) puts a behaviour descriptor where the others put a location. The sentence directly below the table already explains the lowest-latency routing, so consider just Global in the Region column to keep the reference table structurally consistent.

(Ref: style guide, Reference — "Every entry must be structurally consistent with every other entry of the same type.")

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Addressed — though it landed on All regions rather than bare Global. A later review flagged that Global reads as a routing mode, not a location, under a column headed Region; All regions satisfies both your structural-consistency point and that precision point, and the lowest-latency routing is still spelled out in the sentence below the table. Also bolded the endpoints to match the Batch table. Happy to switch to bare Global if you'd prefer it.

Comment thread docs/api-ref/realtime-transcription-websocket.mdx

@jimmypsm jimmypsm left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Docs review against CLAUDE.md governance (docs-style-guide, terminology, product-architecture).

Verdict: approve with one content fix + one flag. Terminology and style are clean — prose is concise and admonition syntax is correct.

  • Fix: the region param note over-generalizes to all temp keys (inline comment on line 189).
  • Flag: the global-endpoint routing, data-residency, and cross-region temp-key statements are product claims not covered by product-architecture.md — verify against DEL-33644 / the RT platform team, not project docs.

Inline comments below.

Comment thread docs/get-started/authentication.mdx Outdated
Comment thread docs/get-started/authentication.mdx Outdated
| All | US1 (USA) | us.rt.speechmatics.com |
| Customer type | Region | Endpoint |
| ------------- | ----------------------- | -------------------------- |
| All | Global | global.rt.speechmatics.com |

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Two small things on this table:

  • "Global" isn't a region — it's a routing mode. All regions or a footnote would be more precise under a column headed Region.
  • Bold inconsistency: the Batch SaaS table above bolds endpoints (**eu1...**), this one doesn't. Pre-existing, but worth aligning since you're already editing it.

Comment thread docs/get-started/authentication.mdx
Comment thread docs/get-started/authentication.mdx
Comment thread docs/get-started/authentication.mdx Outdated
Comment thread docs/api-ref/realtime-transcription-websocket.mdx Outdated
Comment thread docs/get-started/authentication.mdx Outdated
| ------------- | ------------ | ------------------------------ |
| All | All regions | **global.rt.speechmatics.com** |
| All | EU1 (Europe) | **eu.rt.speechmatics.com** |
| All | US1 (USA) | **us.rt.speechmatics.com** |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we remove the "Customer Type" column, it feels redundant now.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Done — dropped the Customer type column from the Realtime table (all rows were All). Kept it on the Batch table above, where it still distinguishes All vs Enterprise (EU2/US2).

Comment thread docs/get-started/authentication.mdx Outdated
| All | EU1 (Europe) | **eu.rt.speechmatics.com** |
| All | US1 (USA) | **us.rt.speechmatics.com** |

`global.rt.speechmatics.com` automatically routes each connection to the lowest-latency region, so you do not have to choose one. The regional endpoints remain available if you want to pin to a specific region.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"automatically routes each connection to the nearest region for lowest latency, so you don't have to select one."

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Applied verbatim: "…automatically routes each connection to the nearest region for lowest latency, so you don't have to select one."

</pre>

:::info
You can also connect to `wss://global.rt.speechmatics.com/v2/`, which automatically routes to the lowest-latency region. See [Supported endpoints](/get-started/authentication#supported-endpoints).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You can either pin to a specific region for data residency or connect to wss://global.rt.speechmatics.com/v2/ which automatically routes each connection to the nearest region for lowest latency. See Supported endpoints.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Applied your wording to the info note. Done in da6a406.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants