MarkUDown

API Create Schema — documentação do gerador de schema de extração com IA MarkUDown

POST/api/create-schema

Gerar schema (Create Schema)

Descreva em linguagem natural os dados que você quer e receba uma sugestão de configuração de extração, gerada por um LLM: os campos e seus tipos, o escopo da extração e filtros de palavras/caminhos para URLs. A requisição é síncrona.

ParâmetroTipoObrigatórioPadrãoDescrição
querystringobrigatório—Descrição em linguagem natural dos dados que você quer, se quiser com a URL do site.

Requisição

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"}'

Resposta

{
  "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);
A resposta é um único objeto JSON plano: toda chave que não seja url, extraction_scope, extraction_target ou uma das quatro listas de filtro é um nome de campo com o seu tipo. Para usar no Extract, transforme cada campo em {"name": …, "type": …, "active": true}. extraction_scope é um de whole_site, category, single_page, search_query, list_page ou unknown. Revise o resultado: ele é escrito por um LLM.

Custo: Não consome créditos; conta para o limite de requisições.