Authentication with the SpeechKit API
To work with the SpeechKit API, you need to pass authentication. The authentication method depends on the account type:
- Get an IAM token for your Yandex account or federated account.
- Get the ID of the folder for which your account has the
ai.speechkit-stt.user,ai.speechkit-tts.user, or higher roles. -
When accessing SpeechKit via the API, provide the received parameters in each request:
-
For API v1 and API v2:
Specify the IAM token in the
Authorizationheader in the following format:Authorization: Bearer <IAM token>Specify the folder ID in the request body in the
folderIdparameter. -
For API v3:
- Specify the IAM token in the
Authorizationheader. - Specify the folder ID in the
x-folder-idheader.
Authorization: Bearer <IAM_token> x-folder-id <folder_ID> - Specify the IAM token in the
-
SpeechKit supports two authentication methods based on service accounts:
-
With an IAM token:
-
Get an IAM token.
-
Provide the IAM token in the
Authorizationheader in the following format:Authorization: Bearer <IAM_token>
-
-
With API keys.
API keys do not expire. This means that this authentication method is simpler, but less secure. Use it if you can't automatically request an IAM token.
-
Provide the API key in the
Authorizationheader in the following format:Authorization: Api-Key <API_key>
Do not specify the folder ID in your requests, as YandexGPT uses the folder in which the service account was created.