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

> Leggi il README Markdown dell’app.

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

Autenticazione: facoltativa. Con API key puoi vedere app che richiedono una vista autenticata.

Rich text orientato all’uomo (Markdown grezzo). Non fa parte del payload di dettaglio machine-readable; si recupera on demand. Default: ultima versione.

## Richiesta

### Parametri di percorso

<ParamField path="app_id" type="string" required>
  Riferimento app: `app_<hex>` oppure `<namespace>/<app_name>`.
</ParamField>

### Parametri di query

<ParamField query="version" type="string">
  Versione da leggere. Default: latest.
</ParamField>

### Esempio di richiesta

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

## Risposta

### 200 successo

Il body è `text/markdown` grezzo, senza envelope. Le app senza README restituiscono un body vuoto.

### Errori

| HTTP | `code`          | `category`  | Descrizione                                                                                                        |
| ---- | --------------- | ----------- | ------------------------------------------------------------------------------------------------------------------ |
| 401  | `unauthorized`  | `forbidden` | API key mancante o non valida.                                                                                     |
| 404  | `app-not-found` | `not_found` | L’app non esiste, è stata rinominata o è invisibile alla credenziale corrente (private / fuori dallo share scope). |

Le risposte di errore usano `{"error": {code, category, message, retryable}}`. Vedi <a href="/docs/it/datahub/api/reference/introduction#errors">Errori</a>.

## Librerie client

Gli SDK Python e JavaScript non wrappano ancora questo endpoint. Chiama REST direttamente.