Quickstart da API de Busca

Execute buscas neurais ou por palavra-chave na sua Biblioteca via linha de comando ou qualquer cliente HTTP.

21 de mai. de 2026

A API de Busca dá acesso programático ao mesmo mecanismo de recuperação que alimenta a Busca e o Chat do Vulgate. Você pode executar buscas neurais (baseadas em significado) e por palavra-chave (correspondência literal), com filtros opcionais para autor, ano de publicação, ISBN e ID do documento.

A referência completa está em /developers/search/overview. Este guia cobre os padrões mais comuns.

Busca neural

Encontre passagens cujo significado corresponde a uma consulta:

curl -G "https://vulgate.ai/api/search" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=concílios da igreja primitiva sobre autoridade civil" \
  --data-urlencode "mode=neural" \
  --data-urlencode "per_page=5"

Resposta (truncada):

{
  "data": [
    {
      "id": "part-abc123",
      "document_id": "doc-xyz789",
      "index": "urn:vulgate:doc-xyz789:42",
      "content_rendered": "<p>Os padres raciocinaram que a governança civil...</p>",
      "language": "pt",
      "namespace": "mai",
      "documents": {
        "id": "doc-xyz789",
        "title": "O Concílio de Niceia",
        "author": "...",
        "publication_date": "1995",
        "document_format": "PDF",
        "scope": "organization"
      }
    }
  ],
  "count": 42,
  "error": null
}

Busca por palavra-chave

Encontre passagens que contenham as palavras literais. Defina mode=keyword:

curl -G "https://vulgate.ai/api/search" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=Constantino" \
  --data-urlencode "mode=keyword" \
  --data-urlencode "per_page=10"

Filtragem

Adicione filtros via parâmetros de consulta:

curl -G "https://vulgate.ai/api/search" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=graça" \
  --data-urlencode "author=Agostinho" \
  --data-urlencode "mode=neural"

Filtros disponíveis: author, publication_date (ano), isbn, id (ID do documento para correspondência exata) e document_id (para buscar dentro de um único documento).

Escolhendo bibliotecas

O parâmetro de consulta libraries restringe a busca a uma ou mais Bibliotecas. Passe-o como um parâmetro de consulta repetido:

curl -G "https://vulgate.ai/api/search" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=calendário litúrgico" \
  --data-urlencode "libraries=mai" \
  --data-urlencode "libraries=orientale"

Se libraries for omitido, a API usa por padrão sua biblioteca privada.

Buscando documentos (não passagens)

Para listar documentos que correspondem por título em vez de retornar passagens individuais, use /api/search/documents:

curl -G "https://vulgate.ai/api/search/documents" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=Eucaristia" \
  --data-urlencode "per_page=20"

Paginação

Use page (indexado a partir de 1) e per_page (máximo 100) para navegar pelo conjunto de resultados:

?search=teologia&per_page=20&page=2

O campo count da resposta é um total estimado — adequado para interfaces de paginação.

Relacionados

Pesquisar ajuda