TranslaQEDevelopers

Authentication

API keys, live and test modes, the request limit and the id of every request.

Every request carries your API key as a bearer token. The base address is https://api.translaqe.com and every route starts with /v1.

POST /v1/translate HTTP/1.1
Host: api.translaqe.com
Authorization: Bearer tq_live_…
Content-Type: application/json

Only GET /v1/languages works without a key.

Keys

Keys are created and revoked in the web app, under API keys. A key is shown once, when you create it: TranslaQE stores only a fingerprint of it, so it cannot be shown again. If you lose it, create another and revoke the old one.

A key acts for your whole organisation: it can translate, read every document and manage memories, glossaries and projects. Treat it like a password.

  • Keep it on your server, in an environment variable or a secrets manager.
  • Never put it in a web page, a mobile app or a public repository. The API does not accept calls from browsers on other sites.
  • Use one key per integration, and name it, so you can revoke one without stopping the rest.

Live and test keys

A key is live (tq_live_…) or test (tq_test_…). Both work the same. What is done with a test key is reported apart: GET /v1/usage?group_by=mode and GET /v1/requests tell them apart, so the numbers of your integration tests do not mix with production.

Request limit

Each key can make 120 requests per minute. Every response says where you are:

Header What it says
RateLimit-Limit Requests allowed per minute.
RateLimit-Remaining Requests left in this minute.
RateLimit-Reset Seconds until the count starts again.

Past the limit the answer is 429 with the type rate-limited and a Retry-After header: wait that many seconds and send the request again.

Request ids

Every response carries an X-Request-Id header (req_…), also when it is an error. Log it: it is what we need to follow a request, and GET /v1/requests/{request_id} shows what the API recorded about it.

If you send your own X-Request-Id, it is kept alongside as client_request_id.