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

안정적인 App ID.

string

게시자 사용자 이름.

string

App 이름.

string

이 응답이 나타내는 계약 버전.

string

라이프사이클 상태.

string

가시성 범위.

boolean

App이 신규 실행을 받는지.

object

표준 JSON Schema 입력 계약. 실행 시작 body가 충족해야 함.

object

출력 구조. id_field는 레코드 PK, record는 레코드 단위 JSON Schema.

object

실행 프로필. mode는 sync / async. timeout_seconds는 실행당 상한.

object

사용 지식: 언제 쓰는지/안 쓰는지/실패 처리.

object

가격표.

object[]

입력 예. 요청 body 출발점으로 권장.

object

4개 표면 호출 예(mcp / api / cli / sdk).

오류

HTTP	`code`	`category`	설명
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 성공

오류

클라이언트 라이브러리