Vulgate API-Dokumentation

Willkommen in der Vulgate API-Dokumentation. Vulgate ist eine Plattform für Dokumentenintelligenz, mit der Sie Ihre Dokumentenbibliotheken über eine leistungsstarke API aufnehmen, durchsuchen und interagieren können.

Laden Sie Dokumente beliebiger Formate hoch und verarbeiten Sie sie — PDFs, Bilder, Audio und mehr — und durchsuchen Sie sie dann mit semantischer oder schlüsselwortbasierter Suche, oder führen Sie KI-gestützte Konversationen basierend auf Ihren Inhalten mit vollständigen Quellenangaben.

Die API ist OpenAI-kompatibel konzipiert, sodass Sie sie mit jedem vorhandenen SDK integrieren können, das die Chat Completions-Schnittstelle unterstützt.

Authentifizierung

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

Authorization: Bearer <your-api-key>

Einrichten Ihres API-Schlüssels

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.

Bereiche

• 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.