Razpoložljive končne točke
Na tej strani
Pregled API-ja Grok
API xAI ni omejen le na generiranje besedila. Izpostavlja nabor končnih točk, ki pokrivajo generiranje slik in videoposnetkov, sintezo govora, upravljanje datotek in asinhrono obdelavo. Ta lekcija preslika razpoložljive končne točke, da boš vedel, katere funkcije uporabiti v svojih projektih.
Generiranje besedila
POST /v1/responses (priporočeno)
Glavna končna točka za vsakršno interakcijo z modeli Grok. Podpira besedilo, vid, orodja (klicanje funkcij), spletno iskanje in iskanje po X.
Ključni parametri: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (združljivo z OpenAI)
Končna točka v formatu OpenAI, ohranjena zaradi združljivosti z obstoječimi orodji. Sprejema iste parametre kot API OpenAI: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Pridobi predhodno ustvarjen odgovor, če je bil shranjen (parameter store: true). Odgovori se hranijo 30 dni.
DELETE /v1/responses/{id}
Izbriše shranjen odgovor, preden samodejno poteče po 30 dneh.
Asinhrona obdelava
POST /v1/chat/completions (odloženi način)
Ko zahtevi dodaš "deferred": true, API takoj vrne request_id, ne da bi čakal na zaključek generiranja. To je uporabno za dolge zahteve ali serijsko obdelavo.
GET /v1/chat/deferred-completion/{request_id}
Pridobi rezultat asinhronega klica:
- HTTP 200: generiranje je končano in telo vsebuje popoln odgovor
- HTTP 202: generiranje še poteka, zato poskusi znova kasneje
Generiranje slik
POST /v1/images/generations
Ustvari slike na podlagi besedilnega opisa.
POST /v1/images/edits
Uredi obstoječo sliko na podlagi besedilnih navodil.
Generiranje videoposnetkov
POST /v1/videos/generations
Začne generiranje videoposnetka iz besedilnega poziva.
GET /v1/videos/{id}
Preveri stanje generiranega videoposnetka in po zaključku pridobi URL rezultata.
POST /v1/videos/edits
Uredi obstoječi videoposnetek.
POST /v1/videos/extensions
Razširi obstoječi videoposnetek.
Sinteza govora
POST /v1/tts
Pretvori besedilo v zvok (besedilo-v-govor). Uporabno za gradnjo glasovnih pomočnikov ali avtomatizirane zvočne vsebine.
Glasovni agent v realnem času
WSS wss://api.x.ai/v1/realtime
Končna točka WebSocket za gradnjo interaktivnih glasovnih agentov. Komunikacija poteka v realnem času s pošiljanjem in prejemanjem zvoka.
Upravljanje datotek
POST /v1/files
Naloži datoteko na platformo xAI. Datoteke lahko nato uporabiš za RAG (generiranje, povečano s pridobivanjem) z zbirkami.
GET /v1/files
Izpiše vse datoteke, naložene v tvoj prostor.
GET /v1/files/{id}
Pridobi metapodatke določene datoteke.
DELETE /v1/files/{id}
Izbriše naloženo datoteko.
Serijska obdelava
POST /v1/batches
Ustvari serijo zahtev za obdelavo kot skupina, pogosto po znižani ceni.
GET /v1/batches
Izpiše serije, ki so v teku, in končane serije.
Vgrajena orodja na strani strežnika
Končna točka /v1/responses podpira orodja, ki jih API izvaja neposredno, brez logike na strani odjemalca:
- web_search: iskanje po spletu v realnem času
- x_search: iskanje po objavah na X (Twitter)
- code_interpreter: izvajanje kode Python
- function: klici prilagojenih funkcij (klicanje funkcij)
Ta orodja vklopiš s parametrom tools v zahtevi.
Ključne ugotovitve
- API pokriva besedilo, slike, video, zvok in datoteke
/v1/responsesje glavna končna točka z najbolj popolno podporo- Način
deferredomogoča asinhrono obdelavo za dolge zahteve - Orodja na strani strežnika (web_search, x_search, code_interpreter) obogatijo odgovore brez dodatne kode