Skip to main content
POST
/
status
Get engine status
curl --request POST \
  --url https://api.mtengine.example.com/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "formality": "informal",
    "model": "model123",
    "domain": "legal",
    "project_uid": "{project_uid}",
    "job_uid": "{job_uid}",
    "idm_organization_uid": "{idm_organization_uid}"
  }
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://developers.phrase.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 for accessing the MT API. Supports client credentials (service-to-service).

Body

application/json
​
metadata
object

Any custom data in form of key/value pairs.

Phrase automatically resolves the following placeholders in request-level metadata values:

  • {project_uid} — TMS project UID
  • {job_uid} — TMS job UID
  • {idm_organization_uid} — Phrase organization UID
Example:
{
  "formality": "informal",
  "model": "model123",
  "domain": "legal",
  "project_uid": "{project_uid}",
  "job_uid": "{job_uid}",
  "idm_organization_uid": "{idm_organization_uid}"
}

Response

Engine status

​
status
enum<string>
required

Engine status codes, 'ok' for fully operational, 'not_ok' for others (e.g. warm-up...)

Available options:
ok,
not_ok