Détail de l’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}

Détail de l’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} Authentification : facultative. L’accès anonyme fonctionne ; avec une clé API vous débloquez les filtres connectés et davantage de contenu. Détail autonome lisible par machine : contrat d’entrée et structure de sortie (JSON Schema), mode d’exécution, tarifs, connaissances d’usage, exemples d’entrée et échantillons d’appel MCP / REST / CLI / SDK. Par défaut, la dernière version ; passez version pour lire un contrat historique. La visibilité suit la porte d’exécution : les apps publiques sont lisibles anonymement ; les privées uniquement par l’auteur ; les partagées uniquement par la liste de grants. Invisible et manquant renvoient tous deux 404 sans révéler l’existence.

Requête

Paramètres de chemin

string

requis

Référence d’app : app_<hex> ou <namespace>/<app_name>.

Paramètres de requête

string

Lit un contrat historique par version. Par défaut, la dernière version.

Exemple de requête

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

Réponse

200 succès

{
  "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 réponse est un objet libre (uniquement additif à mesure que le spec du manifest évolue). Les champs ci-dessous sont les stables. La charge utile est enveloppée dans data. Champs :

string

Identifiant stable de l’app.

string

Nom d’utilisateur de l’éditeur.

string

Nom de l’app.

string

Version dont le contrat est représenté par cette réponse.

string

Statut du cycle de vie.

string

Portée de visibilité.

boolean

Indique si l’app accepte de nouvelles exécutions.

object

Contrat d’entrée en JSON Schema standard. Le corps de start-run doit le satisfaire.

object

Structure de sortie. id_field est la clé primaire d’enregistrement ; record est le JSON Schema par enregistrement.

object

Profil d’exécution. mode vaut sync / async ; timeout_seconds est la borne supérieure par run.

object

Connaissances d’usage : quand l’utiliser, quand ne pas l’utiliser et gestion des échecs.

object

Grille tarifaire.

object[]

Exemples d’entrée. Préférez-les comme point de départ des corps de requête.

object

Échantillons d’appel rendus pour quatre surfaces (mcp / api / cli / sdk).

Erreurs

HTTP	`code`	`category`	Description
401	`unauthorized`	`forbidden`	Clé API manquante ou invalide.
404	`app-not-found`	`not_found`	L’app n’existe pas, a été renommée ou est invisible pour l’identifiant actuel (privée / hors périmètre de partage).

Les réponses d’erreur utilisent {"error": {code, category, message, retryable}}. Voir Erreurs.

Bibliothèques clientes

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

BIEN DÉMARRER

DÉMARRAGE RAPIDE

RÉFÉRENCE

DATA HUB API

Détail de l’app

Requête

Paramètres de chemin

Paramètres de requête

Exemple de requête

Réponse

200 succès

Erreurs

Bibliothèques clientes

​Requête

​Paramètres de chemin

​Paramètres de requête

​Exemple de requête

​Réponse

​200 succès

​Erreurs

​Bibliothèques clientes

Requête

Paramètres de chemin

Paramètres de requête

Exemple de requête

Réponse

200 succès

Erreurs

Bibliothèques clientes