Základní URL adresa API
Na této stránce
Vstupní bod API Grok
Každý požadavek zaslaný na API xAI prochází přes jedinou základní URL adresu. Než napíšeš první řádek kódu, je nezbytné pochopit tuto adresu a dostupné koncové body.
Základní URL adresa
API Grok běží na této adrese:
https://api.x.ai/v1
Tato URL adresa je kořenem pro každý koncový bod. Pokud chceš například vytvořit odpověď, úplná URL adresa zní https://api.x.ai/v1/responses.
Proč /v1?
Prefix /v1 označuje verzi API. Verzionování umožňuje společnosti xAI vyvíjet API dál, aniž by došlo k narušení stávajících aplikací. Pokud se objeví verze 2, bude během přechodného období koexistovat s verzí v1.
Kompatibilita s ekosystémem OpenAI
Základní vlastností API xAI je jeho kompatibilita s formátem OpenAI. V praxi to znamená, že pokud již máš kód fungující s API OpenAI, stačí pro použití Groku změnit pouze dvě nastavení:
- Základní URL adresu: nahraď
https://api.openai.com/v1adresouhttps://api.x.ai/v1 - API klíč: nahraď svůj klíč OpenAI svým klíčem xAI
Tato kompatibilita se vztahuje na většinu nástrojů a knihoven v ekosystému OpenAI: LangChain, LlamaIndex, LiteLLM a mnoho dalších fungují s Grokem bez jakýchkoli změn v kódu.
Hlavní koncové body
API poskytuje několik koncových bodů seskupených podle funkcí.
Generování textu
POST /v1/responses: hlavní koncový bod pro generování odpovědí (moderní formát)POST /v1/chat/completions: koncový bod kompatibilní s OpenAI (starší formát, stále podporovaný)
Generování médií
POST /v1/images/generations: generování obrázkůPOST /v1/images/edits: úprava existujících obrázkůPOST /v1/videos/generations: generování videíPOST /v1/tts: syntéza řeči (text-to-speech)
Správa souborů
POST /v1/files: nahrání souboruGET /v1/files: výpis nahraných souborů
Reálný čas
wss://api.x.ai/v1/realtime: hlasový agent přes WebSocket
Nastavení URL adresy v tvých SDK
Když používáš SDK kompatibilní s OpenAI, musíš základní URL adresu explicitně určit:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Při použití nativního SDK xAI je URL adresa předkonfigurována a nemusíš nic nastavovat.
Otestování připojení
Než začneš psát jakýkoli kód, přímý volání ověří celý řetězec (URL adresu, klíč, síť):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Odpověď vypíše modely dostupné pro tvůj klíč. Je to také nejspolehlivější způsob, jak zjistit přesná ID modelů dostupná na tvém účtu, aniž bys závisel na dokumentaci, která se může měnit. Zvykni si toto: každé nové prostředí (stroj, CI, server) před jakýmkoli nasazením ověř tímto stejným voláním.
Limity a kvóty
API vynucuje limity rychlosti pro každý tým a každý model. Pokud je překročíš, obdržíš chybu HTTP 429. Konzole xAI zobrazuje tvé aktuální kvóty a využití v reálném čase.
Klíčové poznatky
- Základní URL adresa pro každý koncový bod je
https://api.x.ai/v1 - API je kompatibilní s formátem OpenAI: stačí změnit URL adresu a klíč, a hotovo
- Hlavním koncovým bodem pro generování je
POST /v1/responses - Starší koncový bod
POST /v1/chat/completionszůstává dostupný pro účely kompatibility