Dostępne punkty końcowe
Na tej stronie
Przegląd API Grok
API xAI nie ogranicza się tylko do generowania tekstu. Udostępnia zestaw punktów końcowych obejmujących generowanie obrazów i wideo, syntezę mowy, zarządzanie plikami oraz przetwarzanie asynchroniczne. Ta lekcja przedstawia dostępne punkty końcowe, abyś wiedział, z których funkcji korzystać w swoich projektach.
Generowanie tekstu
POST /v1/responses (zalecane)
Główny punkt końcowy do wszelkich interakcji z modelami Grok. Obsługuje tekst, wizję, narzędzia (wywoływanie funkcji), wyszukiwanie w sieci oraz wyszukiwanie w serwisie X.
Kluczowe parametry: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (kompatybilne z OpenAI)
Punkt końcowy w formacie OpenAI, utrzymany dla kompatybilności z istniejącymi narzędziami. Przyjmuje te same parametry co API OpenAI: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Pobiera wcześniej wygenerowaną odpowiedź, jeśli została zapisana (parametr store: true). Odpowiedzi są przechowywane przez 30 dni.
DELETE /v1/responses/{id}
Usuwa zapisaną odpowiedź przed jej automatycznym wygaśnięciem po 30 dniach.
Przetwarzanie asynchroniczne
POST /v1/chat/completions (tryb odroczony)
Gdy dodasz "deferred": true do żądania, API natychmiast zwraca request_id, nie czekając na zakończenie generowania. Jest to przydatne w przypadku długich żądań lub przetwarzania wsadowego.
GET /v1/chat/deferred-completion/{request_id}
Pobiera wynik wywołania asynchronicznego:
- HTTP 200: generowanie zakończone, ciało odpowiedzi zawiera kompletny wynik
- HTTP 202: generowanie wciąż trwa, spróbuj ponownie później
Generowanie obrazów
POST /v1/images/generations
Generuje obrazy na podstawie opisu tekstowego.
POST /v1/images/edits
Edytuje istniejący obraz zgodnie z instrukcjami tekstowymi.
Generowanie wideo
POST /v1/videos/generations
Rozpoczyna generowanie wideo na podstawie monitu tekstowego.
GET /v1/videos/{id}
Sprawdza status generowanego wideo i pobiera adres URL wyniku po jego zakończeniu.
POST /v1/videos/edits
Edytuje istniejące wideo.
POST /v1/videos/extensions
Rozszerza istniejące wideo.
Synteza mowy
POST /v1/tts
Konwertuje tekst na dźwięk (text-to-speech). Przydatne przy budowaniu asystentów głosowych lub automatycznej treści audio.
Agent głosowy w czasie rzeczywistym
WSS wss://api.x.ai/v1/realtime
Punkt końcowy WebSocket do budowania interaktywnych agentów głosowych. Komunikacja odbywa się w czasie rzeczywistym, z wysyłaniem i odbieraniem dźwięku.
Zarządzanie plikami
POST /v1/files
Przesyła plik na platformę xAI. Pliki można następnie wykorzystać do RAG (generowanie wspomagane retrieverem) wraz z kolekcjami.
GET /v1/files
Wyświetla listę wszystkich plików przesłanych do Twojej przestrzeni.
GET /v1/files/{id}
Pobiera metadane określonego pliku.
DELETE /v1/files/{id}
Usuwa przesłany plik.
Przetwarzanie wsadowe
POST /v1/batches
Tworzy grupę żądań do przetworzenia jako wsad, często po obniżonej cenie.
GET /v1/batches
Wyświetla listę wsadów w toku oraz zakończonych.
Wbudowane narzędzia po stronie serwera
Punkt końcowy /v1/responses obsługuje narzędzia, które API uruchamia bezpośrednio, bez logiki po stronie klienta:
- web_search: wyszukiwanie w sieci w czasie rzeczywistym
- x_search: wyszukiwanie w postach serwisu X (Twitter)
- code_interpreter: wykonywanie kodu Python
- function: niestandardowe wywołania funkcji (function calling)
Aktywujesz te narzędzia za pomocą parametru tools w żądaniu.
Kluczowe wnioski
- API obejmuje tekst, obrazy, wideo, dźwięk i pliki
/v1/responsesto główny punkt końcowy oferujący najbardziej kompletną obsługę- Tryb
deferredumożliwia przetwarzanie asynchroniczne dla długich żądań - Narzędzia po stronie serwera (web_search, x_search, code_interpreter) wzbogacają odpowiedzi bez konieczności pisania dodatkowego kodu