xAI API izstrādātājiem
Šajā lapā
Iekļauj Grok savās lietotnēs
Viss, ko esi iemācījies darīt Grok saskarnē, ir izsaucams no tava koda. xAI API pārnes šīs iespējas uz tavām lietotnēm, tīmekļa vietnēm un servisiem: saruna vairs nav vieta, uz kurieni dodies, bet gan funkcija, ko tavs produkts izsauc.
Priekšnosacījumi
Pirms uzraksti pirmo koda rindiņu, tev vajag četras lietas:
- xAI konts, kas izveidots vietnē accounts.x.ai
- API atslēga, ģenerēta vietnē console.x.ai
- Iestatīts maksājuma veids (lai pārsniegtu bezmaksas kvotu)
- Python vai JavaScript izstrādes vide
Pirmās divas lietas šajā kursā jau esi paveicis: konts nodrošina autentifikāciju, bet atslēga identificē tavu lietotni API. Maksājuma veids kļūst aktuāls tikai tad, kad tava lietojuma apjoms pārsniedz bezmaksas kvotu, kas notiek ātrāk, nekā domā, tiklīdz serviss darbojas nepārtraukti. Kas attiecas uz vidi, Python un JavaScript piedāvā labākos rīkus, taču, tā kā API komunicē caur HTTP, der jebkura valoda, kas spēj nosūtīt pieprasījumu.
Sākotnējā iestatīšana
Pirmais solis ir droši saglabāt savu API atslēgu vides mainīgajā:
export XAI_API_KEY="xai-your-key-here"
Nekad neiekodē atslēgu tieši savā pirmkodā. Iemesls ir prozaisks: failā ierakstīta atslēga agrāk vai vēlāk nonāk Git repozitorijā, un atslēga, kas ievietota publiskā repozitorijā, botu, kas skenē izmaiņas, tiek izmantota dažu minūšu laikā, kamēr rēķins paliek tavā vārdā.
Tālāk jāizvēlas SDK. Natīvais xAI SDK priekš Python tiek instalēts ar pip install xai-sdk. Ja tavs kods jau izsauc OpenAI, bibliotēka openai strādā bez izmaiņām, pateicoties formāta saderībai. JavaScript pusē tu pievieno Vercel AI SDK ar npm install ai @ai-sdk/xai, un tas integrējas ar React un Next.js lietotnēm.
Tavs pirmais pieprasījums
Izmantojot natīvo SDK, klienta izveide un sarunas uzsākšana aizņem trīs rindiņas:
from xai_sdk import Client
import os
client = Client(api_key=os.getenv("XAI_API_KEY"))
response = client.chat.create(model="grok-4.5")
Ceļš, kas saderīgs ar OpenAI, ir tikpat tiešs: salīdzinot ar esošo kodu, mainās tikai base_url, tāpēc daudzas komandas pāriet uz to dažu minūšu laikā.
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."
)
Lai pārbaudītu, vai atslēga strādā, pirms vispār raksti jebkādu kodu, nekas nepārspēj izsaukumu no komandrindas:
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?"
}'
Ko API piedāvā
Pamats ir teksta ģenerēšana (sarunu atbildes, rakstīšana, analīze), kā arī spriešanas režīms, kas soli pa solim risina sarežģītas problēmas. Straumēšana (streaming) to papildina, piegādājot atbildi pa tokeniem, nevis liekot gaidīt, kamēr ģenerēšana beigsies.
Otra kopums nodrošina piekļuvi informācijai: reāllaika meklēšana tīmeklī un platformā X, kā arī RAG, kas veic vaicājumus tavos izveidotajos dokumentu krājumos. Multimodālā puse aptver tavu nodrošināto attēlu izpratni, attēlu un video ģenerēšanu ar grok-imagine, kā arī balss funkcijas, ieskaitot sarunas runas režīmā un teksta pārvēršanu runā (TTS).
Visbeidzot, trīs mehānismi padara API programmējamu stingrā nozīmē: funkciju izsaukšana, kas ļauj modelim izsaukt tavas pašrakstītās funkcijas; strukturētas izejas, kas garantē lietojamu JSON bez trauslas pēcapstrādes; un koda izpilde servera pusē.
Izvēlies savu modeli
Spriešanas spējas atšķiras atkarībā no modeļa. grok-4.7, flagmanis, piedāvā konfigurējamu spriešanu: parametrs reasoning_effort (low, medium, high vai xhigh) nosaka, cik dziļi tas domā, katram pieprasījumam atsevišķi. grok-4.3 paliek budžeta variants ar ļoti garu kontekstu, maksājot aptuveni pusi no cenas. Pastāv arī nespriežojošas modeļu versijas vienkāršiem uzdevumiem: pārrakstīšanai vai klasifikācijai nav nepieciešama iekšēja pārdomu procesa iesaiste.
Nosaukumu konvencijas ietekmē tavas lietotnes stabilitāti:
grok-4.20: jaunākā ieteicamā stabilā versijagrok-4.20-latest: visjaunākā versija (var mainīties)grok-4.20-0309: versija, piesaistīta konkrētam datumam (9. marts)
Produkcijas vidē piesaistīta versija pasargā tavus promptus no nemanāmām modeļa izmaiņām; latest ir piemērots izpētei, kamēr esi gatavs pieņemt, ka uzvedība var mainīties.
Ātruma ierobežojumi un labākā prakse
API piemēro ātruma ierobežojumus, lai uzturētu servisa stabilitāti: ieejas līmenī tas ir aptuveni 10 miljoni tokeni minūtē un 1800 pieprasījumi minūtē tādiem modeļiem kā grok-4.3, un vairāk, pieaugot tavam līmenim. Attēlu un video ģenerēšanas modeļiem ir savi, daudz zemāki griesti – no 30 līdz 300 pieprasījumiem minūtē atkarībā no modeļa, tāpēc uz tiem jāraugās uzmanīgi, ja veido servisu, kas paredzēts gala lietotājiem.
Daži ieradumi atšķir prototipu no stabilas integrācijas. Ieslēdz straumēšanu garām atbildēm, jo trīsdesmit sekundes, skatoties tukšā ekrānā, šķiet kā pārtraukums. Nodod sarunas ID, lai izmantotu kešatmiņu. Novirzi katru uzdevumu atbilstošajam modelim: grok-4.3 vienkāršam apjomam, grok-4.20 spriešanai. Apstrādā kļūdas ar atkārtotiem mēģinājumiem un eksponenciālu paužu palielināšanu (exponential backoff), pretējā gadījumā satiksmes pīķis pārvērtīsies noraidīto pieprasījumu lavīnā. Un seidi līdzi savam lietojumam konsolē, lai mēneša beigās neatklātu kopējo summu ar šoku.
Galvenās atziņas
- xAI API ir saderīgs ar OpenAI formātu, kas atvieglo migrāciju
- Pieejami vairāki SDK: natīvais xAI, OpenAI un Vercel AI SDK
- API aptver tekstu, attēlus, video, balsi un meklēšanu
- Divi modeļu līmeņi: grok-4.7 (flagmanis, konfigurējama spriešana) un grok-4.3 (budžeta variants, 1M konteksts)
- Vienmēr glabā savu API atslēgu vides mainīgajā, nekad neiekodē to tieši kodā