Set Up

1. Create Soniox Account

Create a free Soniox Account to obtain an API key. The API key gives you free access to Soniox API services. You can find your API key under the Manage API Keys tab in Soniox Cloud.

Soniox Account is free of charge and does not require credit card information. You get 300 minutes/month of free speech recognition AI services through Soniox API. If you require additional free usage, contact us, and we will assign you additional free minutes.

2. Download Examples

Clone our soniox_examples GitHub repository with all the code examples and test audio files. We will refer to these examples and audio files throughout our how-to guides.

git clone https://github.com/soniox/soniox_examples.git

3. Install Client Library

Choose any of our available client libraries to ease the integration of Soniox API into your application.

The package includes core functionality for accessing Soniox API.

pip3 install --upgrade pip
pip3 install --upgrade setuptools
pip3 install --upgrade soniox

4. Authenticate

To authenticate your requests, you have to specify the API key. You can find your API key under the Manage API Keys tab in Soniox Cloud.

from soniox.speech_service import Client, set_api_key

set_api_key("<YOUR-API-KEY>")

# From now on when you create Client object, the API key 
# is set automatically for all requests.

You can also set your API key via SONIOX_API_KEY bash variable, which will be then automatically used by the client library.

export SONIOX_API_KEY=<YOUR_API_KEY>

The package includes core functionality for accessing Soniox API.

cd soniox_examples/node
npm install

4. Authenticate

To authenticate your requests, you have to specify the API key. You can find your API key under the Manage API Keys tab in Soniox Cloud.

const { SpeechClient } = require("@soniox/soniox-node");

const speechClient = new SpeechClient({ api_key: "<YOUR-API-KEY>" });

// From now on when you use speechClient object, the API key 
// is set automatically for all requests.

You can also set your API key via SONIOX_API_KEY bash variable, which will be then automatically used by the client library.

export SONIOX_API_KEY=<YOUR_API_KEY>

If the client library is not yet available for your programming language, see gRPC section on how to use Soniox API in almost any programming language.

cookie Change your cookie preferences