Bazinis URL ir pirmasis užklausa
Šiame puslapyje
Valdymo API: atskira valdymo plokštuma
„xAI“ valdymo API skiriasi nuo išvedimo API, kurią naudoji siųsdamas užuominas „Grok“. Ji leidžia administruoti tavo išteklius: kurti ir valdyti API raktus, konfigūruoti atsiskaitymą, stebėti naudojimą ir valdyti tavo komandos prieigą. Visa ši administracija vyksta per specialų URL.
Bazinis URL
Šis atskyrimas nėra tik įgyvendinimo detalė: jis atspindi esminį skirtumą tarp šių dviejų API. Viena sunaudoja žetonus ir paleidžia modelius; kita administruoja, apmokestina ir suteikia leidimus. Laikant jas skirtinguose domenuose ir su skirtingais raktų rinkiniais, užtikrinama, kad pavogtas programos raktas niekada negalėtų sukurti kitų raktų ar nuskaityti tavo atsiskaitymo informacijos.
https://management-api.x.ai
Nesupainiok jo su https://api.x.ai, kuris yra URL išvedimo užklausoms (pokalbių užbaigimai, įterpiniai ir kt.). Visos valdymo užklausos – raktai, atsiskaitymas, analitika – eina per management-api.x.ai.
Valdymo API autentifikavimas
Autentifikavimo mechanizmas yra identiškas – „Bearer“ prieigos raktas antraštėje Authorization, tačiau pats raktas yra kitoks. Tai dažniausia painiava pradedantiesiems, dėl kurios gaunamas visiškai neaiškus 401 klaidos kodas: klaidos pranešime niekas nenurodo, kad tiesiog pateikei teisingą raktą neteisingam API.
curl https://management-api.x.ai/auth/management-keys/validation \
-H "Authorization: Bearer $MANAGEMENT_API_KEY"
Ši patvirtinimo užklausa (GET /auth/management-keys/validation) leidžia patikrinti, ar tavo valdymo raktas yra galiojantis ir aktyvus. Tai paprasčiausias įėjimo taškas tavo konfigūracijai išbandyti.
Valdymo raktas prieš išvedimo raktą
- Valdymo raktas: suteikia prieigą prie
management-api.x.aigalinių punktų (administravimas, atsiskaitymas, analitika) - Išvedimo raktas: suteikia prieigą prie
api.x.aigalinių punktų (pokalbiai, įterpiniai, vaizdai)
Abiejų tipų raktai generuojami „xAI“ konsolėje, tačiau jų apimtys skiriasi. Išvedimo raktas negali pasiekti valdymo galinių punktų, ir atvirkščiai.
Galinių punktų struktūra
Valdymo API galiniai punktai yra logiškai suskirstyti:
/auth/teams/{teamId}/api-keys– API raktų valdymas/auth/api-keys/{apiKeyId}– operacijos su konkrečiu raktu/auth/teams/{teamId}/models– pasiekiami modeliai/auth/teams/{teamId}/endpoints– galimi ACL galiniai punktai/v1/billing/teams/{teamId}/– atsiskaitymas ir analitika
Parametras teamId yra tavo komandos identifikatorius „xAI“ konsolėje, ir jis struktūrizuoja beveik visus galinius punktus. Kiekviena komanda turi savo raktus, kvotas ir atsiskaitymo nustatymus – tai daro ją natūraliu izoliacijos vienetu: dviejų projektų atskyrimas į dvi komandas taip pat atskiria jų biudžetus ir prieigą be jokios papildomos konfigūracijos.
Tavo pirmoji valdymo užklausa
Štai pilnas pavyzdys, kaip patvirtinti tavo konfigūraciją:
# Apibrėžk savo valdymo raktą
export MANAGEMENT_API_KEY="xai-mgmt-..."
# Patvirtink raktą
curl -s https://management-api.x.ai/auth/management-keys/validation \
-H "Authorization: Bearer $MANAGEMENT_API_KEY" | python3 -m json.tool
Jei atsakyme yra tavo komandos ir rakto informacija, tavo konfigūracija veikia. Jei gauni 401 klaidą, patikrink, ar naudoji valdymo raktą (o ne išvedimo raktą).
Svarbiausi punktai
- Valdymo API naudoja
https://management-api.x.ai, kuris skiriasi nuohttps://api.x.ai - Autentifikavimui naudojamas „Bearer“ prieigos raktas antraštėje
Authorization - Valdymo ir išvedimo raktai turi atskiras apimtis
- Galinis punktas
GET /auth/management-keys/validationleidžia išbandyti tavo konfigūraciją - Visi valdymo galiniai punktai yra organizuoti aplink
teamId