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

> Vollständige maschinenlesbare Beschreibung einer Data App: I/O-Verträge, Ausführungsprofil, Preise, Beispiele und Call-Samples.

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

Authentifizierung: optional. Anonymer Zugriff funktioniert; mit API-Schlüssel freigeschaltete Filter und mehr Inhalt.

In sich geschlossene, maschinenlesbare Details: Eingabevertrag und Ausgabestruktur (JSON Schema), Ausführungsmodus, Preise, Nutzungswissen, Eingabebeispiele sowie Aufrufbeispiele für MCP / REST / CLI / SDK. Standardmäßig die neueste Version; übergeben Sie `version`, um einen historischen Vertrag zu lesen.

Sichtbarkeit = Run-Gate: public anonym lesbar; private nur Autor; shared nur Grant-Liste. Unsichtbar und fehlend liefern beide `404` ohne Existenz zu leaken.

## Anfrage

### Pfadparameter

<ParamField path="app_id" type="string" required>
  App-Referenz: `app_<hex>` oder `<namespace>/<app_name>`.
</ParamField>

### Abfrageparameter

<ParamField query="version" type="string">
  Historischen Vertrag nach Version lesen. Standard: neueste Version.
</ParamField>

### Beispielanfrage

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

## Antwort

### 200 Erfolg

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

Die Antwort ist ein freiformiges Objekt (nur additiv, wenn die Manifest-Spec wächst). Die unten gelisteten Felder sind die stabilen.

Payload ist in `data` gewrappt. Felder:

<ResponseField name="app_id" type="string">
  Stabile App-ID.
</ResponseField>

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

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

<ResponseField name="version" type="string">
  Version, deren Vertrag diese Antwort repräsentiert.
</ResponseField>

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

<ResponseField name="scope" type="string">
  Sichtbarkeits-Scope.
</ResponseField>

<ResponseField name="accepting_runs" type="boolean">
  Ob die App neue Runs annimmt.
</ResponseField>

<ResponseField name="input_schema" type="object">
  Eingabevertrag als Standard-JSON-Schema. Der Request-Body zum Starten eines Runs muss ihn erfüllen.
</ResponseField>

<ResponseField name="output_schema" type="object">
  Output-Struktur. `id_field` ist der Record-Primary-Key; `record` ist das Per-Record-JSON-Schema.
</ResponseField>

<ResponseField name="execution" type="object">
  Ausführungsprofil. `mode` ist `sync` / `async`; `timeout_seconds` ist die Per-Run-Obergrenze.
</ResponseField>

<ResponseField name="knowledge" type="object">
  Usage-Knowledge: wann nutzen, wann nicht, und Failure-Handling.
</ResponseField>

<ResponseField name="pricing" type="object">
  Preistabelle.
</ResponseField>

<ResponseField name="examples" type="object[]">
  Eingabebeispiele. Nutzen Sie diese bevorzugt als Ausgangspunkt für Request-Bodys.
</ResponseField>

<ResponseField name="call_examples" type="object">
  Gerenderte Aufrufbeispiele für vier Oberflächen (`mcp` / `api` / `cli` / `sdk`).
</ResponseField>

### Fehler

| HTTP | `code`          | `category`  | Beschreibung                                                                                                            |
| ---- | --------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------- |
| 401  | `unauthorized`  | `forbidden` | Fehlender oder ungültiger API-Schlüssel.                                                                                |
| 404  | `app-not-found` | `not_found` | App existiert nicht, wurde umbenannt oder ist für die aktuelle Credential unsichtbar (private / außerhalb Share-Scope). |

Fehlerantworten nutzen `{"error": {code, category, message, retryable}}`. Siehe <a href="/docs/de/datahub/api/reference/introduction#errors">Fehler</a>.

## Client-Bibliotheken

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