Verfügbare Endpunkte
Auf dieser Seite
Überblick über die Grok-API
Die xAI-API beschränkt sich nicht auf die Textgenerierung. Sie stellt eine Reihe von Endpunkten bereit, die die Bild- und Videogenerierung, die Sprachsynthese, das Dateimanagement sowie die asynchrone Verarbeitung abdecken. In dieser Lektion werden die verfügbaren Endpunkte kartiert, damit Sie wissen, welche Funktionen Sie in Ihren Projekten einsetzen können.
Textgenerierung
POST /v1/responses (empfohlen)
Dies ist der Hauptendpunkt für jede Interaktion mit den Grok-Modellen. Er unterstützt Text, Vision, Tools (Function Calling), Websuche und X-Suche.
Wichtige Parameter: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (OpenAI-kompatibel)
Dies ist der Endpunkt im OpenAI-Format, der zur Kompatibilität mit bestehenden Tools erhalten bleibt. Er akzeptiert dieselben Parameter wie die OpenAI-API: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Ruft eine zuvor generierte Antwort ab, sofern diese gespeichert wurde (Parameter store: true). Antworten werden für 30 Tage aufbewahrt.
DELETE /v1/responses/{id}
Löscht eine gespeicherte Antwort, bevor sie nach 30 Tagen automatisch verfällt.
Asynchrone Verarbeitung
POST /v1/chat/completions (verzögerter Modus)
Wenn Sie "deferred": true zur Anfrage hinzufügen, gibt die API sofort eine request_id zurück, ohne auf das Ende der Generierung zu warten. Dies ist für lange Anfragen oder die Batch-Verarbeitung nützlich.
GET /v1/chat/deferred-completion/{request_id}
Ruft das Ergebnis eines asynchronen Aufrufs ab:
- HTTP 200: Die Generierung ist abgeschlossen, und der Body enthält die vollständige Antwort.
- HTTP 202: Die Generierung läuft noch, versuchen Sie es später erneut.
Bildgenerierung
POST /v1/images/generations
Generiert Bilder aus einer Textbeschreibung.
POST /v1/images/edits
Bearbeitet ein bestehendes Bild basierend auf Textanweisungen.
Videogenerierung
POST /v1/videos/generations
Startet die Generierung eines Videos aus einem Textprompt.
GET /v1/videos/{id}
Überprüft den Status eines generierten Videos und ruft die Ergebnis-URL ab, sobald die Generierung abgeschlossen ist.
POST /v1/videos/edits
Bearbeitet ein bestehendes Video.
POST /v1/videos/extensions
Erweitert ein bestehendes Video.
Sprachsynthese
POST /v1/tts
Konvertiert Text in Audio (Text-zu-Sprache). Nützlich für den Aufbau von Sprachassistenten oder automatisierten Audioinhalten.
Echtzeit-Sprachagent
WSS wss://api.x.ai/v1/realtime
Ein WebSocket-Endpunkt zum Aufbau interaktiver Sprachagenten. Die Kommunikation erfolgt in Echtzeit mit dem Senden und Empfangen von Audio.
Dateimanagement
POST /v1/files
Lädt eine Datei auf die xAI-Plattform hoch. Dateien können anschließend für RAG (retrieval-augmented generation) mit Collections verwendet werden.
GET /v1/files
Listet alle Dateien auf, die in Ihrem Bereich hochgeladen wurden.
GET /v1/files/{id}
Ruft die Metadaten einer spezifischen Datei ab.
DELETE /v1/files/{id}
Löscht eine hochgeladene Datei.
Batch-Verarbeitung
POST /v1/batches
Erstellt eine Gruppe von Anfragen zur gemeinsamen Verarbeitung, oft zu einem reduzierten Preis.
GET /v1/batches
Listet laufende und abgeschlossene Batches auf.
Serverseitige integrierte Tools
Der Endpunkt /v1/responses unterstützt Tools, die die API direkt ausführt, ohne clientseitige Logik:
- web_search: Echtzeit-Websuche
- x_search: Suche in X (Twitter)-Beiträgen
- code_interpreter: Ausführung von Python-Code
- function: Aufrufe benutzerdefinierter Funktionen (Function Calling)
Sie aktivieren diese Tools über den tools-Parameter der Anfrage.
Kernaussagen
- Die API deckt Text, Bilder, Video, Audio und Dateien ab.
/v1/responsesist der Hauptendpunkt und bietet die umfassendste Unterstützung.- Der
deferred-Modus ermöglicht die asynchrone Verarbeitung für lange Anfragen. - Serverseitige Tools (web_search, x_search, code_interpreter) bereichern Antworten ohne zusätzlichen Code.