MarkUDown

API de Extract — documentación de extracción de datos con IA MarkUDown

POST/api/extract

Extract

Extrae una URL y usa un LLM para extraer datos estructurados basados en tu schema. Define exactamente qué campos necesitas — la IA maneja el análisis.

ParámetroTipoRequeridoPor defectoDescripción
urlstringrequerido—URL de la página de la que extraer. Envíala siempre: sin ella el job falla.
extract_querystringrequerido—Descripción en lenguaje natural de lo que extraer, por ejemplo "Título del libro, precio y disponibilidad".
schemaarray<object>requerido—Campos a extraer: [{name, type, active}]. Solo se usan los campos con active: true; type es una indicación para el LLM (por ejemplo String, Number, Boolean, Array).
extraction_scopestringopcionalnullIndicación opcional que se pasa al LLM, por ejemplo "single_page" o "list_page". No hace que Extract lea otras páginas.
extraction_targetstringopcionalnullIndicación opcional que se pasa al LLM, por ejemplo el nombre de una categoría como "poetry".
callback_urlstringopcionalnullURL de webhook que recibe el resultado (POST) cuando el job termina.
allowed_words, blocked_words, allowed_patterns y blocked_patterns (devueltos por Create Schema) se aceptan, pero no se aplican: Extract lee solo la página en url. Solo los primeros 50.000 caracteres del Markdown de la página se envían al LLM.

Solicitud

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

Respuesta

// 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
  }
}