App 詳細

App 詳細

curl --request GET \
  --url https://api.example.com/v1/data-apps/{app_id}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/data-apps/{app_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/data-apps/{app_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/data-apps/{app_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "app_id": "<string>",
  "namespace": "<string>",
  "app_name": "<string>",
  "version": "<string>",
  "status": "<string>",
  "scope": "<string>",
  "accepting_runs": true,
  "input_schema": {},
  "output_schema": {},
  "execution": {},
  "knowledge": {},
  "pricing": {},
  "examples": [
    {}
  ],
  "call_examples": {}
}

GET

data-apps

{app_id}

App 詳細

curl --request GET \
  --url https://api.example.com/v1/data-apps/{app_id}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/data-apps/{app_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/data-apps/{app_id}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/data-apps/{app_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "app_id": "<string>",
  "namespace": "<string>",
  "app_name": "<string>",
  "version": "<string>",
  "status": "<string>",
  "scope": "<string>",
  "accepting_runs": true,
  "input_schema": {},
  "output_schema": {},
  "execution": {},
  "knowledge": {},
  "pricing": {},
  "examples": [
    {}
  ],
  "call_examples": {}
}

GET https://api-datahub.octoparse.com/v1/data-apps/{app_id} 認証：任意。匿名でも利用可。API キーがあるとログイン向けフィルタと追加コンテンツが有効。自己完結の機読詳細：入出力契約（JSON Schema）、実行モード、料金、利用ナレッジ、入力例、MCP / REST / CLI / SDK 呼び出し例。既定は最新。version で過去契約。可視性は実行ゲートと同じ：public は匿名可読、private は作者のみ、shared は grant リストのみ。不可視と不存在はどちらも 404 で存在を漏らさない。

リクエスト

パスパラメータ

string

必須

App 参照: app_<hex> または <namespace>/<app_name>。

クエリパラメータ

string

バージョン指定で過去契約を読む。省略時は最新。

リクエスト例

curl \
  -H "Authorization: Bearer $OCTOPARSE_API_KEY" \
  "https://api-datahub.octoparse.com/v1/data-apps/carol/probe-b"

レスポンス

200 成功

{
  "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 に包まれます。フィールド:

string

Stable app id.

string

発行者ユーザー名。

string

App 名。

string

この応答が表す契約のバージョン。

string

ライフサイクル状態。

string

可視性スコープ。

boolean

App が新規実行を受け付けるか。

object

標準 JSON Schema の入力契約。実行開始 body はこれを満たす必要あり。

object

出力構造。id_field はレコード主キー、record はレコード単位 JSON Schema。

object

実行プロファイル。mode は sync / async。timeout_seconds は実行あたり上限。

object

利用ナレッジ：使うとき／使わないとき／失敗時の扱い。

object

Price table.

object[]

入力例。リクエスト body の出発点として推奨。

object

4 面の呼び出し例（mcp / api / cli / sdk）。

エラー

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

エラー応答は {"error": {code, category, message, retryable}} です。エラーを参照。

クライアントライブラリ

detail = client.get_app("carol/probe-b")      # or app_id
print(detail["input_schema"], detail["pricing"])

const detail = await client.getApp("carol/probe-b");   // or app_id
console.log(detail.input_schema, detail.pricing);

はじめに

クイックスタート

リファレンス

DATA HUB API

リクエスト

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

200 成功

エラー

クライアントライブラリ

​リクエスト

​パスパラメータ

​クエリパラメータ

​リクエスト例

​レスポンス

​200 成功

​エラー

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

リクエスト

パスパラメータ

クエリパラメータ

リクエスト例

レスポンス

200 成功

エラー

クライアントライブラリ