API'ens basis-URL
På denne side
Grok API’ets indgangspunkt
Alle forespørgsler til xAI API’et går gennem en enkelt basis-URL. Det er afgørende at forstå denne URL og de tilgængelige endpoints, før du skriver din første linje kode.
Basis-URL’en
Grok API’et findes på denne adresse:
https://api.x.ai/v1
Denne URL er roden for ethvert endpoint. For at oprette et svar vil den fulde URL f.eks. være https://api.x.ai/v1/responses.
Hvorfor /v1?
Præfikset /v1 angiver API-versionen. Versionering giver xAI mulighed for at udvikle API’et uden at ødelægge eksisterende applikationer. Hvis en version 2 dukker op, vil den sameksistere med v1 i en overgangsperiode.
Kompatibilitet med OpenAI-økosystemet
En grundlæggende funktion ved xAI API’et er dets kompatibilitet med OpenAI-formatet. I praksis betyder det, at hvis du allerede har kode, der virker med OpenAI API’et, skal du kun ændre to indstillinger for at bruge Grok:
- Basis-URL’en: udskift
https://api.openai.com/v1medhttps://api.x.ai/v1 - API-nøglen: udskift din OpenAI-nøgle med din xAI-nøgle
Denne kompatibilitet strækker sig til de fleste værktøjer og biblioteker i OpenAI-økosystemet: LangChain, LlamaIndex, LiteLLM og mange andre fungerer med Grok uden kodeændringer.
De vigtigste endpoints
API’et eksponerer flere endpoints grupperet efter funktion.
Tekstgenerering
POST /v1/responses: hovedendpointen til generering af svar (moderne format)POST /v1/chat/completions: OpenAI-kompatibel endpoint (legacy-format, stadig understøttet)
Mediegenerering
POST /v1/images/generations: generér billederPOST /v1/images/edits: redigér eksisterende billederPOST /v1/videos/generations: generér videoerPOST /v1/tts: talesyntese (tekst-til-tale)
Filhåndtering
POST /v1/files: upload en filGET /v1/files: list uploadede filer
Realtid
wss://api.x.ai/v1/realtime: voice-agent via WebSocket
Indstil URL’en i dine SDK’er
Når du bruger et OpenAI-kompatibelt SDK, skal du angive basis-URL’en eksplicit:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Med det native xAI SDK er URL’en forudkonfigureret, og du behøver ikke indstille noget.
Test forbindelsen
Før du skriver nogen kode, validerer et direkte kald hele kæden (URL, nøgle, netværk):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Svaret lister de modeller, der er tilgængelige med din nøgle. Det er også den mest pålidelige måde at lære de nøjagtige model-ID’er, der er tilgængelige på din konto, uden at være afhængig af dokumentation, der kan ændre sig. Behold denne vane: valider ethvert nyt miljø (maskine, CI, server) med dette samme kald før enhver udrulning.
Grænser og kvoter
API’et håndhæver hastighedsbegrænsninger for hvert team og hver model. Hvis du overskrider dem, får du en HTTP 429-fejl. xAI-konsollen viser dine aktuelle kvoter og dit forbrug i realtid.
Vigtige pointer
- Basis-URL’en er
https://api.x.ai/v1for ethvert endpoint - API’et er kompatibelt med OpenAI-formatet: ændr URL’en og nøglen, så er du klar
- Hovedendpointen til generering er
POST /v1/responses - Den legacy
POST /v1/chat/completions-endpoint forbliver tilgængelig af kompatibilitetsårsager