Bāzes URL un pirmais pieprasījums
Šajā lapā
Pārvaldības API: atsevišķa vadības plakne
xAI pārvaldības API atšķiras no secinājumu API, ko izmanto, lai nosūtītu uzvednes Grok. Tā ļauj pārvaldīt tavus resursus: izveidot un pārvaldīt API atslēgas, konfigurēt rēķinu izrakstīšanu, uzraudzīt lietojumu un kontrolēt tavas komandas piekļuvi. Visa šī administrēšana notiek, izmantojot īpašu URL.
Bāzes URL
Šī nodalīšana nav tikai ieviešanas detaļa: tā atspoguļo fundamentālu atšķirību starp abām API. Viena patērē tokenus un darbina modeļus; otra administrē, veic rēķinu izrakstīšanu un piešķir atļaujas. To uzturēšana divos dažādos domēnos un ar divām atslēgu kopām garantē, ka nozagta lietotnes atslēga nekad nevarēs izveidot citas atslēgas vai nolasīt tavu rēķinu informāciju.
https://management-api.x.ai
Nejauc to ar https://api.x.ai, kas ir URL secinājumu izsaukumiem (sarunu pabeigšana, iegulšanas utt.). Visi pārvaldības pieprasījumi — atslēgas, rēķini, analītika — tiek veikti caur management-api.x.ai.
Pārvaldības API autentifikācija
Autentifikācijas mehānisms ir identisks — Bearer tokens galvenē Authorization, taču pati atslēga nav tāda pati. Šī ir visbiežāk sastopamā neskaidrība, sākot darbu, un tā rada pilnīgi neskaidru 401 kļūdu: kļūdas ziņojumā nekas neliecina, ka vienkārši esi iesniedzis pareizo atslēgu nepareizajai API.
curl https://management-api.x.ai/auth/management-keys/validation \
-H "Authorization: Bearer $MANAGEMENT_API_KEY"
Šis validācijas pieprasījums (GET /auth/management-keys/validation) ļauj pārbaudīt, vai tava pārvaldības atslēga ir derīga un aktīva. Tas ir vienkāršākais ieejas punkts, lai pārbaudītu savu konfigurāciju.
Pārvaldības atslēga pret secinājumu atslēgu
- Pārvaldības atslēga: nodrošina piekļuvi
management-api.x.aibeigu punktiem (administrēšana, rēķini, analītika) - Secinājumu atslēga: nodrošina piekļuvi
api.x.aibeigu punktiem (sarunas, iegulšanas, attēli)
Abi atslēgu veidi tiek ģenerēti xAI konsolē, taču to darbības jomas atšķiras. Secinājumu atslēga nevar piekļūt pārvaldības beigu punktiem un otrādi.
Beigu punktu struktūra
Pārvaldības API beigu punkti ievēro loģisku organizāciju:
/auth/teams/{teamId}/api-keys— API atslēgu pārvaldība/auth/api-keys/{apiKeyId}— operācijas ar konkrētu atslēgu/auth/teams/{teamId}/models— pieejamie modeļi/auth/teams/{teamId}/endpoints— pieejamie ACL beigu punkti/v1/billing/teams/{teamId}/— rēķinu izrakstīšana un analītika
Parametrs teamId ir tavas komandas identifikators xAI konsolē, un tas strukturē gandrīz visus beigu punktus. Katrai komandai ir savas atslēgas, kvotas un rēķinu iestatījumi, padarot to par dabisko izolācijas vienību: divu projektu nodalīšana divās komandās atdala arī to budžetus un piekļuvi bez jebkādas papildu konfigurācijas.
Tavs pirmais pārvaldības pieprasījums
Lūk, pilns piemērs, lai validētu savu konfigurāciju:
# Definē savu pārvaldības atslēgu
export MANAGEMENT_API_KEY="xai-mgmt-..."
# Validē atslēgu
curl -s https://management-api.x.ai/auth/management-keys/validation \
-H "Authorization: Bearer $MANAGEMENT_API_KEY" | python3 -m json.tool
Ja atbilde satur informāciju par tavu komandu un atslēgu, tava konfigurācija darbojas. Ja saņem 401 kļūdu, pārbaudi, vai izmanto pārvaldības atslēgu (nevis secinājumu atslēgu).
Galvenās atziņas
- Pārvaldības API izmanto
https://management-api.x.ai, kas atšķiras nohttps://api.x.ai - Autentifikācija izmanto Bearer token galvenē
Authorization - Pārvaldības atslēgām un secinājumu atslēgām ir atsevišķas darbības jomas
- Beigu punkts
GET /auth/management-keys/validationļauj pārbaudīt tavu konfigurāciju - Visi pārvaldības beigu punkti ir organizēti ap
teamId