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

# Detalle de la app

> Lee la descripción completa legible por máquina de una Data App: contratos de entrada/salida, perfil de ejecución, precios, ejemplos y muestras de llamada.

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

Autenticación: opcional. El acceso anónimo funciona; con ella desbloquea filtros de sesión o más contenido.

Detalle autónomo legible por máquina: contrato de entrada y estructura de salida (JSON Schema), modo de ejecución, precios, conocimiento de uso, ejemplos de entrada y muestras de llamada MCP / REST / CLI / SDK. Por defecto usa la versión más reciente; pase `version` para leer un contrato histórico.

La visibilidad coincide con la puerta de ejecución: las apps públicas se pueden leer de forma anónima; las privadas solo el autor; las compartidas solo la lista de grants. Invisible e inexistente devuelven ambos `404` sin revelar si existe.

## 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">
  Lee un contrato histórico por versión. Por defecto, la versión 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"
```

## Respuesta

### 200 correcto

```json theme={null}
{
  "data": {
    "app_id": "app_6dfe4e839ccf",
    "namespace": "carol",
    "app_name": "probe-b",
    "name": "Product review lookup",
    "type": "data",
    "summary": "Fetch a review list by product id",
    "capability": "data-acquisition",
    "keywords": [
      "reviews",
      "ecommerce"
    ],
    "boundary": "Public reviews only; buyer-show images are not included",
    "version": "0.1.0",
    "published_at": "2026-09-15T07:45:38.633930+00:00",
    "status": "published",
    "scope": "public",
    "accepting_runs": true,
    "source_locale": "en-US",
    "input_schema": {
      "type": "object",
      "properties": {
        "product": {
          "type": "string",
          "description": "Product id"
        }
      },
      "required": [
        "product"
      ],
      "additionalProperties": false
    },
    "output_schema": {
      "id_field": "review_id",
      "record": {
        "type": "object",
        "properties": {
          "review_id": {
            "type": "string"
          },
          "content": {
            "type": "string"
          },
          "rating": {
            "type": "integer"
          }
        }
      }
    },
    "execution": {
      "mode": "sync",
      "timeout_seconds": 60,
      "cancel_notify": false,
      "recovers_partial_on_cancel": false
    },
    "knowledge": {
      "when_to_use": [
        "When you need every public review for a product"
      ],
      "when_not_to_use": [
        "When you need buyer images or video"
      ],
      "failure_handling": [
        "Delisted products return an empty result instead of an error"
      ]
    },
    "pricing": {
      "events": [
        {
          "event": "record",
          "label": "One record",
          "unit_price": 0.001,
          "qty_from": "",
          "unit_size": null
        }
      ]
    },
    "examples": [
      {
        "name": "Basic query",
        "input": {
          "product": "p-9001"
        }
      }
    ],
    "call_examples": {
      "mcp": "…",
      "api": "curl -X POST 'https://api-datahub.octoparse.com/v1/data-apps/carol/probe-b/runs' …",
      "cli": "op run carol/probe-b --input '{\"product\": \"p-9001\"}'",
      "sdk": "from octoparse_client import Client …"
    }
  }
}
```

La respuesta es un objeto de forma libre (solo aditivo a medida que evoluciona el spec del manifest). Los campos siguientes son los estables.

La carga útil va envuelta en `data`. Campos:

<ResponseField name="app_id" type="string">
  Id estable de la app.
</ResponseField>

<ResponseField name="namespace" type="string">
  Nombre de usuario del publicador.
</ResponseField>

<ResponseField name="app_name" type="string">
  Nombre de la app.
</ResponseField>

<ResponseField name="version" type="string">
  Versión cuyo contrato representa esta respuesta.
</ResponseField>

<ResponseField name="status" type="string">
  Estado del ciclo de vida.
</ResponseField>

<ResponseField name="scope" type="string">
  Alcance de visibilidad.
</ResponseField>

<ResponseField name="accepting_runs" type="boolean">
  Si la app acepta nuevas ejecuciones.
</ResponseField>

<ResponseField name="input_schema" type="object">
  Contrato de entrada como JSON Schema estándar. El body de start-run debe satisfacerlo.
</ResponseField>

<ResponseField name="output_schema" type="object">
  Estructura de salida. `id_field` es la clave primaria del registro; `record` es el JSON Schema por registro.
</ResponseField>

<ResponseField name="execution" type="object">
  Perfil de ejecución. `mode` es `sync` / `async`; `timeout_seconds` es el límite superior por run.
</ResponseField>

<ResponseField name="knowledge" type="object">
  Conocimiento de uso: cuándo usarla, cuándo no y manejo de fallos.
</ResponseField>

<ResponseField name="pricing" type="object">
  Tabla de precios.
</ResponseField>

<ResponseField name="examples" type="object[]">
  Ejemplos de entrada. Prefiéralos como punto de partida de los bodies de solicitud.
</ResponseField>

<ResponseField name="call_examples" type="object">
  Muestras de llamada renderizadas para cuatro superficies (`mcp` / `api` / `cli` / `sdk`).
</ResponseField>

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

<CodeGroup>
  ```python Python theme={null}
  detail = client.get_app("carol/probe-b")      # or app_id
  print(detail["input_schema"], detail["pricing"])
  ```

  ```js JavaScript theme={null}
  const detail = await client.getApp("carol/probe-b");   // or app_id
  console.log(detail.input_schema, detail.pricing);
  ```
</CodeGroup>