Dostupné koncové body
Na této stránce
Přehled API Grok
API xAI se neomezuje pouze na generování textu. Poskytuje sadu koncových bodů pokrývajících generování obrázků a videí, syntézu řeči, správu souborů a asynchronní zpracování. Tato lekce ti zmapuje dostupné koncové body, abys věděl, které funkce ve svých projektech použít.
Generování textu
POST /v1/responses (doporučeno)
Hlavní koncový bod pro jakoukoli interakci s modely Grok. Podporuje text, vidění, nástroje (volání funkcí), vyhledávání na webu a vyhledávání na X.
Klíčové parametry: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (kompatibilní s OpenAI)
Koncový bod ve formátu OpenAI, udržovaný pro kompatibilitu s existujícími nástroji. Přijímá stejné parametry jako API OpenAI: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Načte dříve vygenerovanou odpověď, pokud byla uložena (parametr store: true). Odpovědi jsou uchovávány po dobu 30 dnů.
DELETE /v1/responses/{id}
Smaže uloženou odpověď před tím, než po 30 dnech automaticky vyprší.
Asynchronní zpracování
POST /v1/chat/completions (režim odložení)
Když do požadavku přidáš "deferred": true, API okamžitě vrátí request_id, aniž by čekalo na dokončení generování. Je to užitečné pro dlouhé požadavky nebo dávkové zpracování.
GET /v1/chat/deferred-completion/{request_id}
Načte výsledek asynchronního volání:
- HTTP 200: generování je dokončeno a tělo odpovědi obsahuje kompletní výsledek
- HTTP 202: generování stále probíhá, zkuste to tedy později
Generování obrázků
POST /v1/images/generations
Generuje obrázky na základě textového popisu.
POST /v1/images/edits
Upravuje existující obrázek na základě textových pokynů.
Generování videí
POST /v1/videos/generations
Spustí generování videa z textového zadání.
GET /v1/videos/{id}
Zkontroluje stav generovaného videa a po jeho dokončení získá URL adresu výsledku.
POST /v1/videos/edits
Upravuje existující video.
POST /v1/videos/extensions
Prodlužuje existující video.
Syntéza řeči
POST /v1/tts
Převádí text na zvuk (text-to-speech). Užitečné pro budování hlasových asistentů nebo automatizovaného audio obsahu.
Hlasový agent v reálném čase
WSS wss://api.x.ai/v1/realtime
Koncový bod WebSocket pro budování interaktivních hlasových agentů. Komunikace probíhá v reálném čase s odesíláním a přijímáním zvuku.
Správa souborů
POST /v1/files
Nahraje soubor na platformu xAI. Soubory lze následně využít pro RAG (generování rozšířené o vyhledávání) s kolekcemi.
GET /v1/files
Vypíše všechny soubory nahrané do tvého prostoru.
GET /v1/files/{id}
Načte metadata konkrétního souboru.
DELETE /v1/files/{id}
Smaže nahraný soubor.
Dávkové zpracování
POST /v1/batches
Vytvoří dávku požadavků ke zpracování jako skupina, často za sníženou cenu.
GET /v1/batches
Vypíše probíhající a dokončené dávky.
Nástroje vestavěné na straně serveru
Koncový bod /v1/responses podporuje nástroje, které API spouští přímo bez logiky na straně klienta:
- web_search: vyhledávání na webu v reálném čase
- x_search: vyhledávání v příspěvcích na X (Twitter)
- code_interpreter:执行 kódu v Pythonu
- function: volání vlastních funkcí (function calling)
Tyto nástroje aktivuješ pomocí parametru tools v požadavku.
Klíčové poznatky
- API pokrývá text, obrázky, videa, zvuk a soubory
/v1/responsesje hlavní koncový bod s nejúplnější podporou- Režim
deferredumožňuje asynchronní zpracování pro dlouhé požadavky - Nástroje na straně serveru (web_search, x_search, code_interpreter) obohacují odpovědi bez nutnosti psát další kód