xAI API kehittäjille
Tällä sivulla
Grokin integrointi sovelluksiisi
Kaikki, mitä olet oppinut tekemään Grokin käyttöliittymässä, voidaan käynnistää omasta koodistasi. xAI API tuo nämä ominaisuudet sovelluksiisi, verkkosivustoillesi ja palveluihisi: keskustelu ei ole enää paikka, johon menet, vaan funktio, jonka tuotteesi kutsuu.
Edellytykset
Ennen ensimmäisen koodirivin kirjoittamista tarvitset neljä asiaa:
- xAI-tilin, joka on luotu osoitteessa accounts.x.ai
- API-avaimen, joka on generoitu osoitteessa console.x.ai
- Maksumenetelmän asetettuna (ilmaisen kiintiön ylittämiseksi)
- Python- tai JavaScript-kehitysympäristön
Kaksi ensimmäistä olet jo tehnyt tällä kurssilla: tili hoitaa todennuksen, ja avain tunnistaa sovelluksesi API:lle. Maksumenetelmä tulee kuvaan mukaan vasta, kun käyttösi ylittää ilmaisen kiintiön, mikä tapahtuu nopeammin kuin arvaatkaan, jos palvelu pyörii jatkuvasti. Mitä tulee ympäristöön, Pythonilla ja JavaScriptillä on parhaat työkalut, mutta koska API puhuu HTTP:ta, mikä tahansa kieli, joka pystyy lähettämään pyynnön, käy.
Alustava asennus
Ensimmäinen vaihe on tallentaa API-avaimesi turvallisesti ympäristömuuttujaan:
export XAI_API_KEY="xai-your-key-here"
Älä koskaan kovakoodaa avainta lähdekoodiisi. Syy on banalinen: tiedostoon kirjoitettu avain päätyy ennemmin tai myöhemmin Git-varastoon, ja julkiseen varastoon työnnetty avain hyödynnetään minuuteissa bottien toimesta, jotka skannaavat committeja, kun taas lasku jää sinun nimiisi.
Seuraavaksi valitaan SDK. Natiivi xAI SDK Pythonille asennetaan komennolla pip install xai-sdk. Jos koodisi kutsuu jo OpenAI:ta, openai-kirjasto toimii sellaisenaan yhteensopivan formaatin ansiosta. JavaScript-puolella lisäät Vercel AI SDK:n komennolla npm install ai @ai-sdk/xai, ja se integroituu React- ja Next.js-sovelluksiin.
Ensimmäinen pyyntösi
Natiivia SDK:ta käyttäen asiakkaan luominen ja keskustelun avaaminen vie kolme riviä:
from xai_sdk import Client
import os
client = Client(api_key=os.getenv("XAI_API_KEY"))
response = client.chat.create(model="grok-4.5")
OpenAI-yhteensopiva reitti on yhtä suora: vain base_url muuttuu verrattuna olemassa olevaan koodiin, minkä vuoksi monet tiimit vaihtavat siihen muutamassa minuutissa.
from openai import OpenAI
import os
client = OpenAI(
api_key=os.getenv("XAI_API_KEY"),
base_url="https://api.x.ai/v1"
)
response = client.responses.create(
model="grok-4.5",
input="Explain machine learning to me in 3 sentences."
)
Tarkistaaksesi, toimiiko avain ennen kuin kirjoitat yhtäkään koodiriviä, mikään ei voita komentorivikutsua:
curl https://api.x.ai/v1/responses \
-H "Authorization: Bearer $XAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "grok-4.5",
"input": "Hi, how are you?"
}'
Mitä API tarjoaa
Perusta on tekstin generointi (keskustelevat vastaukset, kirjoittaminen, analyysi), sekä päättelytila, joka ratkoo monimutkaisia ongelmia askel askeleelta. Streamaus lisää tähän mahdollisuuden toimittaa vastaus token kerrallaan odottamatta generoinnin valmistumista.
Toinen kokonaisuus tarjoaa pääsyn tietoon: reaaliaikainen web- ja X-haku sekä RAG, joka hakee rakentamistasi dokumenttikokoelmista. Multimodaalinen puoli kattaa tarjoamiesi kuvien ymmärtämisen, kuvien ja videoiden generoinnin grok-imaginella sekä äänen, mukaan lukien puhutut keskustelut ja TTS (tekstistä puheeksi).
Lopuksi kolme mekanismia tekevät API:sta ohjelmoitavan tiukassa mielessä: funktion kutsuminen, jonka avulla malli voi kutsua omia funktioitasi; strukturoidut tulosteet, jotka takaavat käyttökelpoisen JSONin ilman haurasta jälkikäsittelyä; ja palvelinpuolen koodin suoritus.
Valitse mallisi
Päättelykyky vaihtelee mallin mukaan. grok-4.7, lippulaiva, tarjoaa konfiguroitavan päättelyn: parametri reasoning_effort (low, medium, high tai xhigh) määrittää, kuinka syvällisesti se ajattelee, pyyntö kerrallaan. grok-4.3 pysyy edullisena, erittäin pitkän kontekstin vaihtoehtona noin puoleen hintaan. Malleista on olemassa ei-päättelyversioita yksinkertaisia tehtäviä varten: uudelleenmuotoilu tai luokittelu eivät vaadi sisäistä pohdintaa.
Nimeämiskäytännöt vaikuttavat sovelluksesi vakauteen:
grok-4.20: uusin suositeltu vakaa versiogrok-4.20-latest: uusin versio (voi muuttua)grok-4.20-0309: tiettyyn päivämäärään lukittu versio (9. maaliskuuta)
Tuotannossa lukittu versio suojaa prompttejasi mallin hiljaisilta muutoksilta; latest sopii tutkimukseen, kunhan hyväksyt, että käyttäytyminen voi muuttua.
Nopeusrajoitukset ja parhaat käytännöt
API valvoo nopeusrajoituksia palvelun vakauden varmistamiseksi: aloitustasolla noin 10 miljoonaa tokenia minuutissa ja 1 800 pyyntöä minuutissa malleille kuten grok-4.3, ja enemmän tason noustessa. Kuvien ja videoiden generointimalleilla on omat, paljon alhaisemmat rajansa, 30–300 pyyntöä minuutissa mallista riippuen, joten pidä ne silmällä kuluttajille suunnatussa palvelussa.
Muutama tapa erottaa prototyypin vakaasta integraatiosta. Ota streamaus käyttöön pitkissä vastauksissa, sillä kolmekymmentä sekuntia tyhjää näyttöä tuntuu katkokselta. Välitä keskustelutunniste hyötyäksesi välimuistista. Reititä jokainen tehtävä oikealle mallille: grok-4.3 yksinkertaiseen volyymiin, grok-4.20 päättelyyn. Käsittele virheet uudelleenyrityksillä ja eksponentiaalisella viiveellä, tai liikennehuippu muuttuu hylättyjen pyyntöjen vyöryksi. Ja tarkkaile käyttöäsi konsolissa ennen kuin löydät kokonaissumman kuukauden lopussa.
Keskeiset asiat
- xAI API on yhteensopiva OpenAI-formaatin kanssa, mikä tekee migraatiosta helppoa
- Useita SDK:ita on saatavilla: natiivi xAI, OpenAI ja Vercel AI SDK
- API kattaa tekstin, kuvat, videot, äänen ja haun
- Kaksi mallitasoa: grok-4.7 (lippulaiva, konfiguroitava päättely) ja grok-4.3 (edullinen, 1M konteksti)
- Tallenna API-avaimesi aina ympäristömuuttujaan, älä koskaan kovakoodattuna