Galimi galiniai taškai
Šiame puslapyje
Grok API apžvalga
xAI API neapsiriboja tik teksto generavimu. Jis suteikia prieigą prie įvairių galinių taškų, skirtų vaizdų ir vaizdo įrašų kūrimui, kalbos sintezei, failų valdymui bei asinchroniniam apdorojimui. Šioje pamokoje apžvelgsime turimus galinius taškus, kad žinotum, kurias funkcijas naudoti savo projektuose.
Teksto generavimas
POST /v1/responses (rekomenduojama)
Pagrindinis galinis taškas bet kokiam darbui su Grok modeliais. Jis palaiko tekstą, regą, įrankius (funkcijų kvietimą), paiešką internete ir paiešką X platformoje.
Pagrindiniai parametrai: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (suderinamas su OpenAI)
Galinis taškas OpenAI formatu, išlaikytas suderinamumui su esamais įrankiais. Jis priima tuos pačius parametrus kaip ir OpenAI API: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Gauna anksčiau sugeneruotą atsakymą, jei jis buvo išsaugotas (parametras store: true). Atsakymai saugomi 30 dienų.
DELETE /v1/responses/{id}
Ištrina išsaugotą atsakymą prieš jam automatiškai pasibaigiant po 30 dienų.
Asinchroninis apdorojimas
POST /v1/chat/completions (atidėtas režimas)
Kai užklausoje pridėsi "deferred": true, API iškart grąžina request_id nelaukdamas, kol generavimas baigsis. Tai naudinga ilgomis užklausoms arba apdorojant didelius duomenų kiekius grupėmis.
GET /v1/chat/deferred-completion/{request_id}
Gauna asinchroninio kvietimo rezultatą:
- HTTP 200: generavimas baigtas, o kūne pateikiamas pilnas atsakymas
- HTTP 202: generavimas vis dar vyksta, todėl bandykite vėliau
Vaizdų generavimas
POST /v1/images/generations
Generuoja vaizdus iš tekstinio aprašymo.
POST /v1/images/edits
Redaguoja esamą vaizdą pagal tekstines instrukcijas.
Vaizdo įrašų generavimas
POST /v1/videos/generations
Pradeda kurti vaizdo įrašą iš tekstinės užuominos.
GET /v1/videos/{id}
Tikrina kuriamo vaizdo įrašo būseną ir gauna rezultato URL, kai jis baigiamas.
POST /v1/videos/edits
Redaguoja esamą vaizdo įrašą.
POST /v1/videos/extensions
Pratęsia esamą vaizdo įrašą.
Kalbos sintezė
POST /v1/tts
Konvertuoja tekstą į garso įrašą (teksto į kalbą). Naudinga kuriant balso asistentus arba automatizuotą garso turinį.
Realaus laiko balso agentas
WSS wss://api.x.ai/v1/realtime
„WebSocket“ galinis taškas interaktyviems balso agentams kurti. Bendravimas vyksta realiuoju laiku, siunčiant ir gaunant garso duomenis.
Failų valdymas
POST /v1/files
Įkelia failą į xAI platformą. Failus vėliau galima naudoti RAG (generavimui, papildytam gavimu) su kolekcijomis.
GET /v1/files
Pateikia visų į tavo erdvę įkeltų failų sąrašą.
GET /v1/files/{id}
Gauna konkretaus failo metaduomenis.
DELETE /v1/files/{id}
Ištrina įkeltą failą.
Grupinis apdorojimas
POST /v1/batches
Sukuria užklausų grupę apdorojimui kartu, dažnai mažesne kaina.
GET /v1/batches
Pateikia vykdomų ir užbaigtų grupių sąrašą.
Serveryje integruoti įrankiai
Galinis taškas /v1/responses palaiko įrankius, kuriuos API vykdo tiesiogiai, be jokios kliento pusės logikos:
- web_search: paieška internete realiuoju laiku
- x_search: paieška X („Twitter“) įrašuose
- code_interpreter: Python kodo vykdymas
- function: tinkinamų funkcijų kvietimai (funkcijų kvietimas)
Šiuos įrankius įjungiate naudodami užklausos parametrą tools.
Svarbiausi punktai
- API apima tekstą, vaizdus, vaizdo įrašus, garsą ir failus
/v1/responsesyra pagrindinis galinis taškas, turintis išsamiausią palaikymądeferredrežimas leidžia atlikti asinchroninį apdorojimą ilgomis užklausoms- Serveryje veikiantys įrankiai (web_search, x_search, code_interpreter) praturtina atsakymus nereikalaujant papildomo kodo