Contexts
About Contexts
What are contexts?
Contexts give translators and reviewers more information about your content, like where the text is used or how it should sound, with optional screenshots. Create a context first, then pass its id as context_id when you create a translation or create a review.
Possible errors: see here
Endpoints
The context object
| Attribute | Type | Description |
|---|---|---|
id | number | The unique identifier of the context. |
description | object | The description of the context, stored as rich text. The text itself is in body. The other attributes (id, name, record_type, record_id, created_at, updated_at) belong to the rich text record. |
attachments | array | The remote attachments, each with a remote_path_url. |
{
"context": {
"id": 321,
"description": {
"id": 321,
"name": "description",
"body": "The app is a banking app, keep the tone formal.",
"record_type": "Context",
"record_id": 321,
"created_at": "2026-10-02T10:00:00.000Z",
"updated_at": "2026-10-02T10:00:00.000Z"
},
"attachments": [
{ "remote_path_url": "https://example.com/screenshot.png" }
]
}
}