From fd417ecd2466d09ad15b6e021e6cae3c289d0ae4 Mon Sep 17 00:00:00 2001 From: AleksaStojanovic <45732802+AleksaStojanovic@users.noreply.github.com> Date: Fri, 20 Mar 2026 17:56:46 +0100 Subject: [PATCH] Remove filler phrases and fix American English spelling in authentication.mdx Removed two instances of "Note that..." filler phrase and fixed British English spelling "minimise" to American English "minimize" in line with the style guide. This is also a test run for the support team to get started with editing the docs --- docs/get-started/authentication.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/get-started/authentication.mdx b/docs/get-started/authentication.mdx index a5dce2e2..dff8c119 100644 --- a/docs/get-started/authentication.mdx +++ b/docs/get-started/authentication.mdx @@ -109,7 +109,7 @@ When you generate a temporary key with a `client_ref`, that temporary key will o `client_ref` should be a `string` that uniquely identifies an end-user. :::info -Note that temporary keys generated with a `client_ref` can't access the [Usage Batch API endpoint](/api-ref/batch/get-usage-statistics) and will receive a `HTTP 403 - Forbidden`. +Temporary keys generated with a `client_ref` can't access the [Usage Batch API endpoint](/api-ref/batch/get-usage-statistics) and will receive a `HTTP 403 - Forbidden`. ::: :::warning @@ -157,7 +157,7 @@ curl -L -X POST "https://mp.speechmatics.com/v1/api_keys?type=rt" \ ``` :::info -Note that when starting a Realtime transcription session in the browser, you must provide the temporary key as a part of a query parameter. See our documentation on [browser based transcription](/api-ref/realtime-transcription-websocket#browser-based-transcription). +When starting a Realtime transcription session in the browser, you must provide the temporary key as a part of a query parameter. See our documentation on [browser based transcription](/api-ref/realtime-transcription-websocket#browser-based-transcription). ::: @@ -173,7 +173,7 @@ Note that when starting a Realtime transcription session in the browser, you mus | Request Body Parameters | Required | Description | |--------------|-----------|----------------------------------------------------------- -| `ttl` | Yes | Integer: 60-86400. The temporary key's time to live in seconds. **Note** We suggest using the shortest TTL possible to minimise security risks. +| `ttl` | Yes | Integer: 60-86400. The temporary key's time to live in seconds. **Note** We suggest using the shortest TTL possible to minimize security risks. | `client_ref` | No | String. When provided, `batch` tokens can only create and retrieve jobs with that reference; without it, they can access any job. **Must** be set when temporary keys are exposed to end-users to prevent accessing another user's data. `client_ref` is ignored when requesting `rt` tokens. | `region` | No | String: `eu` (default), `usa`, or `au` (Batch transcription only). Defines the region where the temporary key is valid.