API-avaimen luominen
Tällä sivulla
Ohjelmointikäyttöoikeus Grokiin
API-avain on tunnistetunnus, jonka avulla sovelluksesi voivat kommunikoida Grok-mallien kanssa. Ilman sitä mikään pyyntö ei mene läpi. Tässä osiossa käydään läpi avainten luominen ja hallinta xAI-konsolissa.
Avaa konsoli
Siirry osoitteeseen console.x.ai ja kirjaudu sisään edellisessä vaiheessa luomallasi tilillä. Konsoli on keskeinen kojelautasi avainten hallintaan, käytön seurantaan ja laskutuksen asetukseen.
Avaa sivuvalikosta API Keys (täydellinen polku: console.x.ai/team/default/api-keys).
Luo ensimmäinen avaimesi
Klikkaa Create API Key. Voit antaa jokaiselle avaimelle kuvaavan nimen tunnistaaksesi sen käyttötarkoituksen:
dev-localkehitysympäristöllesiprod-backendtuotantopalvelimellesitest-cijatkuvan integraation putkelle
Avain näytetään vain kerran luomishetkellä. Kopioi se välittömästi ja tallenna se turvalliseen paikkaan (esimerkiksi salasananhallintaan tai salaisuuksien säilöön). Jos hukkaat avaimen, sinun on luotava uusi.
Avaimen muoto
xAI:n API-avaimet alkavat etuliitteellä xai-, jota seuraa aakkosnumeerinen merkkijono. Etuliite auttaa tunnistamaan avaimet nopeasti konfiguraatiotiedostoistasi ja havaitsemaan ne, jos ne vahingossa paljastuvat lähdekoodissa.
Hallinnan parhaat käytännöt
Yksi avain per ympäristö
Luo erilliset avaimet jokaiselle kontekstille. Jos avain vuotaa, voit kumota sen vaikuttamatta muihin ympäristöihisi.
Säännöllinen kierrätys
Uusi avaimesi määräajoin, erityisesti tuotantoympäristöissä. Menettely on yksinkertainen: luo uusi avain, päivitä sovelluksesi ja poista sitten vanha.
Tarkista ennen jakamista
Ennen projektin jakamista varmista, että lähdekoodissa ei ole kovakoodattuja avaimia. Käytä .env-tiedostoja, jotka pidetään versionhallinnan ulkopuolella (lisää .env tiedostoon .gitignore).
Avaimiin sidottu laskutus
Jokainen avaimella tehty API-kutsu lasketaan ja laskutetaan. xAI tarjoaa kahta tilaa:
- Ennakkomaksu: ostat luottoja etukäteen, ja kutsut vähennetään välittömästi
- Kuukausilaskutus: luottojen ylittävä käyttö laskutetaan kuukauden lopussa
Tarkista laskutustietosi konsolista ennen API:n käyttöönottoa, sillä laskuja ei voi muuttaa jälkikäteen.
Testaa avain heti
Käytä kolmekymmentä sekuntia avaimen validointiin ennen kuin upotat sen projektiin. Yksinkertaisin testi pyytää malliluetteloa:
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Mallit listaava JSON-vastaus vahvistaa, että avain on aktiivinen ja laskutus kunnossa. 401-virhe tarkoittaa, että avain on kopioitu väärin; 403-virhe viittaa oikeus- tai luotto-ongelmaan. Ongelman diagnosointi tässä vaiheessa, lähteellä, säästää sinut myöhemmältä vianetsinnältä keskellä sovelluskoodia.
Keskeiset asiat
- Luot avaimet osoitteessa console.x.ai/team/default/api-keys
- Ne alkavat etuliitteellä
xai-ja näytetään vain kerran - Luo yksi avain per ympäristö ja tallenna ne salaisuuksien säilöön
- Tarkista laskutustilasi ennen kuin teet yhtään API-kutsua
- Validoi jokainen uusi avain kutsumalla päätepistettä
/v1/modelsennen integraatiota