Baas-URL ja esimene päring
Sellel lehel
Haldus-API: eraldatud juhtimiskiht
xAI haldus-API erineb sellest järeldus-API-st (inference API), mida kasutad Grokile vihjete saatmiseks. See võimaldab sul hallata oma ressursse: luua ja hallata API-võtmeid, seadistada arveldust, jälgida kasutust ning kontrollida oma meeskonna juurdepääsu. Kogu see haldus toimub spetsiaalse URL-i kaudu.
Baas-URL
See eraldatus ei ole pelgalt tehniline detail: see peegeldab kahe API põhjalikku erinevust. Üks tarbib tokeneid ja käivitab mudeleid; teine haldab, arveldab ja annab lubasid. Nende hoidmine erinevatel domeenidel ja erinevate võtmekomplektidega tagab, et varastatud rakenduse võti ei saa kunagi luua uusi võtmeid ega lugeda sinu arveldusteavet.
https://management-api.x.ai
Ära aja seda segamini aadressiga https://api.x.ai, mis on mõeldud järelduspäringute jaoks (vestluse lõpuleviimine, manused jne). Kõik halduspäringud – võtmed, arveldamine, analüütika – läbivad domeeni management-api.x.ai.
Haldus-API autentimine
Autentimismehhanism on identne – päises Authorization saadetakse Bearer-token – kuid võti ise on teine. See on algajate seas kõige levinum segaduseallikas, mis toodab tulemuseks täiesti arusaamatu vea 401: veateates ei ole mingit märki sellest, et esitasid lihtsalt õige võtme valele API-le.
curl https://management-api.x.ai/auth/management-keys/validation \
-H "Authorization: Bearer $MANAGEMENT_API_KEY"
See valideerimispäring (GET /auth/management-keys/validation) võimaldab kontrollida, kas sinu haldusvõti on kehtiv ja aktiivne. See on lihtsaim lähtepunkt oma seadistuse testimiseks.
Haldusvõti vs järeldusvõti
- Haldusvõti: annab juurdepääsu
management-api.x.aiotspunktidele (haldus, arveldamine, analüütika) - Järeldusvõti: annab juurdepääsu
api.x.aiotspunktidele (vestlus, manused, pildid)
Mõlemat tüüpi võtmeid genereeritakse xAI konsoolist, kuid nende ulatus (scope) erineb. Järeldusvõti ei pääse ligi haldusotspunktidele ja vastupidi.
Otspunktide struktuur
Haldus-API otspunktid järgivad loogilist ülesehitust:
/auth/teams/{teamId}/api-keys— API-võtmete haldus/auth/api-keys/{apiKeyId}— toimingud konkreetse võtmega/auth/teams/{teamId}/models— ligipääsetavad mudelid/auth/teams/{teamId}/endpoints— saadaolevad ACL-otspunktid/v1/billing/teams/{teamId}/— arveldamine ja analüütika
Parameeter teamId on sinu meeskonna identifikaator xAI konsoolis ja see struktureerib peaaegu kõiki otspunkte. Igal meeskonnal on oma võtmed, kvoodid ja arveldusseaded – see teeb sellest loomuliku isoleerimisüksuse: kahe projekti eraldamine kaheks meeskonnaks eraldab automaatselt ka nende eelarved ja juurdepääsu ilma igasuguse lisaseadistusteta.
Sinu esimene halduspäring
Siin on täielik näide oma seadistuse valideerimiseks:
# Määra oma haldusvõti
export MANAGEMENT_API_KEY="xai-mgmt-..."
# Valideeri võti
curl -s https://management-api.x.ai/auth/management-keys/validation \
-H "Authorization: Bearer $MANAGEMENT_API_KEY" | python3 -m json.tool
Kui vastus sisaldab sinu meeskonna ja võtme teavet, töötab sinu seadistus korrektselt. Kui saad vea 401, veendu, et kasutad haldusvõtit (mitte järeldusvõtit).
Peamised punktid
- Haldus-API kasutab aadressi
https://management-api.x.ai, mis erineb aadressisthttps://api.x.ai - Autentimine kasutab Bearer-tokenit päises
Authorization - Haldusvõtmetel ja järeldusvõtmetel on eraldatud ulatused
- Otspunkt
GET /auth/management-keys/validationvõimaldab testida sinu seadistust - Kõik haldusotspunktid on organiseeritud ümber parameetri
teamId