Guias

Formatos de Saída

Markdown, JSON estruturado, metadados, HTML, links, imagens, resumo, pergunta/resposta, highlights

A Thunderbit pode retornar qualquer combinação dos formatos abaixo. Use o array formats em /distill, /extract e /search para pedir além do padrão. O array legado include continua suportado para metadata / html.

Formatos disponíveis

FormatoComo solicitarRetornado comoNotas
Markdownformats: ["markdown"] (padrão para /distill)data.markdownGrátis — incluído por padrão.
JSON estruturadoPadrão para /extract; forneça um schema ou deixe a Thunderbit gerar automaticamentedata.dataSchema é opcional a partir de 2026-05-19.
Metadadosinclude: ["metadata"]data.metadataGrátis. Disponível em /distill.
HTML originalinclude: ["html"]data.htmlUse com parcimônia — payloads grandes.
Linksformats: ["links"]data.links (array de {text, href})Grátis.
Imagensformats: ["images"]data.images (array de {src, alt, width, height})Grátis.
Resumoformats: [{"type":"summary"}]data.summary (Markdown)+4 créditos em caso de sucesso.
Pergunta / Respostaformats: [{"type":"question","question":"…"}]data.answer+4 créditos em caso de sucesso.
Highlightsformats: [{"type":"highlights","query":"…"}]data.highlights (array de strings)+4 créditos em caso de sucesso.

Combinando formatos

curl -X POST https://openapi.thunderbit.co/openapi/v1/distill \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/article",
    "formats": [
      "markdown",
      "links",
      "images",
      {"type": "summary"},
      {"type": "question",   "question": "What is this page about?"},
      {"type": "highlights", "query":    "key takeaways"}
    ]
  }'

A resposta carrega cada chave solicitada em data — data.markdown, data.links, data.images, data.summary, data.answer, data.highlights. Chaves não solicitadas são omitidas, não nulas.

Cálculo de créditos

Formatos LLM (summary, question, highlights) só são cobrados quando devolvem um resultado. A resposta traz um campo creditsUsed nas respostas batch e search; para chamadas de página única, confira o ledger da sua conta.

  • Distill com um formato LLM → 1 + 4 = 5 credits
  • Distill com três formatos LLM → 1 + 3×4 = 13 credits
  • Extract com um formato LLM → 20 + 4 = 24 credits
  • Search com limit: 5 e summary → 5 × (1 + 4) + 1 = 26 credits

Booleans legados e include

Requisições antigas usavam includeHtml: true e extractLinks: true. Ambos ainda funcionam; em código novo prefira formats (e include para metadata / html) — são componíveis e mais claros em code review.