Основният URL адрес на API
На тази страница
Точка на вход на Grok API
Всяка заявка към xAI API преминава през един единствен основен URL адрес. Разбирането на този адрес и наличните крайни точки (endpoints) е от съществено значение, преди да напишете първия ред код.
Основният URL адрес
Grok API се намира на следния адрес:
https://api.x.ai/v1
Този URL адрес е коренът за всяка крайна точка. Например, за да генерирате отговор, пълният URL адрес е https://api.x.ai/v1/responses.
Защо /v1?
Префиксът /v1 обозначава версията на API. Версионирането позволява на xAI да развива API, без да нарушава работата на съществуващите приложения. Ако се появи версия 2, тя ще съществува успоредно с v1 по време на преходен период.
Съвместимост с екосистемата на OpenAI
Фундаментална характеристика на xAI API е неговата съвместимост с формата на OpenAI. На практика, ако вече разполагате с код, който работи с OpenAI API, трябва да промените само две настройки, за да използвате Grok:
- Основният URL адрес: заменете
https://api.openai.com/v1сhttps://api.x.ai/v1 - API ключът: заменете вашия OpenAI ключ с вашия xAI ключ
Тази съвместимост обхваща повечето инструменти и библиотеки в екосистемата на OpenAI: LangChain, LlamaIndex, LiteLLM и много други работят с Grok без промени в кода.
Основните крайни точки
API предоставя няколко крайни точки, групирани по функционалност.
Генериране на текст
POST /v1/responses: основната крайна точка за генериране на отговори (съвременен формат)POST /v1/chat/completions: съвместимата с OpenAI крайна точка (остарял формат, все още поддържан)
Генериране на медийно съдържание
POST /v1/images/generations: генериране на изображенияPOST /v1/images/edits: редактиране на съществуващи изображенияPOST /v1/videos/generations: генериране на видеоклиповеPOST /v1/tts: синтез на реч (текст към реч)
Управление на файлове
POST /v1/files: качване на файлGET /v1/files: изброяване на качените файлове
Работа в реално време
wss://api.x.ai/v1/realtime: гласов агент чрез WebSocket
Задаване на URL адреса във вашите SDK
Когато използвате SDK, съвместим с OpenAI, трябва изрично да посочите основния URL адрес:
from openai import OpenAI
client = OpenAI(
api_key="xai-your-key",
base_url="https://api.x.ai/v1"
)
При използване на родния xAI SDK, URL адресът е предварително конфигуриран и не е необходимо да настройвате нищо.
Тестване на свързаността
Преди да напишете какъвто и да е код, директно обаждане валидира цялата верига (URL адрес, ключ, мрежа):
curl https://api.x.ai/v1/models \
-H "Authorization: Bearer xai-your-key"
Отговорът изброява моделите, налични с вашия ключ. Това е също така най-надеждният начин да научите точните ID на моделите, налични във вашия акаунт, без да зависите от документация, която може да се промени. Запазете този навик: валидирайте всяка нова среда (машина, CI, сървър) с това same обаждане преди всяко внедряване.
Лимити и квоти
API прилага ограничения на честотата (rate limits) за всеки екип и всеки модел. Ако ги надвишите, ще получите HTTP грешка 429. Конзолата на xAI показва вашите текущи квоти и използването им в реално време.
Ключови изводи
- Основният URL адрес е
https://api.x.ai/v1за всяка крайна точка - API е съвместим с формата на OpenAI: променете URL адреса и ключа, и това е всичко
- Основната крайна точка за генериране е
POST /v1/responses - Остарялата крайна точка
POST /v1/chat/completionsостава достъпна за съвместимост