Osnovni URL API-ja
Na tej strani
Vstopna točka API-ja Grok
Vsaka zahteva do API-ja xAI potuje skozi en sam osnovni URL. Razumevanje tega URL-ja in razpoložljivih končnih točk je bistveno, preden napišeš prvo vrstico kode.
Osnovni URL
API Grok se nahaja na tem naslovu:
https://api.x.ai/v1
Ta URL je koren za vsako končno točko. Na primer, za ustvarjanje odgovora je polni URL https://api.x.ai/v1/responses.
Zakaj /v1?
Predpona /v1 označuje različico API-ja. Različice omogočajo xAI, da razvija API, ne da bi pri tem pokvaril obstoječe aplikacije. Če se pojavi različica 2, bo ta v prehodnem obdobju sobivala z različico v1.
Združljivost z ekosistemom OpenAI
Temeljna lastnost API-ja xAI je njegova združljivost s formatom OpenAI. V praksi to pomeni, da če že imaš kodo, ki deluje z API-jem OpenAI, moraš za uporabo Groka spremeniti le dve nastavitvi:
- Osnovni URL: zamenjaj
https://api.openai.com/v1zhttps://api.x.ai/v1 - Ključ API: zamenjaj svoj ključ OpenAI s svojim ključem xAI
Ta združljivost sega na večino orodij in knjižnic v ekosistemu OpenAI: LangChain, LlamaIndex, LiteLLM in številna druga delujejo z Grokom brez sprememb v kodi.
Glavne končne točke
API izpostavlja več končnih točk, združenih po funkcijah.
Generiranje besedila
POST /v1/responses: glavna končna točka za generiranje odgovorov (sodobni format)POST /v1/chat/completions: končna točka, združljiva z OpenAI (starejši format, še vedno podprt)
Generiranje medijev
POST /v1/images/generations: generiranje slikPOST /v1/images/edits: urejanje obstoječih slikPOST /v1/videos/generations: generiranje videoposnetkovPOST /v1/tts: sinteza govora (besedilo-v-govor)
Upravljanje datotek
POST /v1/files: prenos datotekeGET /v1/files: seznam prenesenih datotek
Realni čas
wss://api.x.ai/v1/realtime: glasovni agent prek WebSocket
Nastavitev URL-ja v SDK-jih
Ko uporabljaš SDK, združljiv z OpenAI, moraš osnovni URL določiti izrecno:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Pri domačem SDK-ju xAI je URL vnaprej nastavljen in ti ni treba ničesar konfigurirati.
Preizkus povezljivosti
Preden napišeš kakršno koli kodo, neposreden klic potrdi celotno verigo (URL, ključ, omrežje):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Odgovor izpiše modele, ki so na voljo s tvojim ključem. To je tudi najbolj zanesljiv način, da izveš točne ID-je modelov, ki so na voljo na tvojem računu, ne da bi se zanašal na dokumentacijo, ki se lahko spremeni. Ohrani to navado: vsako novo okolje (stroj, CI, strežnik) pred vsako uvedbo potrdi s tem istim klicem.
Omejitve in kvote
API uveljavlja omejitve hitrosti za vsako ekipo in vsak model. Če jih presežeš, prejmeš napako HTTP 429. Konzola xAI prikazuje tvoje trenutne kvote in uporabo v realnem času.
Ključne ugotovitve
- Osnovni URL je
https://api.x.ai/v1za vsako končno točko - API je združljiv s formatom OpenAI: spremeni URL in ključ, in to je vse
- Glavna končna točka za generiranje je
POST /v1/responses - Starejša končna točka
POST /v1/chat/completionsostaja na voljo zaradi združljivosti