> ## Documentation Index
> Fetch the complete documentation index at: https://www.octoparse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Read a translation overlay

> Read the full translation overlay for one locale, including README.

**`GET`** `https://api-datahub.octoparse.com/v1/data-apps/{app_id}/translations/{locale}`

Authentication: optional.

Returns the full translation overlay for one locale, including card fields and README when present.

## Request

### Path parameters

<ParamField path="app_id" type="string" required>
  App reference: `app_<hex>` or `<namespace>/<app_name>`.
</ParamField>

<ParamField path="locale" type="string" required>
  Locale code, for example `ja-JP`.
</ParamField>

### Example request

```bash theme={null}
curl   -H "Authorization: Bearer $OCTOPARSE_API_KEY"   "https://api-datahub.octoparse.com/v1/data-apps/carol/probe-b/translations/en"
```

## Response

### 200 success

```json theme={null}
{
  "data": {
    "locale": "ja-JP",
    "name": "Review search",
    "summary": "Search product reviews",
    "readme": "# How to use\n...",
    "stale": false
  }
}
```

<ResponseField name="locale" type="string" required>
  Locale of this overlay.
</ResponseField>

<ResponseField name="name" type="string">
  Translated display name.
</ResponseField>

<ResponseField name="summary" type="string">
  Translated summary.
</ResponseField>

<ResponseField name="readme" type="string">
  Translated README Markdown, when present.
</ResponseField>

<ResponseField name="stale" type="boolean">
  `true` when the overlay is based on draft changes not yet published as the latest Release.
</ResponseField>

### Errors

| HTTP | `code`                  | `category`  | Description                         |
| ---- | ----------------------- | ----------- | ----------------------------------- |
| 404  | `app-not-found`         | `not_found` | App does not exist or is invisible. |
| 404  | `translation-not-found` | `not_found` | No overlay for this locale.         |

Error responses use `{"error": {code, category, message, retryable}}`. See <a href="/docs/en/datahub/api/reference/introduction#errors">Errors</a>.

## Client libraries

The Python and JavaScript SDKs do not wrap this endpoint yet. Call REST directly.
