Authentication
Transcription:BatchReal-TimeDeployments:AllYour 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 reach out to 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
- Real-Time 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"
wss://eu2.rt.speechmatics.com/v2
Authenticating Using Temporary Tokens
Speechmatics also allows you to generate a temporary token (JWT) which can be used for starting real-time transcription sessions.
This is particularly useful for real-time transcription happening on an end-user's browser. It allows for lower latency transcription, with lower implementation effort and without exposing your long-lived API key.
See here for more details on using temporary tokens.
If you are an enterprise customer and would like to use temporary tokens, please reach out to Support or speak to your Account Manager.
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 |
API keys 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.