Skip to content

List translations

GET
/translations/

Ce point d’accès, publiquement accessible, retourne une liste paginée de toutes les paires de traduction disponibles dans le système.

Il est possible de filtrer les résultats et de naviguer à travers les pages en utilisant des paramètres dans l’URL.

lang_from
string

Filtre par langue source en utilisant son code ISO 639-1 (ex: “en”).

Example
fr
lang_to
string

Filtre par langue de destination en utilisant son code ISO 639-1 (ex: “fr”).

skip
integer

The number of items to skip from the beginning of the result set. This is used for pagination, often referred to as the ‘offset’.

limit
integer

The maximum number of items to return in the response. This is used to control the page size.

Example
100

Successful response (inferred from assertions)

object
data
required
Array<object>

Represents an available translation capability from a specific source language to a target language.

object
id
required

The unique numeric identifier for this specific translation path (e.g., English to French).

integer
Example
5
model
required

The name of the underlying machine translation model used for this language pair.

string
Example
nllb-200-distilled-600M
active
required

Indicates whether this translation path is available for use. An inactive translation (false) cannot be requested when creating a live session.

boolean
Example
true
vram
required

The additional amount of Video RAM (in Megabytes) required to load this translation model. This is added to the VRAM of the base transcription model.

integer
Example
850
lang_from
required

The source language that can be translated from.

object
id
required

The unique numeric identifier for the language. This is the internal primary key.

integer
Example
10
iso_639_1
required

The standard two-letter ISO 639-1 code for the language. This is the primary field you should use when specifying a language for a new transcription session.

string
Example
en
name
required

The full, human-readable name of the language in English.

string
Example
English
active
required

Indicates whether the language is currently available for transcription. An inactive language (false) cannot be selected when creating a new live session.

boolean
Example
true
lang_to
required

The target language that the source can be translated into.

object
id
required

The unique numeric identifier for the language. This is the internal primary key.

integer
Example
10
iso_639_1
required

The standard two-letter ISO 639-1 code for the language. This is the primary field you should use when specifying a language for a new transcription session.

string
Example
en
name
required

The full, human-readable name of the language in English.

string
Example
English
active
required

Indicates whether the language is currently available for transcription. An inactive language (false) cannot be selected when creating a new live session.

boolean
Example
true
pagination
required
object
total_items
required

The total number of items available in the entire dataset that match the query, across all pages.

integer
total_pages
required

The total number of pages calculated from total_items and per_page. A client can use this to build page navigation UI.

integer
current_page
required

The page number for the current set of items being returned. This is typically controlled by skip and limit or page and size query parameters.

integer
per_page
required

The maximum number of items configured to be returned on a single page. This is typically controlled by a limit query parameter.

integer
Example
{
"data": [
{
"model": "opus-mt-en-fr",
"active": false,
"vram": 800,
"id": 1,
"lang_from": {
"iso_639_1": "en",
"name": "English",
"id": 1,
"active": true
},
"lang_to": {
"iso_639_1": "fr",
"name": "French",
"id": 2,
"active": true
}
},
{
"model": "opus-mt-en-de",
"active": false,
"vram": 800,
"id": 2,
"lang_from": {
"iso_639_1": "en",
"name": "English",
"id": 1,
"active": true
},
"lang_to": {
"iso_639_1": "de",
"name": "German",
"id": 3,
"active": true
}
}
],
"pagination": {
"total_items": 2,
"total_pages": 1,
"current_page": 1,
"per_page": 100
}
}