Documentazione API di Vulgate

Benvenuto nella documentazione API di Vulgate. Vulgate è una piattaforma di intelligenza documentale che ti permette di ingerire, cercare e interagire con le tue librerie di documenti attraverso una potente API.

Carica e processa documenti di qualsiasi formato — PDF, immagini, audio e altro — poi interrogali con ricerca semantica o per parole chiave, oppure conduci conversazioni basate sull’IA fondate sui tuoi contenuti con citazioni complete delle fonti.

L’API è progettata per essere compatibile con OpenAI, così puoi integrarla con qualsiasi SDK esistente che supporti l’interfaccia Chat Completions.

Autenticazione

All API endpoints require authentication via a Bearer token in the Authorization header:

Authorization: Bearer <your-api-key>

Configurazione della chiave API

Configure your API key as an environment variable. This approach streamlines your API usage by eliminating the need to include your API key in each request. Moreover, it enhances security by minimizing the risk of inadvertently including your API key in your codebase.

In your terminal of choice:

export VULGATE_API_KEY=<your-api-key-here>

Or, in your project’s .env file:

VULGATE_API_KEY=<your-api-key-here>

Replace <your-api-key-here> with your actual API key, which you can generate in your team dashboard by navigating to Settings > API. See API Console for full details on key management.

Sezioni

• API Console - Manage your API keys and monitor usage.
• Ingest API - Learn how to upload and ingest documents.
• Search API - Semantic and keyword search across your document libraries.
• Chat API - AI-powered conversations grounded in your documents.