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

> Markdown-README der App lesen.

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

Authentifizierung: optional. Mit API-Schlüssel sehen Sie ggf. Apps, die eine angemeldete Ansicht erfordern.

Menschenorientierter Rich Text (rohes Markdown). Nicht Teil des machine-readable Detail-Payloads; on demand geladen. Standard: neueste Version.

## Anfrage

### Pfadparameter

<ParamField path="app_id" type="string" required>
  App-Referenz: `app_<hex>` oder `<namespace>/<app_name>`.
</ParamField>

### Abfrageparameter

<ParamField query="version" type="string">
  Zu lesende Version. Standard: latest.
</ParamField>

### Beispielanfrage

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

## Antwort

### 200 Erfolg

Der Body ist rohes `text/markdown` ohne Envelope. Apps ohne README liefern einen leeren Body.

### Fehler

| HTTP | `code`          | `category`  | Beschreibung                                                                                                            |
| ---- | --------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------- |
| 401  | `unauthorized`  | `forbidden` | Fehlender oder ungültiger API-Schlüssel.                                                                                |
| 404  | `app-not-found` | `not_found` | App existiert nicht, wurde umbenannt oder ist für die aktuelle Credential unsichtbar (private / außerhalb Share-Scope). |

Fehlerantworten nutzen `{"error": {code, category, message, retryable}}`. Siehe <a href="/docs/de/datahub/api/reference/introduction#errors">Fehler</a>.

## Client-Bibliotheken

Die Python- und JavaScript-SDKs wrappen diesen Endpoint noch nicht. REST direkt aufrufen.