Authentication with the Yandex Foundation Models API
To use the Yandex Foundation Models API, you need to get authenticated:
-
Get an IAM token for your Yandex account or federated account.
-
Get the ID of the folder for which your account has the minimum required role to work with the model:
ai.languageModels.user
or higher: For text generation models.ai.imageGeneration.user
or higher: For YandexART.ai.assistants.editor
andai.languageModels.user
or higher: For AI Assistant API.
You will need the folder ID to get the model's URI.
-
When accessing Foundation Models via the API, specify the IAM token in the
Authorization
header of each request:Authorization: Bearer <IAM_token>
To access Foundation Models, your service account needs at least the minimum required role:
ai.languageModels.user
or higher: For text generation models.ai.imageGeneration.user
or higher: For YandexART.ai.assistants.editor
andai.languageModels.user
or higher: For AI Assistant API.
The Foundation Models API supports two methods of authentication with a service account:
-
With an IAM token:
-
Provide the IAM token in the
Authorization
header in the following format:Authorization: Bearer <IAM_token>
-
With API keys.
Use API keys if requesting an IAM token automatically is not an option.
-
Provide the API key in the
Authorization
header in the following format:Authorization: Api-Key <API_key>
Do not specify the folder ID in your request headers, as the service uses the folder the service account was created in. However, you will need the parent folder ID to get the model's URI.