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

> Read the full machine-readable description of a Data App: input/output contracts, execution profile, pricing, examples, and call samples.

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

Authentication: optional. Anonymous access works; with an API key you unlock logged-in filters and more content.

Self-contained machine-readable detail: input contract and output structure (JSON Schema), execution mode, pricing, usage knowledge, input examples, and MCP / REST / CLI / SDK call samples. Defaults to the latest version; pass `version` to read a historical contract.

Visibility matches the run gate: public apps are anonymously readable; private apps are author-only; shared apps are readable only by the grant list. Invisible and missing both return `404` without leaking existence.

## Request

### Path parameters

<ParamField path="app_id" type="string" required>
  App reference: `app_<hex>` or `<namespace>/<app_name>`.
</ParamField>

### Query parameters

<ParamField query="version" type="string">
  Read a historical contract by version. Defaults to the latest version.
</ParamField>

### Example request

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

## Response

### 200 success

```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 …"
    }
  }
}
```

The response is a free-form object (additive only as the manifest spec evolves). The fields listed below are the stable ones.

The payload is wrapped in `data`. Fields:

<ResponseField name="app_id" type="string">
  Stable app id.
</ResponseField>

<ResponseField name="namespace" type="string">
  Publisher username.
</ResponseField>

<ResponseField name="app_name" type="string">
  App name.
</ResponseField>

<ResponseField name="version" type="string">
  Version whose contract this response represents.
</ResponseField>

<ResponseField name="status" type="string">
  Lifecycle status.
</ResponseField>

<ResponseField name="scope" type="string">
  Visibility scope.
</ResponseField>

<ResponseField name="accepting_runs" type="boolean">
  Whether the app accepts new runs.
</ResponseField>

<ResponseField name="input_schema" type="object">
  Input contract as standard JSON Schema. The start-run request body must satisfy it.
</ResponseField>

<ResponseField name="output_schema" type="object">
  Output structure. `id_field` is the record primary key; `record` is the per-record JSON Schema.
</ResponseField>

<ResponseField name="execution" type="object">
  Execution profile. `mode` is `sync` / `async`; `timeout_seconds` is the per-run upper bound.
</ResponseField>

<ResponseField name="knowledge" type="object">
  Usage knowledge: when to use, when not to use, and failure handling.
</ResponseField>

<ResponseField name="pricing" type="object">
  Price table.
</ResponseField>

<ResponseField name="examples" type="object[]">
  Input examples. Prefer these as the starting point for request bodies.
</ResponseField>

<ResponseField name="call_examples" type="object">
  Rendered call samples for four surfaces (`mcp` / `api` / `cli` / `sdk`).
</ResponseField>

### Errors

| HTTP | `code`          | `category`  | Description                                                                                                 |
| ---- | --------------- | ----------- | ----------------------------------------------------------------------------------------------------------- |
| 401  | `unauthorized`  | `forbidden` | Missing or invalid API key.                                                                                 |
| 404  | `app-not-found` | `not_found` | App does not exist, was renamed, or is invisible to the current credential (private / outside share scope). |

Error responses use `{"error": {code, category, message, retryable}}`. See <a href="/docs/en/datahub/api/reference/introduction#errors">Errors</a>.

## Client libraries

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