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

Alle API-Endpunkte erfordern eine Authentifizierung über ein Bearer-Token im Header Authorization:

Authorization: Bearer <ihr-api-schlüssel>

Einrichten Ihres API-Schlüssels

Konfigurieren Sie Ihren API-Schlüssel als Umgebungsvariable. Dieser Ansatz optimiert Ihre API-Nutzung, da Sie Ihren API-Schlüssel nicht in jede Anfrage aufnehmen müssen. Darüber hinaus erhöht er die Sicherheit, indem er das Risiko minimiert, Ihren API-Schlüssel versehentlich in Ihre Codebasis aufzunehmen.

In Ihrem bevorzugten Terminal:

export VULGATE_API_KEY=<ihr-api-schluessel>

Oder in der .env-Datei Ihres Projekts:

VULGATE_API_KEY=<ihr-api-schluessel>

Ersetzen Sie <ihr-api-schluessel> durch Ihren tatsächlichen API-Schlüssel, den Sie in Ihrem Team-Dashboard unter Einstellungen > API generieren können. Unter API-Konsole finden Sie vollständige Details zur Schlüsselverwaltung.

Bereiche

• API-Konsole - Verwalten Sie Ihre API-Schlüssel und überwachen Sie die Nutzung.
• Agent-Skill - Lassen Sie einen KI-Agenten den gesamten Ablauf aus Upload, Bearbeitung und Veröffentlichung übernehmen.
• Ingest API - Erfahren Sie, wie Sie Dokumente hochladen und erfassen.
• Such-API - Semantische und Stichwortsuche in Ihren Dokumentbibliotheken.
• Chat-API - KI-gestützte Unterhaltungen auf der Grundlage Ihrer Dokumente.