MarkUDown
API de Extract — documentação da extração de dados com IA MarkUDown
POST
/api/extractExtract
Extrai uma URL e usa um LLM para extrair dados estruturados baseados no seu schema. Defina exatamente quais campos você precisa — a IA cuida da análise.
| Parâmetro | Tipo | Obrigatório | Padrão | Descrição |
|---|---|---|---|---|
| url | string | obrigatório | — | URL da página de onde extrair. Sempre envie — sem ela o job falha. |
| extract_query | string | obrigatório | — | Descrição em linguagem natural do que extrair, por exemplo "Título do livro, preço e disponibilidade". |
| schema | array<object> | obrigatório | — | Campos a extrair: [{name, type, active}]. Só os campos com active: true são usados; type é uma indicação para o LLM (por exemplo String, Number, Boolean, Array). |
| extraction_scope | string | opcional | null | Indicação opcional passada ao LLM, por exemplo "single_page" ou "list_page". Não faz o Extract ler outras páginas. |
| extraction_target | string | opcional | null | Indicação opcional passada ao LLM, por exemplo o nome de uma categoria como "poetry". |
| callback_url | string | opcional | null | URL de webhook que recebe o resultado (POST) quando o job termina. |
allowed_words, blocked_words, allowed_patterns e blocked_patterns (devolvidos pelo Create Schema) são aceitos, mas não aplicados: o Extract lê apenas a página em url. Só os primeiros 50.000 caracteres do Markdown da página são enviados ao LLM.
Requisição
{
"url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html",
"extract_query": "Book title, price and availability",
"schema": [
{ "name": "title", "type": "String", "active": true },
{ "name": "price", "type": "String", "active": true },
{ "name": "in_stock", "type": "Boolean", "active": true }
],
"extraction_scope": "single_page"
}Resposta
// POST returns { "success": true, "id": "abc123", "url": "/api/extract/abc123" }
// Poll GET /api/extract/{id}
{
"success": true,
"id": "abc123",
"status": "completed",
"data": {
"success": true,
"data": [
{
"title": "A Light in the Attic",
"price": "£51.77",
"in_stock": true,
"url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html"
}
],
"total": 1,
"url": "https://books.toscrape.com/catalogue/a-light-in-the-attic_1000/index.html",
"processing_time_ms": 6120
}
}