Yandex Translate API reference

New to Corsair? See API access, authentication, and error handling.

Detect Languages

detectLanguages.run Detect the language of each passage, one result per entry and in order Risk: read

await corsair.yandex.api.detectLanguages.run({ texts: ['Hello', 'Guten Tag'] });

Input

Name	Type	Required	Description
`texts`	`string[]`	Yes	—
`folderId`	`string`	No	The Yandex Cloud folder to bill and scope the call to. Required with a user account’s IAM token; leave it out with a service-account API key or IAM token, which use the service account’s folder.

Output

Name	Type	Required	Description
`detections`	`object[]`	Yes	—

detections full type

{
  languageCode: string
}[]

listLanguages.run List the supported languages, with their codes and display names Risk: read

await corsair.yandex.api.listLanguages.run({});

Input

Name	Type	Required	Description
`folderId`	`string`	No	The Yandex Cloud folder to bill and scope the call to. Required with a user account’s IAM token; leave it out with a service-account API key or IAM token, which use the service account’s folder.

Output

Name	Type	Required	Description
`languages`	`object[] \| null`	No	—

languages full type

{
  code?: string | null,
  name?: string | null
}[] | null

translate.text Translate up to 1,000 passages into a target language, detecting the source per passage when it is not given Risk: read

await corsair.yandex.api.translate.text({ targetLanguageCode: 'ru', texts: ['Hello'] });

Input

Name	Type	Required	Description
`targetLanguageCode`	`string`	Yes	The language to translate into, such as `ru` or `en`.
`texts`	`string[]`	Yes	The passages to translate. Each is translated separately.
`sourceLanguageCode`	`string`	No	The source language. Omit to detect it.
`format`	`PLAIN_TEXT \| HTML`	No	How the text is interpreted. Defaults to PLAIN_TEXT.
`speller`	`boolean`	No	Correct spelling in the result.
`folderId`	`string`	No	The Yandex Cloud folder to bill and scope the call to. Required with a user account’s IAM token; leave it out with a service-account API key or IAM token, which use the service account’s folder.

Output

Name	Type	Required	Description
`translations`	`object[]`	Yes	—

translations full type

{
  text: string,
  detectedLanguageCode?: string | null
}[]