Chat-API-Schnellstart

Die Chat-API ist OpenAI-kompatibel. Sie implementiert dieselbe /chat/completions-Form wie die OpenAI Chat Completions API, sodass jeder Client, der dieses Protokoll spricht — die offiziellen openai-SDKs, das Vercel ai-SDK, Ihre eigenen fetch-Aufrufe — funktioniert, indem Sie ihn auf Vulgate richten.

Unter der Haube führt Vulgate Retrieval gegen die Bibliotheken durch, auf die Ihr API-Schlüssel Zugriff hat, und übergibt die relevanten Passagen an das Modell. Antworten enthalten Zitate, die auf die Quellpassagen verweisen.

Die vollständige Referenz finden Sie unter /developers/chat/overview. Dies ist das Minimum zum Einstieg.

Eine minimale Anfrage

curl -X POST "https://vulgate.ai/api/chat/completions" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "vulgate-1",
    "messages": [
      {"role": "user", "content": "Summarize the council teachings on Eucharistic adoration."}
    ]
  }'

Antwort (gekürzt):

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "model": "vulgate-1",
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": "The councils teach that Eucharistic adoration..."
    },
    "finish_reason": "stop"
  }],
  "citations": [
    {
      "cited_text": "<p>...</p>",
      "document_title": "Ecclesia de Eucharistia",
      "document_index": 0,
      "document_author": "John Paul II",
      "source_url": null
    }
  ]
}

Streaming

Setzen Sie stream: true und Sie erhalten Server-Sent-Events im OpenAI chat.completion.chunk-Format:

curl -X POST "https://vulgate.ai/api/chat/completions" \
  -H "Authorization: Bearer $VULGATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "vulgate-1",
    "stream": true,
    "messages": [{"role": "user", "content": "Hello"}]
  }'

Jeder Chunk ist ein JSON-Objekt mit dem Präfix data: , endend mit data: [DONE]. Identisch mit OpenAI; vorhandene Parser funktionieren.

Bibliotheken

Im Gegensatz zur Search-API nimmt die Chat-API keinen libraries-Parameter. Die KI durchsucht automatisch die Bibliotheken, auf die das Team Ihres API-Schlüssels Zugriff hat.

OpenAI Python SDK verwenden

Das OpenAI-SDK funktioniert direkt — richten Sie einfach base_url auf Vulgate:

from openai import OpenAI

client = OpenAI(
    api_key=os.environ["VULGATE_API_KEY"],
    base_url="https://vulgate.ai/api",
)

response = client.chat.completions.create(
    model="vulgate-1",
    messages=[{"role": "user", "content": "Summarize the canon on confirmation."}],
)
print(response.choices[0].message.content)

Modelle

Übergeben Sie vulgate-1 (oder den Alias vulgate) im model-Feld. Die aktuelle Liste finden Sie unter /developers/chat/overview.

Rate-Limits und Timeouts

10 Anfragen pro 10 Sekunden pro Team (gleitendes Fenster).
120 Sekunden pro Anfrage.

Das Überschreiten des Rate-Limits gibt 429 mit den Headern X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset zurück.

Fehler

Die API verwendet Standard-HTTP-Statuscodes:

401 — ungültiger oder fehlender API-Schlüssel.
429 — Rate-Limit überschritten.
400 — Request-Body fehlerhaft; der Response-Body erklärt, was falsch ist.
500 / 502 — Vulgate-seitiges Problem; mit exponentiellem Backoff wiederholen.