L-URL bażika tal-API
F'din il-paġna
Il-punt tad-dħul tal-API ta’ Grok
Kull talba lill-API ta’ xAI tgħaddi minn URL bażika waħda. Huwa essenzjali li tifhem dik l-URL u l-endpoints disponibbli qabel ma tikteb l-ewwel linja ta’ kodiċi tiegħek.
L-URL bażika
L-API ta’ Grok tinsab f’dan l-indirizz:
https://api.x.ai/v1
Din l-URL hija l-għerq għal kull endpoint. Pereżempju, biex toħloq tweġiba, l-URL sħiħa hija https://api.x.ai/v1/responses.
Għaliex /v1?
Il-prefiss /v1 jindika l-verżjoni tal-API. Il-verżjonament jippermetti lil xAI tiżviluppa l-API mingħajr ma tkisser applikazzjonijiet eżistenti. Jekk toħroġ verżjoni 2, din se tkun ko-eżistenti mal-v1 matul perjodu ta’ tranżizzjoni.
Kompatibbiltà mal-ekosistema ta’ OpenAI
Karatteristika fundamentali tal-API ta’ xAI hija l-kompatibbiltà mal-format ta’ OpenAI. Fil-prattika, jekk diġà għandek kodiċi li jaħdem mal-API ta’ OpenAI, trid biss tbiddel żewġ settinġs biex tuża Grok:
- L-URL bażika: ibdel
https://api.openai.com/v1b’https://api.x.ai/v1 - Iċ-ċavetta tal-API: ibdel iċ-ċavetta ta’ OpenAI tiegħek b’ta’ xAI
Dik il-kompatibbiltà testendi għall-biċċa l-kbira tal-għodod u l-libreriji fl-ekosistema ta’ OpenAI: LangChain, LlamaIndex, LiteLLM, u ħafna oħrajn jaħdmu ma’ Grok mingħajr bidliet fil-kodiċi.
L-endpoints ewlenin
L-API tesponi diversi endpoints raggruppati skont il-funzjoni.
Ġenerazzjoni tat-test
POST /v1/responses: l-endpoint prinċipali għall-ġenerazzjoni ta’ tweġibiet (format modern)POST /v1/chat/completions: l-endpoint kompatibbli ma’ OpenAI (format antik, għadu appoġġjat)
Ġenerazzjoni tal-midja
POST /v1/images/generations: iġġenera stampiPOST /v1/images/edits: editja stampi eżistentiPOST /v1/videos/generations: iġġenera vidjowsPOST /v1/tts: sintesi tad-diskors (test-għal-kliem)
Ġestjoni tal-fajls
POST /v1/files: ittella’ fajlGET /v1/files: elenka fajls imtellgħin
Ħin reali
wss://api.x.ai/v1/realtime: aġent vokali fuq WebSocket
Issettja l-URL fl-SDKs tiegħek
Meta tuża SDK kompatibbli ma’ OpenAI, trid tispeċifika l-URL bażika b’mod espliċitu:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Bl-SDK nattiva ta’ xAI, l-URL hija prekonfigurata u m’għandekx bżonn tissettja xejn.
Ittestja l-konnettività
Qabel ma tikteb kwalunkwe kodiċi, sejħa diretta tivvalida l-katina kollha (URL, ċavetta, netwerk):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
It-tweġiba telenka l-mudelli disponibbli maċ-ċavetta tiegħek. Hija wkoll l-aktar mod affidabbli biex titgħallem l-ID eżatti tal-mudelli disponibbli fuq il-kont tiegħek, mingħajr ma tiddependi fuq dokumentazzjoni li tista’ tinbidel. Żomm din id-drawwa: ivvalida kull ambjent ġdid (magna, CI, server) b’din l-istess sejħa qabel kwalunkwe dispjegament.
Limiti u kwoti
L-API timponi limiti ta’ rata għal kull tim u kull mudell. Jekk taqbeżhom, tirċievi żball HTTP 429. Il-konsowl ta’ xAI juri l-kwoti attwali tiegħek u l-użu tiegħek f’ħin reali.
Punti Ewlenin
- L-URL bażika hija
https://api.x.ai/v1għal kull endpoint - L-API hija kompatibbli mal-format ta’ OpenAI: ibdel l-URL u ċ-ċavetta, u hemmhekk
- L-endpoint prinċipali tal-ġenerazzjoni huwa
POST /v1/responses - L-endpoint antik
POST /v1/chat/completionsjibqa’ disponibbli għall-kompatibbiltà