Základná URL adresa API
Na tejto strane
Vstupný bod API Grok
Každá požiadavka odoslaná na API xAI prechádza cez jednu základnú URL adresu. Porozumenie tejto adrese a dostupným koncovým bodom je nevyhnutné ešte predtým, ako napíšeš svoj prvý riadok kódu.
Základná URL adresa
API Grok sa nachádza na tejto adrese:
https://api.x.ai/v1
Táto URL adresa je koreňom pre každý koncový bod. Napríklad, ak chceš vytvoriť odpoveď, úplná URL adresa bude https://api.x.ai/v1/responses.
Prečo /v1?
Predpona /v1 označuje verziu API. Verziovanie umožňuje spoločnosti xAI vyvíjať API ďalej bez toho, aby došlo k narušeniu fungovania existujúcich aplikácií. Ak sa v budúcnosti objaví verzia 2, bude počas prechodného obdobia koexistovať s verziou v1.
Kompatibilita s ekosystémom OpenAI
Základnou vlastnosťou API xAI je jeho kompatibilita s formátom OpenAI. V praxi to znamená, že ak už máš kód, ktorý funguje s API OpenAI, stačí zmeniť iba dve nastavenia, aby si mohol používať Grok:
- Základná URL adresa: nahraď
https://api.openai.com/v1adresouhttps://api.x.ai/v1 - API kľúč: nahraď svoj kľúč OpenAI svojím kľúčom xAI
Táto kompatibilita sa vzťahuje na väčšinu nástrojov a knižníc v ekosystéme OpenAI: LangChain, LlamaIndex, LiteLLM a mnohé ďalšie fungujú s Grokom bez potreby úprav kódu.
Hlavné koncové body
API poskytuje niekoľko koncových bodov zoskupených podľa funkcie.
Generovanie textu
POST /v1/responses: hlavný koncový bod na generovanie odpovedí (moderný formát)POST /v1/chat/completions: koncový bod kompatibilný s OpenAI (starší formát, stále podporovaný)
Generovanie médií
POST /v1/images/generations: generovanie obrázkovPOST /v1/images/edits: úprava existujúcich obrázkovPOST /v1/videos/generations: generovanie videíPOST /v1/tts: syntéza reči (text-na-reč)
Správa súborov
POST /v1/files: nahranie súboruGET /v1/files: zoznam nahraných súborov
Reálny čas
wss://api.x.ai/v1/realtime: hlasový agent cez WebSocket
Nastavenie URL adresy v SDK
Keď používaš SDK kompatibilné s OpenAI, musíš základnú URL adresu explicitne určiť:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Pri natívnom SDK od xAI je URL adresa prednastavená a nemusíš nič konfigurvať.
Testovanie pripojenia
Ešte predtým, ako začneš písať kód, overí priamy volanie celý reťazec (URL adresa, kľúč, sieť):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Odpoveď vypíše modely dostupné pre tvoj kľúč. Je to tiež najspoľahlivejší spôsob, ako zistiť presné ID modelov dostupných na tvojom účte, bez závislosti na dokumentácii, ktorá sa môže meniť. Zvykni si toto: over každé nové prostredie (stroj, CI, server) týmto rovnakým volaním pred akýmkoľvek nasadením.
Limity a kvóty
API presadzuje limity rýchlosti (rate limits) pre každý tím a každý model. Ak ich prekročíš, dostaneš chybu HTTP 429. Konzola xAI zobrazuje tvoje aktuálne kvóty a využitie v reálnom čase.
Kľúčové poznatky
- Základná URL adresa je
https://api.x.ai/v1pre každý koncový bod - API je kompatibilné s formátom OpenAI: stačí zmeniť URL adresu a kľúč a hotovo
- Hlavným koncovým bodom pre generovanie je
POST /v1/responses - Starší koncový bod
POST /v1/chat/completionszostáva dostupný kvôli kompatibilite