> ## 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.

# App README

> Read the app Markdown README.

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

Authentication: optional. With an API key you may see apps that require a logged-in view.

Human-oriented rich text (raw Markdown). It is not part of the machine-readable detail payload and is fetched on demand. Defaults to the latest version.

## Request

### Path parameters

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

### Query parameters

<ParamField query="version" type="string">
  Version to read. Defaults to latest.
</ParamField>

### Example request

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

## Response

### 200 success

The body is raw `text/markdown` with no envelope. Apps without a README return an empty body.

### Errors

| HTTP | `code`          | `category`  | Description                                                                                                 |
| ---- | --------------- | ----------- | ----------------------------------------------------------------------------------------------------------- |
| 401  | `unauthorized`  | `forbidden` | Missing or invalid API key.                                                                                 |
| 404  | `app-not-found` | `not_found` | App does not exist, was renamed, or is invisible to the current credential (private / outside share scope). |

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.