Documentação da API do Vulgate
Bem-vindo à documentação da API do Vulgate. O Vulgate é uma plataforma de inteligência documental que permite ingestar, buscar e interagir com suas bibliotecas de documentos através de uma API poderosa.
Envie e processe documentos de qualquer formato — PDFs, imagens, áudio e mais — depois consulte-os com busca semântica ou por palavras-chave, ou tenha conversas com IA baseadas no seu conteúdo com citações completas das fontes.
A API foi projetada para ser compatível com OpenAI, então você pode integrá-la com qualquer SDK existente que suporte a interface de Chat Completions.
Autenticação
Todos os endpoints da API exigem autenticação via token Bearer no cabeçalho Authorization:
Authorization: Bearer <sua-chave-de-api>Configurando sua chave API
Configure sua chave de API como uma variável de ambiente. Essa abordagem agiliza o uso da API eliminando a necessidade de incluir a chave em cada requisição. Além disso, melhora a segurança minimizando o risco de incluir acidentalmente a chave no seu código.
No seu terminal de preferência:
export VULGATE_API_KEY=<sua-chave-de-api>Ou, no arquivo .env do seu projeto:
VULGATE_API_KEY=<sua-chave-de-api>Substitua <sua-chave-de-api> pela sua chave de API real, que você pode gerar no painel da sua equipe acessando Configurações > API. Consulte o Console de API para detalhes completos sobre o gerenciamento de chaves.
Seções
- Console de API - Gerencie suas chaves de API e monitore o uso.
- Habilidade para agentes - Deixe um agente de IA executar todo o ciclo de envio, edição e publicação.
- API de Ingestão - Aprenda como enviar documentos e iniciar o processo de ingestão.
- API de Busca - Busca semântica e por palavras-chave em suas bibliotecas de documentos.
- API de Chat - Conversas com IA fundamentadas em seus documentos.