xAI API ir suderinamumas su OpenAI
Šiame puslapyje
Pažįstama API
xAI API naudoja tą patį formatą kaip ir OpenAI API. Jei anksčiau dirbai su OpenAI API arba jai suderinamais įrankiais, tau nereikia mokytis nieko naujo. Vienintelis dalykas, kuris keičiasi, – tai bazinis URL adresas.
https://api.x.ai/v1
Šis suderinamumas yra strateginis xAI pasirinkimas. Užuot diegę naują nuosavybinį formatą, jie priėmė faktinį pramonės standartą. Dėl to bet koks įrankis, SDK ar redaktorius, palaikantis OpenAI API, gali iškart naudoti grok-build-0.1.
Minimali konfigūracija
Norėdamas bet kuriame suderinamame kliente pereiti nuo OpenAI prie xAI, turi pakeisti tik du parametrus:
- Bazinis URL: pakeisk
https://api.openai.com/v1įhttps://api.x.ai/v1 - API raktas: naudok savo xAI API raktą (gautą iš
console.x.ai)
Viskas kita – žinučių formatas, temperatūros parametrai, atsako struktūra – yra identiška.
Pavyzdys naudojant OpenAI Python SDK
from openai import OpenAI
client = OpenAI(
api_key="your-xai-key",
base_url="https://api.x.ai/v1"
)
response = client.chat.completions.create(
model="grok-build-0.1",
messages=[
{"role": "system", "content": "You are a programming assistant."},
{"role": "user", "content": "Write a quicksort function in Python."}
]
)
Naudoji standartinį OpenAI SDK be jokių modifikacijų. Keičiasi tik base_url ir modelio pavadinimas.
Pavyzdys naudojant curl
curl https://api.x.ai/v1/chat/completions \
-H "Authorization: Bearer your-xai-key" \
-H "Content-Type: application/json" \
-d '{
"model": "grok-build-0.1",
"messages": [
{"role": "user", "content": "Explain the difference between let and const in JavaScript"}
]
}'
API rakto gavimas
- Eik į console.x.ai
- Prisijunk naudodamas savo xAI paskyrą (arba susikurk ją adresu accounts.x.ai)
- Skiltyje „API Keys“ sugeneruok naują raktą
- Nedelsiant jį nukopijuok – daugiau jis nebus rodomas
Laikyk šį raktą saugiai. Niekada neįkelk jo į „Git“ saugyklą ir nebendrink komandos pokalbiuose. Naudok aplinkos kintamąjį arba paslapčių valdyklę.
Galimi galiniai taškai (endpoints)
grok-build-0.1 palaiko šiuos galinius taškus, visus OpenAI formatu:
/v1/chat/completions: teksto ir kodo generavimas (dažniausiai naudojamas)/v1/chat/completionssustream: true: srautinis perdavimas sureasoning_content/v1/chat/completionssutools: vietinis įrankių kvietimas
Suderinamumo apribojimai
Yra keletas nedidelių skirtumų:
- Galimi modeliai yra xAI (grok-build-0.1, grok-4.5 ir kt.), o ne OpenAI
- Kai kurie specifiniai OpenAI parametrai (pvz.,
logprobs) gali būti nepalaikomi reasoning_contentyra specifinis xAI API ir neegzistuoja OpenAI API
Svarbiausi punktai
- xAI API yra adresu
https://api.x.ai/v1ir yra suderinama su OpenAI formatu - Migracijai tereikia pakeisti bazinį URL ir API raktą
- OpenAI Python SDK veikia taip, kaip yra
- API raktą gauk adresu console.x.ai
- Visi OpenAI suderinami redaktoriai veikia su xAI