Vulgate API – Übersicht

Ein Überblick über die Ingest-, Search- und Chat-APIs und wo Sie sie finden.

21. Mai 2026

Die Vulgate-Plattform stellt alles, was die Web-App kann, über eine REST + JSON API bereit. Ob Sie ein internes Tool, eine Forschungs-Pipeline oder ein kundenorientiertes Produkt entwickeln — die API ist Ihr Einstieg in Verarbeitung, Suche und KI-Chat.

Die drei APIs

APIWas sie machtReferenz
IngestDateien hochladen, Verarbeitungsaufträge starten, Fortschritt überwachen, Dokumente verwalten./developers/ingest/overview
SearchNeuronale oder Stichwortsuche in Ihrer Bibliothek durchführen. Passagen oder Dokument-IDs zurückgeben./developers/search/overview
ChatOpenAI-kompatibler Chat-Completions-Endpunkt, der auf Ihrer Bibliothek basiert./developers/chat/overview

Die Chat-API verwendet das OpenAI Chat Completions-Format, sodass die meisten vorhandenen SDKs (Python openai, Vercel ai, LangChain usw.) funktionieren, indem Sie sie einfach auf https://vulgate.ai/api mit Ihrem Vulgate API-Schlüssel richten.

Basis-URL

https://vulgate.ai/api

Alle Endpunkte sind nur HTTPS.

Authentifizierung

Jede Anfrage benötigt ein Bearer-Token im Authorization-Header:

Authorization: Bearer <your-api-key>

Unter API-Schlüssel erstellen erfahren Sie, wie Sie einen generieren.

Schnellbeispiel

Eine Suche in Ihrer Bibliothek ausführen:

curl -G "https://vulgate.ai/api/search" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  --data-urlencode "search=eucharistic theology" \
  --data-urlencode "mode=neural" \
  --data-urlencode "per_page=5"

Die Antwort ist ein JSON-Objekt mit einer Liste von Ergebnispassagen, jeweils mit der Dokument-ID, einem Index, dem gerenderten Inhalt und den Metadaten des Quelldokuments. Alle Felder finden Sie in der Search-API-Referenz.

Streaming

Die Chat-API unterstützt gestreamte Antworten im OpenAI Chat Completions-Format. Setzen Sie stream: true im Request-Body. Siehe die Chat-API-Übersicht.

Rate-Limits

Die Chat-API erzwingt ein gleitendes Rate-Limit von 10 Anfragen pro 10 Sekunden pro Team mit einem Ausführungs-Timeout von 120 Sekunden pro Anfrage. Die Search-API hat ein Ausführungs-Timeout von 40 Sekunden pro Anfrage. Wenn Sie ein Limit überschreiten, gibt die API HTTP 429 zurück.

SDKs

Vulgate bietet derzeit kein First-Party-SDK, aber die Chat-API ist absichtlich kompatibel mit dem OpenAI-Client. Richten Sie das OpenAI-SDK auf https://vulgate.ai/api und übergeben Sie Ihren Vulgate API-Schlüssel:

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.VULGATE_API_KEY,
  baseURL: "https://vulgate.ai/api",
});

Für die Ingest- und Search-APIs funktioniert jeder HTTP-Client (fetch, axios, requests).

Nächste Schritte

Hilfe durchsuchen