Detalle de la 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}

Detalle de la 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} Autenticación: opcional. El acceso anónimo funciona; con ella desbloquea filtros de sesión o más contenido. Detalle autónomo legible por máquina: contrato de entrada y estructura de salida (JSON Schema), modo de ejecución, precios, conocimiento de uso, ejemplos de entrada y muestras de llamada MCP / REST / CLI / SDK. Por defecto usa la versión más reciente; pase version para leer un contrato histórico. La visibilidad coincide con la puerta de ejecución: las apps públicas se pueden leer de forma anónima; las privadas solo el autor; las compartidas solo la lista de grants. Invisible e inexistente devuelven ambos 404 sin revelar si existe.

Solicitud

Parámetros de ruta

string

requerido

Referencia de app: app_<hex> o <namespace>/<app_name>.

Parámetros de consulta

string

Lee un contrato histórico por versión. Por defecto, la versión más reciente.

Ejemplo de solicitud

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

Respuesta

200 correcto

{
  "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 respuesta es un objeto de forma libre (solo aditivo a medida que evoluciona el spec del manifest). Los campos siguientes son los estables. La carga útil va envuelta en data. Campos:

string

Id estable de la app.

string

Nombre de usuario del publicador.

string

Nombre de la app.

string

Versión cuyo contrato representa esta respuesta.

string

Estado del ciclo de vida.

string

Alcance de visibilidad.

boolean

Si la app acepta nuevas ejecuciones.

object

Contrato de entrada como JSON Schema estándar. El body de start-run debe satisfacerlo.

object

Estructura de salida. id_field es la clave primaria del registro; record es el JSON Schema por registro.

object

Perfil de ejecución. mode es sync / async; timeout_seconds es el límite superior por run.

object

Conocimiento de uso: cuándo usarla, cuándo no y manejo de fallos.

object

Tabla de precios.

object[]

Ejemplos de entrada. Prefiéralos como punto de partida de los bodies de solicitud.

object

Muestras de llamada renderizadas para cuatro superficies (mcp / api / cli / sdk).

Errores

HTTP	`code`	`category`	Descripción
401	`unauthorized`	`forbidden`	Falta la API key o no es válida.
404	`app-not-found`	`not_found`	La app no existe, se renombró o es invisible para la credencial actual (privada / fuera del alcance de compartición).

Las respuestas de error usan {"error": {code, category, message, retryable}}. Ver Errores.

Bibliotecas cliente

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

PRIMEROS PASOS

INICIO RÁPIDO

REFERENCIA

DATA HUB API

Detalle de la app

Solicitud

Parámetros de ruta

Parámetros de consulta

Ejemplo de solicitud

Respuesta

200 correcto

Errores

Bibliotecas cliente

​Solicitud

​Parámetros de ruta

​Parámetros de consulta

​Ejemplo de solicitud

​Respuesta

​200 correcto

​Errores

​Bibliotecas cliente

Solicitud

Parámetros de ruta

Parámetros de consulta

Ejemplo de solicitud

Respuesta

200 correcto

Errores

Bibliotecas cliente