Saadaolevad lõpp-punktid
Sellel lehel
Grok API ülevaade
xAI API ei piirdu ainult teksti genereerimisega. See pakub lõpp-punktide komplekti, mis hõlmab piltide ja videote loomist, kõnesünteesi, failihaldust ja asünkroonset töötlemist. See tund kaardistab saadaolevad lõpp-punktid, et teaksid, milliseid funktsioone oma projektides kasutada.
Teksti genereerimine
POST /v1/responses (soovitatav)
Peamine lõpp-punkt igasuguseks suhtluseks Groki mudelitega. See toetab teksti, nägemist, tööriistu (funktsioonide kutsumine), veebiotsingut ja X-i otsingut.
Põhiparameetrid: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (OpenAI-ga ühilduv)
Lõpp-punkt OpenAI vormingus, mida hallatakse olemasolevate tööriistadega ühilduvuse tagamiseks. See aktsepteerib samu parameetreid kui OpenAI API: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Toob tagasi varem genereeritud vastuse, kui see salvestati (parameeter store: true). Vastuseid hoitakse 30 päeva.
DELETE /v1/responses/{id}
Kustutab salvestatud vastuse enne, kui see 30 päeva möödudes automaatselt aegub.
Asünkroonne töötlemine
POST /v1/chat/completions (edasilükatud režiim)
Kui lisad päringusse "deferred": true, tagastab API viivitamata request_id, ootamata genereerimise lõppemist. See on kasulik pikkade päringute või hargtöötluse korral.
GET /v1/chat/deferred-completion/{request_id}
Toob tagasi asünkroonse kõne tulemuse:
- HTTP 200: genereerimine on lõppenud ja keha sisaldab täielikku vastust
- HTTP 202: genereerimine on veel pooleli, proovi hiljem uuesti
Piltide genereerimine
POST /v1/images/generations
Genereerib pilte tekstikirjelduse põhjal.
POST /v1/images/edits
Redigeerib olemasolevat pilti tekstijuhiste põhjal.
Videote genereerimine
POST /v1/videos/generations
Algatab video genereerimise tekstisisendi põhjal.
GET /v1/videos/{id}
Kontrollib genereeritava video olekut ja toob tulemuse URL-i, kui see on valmis.
POST /v1/videos/edits
Redigeerib olemasolevat videot.
POST /v1/videos/extensions
Pikendab olemasolevat videot.
Kõnesüntees
POST /v1/tts
Teisendab teksti heliks (tekst-kõneks). Kasulik hääleassistentide või automatiseeritud helisisu loomisel.
Reaalaja hääleagent
WSS wss://api.x.ai/v1/realtime
WebSocketi lõpp-punkt interaktiivsete hääleagentide loomiseks. Suhtlus toimub reaalajas, saates ja vastu võttes heli.
Failihaldus
POST /v1/files
Laeb faili üles xAI platvormile. Faile saab seejärel kasutada RAG-i (otsinguga täiendatud genereerimine) jaoks koos kollektsioonidega.
GET /v1/files
Loetleb kõik sinu ruumi üles laaditud failid.
GET /v1/files/{id}
Toob tagasi konkreetse faili metaandmed.
DELETE /v1/files/{id}
Kustutab üles laaditud faili.
Hargtöötlus
POST /v1/batches
Loob päringute partii, mida töödeldakse grupina, sageli soodsama hinnaga.
GET /v1/batches
Loetleb käimasolevad ja lõpetatud partiisid.
Serveripoolsed sisseehitatud tööriistad
Lõpp-punkt /v1/responses toetab tööriistu, mida API käitab otse, ilma kliendipoolse loogikata:
- web_search: reaalajas veebiotsing
- x_search: otsing X-i (Twitter) postitustes
- code_interpreter: Pythoni koodi täitmine
- function: kohandatud funktsioonide kutsumine (function calling)
Lülidad need tööriistad sisse päringu parameetri tools abil.
Peamised punktid
- API hõlmab teksti, pilte, videoid, heli ja faile
/v1/responseson peamine lõpp-punkt, pakkudes kõige täielikumat tuge- Režiim
deferredvõimaldab pikkade päringute asünkroonset töötlemist - Serveripoolsed tööriistad (web_search, x_search, code_interpreter) rikastavad vastuseid ilma lisakoodita