Die Basis-URL der API
Auf dieser Seite
Der Einstiegspunkt der Grok API
Jede Anfrage an die xAI API läuft über eine einzige Basis-URL. Das Verständnis dieser URL und der verfügbaren Endpunkte ist unerlässlich, bevor Sie die erste Zeile Code schreiben.
Die Basis-URL
Die Grok API befindet sich an folgender Adresse:
https://api.x.ai/v1
Diese URL ist die Wurzel für jeden Endpunkt. Zum Beispiel lautet die vollständige URL zum Erstellen einer Antwort https://api.x.ai/v1/responses.
Warum /v1?
Der Präfix /v1 kennzeichnet die API-Version. Durch Versionierung kann xAI die API weiterentwickeln, ohne bestehende Anwendungen zu beeinträchtigen. Sollte eine Version 2 erscheinen, wird sie sich während eines Übergangszeitraums parallel zu v1 befinden.
Kompatibilität mit dem OpenAI-Ökosystem
Eine grundlegende Eigenschaft der xAI API ist ihre Kompatibilität mit dem OpenAI-Format. In der Praxis müssen Sie, wenn Sie bereits Code besitzen, der mit der OpenAI API funktioniert, lediglich zwei Einstellungen ändern, um Grok zu nutzen:
- Die Basis-URL: Ersetzen Sie
https://api.openai.com/v1durchhttps://api.x.ai/v1 - Der API-Schlüssel: Ersetzen Sie Ihren OpenAI-Schlüssel durch Ihren xAI-Schlüssel
Diese Kompatibilität erstreckt sich auf die meisten Tools und Bibliotheken im OpenAI-Ökosystem: LangChain, LlamaIndex, LiteLLM und viele andere funktionieren mit Grok ohne Codeänderungen.
Die Hauptendpunkte
Die API stellt mehrere Endpunkte bereit, die nach Funktion gruppiert sind.
Textgenerierung
POST /v1/responses: Der Hauptendpunkt zur Generierung von Antworten (modernes Format)POST /v1/chat/completions: Der OpenAI-kompatible Endpunkt (Legacy-Format, weiterhin unterstützt)
Mediengenerierung
POST /v1/images/generations: Bilder generierenPOST /v1/images/edits: Bestehende Bilder bearbeitenPOST /v1/videos/generations: Videos generierenPOST /v1/tts: Sprachsynthese (Text-zu-Sprache)
Dateiverwaltung
POST /v1/files: Eine Datei hochladenGET /v1/files: Hochgeladene Dateien auflisten
Echtzeit
wss://api.x.ai/v1/realtime: Sprachagent über WebSocket
Die URL in Ihren SDKs festlegen
Wenn Sie einen OpenAI-kompatiblen SDK verwenden, müssen Sie die Basis-URL explizit angeben:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Mit dem nativen xAI SDK ist die URL vorab konfiguriert, und Sie müssen nichts einstellen.
Verbindung testen
Bevor Sie Code schreiben, validiert ein direkter Aufruf die gesamte Kette (URL, Schlüssel, Netzwerk):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Die Antwort listet die verfügbaren Modelle mit Ihrem Schlüssel auf. Es ist auch der zuverlässigste Weg, um die genauen Modell-IDs zu ermitteln, die auf Ihrem Konto verfügbar sind, ohne auf Dokumentation angewiesen zu sein, die sich ändern kann. Bewahren Sie diese Gewohnheit bei sich: Validieren Sie jede neue Umgebung (Maschine, CI, Server) mit diesem Aufruf, bevor Sie eine Bereitstellung durchführen.
Limits und Quoten
Die API setzt für jedes Team und jedes Modell Rate-Limits durch. Wenn Sie diese überschreiten, erhalten Sie einen HTTP 429-Fehler. Die xAI-Konsole zeigt Ihre aktuellen Quoten und Ihre Nutzung in Echtzeit an.
Kernaussagen
- Die Basis-URL ist
https://api.x.ai/v1für jeden Endpunkt - Die API ist mit dem OpenAI-Format kompatibel: Ändern Sie die URL und den Schlüssel, und das ist es
- Der Hauptendpunkt zur Generierung ist
POST /v1/responses - Der Legacy-Endpunkt
POST /v1/chat/completionsbleibt zur Kompatibilität erhalten