Documentation

API REFERENCE

Simplify and translate content into 24 output languages.

The synchronous endpoint accepts source text, an output locale, and one of two modes. It detects the source language automatically and returns a ready-to-use result in the selected output language.

{
  "text": "Complex source content in the selected language.",
  "locale": "en",
  "mode": "simple-language"
}

SDK and cURL examples available

Endpoint

POST /api/v2/translate

Create one Plain Language or Easy Language result and return it in the same HTTP response.

Required headers

HeaderValuePurpose
AuthorizationBearer <API_KEY>Authenticates the project with the current HTTP Bearer scheme
Content-Typeapplication/jsonDeclares the request body format
Acceptapplication/jsonRequests a JSON response
Idempotency-KeyRequired for jobs and batches onlyKeeps repeated asynchronous submissions from creating duplicate work

Request body

No other content setting is part of the public request schema.

FieldTypeRequiredAllowed valueDescription
textstringYes1 to 10,000 Unicode charactersSource content in the selected locale
localestringYesOne of 24 supported two-letter codesOutput language. The source language is detected automatically.
modestringYessimple-language, easy-languageSimplification mode
json
{
  "text": "Applicants must provide the required documentation before the deadline.",
  "locale": "en",
  "mode": "easy-language"
}

Response body

The response must not contain retired request settings or a separate quality-information array.

FieldTypeDescription
requestIdstringUnique identifier for support and logs
localestringSelected output locale
modestringSelected simplification mode
outputstringFinished result in the selected output locale
usage.inputCharactersintegerCharacters counted for this request, or 0 for a cache hit
usage.cacheHitbooleanWhether the result came from the 30-day cache
json
{
  "requestId": "req_sync_002",
  "locale": "en",
  "mode": "easy-language",
  "output": "You need to send documents.\nSend the documents before the deadline.",
  "usage": {
    "inputCharacters": 78,
    "cacheHit": false
  }
}

Validation behavior

  • Missing text: reject with a documented field error.
  • Empty text: reject with a documented field error.
  • Unsupported locale: reject; never silently substitute another locale.
  • Unsupported mode: reject; never choose a mode automatically.
  • Unknown retired field: reject with a migration-focused error or handle only through an explicitly versioned compatibility layer.
  • Source text may use a different language from locale. Simple8 detects the source language automatically and writes the result in the selected output locale.