Toptranslation Translation API

Separated Toptranslation APIs

To separate different services and its data our APIs are served by separated APIs.

E.g. the Base-API serves endpoints for managing a users orders, invoices and user data. The authentication service serves endpoints to for the sign ins, managin access tokens or changing a users password. The file service is the only service that handles documents and therefore serves endpoints for up- and downloading documents.

API for managing users, orders, translations, cost-centers, teams etc.
Provides endpoints to authenticate or register a user and to manage the access tokens required by the Base API.
Manages up- and downloads of documents.
Offers endpoints to serve mostly static data, like the currently available languages or countries used in the Toptranslation API.

How-to create an order via the API

1. Authenticate

Use the v2/sign_in endpoint from the Authentication Service to sign in the user.


The endpoint will return an access token that you can you use to authenticate against the Base-API. See "Sign in" in the authentication service api for more details.

2. Upload documents to fileserver

Use the file service API to upload a document you want to translate to the file service.


The endpoint answers with a token for each document. This token will later be used to add the document to an order. See "Upload a document" in the file service api for more details.

3. Create an order

Use the Base API to create an empty order and add meta-data like a briefing or the desired delivery date.


The endpoint answers with an order object that includes the identifier for the order. See "Create an order" in the base api for more details.

4. Add documents to order

Use the token that was returned from the file service in step 2 to identify the uploaded document for this request.


See "Add document to an order" in the base api for more details.

5. Request order

When all documents have been added and the order is ready to be sent to our project managers, the order needs to be marked as requested. This is the sign for the API that the order is now complete and ready to be processed.


See "Request an order" in the base api for more details.

6. Optional - Quote workflow

If no frame contract is in place or a quote is required Toptranslation will create a quote that needs to be accepted by the user before translation will begin. The base API servers endpoints to manage the quotes of an order.


List all available quotes for an order.


See "List quotes of an order" for more details.


Accept the quote. After this the translators will start the translation process.


See "Accept a quote" for more details.

7. Check translation status of an order


The response includes the documents added to the order. The documents include the translations of the document. The attribute downloadable shows if a translation can be downloaded. See "List documents of an order" for more details.

8. Get download URL for a translation

To download a translation the base API provides a method to retrieve the download url for a translation. For this use the translation identifier to identify the translation you want to download.


The endpoint will return a download link that links to the file service and contains a token that will expire after a given time.

Lexeri Terminology management API

Lexeri is the terminology management solution of Toptranslation. Lexeri comes with a separate API and uses Toptranslations User-API and Document-API services for user information or document up- and download.

Lexeri API
Terminology management API to serve termbases, terms, term requests etc.

Developer resources

You can find the following other resources

Current status of our systems

You can find information about upcoming scheduled maintenances, current issues or outages of our services on our status page.

Follow our developers on Twitter

We will tweet about new API version and other changes to our services as well as the developer life at Toptranslation.

Create your own application

Creating an application with our APIs will be publically available soon. For now please contact us if you want to create an application and we will be happy to help you out.