Dostupné koncové body
Na tejto strane
Prehľad API Grok
API xAI sa neobmedzuje len na generovanie textu. Sprístupňuje súbor koncových bodov pokrývajúcich generovanie obrázkov a videí, syntézu reči, správu súborov a asynchrónne spracovanie. Táto lekcia ti zmapuje dostupné koncové body, aby si vedel, ktoré funkcie použiť vo svojich projektoch.
Generovanie textu
POST /v1/responses (odporúčané)
Hlavný koncový bod pre akúkoľvek interakciu s modelmi Grok. Podporuje text, videnie, nástroje (volanie funkcií), vyhľadávanie na webe a vyhľadávanie v sieti X.
Kľúčové parametre: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (kompatibilné s OpenAI)
Koncový bod vo formáte OpenAI, udržovaný pre kompatibilitu s existujúcimi nástrojmi. Prijíma rovnaké parametre ako API OpenAI: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Získa predtým vygenerovanú odpoveď, ak bola uložená (parameter store: true). Odpovede sa uchovávajú 30 dní.
DELETE /v1/responses/{id}
Odstráni uloženú odpoveď skôr, než sa automaticky po 30 dňoch vyprší jej platnosť.
Asynchrónne spracovanie
POST /v1/chat/completions (režim oneskoreného vykonania)
Keď do požiadavky pridáš "deferred": true, API okamžite vráti request_id bez čakania na dokončenie generovania. Je to užitočné pre dlhé požiadavky alebo dávkové spracovanie.
GET /v1/chat/deferred-completion/{request_id}
Získa výsledok asynchrónneho volania:
- HTTP 200: generovanie je dokončené a telo odpovede obsahuje kompletnú odpoveď
- HTTP 202: generovanie stále prebieha, skús to teda neskôr
Generovanie obrázkov
POST /v1/images/generations
Generuje obrázky na základe textového popisu.
POST /v1/images/edits
Upraví existujúci obrázok na základe textových inštrukcií.
Generovanie videí
POST /v1/videos/generations
Spustí generovanie videa z textového promptu.
GET /v1/videos/{id}
Skontroluje stav generovaného videa a po jeho dokončení získa URL adresu výsledku.
POST /v1/videos/edits
Upraví existujúce video.
POST /v1/videos/extensions
Rozšíri existujúce video.
Syntéza reči
POST /v1/tts
Konvertuje text na audio (text-to-speech). Užitočné pre budovanie hlasových asistentov alebo automatizovaný audio obsah.
Hlasový agent v reálnom čase
WSS wss://api.x.ai/v1/realtime
Koncový bod WebSocket pre budovanie interaktívnych hlasových agentov. Komunikácia prebieha v reálnom čase s odosielaním a prijímaním audia.
Správa súborov
POST /v1/files
Nahraje súbor na platformu xAI. Súbory sa následne dajú využiť pre RAG (generovanie augmentované vyhľadávaním) s kolekciami.
GET /v1/files
Vypíše všetky súbory nahrané do tvojho priestoru.
GET /v1/files/{id}
Získa metadáta konkrétneho súboru.
DELETE /v1/files/{id}
Odstráni nahraný súbor.
Dávkové spracovanie
POST /v1/batches
Vytvorí dávku požiadaviek na spracovanie ako skupina, často za zníženú cenu.
GET /v1/batches
Vypíše prebiehajúce a dokončené dávky.
Vstavané nástroje na strane servera
Koncový bod /v1/responses podporuje nástroje, ktoré API spúšťa priamo bez logiky na strane klienta:
- web_search: vyhľadávanie na webe v reálnom čase
- x_search: vyhľadávanie v príspevkoch na sieti X (Twitter)
- code_interpreter: vykonávanie kódu v Pythone
- function: volania vlastných funkcií (function calling)
Tieto nástroje zapneš pomocou parametra tools v požiadavke.
Kľúčové poznatky
- API pokrýva text, obrázky, video, audio a súbory
/v1/responsesje hlavný koncový bod s najkompletnejšou podporou- Režim
deferredumožňuje asynchrónne spracovanie pre dlhé požiadavky - Nástroje na strane servera (web_search, x_search, code_interpreter) obohacujú odpovede bez potreby ďalšieho kódu