xAI API

Что такое xAI API?

xAI API — это способ для разработчиков использовать модели Grok от xAI прямо из кода вашего приложения. Основная цель API — принимать промпты (и для некоторых моделей изображения) и возвращать сгенерированные ответы, которые можно отображать, обрабатывать или структурировать для дальнейшего использования.

В быстром старте описан полный рабочий процесс: создание аккаунта xAI и добавление кредитов, генерация API-ключа, установка SDK и отправка первого запроса к модели Grok с использованием поддерживаемых эндпоинтов и примеров.

Ключевые возможности

• Аутентификация по API-ключу через переменную окружения: Настройте код с помощью XAI_API_KEY, которую SDK от xAI читают автоматически.
• Поддержка SDK для популярных языков: Установите xAI SDK для Python или JavaScript, чтобы вызывать модели Grok без написания сырых HTTP-запросов.
• Генерация текста в стиле чата: Отправляйте системные и пользовательские сообщения и сэмплируйте вывод модели для текстовых ответов.
• Совместимость с эндпоинтом Responses: Вызывайте https://api.x.ai/v1/responses напрямую с API-ключом для инференса модели.
• Мультимодальные входы (текст + изображение): Для поддерживаемых моделей добавляйте URL изображения вместе с текстом в одном запросе.
• Структурированные выходы (для поддерживаемых моделей): Некоторые модели позволяют задавать схему вывода для контроля формы сгенерированных результатов.

Как использовать xAI API

1. Создайте аккаунт xAI на accounts.x.ai, затем добавьте кредиты, чтобы использовать API.
2. Создайте API-ключ в xAI Console в разделе API Keys.
3. Установите XAI_API_KEY — экспортируйте в терминале или добавьте в файл .env:
   • export XAI_API_KEY="your_api_key"
   • XAI_API_KEY=your_api_key
4. Установите SDK в зависимости от языка:
   • Python: pip install xai-sdk
   • JavaScript: npm install ai @ai-sdk/xai zod
5. Отправьте запрос к модели Grok (пример показывает grok-4.20-reasoning для текста и grok-4 для изображения+текста). Используйте примеры SDK или прямой HTTP-запрос к responses.

Примеры использования

• Создайте чат-интерфейс для Grok: Разработайте приложение, которое отправляет вопросы пользователя и опциональные системные инструкции, затем отображает response.content или completion.output_text.
• Генерируйте текст с известным эндпоинтом модели: Используйте workflow POST https://api.x.ai/v1/responses для интеграции Grok в сервисы, где предпочтительны прямые HTTP-вызовы.
• Добавьте понимание изображений в Q&A-поток: Отправьте URL изображения с промптом вроде «Что на этом изображении?» в формате мультимодального запроса из быстрого старта.
• Принуждайте форматирование вывода для обработки: При использовании поддерживаемой модели Grok применяйте Structured Outputs, чтобы результаты следовали вашей схеме.
• Проводите быстрые эксперименты в разных средах: Переключайтесь между примерами на Python и JavaScript, сохраняя одну настройку переменной окружения (XAI_API_KEY).

FAQ

Как аутентифицировать запросы к xAI API?

Создайте API-ключ в xAI Console и установите его как XAI_API_KEY (например, через export XAI_API_KEY="..." или файл .env). SDK от xAI настроены на автоматическое чтение этой переменной окружения.

Какую модель Grok использовать для первого запроса?

Примеры в быстром старте используют grok-4.20-reasoning для генерации текста в стиле чата и grok-4 для входных данных изображения+текст.

Можно ли вызывать API без SDK?

Да. В быстром старте есть пример с прямым curl, который постит на https://api.x.ai/v1/responses с JSON-телом, содержащим model и input.

Как отправить изображения в Grok?

Для моделей, принимающих изображения, добавьте URL изображения в input вместе с текстом (пример использует структуру input_image / input_text в SDK или типизированную структуру content в вызове responses).

Что такое Structured Outputs?

Быстрый старт отмечает, что определённые модели поддерживают Structured Outputs, позволяющие задавать схему для вывода LLM. Страница ссылается на отдельное руководство «Text Generation Guide» для детального использования.

Альтернативы

• Используйте chat/assistants API другого провайдера LLM: Если ваш workflow — «промпт внутрь, сгенерированный текст наружу», замените на API другого вендора с похожей аутентификацией по ключу и форматом запроса.
• Примените универсальный подход к генерации текста: Вместо SDK конкретного вендора стройте запросы напрямую к эндпоинту в стиле «completions/responses» для консистентной интеграции на разных языках.
• Используйте API моделей с мультимодальными возможностями: Если основная потребность — понимание изображения+текст, ищите провайдеров с явной поддержкой изображений в схеме API-запроса, затем адаптируйте payload запроса.