Elérhető végpontok
Ezen az oldalon
A Grok API áttekintése
A xAI API nem korlátozódik csupán a szöveggenerálásra. Olyan végpontokat tesz elérhetővé, amelyek lefedik a kép- és videógyártást, a beszédszintézist, a fájlkezelést és az aszinkron feldolgozást. Ez a lecke feltérképezi a rendelkezésre álló végpontokat, hogy tudd, mely funkciókat használd a projektjeidben.
Szöveggenerálás
POST /v1/responses (ajánlott)
Ez a fő végpont minden, a Grok modellekkel való interakcióhoz. Támogatja a szöveget, a látást, az eszközöket (függvényhívás), a webes keresést és az X keresést.
Fő paraméterek: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (OpenAI-kompatibilis)
Ez a végpont OpenAI formátumban működik, és a meglévő eszközökkel való kompatibilitás érdekében tartották fenn. Ugyanazokat a paramétereket fogadja el, mint az OpenAI API: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Lekéri egy korábban generált választ, ha azt eltárolták (store: true paraméter). A válaszokat 30 napig őrzik meg.
DELETE /v1/responses/{id}
Töröl egy tárolt választ, mielőt az automatikusan lejárna 30 nap után.
Aszinkron feldolgozás
POST /v1/chat/completions (késleltetett mód)
Ha hozzáadod a "deferred": true értéket a kéréshez, az API azonnal visszaad egy request_id azonosítót anélkül, hogy megvárná a generálás befejezését. Ez hosszú kérések vagy kötegelt feldolgozás esetén hasznos.
GET /v1/chat/deferred-completion/{request_id}
Lekéri egy aszinkron hívás eredményét:
- HTTP 200: a generálás befejeződött, és a törzs tartalmazza a teljes választ
- HTTP 202: a generálás még folyamatban van, ezért próbáld meg később újra
Képgenerálás
POST /v1/images/generations
Képeket generál szöveges leírás alapján.
POST /v1/images/edits
Meglévő képet szerkeszt szöveges utasítások alapján.
Videógyártás
POST /v1/videos/generations
Elindít egy videó generálását szöveges prompt alapján.
GET /v1/videos/{id}
Ellenőrzi egy generálás alatt álló videó státuszát, és lekéri az eredmény URL-címét, ha elkészült.
POST /v1/videos/edits
Meglévő videót szerkeszt.
POST /v1/videos/extensions
Meglévő videót hosszabbít meg.
Beszédszintézis
POST /v1/tts
Szöveget alakít hangfájllá (szöveg-beszéd). Hasznos hangalapú asszisztensek vagy automatizált hangtartalmak építéséhez.
Valós idejű hangügynök
WSS wss://api.x.ai/v1/realtime
Egy WebSocket végpont interaktív hangügynökök létrehozásához. A kommunikáció valós időben zajlik, audio adatok küldésével és fogadásával.
Fájlkezelés
POST /v1/files
Fájlt tölt fel a xAI platformra. A fájlokat ezután gyűjteményekkel együtt RAG-hoz (lekérdezéssel bővített generálás) lehet használni.
GET /v1/files
Listázza az összes feltöltött fájlt a saját területeden.
GET /v1/files/{id}
Lekéri egy adott fájl metaadatait.
DELETE /v1/files/{id}
Töröl egy feltöltött fájlt.
Kötegelt feldolgozás
POST /v1/batches
Létrehoz egy kéréscsomagot, amelyet csoportként dolgoz fel, gyakran kedvezőbb áron.
GET /v1/batches
Listázza a folyamatban lévő és befejezett kötegeket.
Szerveroldali beépített eszközök
A /v1/responses végpont támogat olyan eszközöket, amelyeket az API közvetlenül futtat, kliensoldali logika nélkül:
- web_search: valós idejű webes keresés
- x_search: keresés az X (Twitter) bejegyzéseiben
- code_interpreter: Python kód végrehajtása
- function: egyéni függvényhívások (function calling)
Ezeket az eszközöket a kérés tools paraméterével kapcsolhatod be.
Főbb megállapítások
- Az API lefedi a szöveget, képeket, videókat, hangot és fájlokat
- A
/v1/responsesa fő végpont, a legteljesebb támogatással - A
deferredmód lehetővé teszi az aszinkron feldolgozást hosszú kérések esetén - A szerveroldali eszközök (web_search, x_search, code_interpreter) extra kód nélkül gazdagítják a válaszokat