De basis-URL van de API
Op deze pagina
Het toegangspunt van de Grok API
Elk verzoek aan de xAI API loopt via één enkele basis-URL. Het begrijpen van deze URL en de beschikbare eindpunten is essentieel voordat u uw eerste regel code schrijft.
De basis-URL
De Grok API bevindt zich op dit adres:
https://api.x.ai/v1
Deze URL vormt de root voor elk eindpunt. Om bijvoorbeeld een respons te genereren, is de volledige URL https://api.x.ai/v1/responses.
Waarom /v1?
Het voorvoegsel /v1 geeft de API-versie aan. Versiebeheer stelt xAI in staat de API verder te ontwikkelen zonder bestaande applicaties te breken. Mocht er ooit een versie 2 verschijnen, dan zal deze tijdens een overgangsperiode naast v1 bestaan.
Compatibiliteit met het OpenAI-ecosysteem
Een fundamentele eigenschap van de xAI API is de compatibiliteit met het OpenAI-formaat. In de praktijk hoeft u, als u al code heeft die werkt met de OpenAI API, slechts twee instellingen te wijzigen om Grok te gebruiken:
- De basis-URL: vervang
https://api.openai.com/v1doorhttps://api.x.ai/v1 - De API-sleutel: vervang uw OpenAI-sleutel door uw xAI-sleutel
Deze compatibiliteit strekt zich uit tot de meeste tools en bibliotheken in het OpenAI-ecosysteem: LangChain, LlamaIndex, LiteLLM en vele anderen werken zonder code-aanpassingen met Grok.
De belangrijkste eindpunten
De API biedt verschillende eindpunten, gegroepeerd per functionaliteit.
Tekstgeneratie
POST /v1/responses: het belangrijkste eindpunt voor het genereren van responsen (modern formaat)POST /v1/chat/completions: het OpenAI-compatibele eindpunt (verouderd formaat, nog steeds ondersteund)
Mediageneratie
POST /v1/images/generations: afbeeldingen genererenPOST /v1/images/edits: bestaande afbeeldingen bewerkenPOST /v1/videos/generations: video’s genererenPOST /v1/tts: spraaksynthese (text-to-speech)
Bestandsbeheer
POST /v1/files: een bestand uploadenGET /v1/files: geüploade bestanden oplijsten
Real-time
wss://api.x.ai/v1/realtime: voice-agent via WebSocket
De URL instellen in uw SDK’s
Wanneer u een OpenAI-compatibele SDK gebruikt, moet u de basis-URL expliciet opgeven:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Bij de native xAI SDK is de URL reeds voorgeconfigureerd en hoeft u niets in te stellen.
Connectiviteit testen
Voordat u code schrijft, valideert een directe oproep de volledige keten (URL, sleutel, netwerk):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Het antwoord toont de modellen die beschikbaar zijn met uw sleutel. Dit is ook de meest betrouwbare manier om de exacte model-ID’s te achterhalen die op uw account beschikbaar zijn, zonder afhankelijk te zijn van documentatie die kan wijzigen. Maak er een gewoonte van: valideer elke nieuwe omgeving (machine, CI, server) met dezezelfde oproep voordat u iets implementeert.
Limieten en quota
De API handhaaft snelheidslimieten (rate limits) voor elk team en elk model. Als u deze overschrijdt, ontvangt u een HTTP 429-fout. De xAI-console toont uw huidige quota en uw gebruik in real-time.
Belangrijkste punten
- De basis-URL is
https://api.x.ai/v1voor elk eindpunt - De API is compatibel met het OpenAI-formaat: wijzig de URL en de sleutel, en dat is alles
- Het belangrijkste generatie-eindpunt is
POST /v1/responses - Het verouderde eindpunt
POST /v1/chat/completionsblijft beschikbaar voor compatibiliteit