Grok API bāzes URL
Šajā lapā
Grok API ieejas punkts
Katrs pieprasījums xAI API iet caur vienu bāzes URL. Pirms uzraksti savu pirmo koda rindiņu, ir būtiski saprast šo URL un pieejamos galapunktus.
Bāzes URL
Grok API atrodas šajā adresē:
https://api.x.ai/v1
Šis URL ir sakne katram galapunktam. Piemēram, lai ģenerētu atbildi, pilnais URL ir https://api.x.ai/v1/responses.
Kāpēc /v1?
Prefikss /v1 norāda API versiju. Versiju kontrole ļauj xAI attīstīt API, nesabojājot esošās lietotnes. Ja nākotnē parādīsies 2. versija, tā pārejas periodā pastāvēs līdzās v1.
Saderība ar OpenAI ekosistēmu
Būtiska xAI API iezīme ir tā saderība ar OpenAI formātu. Praksē tas nozīmē, ka, ja tev jau ir kods, kas strādā ar OpenAI API, tev Grok lietošanai jāmaina tikai divi iestatījumi:
- Bāzes URL: nomaini
https://api.openai.com/v1uzhttps://api.x.ai/v1 - API atslēga: nomaini savu OpenAI atslēgu uz savu xAI atslēgu
Šī saderība attiecas uz lielāko daļu OpenAI ekosistēmas rīku un bibliotēkām: LangChain, LlamaIndex, LiteLLM un daudzas citas strādā ar Grok bez koda izmaiņām.
Galvenie galapunkti
API piedāvā vairākus galapunktus, sagrupētus pēc funkcijām.
Teksta ģenerēšana
POST /v1/responses: galvenais galapunkts atbilžu ģenerēšanai (mūsdienu formāts)POST /v1/chat/completions: OpenAI saderīgais galapunkts (vecais formāts, joprojām atbalstīts)
Mediju ģenerēšana
POST /v1/images/generations: attēlu ģenerēšanaPOST /v1/images/edits: esošo attēlu rediģēšanaPOST /v1/videos/generations: video ģenerēšanaPOST /v1/tts: runas sintēze (teksts uz runu)
Failu pārvaldība
POST /v1/files: faila augšupielādeGET /v1/files: augšupielādēto failu saraksta iegūšana
Reāllaiks
wss://api.x.ai/v1/realtime: balss aģents, izmantojot WebSocket
URL iestatīšana SDK
Lietojot OpenAI saderīgu SDK, tev ir jānorāda bāzes URL eksplicīti:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Izmantojot natīvo xAI SDK, URL ir iepriekš konfigurēts, un tev nekas nav jāiestata.
Savienojuma testēšana
Pirms raksti jebkādu kodu, tiešs izsaukums validē visu ķēdi (URL, atslēgu, tīklu):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Atbilde uzskaita modeļus, kas pieejami ar tavu atslēgu. Tas ir arī visdrošākais veids, kā uzzināt precīzos modeļu ID, kas pieejami tavā kontā, nepaļaujoties uz dokumentāciju, kas var mainīties. Ievies šo ieradumu: validē katru jaunu vidi (datoru, CI, serveri) ar šo pašu izsaukumu pirms jebkādas izvietošanas.
Limiti un kvotas
API piemēro ātruma ierobežojumus katrai komandai un katram modelim. Ja tos pārsniedz, saņemsi HTTP 429 kļūdu. xAI konsole rāda tavas pašreizējās kvotas un lietojumu reāllaikā.
Galvenās atziņas
- Bāzes URL ir
https://api.x.ai/v1katram galapunktam - API ir saderīgs ar OpenAI formātu: nomaini URL un atslēgu, un tas ir viss
- Galvenais ģenerēšanas galapunkts ir
POST /v1/responses - Vecais
POST /v1/chat/completionsgalapunkts joprojām ir pieejams saderības nodrošināšanai