Skip to main content

Interface: LibreTranslateClient

Defined in: src/client.ts:97

Properties​

baseUrl​

readonly baseUrl: string

Defined in: src/client.ts:99

The instance's normalized URL.

hasApiKey​

readonly hasApiKey: boolean

Defined in: src/client.ts:101

Whether requests carry an API key.

Methods​

call()​

call(operationId, body?, options?): Promise<unknown>

Defined in: src/client.ts:124

Calls one operation by operationId with its raw request body, the API key added. The typed methods above are the usual way; this is what the MCP's generic tools use.

Parameters​

operationId​

OperationId

body?​

unknown

options?​

CallOptions

Returns​

Promise<unknown>

detect()​

detect(text, options?): Promise<Detection[]>

Defined in: src/client.ts:107

The candidate languages of a text, most likely first.

Parameters​

text​

string

options?​

CallOptions

Returns​

Promise<Detection[]>

downloadFile()​

downloadFile(url, options?): Promise<DownloadedFile>

Defined in: src/client.ts:119

Downloads a translated file (or any URL on the instance) as bytes.

Parameters​

url​

string

options?​

CallOptions

Returns​

Promise<DownloadedFile>

health()​

health(options?): Promise<Health>

Defined in: src/client.ts:113

{ status: "ok" } when the instance is up.

Parameters​

options?​

CallOptions

Returns​

Promise<Health>

languages()​

languages(options?): Promise<Language[]>

Defined in: src/client.ts:109

Every source language with the languages it translates into.

Parameters​

options?​

CallOptions

Returns​

Promise<Language[]>

settings()​

settings(options?): Promise<FrontendSettings>

Defined in: src/client.ts:111

The instance settings: key required, character limit, file formats, suggestions.

Parameters​

options?​

CallOptions

Returns​

Promise<FrontendSettings>

suggest()​

suggest(params, options?): Promise<SuggestResponse>

Defined in: src/client.ts:115

Sends a better translation back (the instance must enable suggestions).

Parameters​

params​

SuggestParams

options?​

CallOptions

Returns​

Promise<SuggestResponse>

translate()​

translate(params, options?): Promise<TranslateTextResult>

Defined in: src/client.ts:103

Translates one text.

Parameters​

params​

TranslateTextParams

options?​

CallOptions

Returns​

Promise<TranslateTextResult>

translateFile()​

translateFile(params, options?): Promise<TranslateFileResponse>

Defined in: src/client.ts:117

Uploads a document to translate; download the result from translatedFileUrl with downloadFile.

Parameters​

params​

TranslateFileParams

options?​

CallOptions

Returns​

Promise<TranslateFileResponse>

translateMany()​

translateMany(params, options?): Promise<TranslateManyResult>

Defined in: src/client.ts:105

Translates several texts in one request.

Parameters​

params​

TranslateManyParams

options?​

CallOptions

Returns​

Promise<TranslateManyResult>