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

Dettaglio 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} Autenticazione: facoltativa. L’accesso anonimo funziona; con API key sblocchi filtri da loggato e più contenuti. Dettaglio autonomo e leggibile dalle macchine: contratto di input e struttura di output (JSON Schema), modalità di esecuzione, prezzi, conoscenze d’uso, esempi di input ed esempi di chiamata MCP / REST / CLI / SDK. Per impostazione predefinita è la versione più recente; passa version per leggere un contratto storico. Visibilità = gate run: public leggibili in anonimo; private solo autore; shared solo grant list. Invisibile e mancante restituiscono entrambi 404 senza leak di esistenza.

Richiesta

Parametri di percorso

string

obbligatorio

Riferimento app: app_<hex> oppure <namespace>/<app_name>.

Parametri di query

string

Leggi un contratto storico per versione. Default: ultima versione.

Esempio di richiesta

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

Risposta

200 successo

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

La risposta è un oggetto free-form (solo additivo man mano che evolve la spec del manifest). I campi elencati sotto sono quelli stabili. Il payload è wrappato in data. Campi:

string

ID app stabile.

string

Username del publisher.

string

Nome dell’app.

string

Versione il cui contratto rappresenta questa risposta.

string

Stato del lifecycle.

string

Scope di visibilità.

boolean

Se l’app accetta nuove run.

object

Contratto di input come JSON Schema standard. Il body della richiesta di avvio del run deve rispettarlo.

object

Struttura output. id_field è la primary key del record; record è lo JSON Schema per record.

object

Profilo di esecuzione. mode è sync / async; timeout_seconds è il bound superiore per run.

object

Usage knowledge: quando usare, quando no, e gestione failure.

object

Tabella prezzi.

object[]

Esempi di input. Usali preferibilmente come punto di partenza per i body delle richieste.

object

Esempi di chiamata renderizzati per quattro superfici (mcp / api / cli / sdk).

Errori

HTTP	`code`	`category`	Descrizione
401	`unauthorized`	`forbidden`	API key mancante o non valida.
404	`app-not-found`	`not_found`	L’app non esiste, è stata rinominata o è invisibile alla credenziale corrente (private / fuori dallo share scope).

Le risposte di errore usano {"error": {code, category, message, retryable}}. Vedi Errori.

Librerie client

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

PER INIZIARE

GUIDA RAPIDA

RIFERIMENTO

DATA HUB API

Dettaglio app

Richiesta

Parametri di percorso

Parametri di query

Esempio di richiesta

Risposta

200 successo

Errori

Librerie client

​Richiesta

​Parametri di percorso

​Parametri di query

​Esempio di richiesta

​Risposta

​200 successo

​Errori

​Librerie client

Richiesta

Parametri di percorso

Parametri di query

Esempio di richiesta

Risposta

200 successo

Errori

Librerie client