API-võtme genereerimine
Sellel lehel
Programmeeriline juurdepääs Grokile
API-võti on autentimistoken, mis võimaldab sinu rakendustel suhelda Groki mudelitega. Ilma selleta ükski päring ei läbi. See õppetund viib sind läbi võtmete loomise ja haldamise xAI konsoolis.
Ava konsool
Mine aadressile console.x.ai ja logi sisse kontoga, mille lõid eelmises etapis. Konsool on sinu keskne armatuurlaud võtmete haldamiseks, kasutuse jälgimiseks ja arvelduse seadistamiseks.
Ava külgmenüüst API Keys (täielik tee: console.x.ai/team/default/api-keys).
Loo oma esimene võti
Klõpsa nuppu Create API Key. Saad anda igale võtmele kirjeldava nime, et tuvastada, milleks see mõeldud on:
dev-localarenduskeskkonna jaoksprod-backendtootmisserveri jaokstest-cipideva integreerimise (CI) torustiku jaoks
Võti kuvatakse ainult üks kord selle loomise hetkel. Kopeeri see koheselt ja salvesta turvalisse kohta (paroolihaldurisse või saladuste hoidlasse). Kui võtme kaotad, pead genereerima uue.
Võtme formaat
xAI API-võtmed algavad eesliitega xai-, millele järgneb tähtnumbriline string. See eesliide aitab sul neid konfiguratsioonifailides kiiresti ära tunda ja avastada, kui need kogemata lähtekoodi lekivad.
Haldamise parimad tavad
Üks võti keskkonna kohta
Loo iga konteksti jaoks eraldi võtmed. Kui võti lekib, saad selle tühistada, mõjutamata teisi keskkondi.
Regulaarne rotatsioon
Uuenda oma võtmeid perioodiliselt, eriti tootmiskeskkondades. Protseduur on lihtne: loo uus võti, uuenda oma rakendust ja seejärel kustuta vana.
Kontrolli enne jagamist
Enne projekti jagamist veendu, et ükski võti ei ole lähtekoodi sisse kodeeritud. Kasuta .env faile, mida hoitakse versioonikontrollist väljas (lisa .env faili .gitignore).
Arveldus seotud võtmetega
Iga võtmega tehtud API-kutsed loetakse ja neid arveldatakse. xAI pakub kahte režiimi:
- Ettemakstud krediit: ostad krediiti ette ja kutsed lahutatakse koheselt
- Kuuarveldus: kasutus üle krediidi arveldatakse kuu lõpus
Kontrolli oma arveldusteavet konsoolis enne API kasutamise alustamist, kuna arveid ei saa tagasiulatuvalt muuta.
Testi võtit kohe
Võta kolmkümmend sekundit, et võti valideerida, enne kui selle projekti sügavusse peidad. Lihtsaim test küsib mudelite loendit:
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Mudelite loendit tagastav JSON-vastus kinnitab, et võti on aktiivne ja arveldus korras. Viga 401 tähendab, et võti kopeeriti valesti; viga 403 viitab õiguste või krediidi probleemile. Selle diagnoosimine siin, allikal, säästab sind hilisemast silumisest oma rakenduse koodi sees.
Peamised punktid
- Lood võtmeid aadressil console.x.ai/team/default/api-keys
- Need algavad eesliitega
xai-ja kuvatakse ainult üks kord - Loo iga keskkonna jaoks eraldi võti ja salvesta need saladuste hoidlasse
- Kontrolli oma arveldusrežiimi enne mis tahes API-kutset
- Valideeri iga uus võti kutsega aadressile
/v1/modelsenne selle integreerimist