Bazowy adres URL interfejsu API
Na tej stronie
Punkt wejścia do interfejsu API Grok
Każde żądanie wysyłane do interfejsu API xAI przechodzi przez jeden bazowy adres URL. Zrozumienie tego adresu oraz dostępnych punktów końcowych jest kluczowe, zanim napiszesz pierwszą linię kodu.
Bazowy adres URL
Interfejs API Grok znajduje się pod tym adresem:
https://api.x.ai/v1
Ten adres URL jest głównym katalogiem dla każdego punktu końcowego. Na przykład, aby wygenerować odpowiedź, pełny adres URL to https://api.x.ai/v1/responses.
Dlaczego /v1?
Prefiks /v1 oznacza wersję interfejsu API. Wersjonowanie pozwala firmie xAI rozwijać interfejs bez psucia istniejących aplikacji. Jeśli pojawi się wersja 2, będzie ona współistnieć z wersją v1 przez okres przejściowy.
Zgodność z ekosystemem OpenAI
Fundamentalną cechą interfejsu API xAI jest jego zgodność z formatem OpenAI. W praktyce, jeśli masz już kod działający z interfejsem API OpenAI, musisz zmienić tylko dwa ustawienia, aby korzystać z Grok:
- Bazowy adres URL: zamień
https://api.openai.com/v1nahttps://api.x.ai/v1 - Klucz API: zamień swój klucz OpenAI na klucz xAI
Ta zgodność obejmuje większość narzędzi i bibliotek w ekosystemie OpenAI: LangChain, LlamaIndex, LiteLLM i wiele innych działa z Grok bez konieczności zmian w kodzie.
Główne punkty końcowe
Interfejs API udostępnia kilka punktów końcowych pogrupowanych według funkcji.
Generowanie tekstu
POST /v1/responses: główny punkt końcowy do generowania odpowiedzi (nowoczesny format)POST /v1/chat/completions: punkt końcowy zgodny z OpenAI (starszy format, nadal obsługiwany)
Generowanie multimediów
POST /v1/images/generations: generowanie obrazówPOST /v1/images/edits: edycja istniejących obrazówPOST /v1/videos/generations: generowanie wideoPOST /v1/tts: synteza mowy (tekst na mowę)
Zarządzanie plikami
POST /v1/files: przesyłanie plikuGET /v1/files: lista przesłanych plików
Czas rzeczywisty
wss://api.x.ai/v1/realtime: agent głosowy przez WebSocket
Konfiguracja adresu URL w SDK
Kiedy używasz SDK zgodnego z OpenAI, musisz jawnie określić bazowy adres URL:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
W przypadku natywnego SDK xAI adres URL jest skonfigurowany domyślnie i nie musisz nic ustawiać.
Testowanie łączności
Zanim napiszesz jakikolwiek kod, bezpośrednie wywołanie pozwala zweryfikować cały łańcuch (adres URL, klucz, sieć):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Odpowiedź zawiera listę modeli dostępnych dla Twojego klucza. Jest to również najbardziej niezawodny sposób na poznanie dokładnych identyfikatorów modeli dostępnych na Twoim koncie, bez polegania na dokumentacji, która może ulec zmianie. Wyrobij sobie nawyk walidowania każdego nowego środowiska (maszyna, CI, serwer) za pomocą tego samego wywołania przed jakimkolwiek wdrożeniem.
Limity i kwoty
Interfejs API egzekwuje limity częstotliwości żądań (rate limits) dla każdego zespołu i każdego modelu. Jeśli je przekroczysz, otrzymasz błąd HTTP 429. Konsola xAI wyświetla Twoje bieżące kwoty oraz zużycie w czasie rzeczywistym.
Kluczowe wnioski
- Bazowy adres URL dla każdego punktu końcowego to
https://api.x.ai/v1 - Interfejs API jest zgodny z formatem OpenAI: zmień adres URL i klucz, i to wszystko
- Głównym punktem końcowym generowania jest
POST /v1/responses - Starszy punkt końcowy
POST /v1/chat/completionspozostaje dostępny ze względów kompatybilności