Skip to main content
POST
Translate Document Api

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

document_id
string
required

The document id

tenant
string | null
required

The domain of the customer

Example:

"example.com"

Body

application/json
document_id
string
required

The ID of the document to translate

target_language
string
required

The target language for translation (e.g. 'French', 'German', 'Spanish')

attachment_filters
AttachmentFilter · object[] | null

The attachments to translate. If provided, only attachments matching one of the filters are translated. If not provided, all supported attachments will be translated.

prompt_extension
string
default:""

Optional additional instructions appended to the translation prompt

pubsub_topic
string | null

Fully-qualified Pub/Sub topic ('projects//topics/') to receive per-attachment completion/failure notifications. If omitted, no notifications are sent.

Response

Successful Response

translations_started
TranslationStartedAttachment · object[]
required

List of attachments for which translation has been started