Getting started with Translate

Yandex Translate provides its own API for integrating translation algorithms into your applications. If you want to use a UI for translation, use Yandex Translator.

In this section, you will learn how to translate text using the Translate API.

To use the examples, install cURL.

Refer to the step-by-step guides for more examples in different programming languages.

To learn how to create a service account and an API key to integrate Yandex Translate into your application, see How to create an API key for accessing Yandex Cloud AI Studio.

Getting started

  1. On the Billing page, make sure you have a billing account that is either ACTIVE or TRIAL_ACTIVE. If you do not have a billing account yet, create one.

  2. To authenticate on behalf of a service account, you can use an API key or an IAM token; to authenticate on behalf of a user account, you can only use an IAM token.

    Get your account credentials for authentication in the Translate API:

    1. If you do not have a service account, create one.

    2. Assign the ai.translate.user role for the folder to the service account.

    3. Get the ID of the folder your service account was created in. Make sure to provide the folder ID in the folderId field in the body of each request.

    4. Create an API key with the yc.ai.translate.execute scope.

      Provide the key in the Authorization header of each request in the following format:

      Authorization: Api-Key <API_key>

    1. Get the ID of any folder for which your account has the ai.translate.user role or higher. Make sure to provide the folder ID in the folderId field in the body of each request.

    2. Get an IAM token for your Yandex account, federated account, local account, or service account.

      Provide the token in the Authorization header of each request in the following format:

      Authorization: Bearer <IAM_token>

Translating text

The example below is for MacOS and Linux. To implement it in Windows, see how to use Bash in Microsoft Windows.

This example shows how to translate two lines containing Hello and World into Russian. The text source language will be detected automatically.

  1. Create a file with the request body, e.g., body.json:

    {
            "folderId": "<folder_ID>",
            "texts": ["Hello", "World"],
            "targetLanguageCode": "ru"
        }

    Where:

  2. Provide the file for translation by running this command:

    export API_KEY=<API_key>
        curl \
          --request POST \
          --header "Content-Type: application/json" \
          --header "Authorization: Api-Key ${API_KEY}" \
          --data '@<path_to_JSON_file>' \
          "https://translate.api.cloud.yandex.net/translate/v2/translate"

    Where API_KEY is the API key you got before you started. If you use an IAM token for authentication, change the Authorization header to "Authorization: Bearer <IAM_token>".

    This will return the translated text lines:

    {
            "translations": [
                {
                "text": "Привет",
                "detectedLanguageCode": "en"
                },
                {
                "text": "Мир",
                "detectedLanguageCode": "en"
                }
            ]
        }

What's next

Previous
About Translate
Next
Supported languages