Translation Request Documentation

Request

Example JSON request for translation:

{
  "request": {
    "a.key": {
      "text": "Some text to translate"
    },
    "b.key": {
      "text": "More text to translate"
    }
  },
  "source_language_code": "en",
  "target_language_code": "de",
  "quality": "translation",
  "options": {
    "style_guide_reference_id": 1,
    "context_url": "http://tolq.com/translations_on_this_page",
    "name": "My translations",
    "description": "A clarification for future reference",
    "auto_client_review": false,
    "callback_url": "http://www.tolq.com/translations_completed",
    "purchase_order_code": "2022-order-18"
  }
}

Results

Successful Response (201):

{
  "id": 9,
  "name": "I like bacon",
  "slug": "i-like-bacon",
  "context_url": "http://www.tolq.com",
  "description": "This is a description",
  "created_at": "2014-09-16T13:17:04.368Z",
  "completed_at": "2014-09-16T13:17:04.368Z",
  "quality": "standard",
  "status": "pending"
}

Error Response (400):

{}

Callback URL

You don't need to constantly poll for the state of translation of a translation request in order to get the approved translations as soon as possible in your system.

If you provide a callback_url in the request, we will call back on that URL with the same payload as Retrieve a Translation Request when the translations have been reviewed and are finished.

Payment

The order will be billed to your account according to the billing information you have set up.

The order won't be made effective until you order it using the clients application or using the API.

Language Codes

All language codes have to be in ISO 639-1 format (two letters).