Skip to content

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

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jimmypsm wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −4
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions docs/api-ref/realtime-transcription-websocket.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ import realtimeSchema from "!asyncapi-schema-loader!@site/spec/realtime.yaml";
<h2 className="openapi__method-endpoint-path">wss://eu.rt.speechmatics.com/v2/</h2>
</pre>

:::info
You can also connect to `wss://global.rt.speechmatics.com/v2/`, which automatically routes to the lowest-latency region. Customers with data residency requirements should use a regional endpoint (`eu.rt` / `us.rt`) instead. See [Supported endpoints](/get-started/authentication#supported-endpoints).
:::
Comment on lines +26 to +28

@petemomo petemomo Jun 22, 2026

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.

Three small consistency points on this note:

  1. Person — "Customers with data residency requirements should use…" is third person, while the matching warning on the authentication page uses second person ("If you have data residency or compliance requirements…"). The style guide defaults to "you"; worth matching.
  2. Hostnames — this abbreviates eu.rt / us.rt, whereas the authentication page uses the full eu.rt.speechmatics.com / us.rt.speechmatics.com. Suggest the full forms.
  3. Duplication — the data-residency caveat now lives on both this page and the authentication page. Since this note already links to Supported endpoints, consider trimming it to the new fact (you can connect to the global endpoint) plus the link, and letting the authentication page be authoritative on the caveat.

(Refs: style guide #6 second person; terminology consistency; governance — link rather than duplicate.)


## Protocol overview

A basic Realtime session will have the following message exchanges:
Expand Down
15 changes: 11 additions & 4 deletions docs/get-started/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,17 @@ The EU2 and US2 Batch SaaS endpoints are provided for enterprise customer high a

Speechmatics Realtime SaaS supports the following endpoints for production use:

| Customer type | Region | Endpoint |
| ------------- | ------------ | ---------------------- |
| All | EU1 (Europe) | eu.rt.speechmatics.com |
| All | US1 (USA) | us.rt.speechmatics.com |
| Customer type | Region | Endpoint |
| ------------- | ----------------------- | -------------------------- |
| All | Global (lowest-latency) | global.rt.speechmatics.com |

@petemomo petemomo Jun 22, 2026

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.")

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

:::warning
`global.rt.speechmatics.com` may route a connection to any region. If you have data residency or compliance requirements, use a regional endpoint (`eu.rt.speechmatics.com` or `us.rt.speechmatics.com`) instead.
:::
</TabItem>
</Tabs>

Expand Down