Translation APIReference
v2.0.0

Translation API · Concept

Structured JSON and Text

Create projects directly from inline JSON or text and retrieve structure-preserving deliveries.

Inline content avoids a separate upload and is the most natural integration for catalogs, CMS records, messages, and application data.

JSON Input

Set content.format to json and place the object or array in content.value. Every non-empty string leaf is translatable. Property names, arrays, objects, numbers, booleans, and null values are preserved.

{
  "name": "Catalog SKU 1042",
  "external_id": "SKU-1042-ES",
  "source_language": "EN-US",
  "target_languages": ["ES-ES"],
  "content": {
    "format": "json",
    "value": {
      "title": "Waterproof hiking jacket",
      "sku": 1042,
      "active": true
    }
  }
}

Text Input

Set content.format to text and provide one non-empty string in content.value. The API retains it through the same private content manifest used for structure-safe delivery reconstruction.

Source Retrieval

The project response includes a source file with content_url. It returns the exact submitted JSON or text for authorized callers.

Delivery Reconstruction

After delivery.ready, list project deliveries and request the selected delivery’s /content endpoint. JSON is reconstructed only when the completed translated segments align exactly with the source manifest. The API returns a conflict instead of guessing or corrupting customer structure.

Limits

Use GET /capabilities to read the active maximum inline-content byte limit and target-language limit. Do not hard-code defaults into a long-lived integration.

Related Reference