MarkUDown

API Agent — documentação do agente de navegação web com IA MarkUDown

POST/api/agent

Agente (Agent)

Dê ao agente uma URL inicial e uma pergunta. Ele lê a página, pergunta a um LLM se já pode responder ou se deve seguir um link, e repete até responder ou esgotar os passos. Você recebe a resposta e cada passo que ele deu.

ParâmetroTipoObrigatórioPadrãoDescrição
urlstringobrigatório—Página onde o agente começa.
promptstringobrigatório—Pergunta ou tarefa para o agente.
max_stepsintegeropcional10Número máximo de decisões que o agente toma (limitado a 25).
max_pagesintegeropcional5Máximo de páginas que o agente pode visitar (no mínimo 1, limitado a 15). O job cobra max_pages × 2 créditos ao começar.
allow_navigationbooleanopcionaltruePermite que o agente siga links para outras páginas.
timeoutintegeropcional120Tempo limite de carregamento de cada página, em segundos.
callback_urlstringopcionalnullURL de webhook que recebe o resultado (POST) quando o job termina.

Requisição

curl -X POST https://api.scrapetechnology.com/api/agent \
  -H "X-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://quotes.toscrape.com/", "prompt": "Which tags appear on the quotes by Albert Einstein on the first two pages?", "max_pages": 3}'

Resposta

// POST returns { "success": true, "id": "abc123", "url": "/api/agent/abc123" }
// Poll GET /api/agent/{id}
{
  "success": true,
  "id": "abc123",
  "status": "completed",
  "data": {
    "success": true,
    "data": {
      "url": "https://quotes.toscrape.com/",
      "answer": "Einstein's quotes are tagged: change, deep-thoughts, ...",
      "steps": [
        {
          "step": 1,
          "url": "https://quotes.toscrape.com/",
          "action": "navigate",
          "reasoning": "Page 1 read; page 2 is needed.",
          "result": "Navigating to: https://quotes.toscrape.com/page/2/"
        },
        {
          "step": 2,
          "url": "https://quotes.toscrape.com/page/2/",
          "action": "answer",
          "reasoning": "Both pages read.",
          "result": "Einstein's quotes are tagged: change, deep-thoughts, ..."
        }
      ],
      "pages_visited": [
        "https://quotes.toscrape.com/",
        "https://quotes.toscrape.com/page/2/"
      ],
      "total_steps": 2
    },
    "processing_time_ms": 21400
  }
}

Python — pip install markudown

from markudown import MarkUDown

md = MarkUDown(api_key="your-api-key")
job = md.agent(
    "https://quotes.toscrape.com/",
    "Which tags appear on the quotes by Albert Einstein on the first two pages?",
    max_pages=3,
)
print(job["data"]["data"]["answer"])

Node.js — npm install markudown-sdk

import { MarkUDown } from "markudown-sdk";

const md = new MarkUDown({ apiKey: "your-api-key" });
const job = await md.agent(
  "https://quotes.toscrape.com/",
  "Which tags appear on the quotes by Albert Einstein on the first two pages?",
  { maxPages: 3 },
);
console.log(job.data.data.answer);
O agente lê páginas (rolando para carregar conteúdo tardio) e segue links; ele não clica em botões nem preenche formulários. A action de cada passo é answer, navigate, extract ou done (scrape_failed ou llm_error quando algo falhou). Cancele um job em andamento com DELETE /api/agent/{id}.

Custo: max_pages × 2 créditos, cobrados quando o job começa.