API baas-URL
Sellel lehel
Grok API sisenemispunkt
Iga xAI API päring läbib ühte kindlat baas-URL-i. Enne esimese koodirea kirjutamist on hädavajalik mõista selle URL-i ülesehitust ja saadaolevaid lõpp-punkte.
Baas-URL
Grok API asub järgmisel aadressil:
https://api.x.ai/v1
See URL on kõigi lõpp-punktide juur. Näiteks vastuse loomiseks on täielik URL https://api.x.ai/v1/responses.
Miks /v1?
Eesliide /v1 tähistab API versiooni. Versioonihaldus võimaldab xAI-l API-d arendada, katkestamata olemasolevate rakenduste tööd. Kui tulevikus ilmub versioon 2, eksisteerib see üleminekuperioodil kõrvuti versiooniga v1.
Ühilduvus OpenAI ökosüsteemiga
xAI API põhiline omadus on selle ühilduvus OpenAI vorminguga. Praktikas tähendab see, et kui sul on juba olemas OpenAI API-ga töötav kood, pead Groki kasutamiseks muutma vaid kahte seadet:
- Baas-URL: asenda
https://api.openai.com/v1aadressigahttps://api.x.ai/v1 - API võti: asenda oma OpenAI võti xAI võtmega
See ühilduvus hõlmab enamikku OpenAI ökosüsteemi tööriistu ja teeke: LangChain, LlamaIndex, LiteLLM ja paljud teised töötavad Grokiga ilma koodi muutmata.
Peamised lõpp-punktid
API pakub mitmeid funktsioonide kaupa rühmitatud lõpp-punkte.
Teksti genereerimine
POST /v1/responses: peamine lõpp-punkt vastuste genereerimiseks (moodne vorming)POST /v1/chat/completions: OpenAI-ga ühilduv lõpp-punkt (vananenud vorming, endiselt toetatud)
Meedia genereerimine
POST /v1/images/generations: piltide genereeriminePOST /v1/images/edits: olemasolevate piltide muutminePOST /v1/videos/generations: videote genereeriminePOST /v1/tts: kõnesüntees (tekst-kõneks)
Failihaldus
POST /v1/files: faili üleslaadimineGET /v1/files: üleslaaditud failide loetlemine
Reaalaeg
wss://api.x.ai/v1/realtime: häälagent üle WebSocketi
URL-i määramine SDK-des
Kui kasutad OpenAI-ga ühilduvat SDK-d, pead baas-URL-i sõnaselgelt määrama:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Kasutades xAI enda SDK-d, on URL eelseadistatud ja sul pole vaja midagi lisaks määrata.
Ühenduse testimine
Enne koodi kirjutamist valideerib otsene kutse kogu ahela (URL, võti, võrk):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Vastus loetleb mudelid, mis on sinu võtmega saadaval. See on ka kõige usaldusväärsem viis teada saada oma kontole ligipääsetavate täpsete mudeli-ID-de kohta, sõltumata dokumentatsioonist, mis võib muutuda. Võta see harjumuseks: valideeri iga uus keskkond (masin, CI, server) selle sama kutsega enne mis tahes kasutuselevõttu.
Piirangud ja kvoodid
API rakendab kiirusepiiranguid iga meeskonna ja iga mudeli kohta. Kui need ületad, saad vea HTTP 429. xAI konsoolis näed oma praeguseid kvootide ja kasutust reaalajas.
Peamised punktid
- Iga lõpp-punkti baas-URL on
https://api.x.ai/v1 - API on ühilduv OpenAI vorminguga: muuda URL ja võti ning see ongi kõik
- Peamine genereerimise lõpp-punkt on
POST /v1/responses - Vananenud lõpp-punkt
POST /v1/chat/completionson ühilduvuse huvides endiselt saadaval