Beschikbare eindpunten
Op deze pagina
Overzicht van de Grok API
De xAI API beperkt zich niet tot tekstgeneratie. Het biedt een reeks eindpunten voor beeld- en videogeneratie, spraaksynthese, bestandsbeheer en asynchrone verwerking. Deze les brengt de beschikbare eindpunten in kaart, zodat u weet welke functies u in uw projecten moet gebruiken.
Tekstgeneratie
POST /v1/responses (aanbevolen)
Dit is het belangrijkste eindpunt voor elke interactie met de Grok-modellen. Het ondersteunt tekst, visie, tools (function calling), webzoekopdrachten en X-zoekopdrachten.
Belangrijkste parameters: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (OpenAI-compatibel)
Dit eindpunt volgt het OpenAI-formaat en wordt onderhouden voor compatibiliteit met bestaande tools. Het accepteert dezelfde parameters als de OpenAI API: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Haalt een eerder gegenereerd antwoord op als dit is opgeslagen (parameter store: true). Antwoorden worden 30 dagen bewaard.
DELETE /v1/responses/{id}
Verwijdert een opgeslagen antwoord voordat het na 30 dagen automatisch verloopt.
Asynchrone verwerking
POST /v1/chat/completions (uitgestelde modus)
Wanneer u "deferred": true aan het verzoek toevoegt, retourneert de API onmiddellijk een request_id zonder te wachten tot de generatie is voltooid. Dit is nuttig voor lange verzoeken of batchverwerking.
GET /v1/chat/deferred-completion/{request_id}
Haalt het resultaat van een asynchrone oproep op:
- HTTP 200: de generatie is voltooid en de body bevat het volledige antwoord
- HTTP 202: de generatie is nog bezig, probeer het later opnieuw
Beeldgeneratie
POST /v1/images/generations
Genereert afbeeldingen op basis van een tekstbeschrijving.
POST /v1/images/edits
Bewerkt een bestaande afbeelding op basis van tekstinstructies.
Videogeneratie
POST /v1/videos/generations
Start met het genereren van een video op basis van een tekstprompt.
GET /v1/videos/{id}
Controleert de status van een video die wordt gegenereerd en haalt de resultaat-URL op zodra deze klaar is.
POST /v1/videos/edits
Bewerkt een bestaande video.
POST /v1/videos/extensions
Verlengt een bestaande video.
Spraaksynthese
POST /v1/tts
Zet tekst om in audio (text-to-speech). Nuttig voor het bouwen van spraakassistenten of geautomatiseerde audio-inhoud.
Real-time spraakagent
WSS wss://api.x.ai/v1/realtime
Een WebSocket-eindpunt voor het bouwen van interactieve spraakagenten. De communicatie verloopt in real time, waarbij audio wordt verzonden en ontvangen.
Bestandsbeheer
POST /v1/files
Uploadt een bestand naar het xAI-platform. Bestanden kunnen vervolgens worden gebruikt voor RAG (retrieval-augmented generation) met collecties.
GET /v1/files
Toont een lijst van alle bestanden die naar uw ruimte zijn geüpload.
GET /v1/files/{id}
Haalt de metadata van een specifiek bestand op.
DELETE /v1/files/{id}
Verwijdert een geüpload bestand.
Batchverwerking
POST /v1/batches
Maakt een batch verzoeken aan om als groep te verwerken, vaak tegen een verlaagde prijs.
GET /v1/batches
Toont een lijst van batches die bezig zijn of voltooid.
Ingebouwde server-side tools
Het eindpunt /v1/responses ondersteunt tools die de API direct uitvoert, zonder client-side logica:
- web_search: real-time webzoekopdracht
- x_search: zoeken in X (Twitter)-berichten
- code_interpreter: uitvoeren van Python-code
- function: aangepaste functieaanroepen (function calling)
U schakelt deze tools in met de parameter tools van het verzoek.
Belangrijkste punten
- De API bestrijkt tekst, afbeeldingen, video, audio en bestanden
/v1/responsesis het belangrijkste eindpunt, met de meest volledige ondersteuning- De
deferred-modus maakt asynchrone verwerking mogelijk voor lange verzoeken - Server-side tools (web_search, x_search, code_interpreter) verrijken antwoorden zonder extra code