Translate PDF

The file parameter allows you to select a local file to be uploaded to pdfRest’s processing server for processing. PDF (.pdf), Markdown (.md), and Plain Text (.txt) files are supported for translation.

This is a required field unless you include the id parameter instead.

The id parameter allows you to submit a resource ID for a file already on the processing server. Each of our API Tools assigns a unique resource ID to all uploaded input files and generated output files and returns these IDs in the response to each API Call. This allows you to store the IDs from one call and submit them to the next, chaining requests together without having to download intermediate files between requests.

This is a required field unless you include the file parameter instead.

The output_language parameter specifies the target language for the text translation.

This parameter controls the language into which the content of the PDF, Markdown, or Plain Text file will be translated.

The language must be provided as a standard IETF BCP 47 language tag, which typically follows the format: {language code}-{subtag}.

Components of the Language Tag:

• Language Code: The primary language identifier (2 or 3 letters, ISO 639). Examples: en (English), zh (Chinese).
• Script Subtag (Optional): Specifies a writing script (4 letters, ISO 15924). Examples: Latn (Latin), Cyrl (Cyrillic), Hant (Traditional Han).
• Region Subtag (Optional): Specifies a country or regional dialect. This can be a 2-letter country code (e.g., US, BR) or a 3-digit numeric region code (e.g., 419 for Latin America).

Examples of valid output_language values:

• es (Spanish)
• zh-Hant (Chinese, Traditional Script)
• en-GB (English, United Kingdom)
• pt-BR (Portuguese, Brazil)
• fr-419 (French, Latin America)

The pages parameter specifies the page or range of pages within the PDF document whose text content should be translated.

This allows you to target specific sections of a large document, avoiding the translation of irrelevant content such as cover pages, indices, or appendices. This parameter is ignored if the input is a Markdown (.md) or Plain Text (.txt) file.

The accepted values include:

• Single Page: 3
• Range: 5-10
• Combinations: 1, 5, 10-last

Default: 1-last (The entire document is processed).

The output_format parameter controls whether the translated text should contain Markdown syntax.

This is essential for preparing the translated text for its final destination:

• markdown: The output text includes Markdown syntax (headings, lists, bold/italic) which is ideal for LLM training or direct rendering in web applications, documentation, or content management systems.
• plaintext: The output is raw, unformatted text, perfect for direct ingestion into databases or simple text fields.

Accepted values: plaintext, markdown Default: markdown

The output_type parameter determines how the translated content is delivered back to your application.

This control allows you to optimize your workflow based on performance and file size:

• json: The translated content is included directly within the API's JSON response body, enabling the fastest possible integration for immediate application use.
• file: The API returns a secure, time-limited download URL, which is typically preferred for very large translations or for workflows requiring the content to be stored in an external location.

Accepted values: file, json Default: json

The output parameter specifies the name of the generated output file.

This parameter is only relevant when the output_type is set to file. The value provided will be used as the filename for the downloadable translation, but you should not include the file extension (e.g., use translated_report not translated_report.md).