API:ns bas-URL
På denna sida
Grok API:s ingångspunkt
Varje begäran till xAI:s API går genom en enda bas-URL. Det är avgörande att förstå denna URL och de tillgängliga slutpunkterna innan du skriver din första kodrad.
Bas-URL:en
Grok API finns på följande adress:
https://api.x.ai/v1
Denna URL är roten för varje slutpunkt. För att skapa ett svar blir den fullständiga URL:en till exempel https://api.x.ai/v1/responses.
Varför /v1?
Prefixet /v1 anger API-versionen. Versionshantering låter xAI utveckla API:t utan att befintliga applikationer slutar fungera. Om en version 2 släpps kommer den att samexistera med v1 under en övergångsperiod.
Kompatibilitet med OpenAI-ekosystemet
En grundläggande funktion hos xAI API är dess kompatibilitet med OpenAI-formatet. I praktiken behöver du, om du redan har kod som fungerar med OpenAI API, bara ändra två inställningar för att använda Grok:
- Bas-URL:en: byt ut
https://api.openai.com/v1mothttps://api.x.ai/v1 - API-nyckeln: byt ut din OpenAI-nyckel mot din xAI-nyckel
Denna kompatibilitet sträcker sig till de flesta verktyg och bibliotek i OpenAI-ekosystemet: LangChain, LlamaIndex, LiteLLM och många andra fungerar med Grok utan kodändringar.
De viktigaste slutpunkterna
API:t exponerar flera slutpunkter grupperade efter funktion.
Textgenerering
POST /v1/responses: huvudslutpunkten för att generera svar (modernt format)POST /v1/chat/completions: OpenAI-kompatibel slutpunkt (äldre format, stöds fortfarande)
Mediagenerering
POST /v1/images/generations: generera bilderPOST /v1/images/edits: redigera befintliga bilderPOST /v1/videos/generations: generera videorPOST /v1/tts: talsyntes (text-to-tal)
Filhantering
POST /v1/files: ladda upp en filGET /v1/files: lista uppladdade filer
Realtid
wss://api.x.ai/v1/realtime: röstagent via WebSocket
Ställ in URL:en i dina SDK:n
När du använder ett OpenAI-kompatibelt SDK måste du ange bas-URL:en explicit:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Med det nativa xAI SDK:t är URL:en förkonfigurerad och du behöver inte ställa in något.
Testa anslutningen
Innan du skriver någon kod validerar ett direkt anrop hela kedjan (URL, nyckel, nätverk):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Svaret listar de modeller som är tillgängliga med din nyckel. Det är också det mest pålitliga sättet att ta reda på de exakta modell-ID:n som finns på ditt konto, utan att förlita sig på dokumentation som kan ändras. Behåll denna vana: validera varje ny miljö (maskin, CI, server) med samma anrop innan någon driftsättning.
Gränser och kvoter
API:t tillämpar hastighetsbegränsningar för varje team och varje modell. Om du överskrider dem får du ett HTTP 429-fel. xAI-konsolen visar dina aktuella kvoter och din användning i realtid.
Viktiga punkter
- Bas-URL:en är
https://api.x.ai/v1för varje slutpunkt - API:t är kompatibelt med OpenAI-formatet: ändra URL:en och nyckeln, så är det klart
- Den huvudsakliga genereringsslutpunkten är
POST /v1/responses - Den äldre slutpunkten
POST /v1/chat/completionsfinns fortfarande tillgänglig för kompatibilitet