Zum Hauptinhalt springen
Die Venice API bietet HTTP-basierte REST- und Streaming-Schnittstellen für die Entwicklung von KI-Anwendungen mit unzensierten Modellen und privater Inferenz. Sie können Texterzeugung, Bildgenerierung, Embeddings und mehr erstellen — alles ohne restriktive Inhaltsrichtlinien. Integrationsbeispiele und SDKs sind in der Dokumentation verfügbar. Unsere API-Referenz ist auch als OpenAPI-YAML-Spezifikation verfügbar.

Authentifizierung

Die Venice API verwendet API-Schlüssel zur Authentifizierung. Erstellen und verwalten Sie Ihre API-Schlüssel in Ihren API-Einstellungen. Alle API-Anfragen erfordern HTTP-Bearer-Authentifizierung:
Ihr API-Schlüssel ist ein Geheimnis. Geben Sie ihn nicht weiter und legen Sie ihn nicht in clientseitigem Code offen.

OpenAI-Kompatibilität

Die API von Venice implementiert die OpenAI-API-Spezifikation und stellt damit die Kompatibilität mit bestehenden OpenAI-Clients und -Tools sicher. So können Sie Venice über die gewohnte OpenAI-Schnittstelle einbinden und gleichzeitig auf die einzigartigen Funktionen von Venice und seine unzensierten Modelle zugreifen.

Setup

Konfigurieren Sie Ihren Client so, dass er die Base-URL von Venice (https://api.venice.ai/api/v1) verwendet, und stellen Sie Ihre erste Anfrage:

Venice-spezifische Funktionen

System-Prompts

Venice stellt Standard-System-Prompts bereit, die unzensierte und natürliche Modellantworten gewährleisten sollen. Sie haben zwei Optionen zum Umgang mit System-Prompts:
  1. Standardverhalten: Ihre System-Prompts werden an die Defaults von Venice angehängt
  2. Benutzerdefiniertes Verhalten: Die System-Prompts von Venice vollständig deaktivieren

Venice-System-Prompts deaktivieren

Verwenden Sie die Option venice_parameters, um die Standard-System-Prompts von Venice zu entfernen:

Venice-Parameter

Das Objekt venice_parameters ermöglicht den Zugriff auf Venice-spezifische Funktionen, die in der Standard-OpenAI-API nicht verfügbar sind:
Diese Parameter können auch als Modell-Suffixe an den Modellnamen angehängt werden (z. B. zai-org-glm-5:enable_web_search=auto). Details siehe Model Feature Suffixes.

Prompt Caching

Venice unterstützt Prompt Caching auf ausgewählten Modellen, um Latenz und Kosten für wiederholten Inhalt zu reduzieren. Für unterstützte Modelle cached Venice System-Prompts automatisch — es sind keine Code-Änderungen erforderlich. Sie können Inhalte auch manuell zum Caching markieren, indem Sie die Eigenschaft cache_control am Nachrichteninhalt verwenden. Siehe Prompt Caching für Details zur Funktionsweise des Caching, zur Abrechnung und zu Best Practices.

Response-Header-Referenz

Alle Antworten der Venice API enthalten HTTP-Header, die Metadaten zur Anfrage, Rate-Limits, Modellinformationen und Kontoguthaben bereitstellen. Zusätzlich zu Fehlercodes aus API-Antworten können Sie diese Header prüfen, um die eindeutige ID einer bestimmten API-Anfrage zu erhalten, Rate-Limits zu überwachen und Ihr Kontoguthaben zu verfolgen. Venice empfiehlt, Request-IDs (CF-RAY-Header) in Produktivumgebungen zu protokollieren, um die Problemanalyse mit unserem Support-Team bei Bedarf effizienter zu gestalten. Die folgende Tabelle bietet eine umfassende Referenz aller Header, denen Sie begegnen können:

Wichtige Hinweise

  • Header-Namens-Schreibweise: HTTP-Header sind case-insensitive, aber Venice verwendet aus Konsistenzgründen Kleinschreibung mit Bindestrichen
  • String-Werte: Boolesche Werte in Headern werden als Strings zurückgegeben ("true" oder "false")
  • Numerische Werte: Große Zahlen und Guthabenwerte können als Strings zurückgegeben werden, um Genauigkeitsverlust zu vermeiden
  • Optionale Header: Nicht alle Header werden in jeder Antwort zurückgegeben; die Verfügbarkeit hängt vom Endpoint und Request-Kontext ab
  • Komprimierung: Verwenden Sie Accept-Encoding: gzip, br in Anfragen, um dort, wo unterstützt, komprimierte Antworten zu erhalten

Beispiel: Auf Response-Header zugreifen

Best Practices

  1. Rate-Limiting: Überwachen Sie die Header x-ratelimit-remaining-requests und x-ratelimit-remaining-tokens und implementieren Sie exponentielles Backoff
  2. Guthaben-Überwachung: Verfolgen Sie die Header x-venice-balance-usd und x-venice-balance-diem, um Dienstunterbrechungen zu vermeiden
  3. System-Prompts: Testen Sie mit und ohne Venice-System-Prompts, um die beste Anpassung an Ihren Use Case zu finden
  4. API-Schlüssel: Halten Sie Ihre API-Schlüssel sicher und rotieren Sie sie regelmäßig
  5. Request-Logging: Protokollieren Sie die Werte des CF-RAY-Headers zur Problemanalyse mit dem Support
  6. Modell-Deprecation: Prüfen Sie bei der Modellnutzung auf x-venice-model-deprecation-warning-Header

Unterschiede zur OpenAI-API

Während Venice eine hohe Kompatibilität mit der OpenAI-API-Spezifikation aufrechterhält, gibt es einige wesentliche Unterschiede:
  1. venice_parameters: Zusätzliche Konfigurationen wie enable_web_search, character_slug und strip_thinking_response für erweiterte Funktionalität
  2. System-Prompts: Venice hängt Ihre System-Prompts an Defaults an, die auf unzensierte Antworten optimiert sind (deaktivieren mit include_venice_system_prompt: false)
  3. Modell-Ökosystem: Venice bietet eine eigene Modell-Auswahl inklusive unzensierter und Reasoning-Modelle — verwenden Sie Venice-Modell-IDs statt OpenAI-Mappings
  4. Response-Header: Einzigartige Header für Guthaben-Tracking (x-venice-balance-usd, x-venice-balance-diem), Modell-Deprecation-Warnungen und Content-Safety-Flags
  5. Inhaltsrichtlinien: Großzügigere Richtlinien mit dedizierten unzensierten Modellen und optionaler Inhaltsfilterung

API-Stabilität

Venice gewährleistet Abwärtskompatibilität für v1-Endpoints und -Parameter. Für die Modell-Lifecycle-Policy, Deprecation-Hinweise und Migrations-Anleitung siehe Deprecations.

OpenAPI-Spezifikation & Rohdaten

Für den programmatischen Zugriff auf die Venice-API-Dokumentation und -Daten — einschließlich der Nutzung mit RAG (Retrieval-Augmented Generation) — stehen die folgenden Ressourcen zur Verfügung:
Request-Felder, die in dieser Dokumentation nicht aufgeführt sind, können durchgereicht werden, sind aber nicht validiert und ihr Verhalten ist nicht garantiert.