▣ FILE CONVERSION · SMART GENERATION

Translate Documents API

What it does

Document Translator translates uploaded documents or documents fetched from a URL into a target language you choose. Send a file and a language code, or provide a url and language, and get translated text back along with the target language that was used.

Use the /file endpoint when you already have the document in hand. It accepts a binary file, a target language code such as fr or de, and optional file_type and transliteration query values. Use /url when the document is already hosted elsewhere; it accepts a url, a target language, and optional perform_transliteration, file_type, and transliteration values.

The response includes translation and translated_language as required fields. When language detection is available, you also get detected_language with a language code and confidence score. If transliteration is requested and supported, the response may also include transliteration.

Document Translator fits workflows such as localizing uploaded PDFs, translating reference docs from a public URL, or routing translated content into review and publishing systems without adding manual copy-paste steps.

▣ ENDPOINT 01 / 02

POST

Translate uploaded document

https://api.eu.apyverse.com/apyhub/translate-document-text/file

QUICKSTART

GUIDE

Quickstart

Translate a document file to a target language by uploading the file and the language code.

curl -X POST "https://api.eu.apyverse.com/apyhub/translate-document-text/file" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/document.pdf" \
  -F "language=fr"

What you'll get back

Returns a JSON object with required translation and translated_language string fields. It may also include optional transliteration and detected_language fields.

{
  "translation": "Translated document text.",
  "translated_language": "de"
}

TRY ITLIVE · 150 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

About this endpoint

What it does

Translates an uploaded document from the file you send in the request body and returns the translated text plus the translated language. It can also return detected language details and transliteration output when present in the response schema.

Query Parameter(s)

Attribute	Type	Mandatory	Description
file_type	String	No	Document file type, e.g. `pdf`.
transliteration	String	No	Whether transliteration is requested, e.g. `true`.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	Document file to translate. Binary file upload.
language	String	Yes	Azure target language code, e.g. `fr`, `de`.

Response

Returns a JSON object with required translation and translated_language string fields. It may also include transliteration as a string, and detected_language as an object containing score and language.

Parameter	Type	Mandatory	Description
translation	String	Yes	Translated document text.
transliteration	String	No	Present when transliteration was requested and supported.
detected_language	Object	No	Detected language details. Contains `score` and `language` when present.
detected_language.score	Number	No	Detection confidence score as a float.
detected_language.language	String	No	Detected language code, e.g. `en`.
translated_language	String	Yes	Translated language code, e.g. `de`.

Query parameters

Name

Type

Description

file_typeOPTIONAL

string

—

transliterationOPTIONAL

string

—

Body

Name

Type

Description

bodyREQUIRED

object

—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ ENDPOINT 02 / 02

POST

Translate document from URL

https://api.eu.apyverse.com/apyhub/translate-document-text/url

QUICKSTART

GUIDE

Quickstart

Translate a document from a URL into the target language.

curl -X POST "https://api.eu.apyverse.com/apyhub/translate-document-text/url?file_type=pdf" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://assets.apyhub.com/samples/sample.pdf",
    "language": "de"
  }'

What you'll get back

Returns a JSON object with translation and translated_language fields, plus optional transliteration and detected_language data when available.

{
  "translation": "Translated document text.",
  "translated_language": "de"
}

TRY ITLIVE · 150 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Translates a document fetched from a URL into the requested language. It takes the source document URL and target language in the request body, with optional query parameters that can influence file type handling and transliteration behavior.

Query Parameter(s)

Attribute	Type	Mandatory	Description
file_type	String	No	File type of the document, for example `pdf`.
transliteration	String	No	Transliteration setting, for example `true`.

Request Body

Parameter	Type	Mandatory	Description
url	String	Yes	Source document URL. Must be a URI.
language	String	Yes	Target language code, for example `de`.
perform_transliteration	Boolean	No	Whether transliteration should be performed.

Response

Returns a JSON object with required translation and translated_language string fields. It may also include a transliteration string field and a detected_language object with score and language fields.

Parameter	Type	Mandatory	Description
translation	String	Yes	Translated document text.
transliteration	String	No	Present when transliteration was requested and supported.
detected_language	Object	No	Detected source language information. Contains `score` and `language` when present.
detected_language.score	Number	No	Confidence score for the detected language.
detected_language.language	String	No	Detected language code, for example `en`.
translated_language	String	Yes	Target language code, for example `de`.

Query parameters

Name

Type

Description

file_typeOPTIONAL

string

—

transliterationOPTIONAL

string

—

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.