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

# README de l’app

> Lit le README Markdown de l’app.

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

Authentification : facultative. Avec une clé API vous pouvez voir des apps qui exigent une vue connectée.

Texte enrichi orienté humain (Markdown brut). Il ne fait pas partie de la charge de détail lisible par machine et se récupère à la demande. Par défaut, la dernière version.

## Requête

### Paramètres de chemin

<ParamField path="app_id" type="string" required>
  Référence d’app : `app_<hex>` ou `<namespace>/<app_name>`.
</ParamField>

### Paramètres de requête

<ParamField query="version" type="string">
  Version à lire. Par défaut, la plus récente.
</ParamField>

### Exemple de requête

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

## Réponse

### 200 succès

Le corps est du `text/markdown` brut, sans enveloppe. Les apps sans README renvoient un corps vide.

### Erreurs

| HTTP | `code`          | `category`  | Description                                                                                                         |
| ---- | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------- |
| 401  | `unauthorized`  | `forbidden` | Clé API manquante ou invalide.                                                                                      |
| 404  | `app-not-found` | `not_found` | L’app n’existe pas, a été renommée ou est invisible pour l’identifiant actuel (privée / hors périmètre de partage). |

Les réponses d’erreur utilisent `{"error": {code, category, message, retryable}}`. Voir <a href="/docs/fr/datahub/api/reference/introduction#errors">Erreurs</a>.

## Bibliothèques clientes

Les SDK Python et JavaScript n’encapsulent pas encore cet endpoint. Appelez REST directement.