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

> Data App の完全な機読詳細。

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

認証：任意。匿名でも利用可。API キーがあるとログイン向けフィルタと追加コンテンツが有効。

自己完結の機読詳細：入出力契約（JSON Schema）、実行モード、料金、利用ナレッジ、入力例、MCP / REST / CLI / SDK 呼び出し例。既定は最新。`version` で過去契約。

可視性は実行ゲートと同じ：public は匿名可読、private は作者のみ、shared は grant リストのみ。不可視と不存在はどちらも `404` で存在を漏らさない。

## リクエスト

### パスパラメータ

<ParamField path="app_id" type="string" required>
  App 参照: `app_<hex>` または `<namespace>/<app_name>`。
</ParamField>

### クエリパラメータ

<ParamField query="version" type="string">
  バージョン指定で過去契約を読む。省略時は最新。
</ParamField>

### リクエスト例

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

## レスポンス

### 200 成功

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

応答は自由形式オブジェクト（マニフェスト仕様進化に伴い追加のみ）。下記は安定フィールド。

ペイロードは `data` に包まれます。フィールド:

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

<ResponseField name="namespace" type="string">
  発行者ユーザー名。
</ResponseField>

<ResponseField name="app_name" type="string">
  App 名。
</ResponseField>

<ResponseField name="version" type="string">
  この応答が表す契約のバージョン。
</ResponseField>

<ResponseField name="status" type="string">
  ライフサイクル状態。
</ResponseField>

<ResponseField name="scope" type="string">
  可視性スコープ。
</ResponseField>

<ResponseField name="accepting_runs" type="boolean">
  App が新規実行を受け付けるか。
</ResponseField>

<ResponseField name="input_schema" type="object">
  標準 JSON Schema の入力契約。実行開始 body はこれを満たす必要あり。
</ResponseField>

<ResponseField name="output_schema" type="object">
  出力構造。`id_field` はレコード主キー、`record` はレコード単位 JSON Schema。
</ResponseField>

<ResponseField name="execution" type="object">
  実行プロファイル。`mode` は `sync` / `async`。`timeout_seconds` は実行あたり上限。
</ResponseField>

<ResponseField name="knowledge" type="object">
  利用ナレッジ：使うとき／使わないとき／失敗時の扱い。
</ResponseField>

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

<ResponseField name="examples" type="object[]">
  入力例。リクエスト body の出発点として推奨。
</ResponseField>

<ResponseField name="call_examples" type="object">
  4 面の呼び出し例（`mcp` / `api` / `cli` / `sdk`）。
</ResponseField>

### エラー

| HTTP | `code`          | `category`  | Description                                  |
| ---- | --------------- | ----------- | -------------------------------------------- |
| 401  | `unauthorized`  | `forbidden` | API キー欠落または無効。                               |
| 404  | `app-not-found` | `not_found` | App が存在しない、改名された、または現在の資格情報から不可視（非公開／共有範囲外）。 |

エラー応答は `{"error": {code, category, message, retryable}}` です。<a href="/docs/jp/datahub/api/reference/introduction#errors">エラー</a> を参照。

## クライアントライブラリ

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