Authentication

Transcription:Batch Real-Time Deployments:All

Your API key must be used with any interaction with the Speechmatics API to authenticate to the service. Any interaction without this key will receive a HTTP 401 - Unauthorized response.

It is recommended that you store and provide access to the API key on the principle of least privilege. If you believe that your key has been compromised, please contact Speechmatics Support.

Get your API key

Navigate to the manage access page of the Speechmatics portal to create an API key. You may need to register and sign in if you haven't already.

Enter a name for your API key and then store it somewhere safe when you have generated it.

Authenticating

Batch transcription

Your API key needs to be included in the header of all requests to the Speechmatics Jobs API. For example:

curl -X GET "https://asr.api.speechmatics.com/v2/jobs/" \
  -H "Authorization: Bearer $API_KEY"`}

Real-Time transcription

Authentication on the Speechmatics Real-Time SaaS is done in two steps:

1. Generate a temporary key
2. Start the WebSocket handshake process with your temporary key

To generate your temporary key:

curl -L -X POST "https://mp.speechmatics.com/v1/api_keys?type=rt" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{"ttl": 60}'`}

Your temporary key must then be provided in the WebSocket connection request header. On-demand SaaS customers should use the following endpoint to start transcribing in English:

wss://eu2.rt.speechmatics.com/v2/en

info

If you are an enterprise customer, you should use your API key to start the WebSocket handshake process, without generating a temporary key. Please also refer to the list of suppported endpoints below for details.

Supported endpoints

Speechmatics Batch SaaS supports the following endpoints for production use:

Customer type	Region	Environment	Endpoints
On-demand	N/A	N/A	asr.api.speechmatics.com
Enterprise	EU	EU1	eu.asr.api.speechmatics.com eu1.asr.api.speechmatics.com asr.api.speechmatics.com
Enterprise	EU	EU2	eu2.asr.api.speechmatics.com
Enterprise	US	US1	us.asr.api.speechmatics.com us1.asr.api.speechmatics.com
Enterprise	US	US2	us2.asr.api.speechmatics.com
Enterprise	AU	AU1	au1.asr.api.speechmatics.com

Speechmatics Real-Time SaaS supports the following endpoints for production use:

Customer type	Region	Environment	Endpoints
On-demand	EU	EU2	eu2.rt.speechmatics.com
Enterprise	EU	EU1	neu.rt.speechmatics.com
Enterprise	US	US1	wus.rt.speechmatics.com

Authorization Tokens are replicated between all environments in the same region. Therefore, you can use any environment in a region that you are entitled to access.

All production environments are active and highly available. Multiple environments can be used to balance requests or provide a failover in the event of disruption to one environment.

Note that jobs are created in the environment corresponding to the endpoint used. You must use the same endpoint for all requests relating to a specific job.

If you attempt to use an endpoint for a region you are not contracted to use, that request will be unsuccessful. If you want to use a different region, please contact sales@speechmatics.com.

Enterprise trials

The Batch SaaS Trial endpoint is trial.asr.api.speechmatics.com

If you are using the trial Speechmatics endpoint, please note your authorization token may be time limited. If you try and use the token after the trial period has expired, you will receive a HTTP 401 - Unauthorized response.