MarkUDown

API Create Schema — documentación del generador de esquemas de extracción con IA MarkUDown

POST/api/create-schema

Generar esquema (Create Schema)

Describe en lenguaje natural los datos que quieres y recibe una configuración de extracción sugerida, generada por un LLM: los campos y sus tipos, el alcance de la extracción y filtros de palabras/rutas para URLs. La petición es síncrona.

ParámetroTipoRequeridoPor defectoDescripción
querystringrequerido—Descripción en lenguaje natural de los datos que quieres, opcionalmente con la URL del sitio.

Solicitud

curl -X POST https://api.scrapetechnology.com/api/create-schema \
  -H "X-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"query": "title, price and star rating of every book on https://books.toscrape.com"}'

Respuesta

{
  "url": "https://books.toscrape.com",
  "extraction_scope": "list_page",
  "extraction_target": null,
  "title": "string",
  "price": "float",
  "rating": "string",
  "allowed_words": ["catalogue", "book"],
  "blocked_words": ["login", "basket"],
  "allowed_patterns": ["/catalogue/"],
  "blocked_patterns": []
}

Python — pip install markudown

from markudown import MarkUDown

md = MarkUDown(api_key="your-api-key")
schema = md.create_schema("title, price and star rating of every book on https://books.toscrape.com")
print(schema)

Node.js — npm install markudown-sdk

import { MarkUDown } from "markudown-sdk";

const md = new MarkUDown({ apiKey: "your-api-key" });
const schema = await md.createSchema("title, price and star rating of every book on https://books.toscrape.com");
console.log(schema);
La respuesta es un único objeto JSON plano: toda clave que no sea url, extraction_scope, extraction_target o una de las cuatro listas de filtros es un nombre de campo con su tipo. Para usarlo con Extract, convierte cada campo en {"name": …, "type": …, "active": true}. extraction_scope es uno de whole_site, category, single_page, search_query, list_page o unknown. Revisa el resultado: lo escribe un LLM.

Costo: No consume créditos; cuenta para el límite de peticiones.