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

> Lee el README Markdown de la app.

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

Autenticación: opcional. Con una API key puede ver apps que requieren una vista con sesión iniciada.

Texto enriquecido orientado a humanos (Markdown en bruto). No forma parte de la carga de detalle legible por máquina y se obtiene bajo demanda. Por defecto usa la versión más reciente.

## Solicitud

### Parámetros de ruta

<ParamField path="app_id" type="string" required>
  Referencia de app: `app_<hex>` o `<namespace>/<app_name>`.
</ParamField>

### Parámetros de consulta

<ParamField query="version" type="string">
  Versión a leer. Por defecto, la más reciente.
</ParamField>

### Ejemplo de solicitud

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

## Respuesta

### 200 correcto

El cuerpo es `text/markdown` en bruto, sin sobre. Las apps sin README devuelven un cuerpo vacío.

### Errores

| HTTP | `code`          | `category`  | Descripción                                                                                                           |
| ---- | --------------- | ----------- | --------------------------------------------------------------------------------------------------------------------- |
| 401  | `unauthorized`  | `forbidden` | Falta la API key o no es válida.                                                                                      |
| 404  | `app-not-found` | `not_found` | La app no existe, se renombró o es invisible para la credencial actual (privada / fuera del alcance de compartición). |

Las respuestas de error usan `{"error": {code, category, message, retryable}}`. Ver <a href="/docs/es/datahub/api/reference/introduction#errors">Errores</a>.

## Bibliotecas cliente

Los SDK de Python y JavaScript aún no encapsulan este endpoint. Llame a REST directamente.