Configuration

Integrations

Let other self-hosted apps use TraDoc as their translation engine.

Other apps can send a document to TraDoc, follow its translation and get the rebuilt file back, without exporting and importing by hand. TraDoc translates it with its usual pipeline, and the project also appears in TraDoc, tagged with the app's name.

Connect an app

  1. Open Settings → Integrations.
  2. Name the connection, for example My library, and choose its default model.
  3. Select Create the connection and copy the key that starts with tdk_. It is shown only once.
  4. In the other app, enter the API address shown on the same page and the key.

Disconnect revokes the key immediately; projects already created stay in TraDoc.

What a connected app can do

  • check the connection and list the available models;
  • send an EPUB, PDF, DOCX, Markdown or text file, which starts translating with the connection's default model unless the app chooses another one;
  • follow progress, pause and resume;
  • download the translated file, or a partial preview before the end;
  • delete the projects it created.

A connection only sees its own projects. The TraDoc interface keeps working without a password; only the integration API requires the key. Outside a trusted network, put TraDoc behind HTTPS and an authenticating reverse proxy.

For developers

Endpoints, fields, statuses and a complete curl example are in the Integration API reference.