Pagrindinis API URL
Šiame puslapyje
Grok API įvesties taškas
Kiekvienas užklausas xAI API gauna per vieną pagrindinį URL. Prieš rašydami pirmąją kodo eilutę, privalote suprasti šį URL ir turimus galinius taškus (endpoints).
Pagrindinis URL
Grok API yra šiuo adresu:
https://api.x.ai/v1
Šis URL yra šaknis visiems galiniams taškams. Pavyzdžiui, norint sukurti atsakymą, pilnas URL yra https://api.x.ai/v1/responses.
Kodėl /v1?
Priešdėlis /v1 nurodo API versiją. Versijų valdymas leidžia xAI tobulinti API nepažeidžiant esamų programų. Jei atsiras 2 versija, pereinamuoju laikotarpiu ji gyvuos kartu su v1.
Suderinamumas su „OpenAI“ ekosistema
Pagrindinė xAI API savybė – suderinamumas su „OpenAI“ formatu. Praktiškai, jei jau turite kodą, veikiantį su „OpenAI“ API, tereikia pakeisti du nustatymus, kad naudotumėte Grok:
- Pagrindinį URL: pakeiskite
https://api.openai.com/v1įhttps://api.x.ai/v1 - API raktą: pakeiskite savo „OpenAI“ raktą į savo xAI raktą
Šis suderinamumas apima daugelį „OpenAI“ ekosistemos įrankių ir bibliotekų: LangChain, LlamaIndex, LiteLLM ir daugelis kitų veikia su Grok be jokių kodo pakeitimų.
Pagrindiniai galiniai taškai
API pateikia kelis galinius taškus, sugrupuotus pagal funkcijas.
Teksto generavimas
POST /v1/responses: pagrindinis galinis taškas atsakymams generuoti (šiuolaikinis formatas)POST /v1/chat/completions: su „OpenAI“ suderinamas galinis taškas (senesnis formatas, vis dar palaikomas)
Medijos generavimas
POST /v1/images/generations: vaizdų generavimasPOST /v1/images/edits: esamų vaizdų redagavimasPOST /v1/videos/generations: vaizdo įrašų generavimasPOST /v1/tts: kalbos sintezė (tekstas į kalbą)
Failų valdymas
POST /v1/files: failo įkėlimasGET /v1/files: įkeltų failų sąrašo gavimas
Realiuoju laiku
wss://api.x.ai/v1/realtime: balso agentas per WebSocket
URL nustatymas SDK
Naudojant su „OpenAI“ suderinamą SDK, pagrindinį URL reikia nurodyti aiškiai:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
Naudojant vietinį xAI SDK, URL jau sukonfigūruotas iš anksto, todėl nieko nustatyti nereikia.
Ryšio testavimas
Prieš rašydami kodą, tiesioginis kvietimas patikrina visą grandinę (URL, raktą, tinklą):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Atsakyme pateikiami modeliai, доступные su jūsų raktu. Tai taip pat patikimiausias būdas sužinoti tikslius jūsų paskyroje esančius modelio ID, nesiremiant dokumentacija, kuri gali keistis. Įpraskite: prieš bet kokį diegimą patikrinkite kiekvieną naują aplinką (kompiuterį, CI, serverį) šiuo pačiu kvietimu.
Ribos ir kvotos
API taiko užklausų dažnio ribas kiekvienai komandai ir kiekvienam modeliui. Jas viršijus, gausite HTTP 429 klaidą. xAI konsolėje realiuoju laiku matomos jūsų dabartinės kvotos ir naudojimas.
Svarbiausi punktai
- Pagrindinis URL visiems galiniams taškams yra
https://api.x.ai/v1 - API suderinamas su „OpenAI“ formatu: tereikia pakeisti URL ir raktą
- Pagrindinis generavimo galinis taškas yra
POST /v1/responses - Senesnis
POST /v1/chat/completionsgalinis taškas vis dar prieinamas suderinamumui užtikrinti