Налични крайни точки
На тази страница
Преглед на Grok API
API на xAI не се ограничава само до генериране на текст. Той предоставя набор от крайни точки, обхващащи генериране на изображения и видеоклипове, синтез на реч, управление на файлове и асинхронна обработка. Този урок описва наличните крайни точки, за да знаете кои функции да използвате във вашите проекти.
Генериране на текст
POST /v1/responses (препоръчително)
Основната крайна точка за всякакво взаимодействие с моделите на Grok. Тя поддържа текст, визия, инструменти (извикване на функции), търсене в уеб и търсене в X.
Ключови параметри: model, input, instructions, stream, tools, reasoning.
POST /v1/chat/completions (съвместим с OpenAI)
Крайната точка във формат на OpenAI, поддържана за съвместимост със съществуващи инструменти. Тя приема същите параметри като API на OpenAI: model, messages, temperature, stream, tools.
GET /v1/responses/{id}
Извлича предишно генериран отговор, ако е бил запазен (параметър store: true). Отговорите се съхраняват в продължение на 30 дни.
DELETE /v1/responses/{id}
Изтрива запазен отговор преди автоматичното му изтичане след 30 дни.
Асинхронна обработка
POST /v1/chat/completions (отложен режим)
Когато добавите "deferred": true към заявката, API незабавно връща request_id, без да изчаква приключването на генерирането. Това е полезно за дълги заявки или пакетна обработка.
GET /v1/chat/deferred-completion/{request_id}
Извлича резултата от асинхронно извикване:
- HTTP 200: генерирането е приключило и тялото съдържа пълния отговор
- HTTP 202: генерирането все още е в процес, опитайте отново по-късно
Генериране на изображения
POST /v1/images/generations
Генерира изображения въз основа на текстово описание.
POST /v1/images/edits
Редактира съществуващо изображение въз основа на текстови инструкции.
Генериране на видео
POST /v1/videos/generations
Стартира генерирането на видео от текстов подканващ сигнал (prompt).
GET /v1/videos/{id}
Проверява статуса на генерирано видео и извлича URL адреса на резултата, след като приключи.
POST /v1/videos/edits
Редактира съществуващо видео.
POST /v1/videos/extensions
Разширява съществуващо видео.
Синтез на реч
POST /v1/tts
Преобразува текст в аудио (текст-към-реч). Полезно за изграждане на гласови асистенти или автоматизирано аудио съдържание.
Гласов агент в реално време
WSS wss://api.x.ai/v1/realtime
Крайна точка на WebSocket за изграждане на интерактивни гласови агенти. Комunikацията се осъществява в реално време, като се изпраща и получава аудио.
Управление на файлове
POST /v1/files
Качва файл в платформата на xAI. След това файловете могат да се използват за RAG (генериране, подпомогнато от извличане) с колекции.
GET /v1/files
Изброява всички файлове, качени във вашето пространство.
GET /v1/files/{id}
Извлича метаданните на конкретен файл.
DELETE /v1/files/{id}
Изтрива качен файл.
Пакетна обработка
POST /v1/batches
Създава пакет от заявки за обработка като група, често на намалена цена.
GET /v1/batches
Изброява пакетите в процес на изпълнение и завършените.
Вградени инструменти на сървъра
Крайната точка /v1/responses поддържа инструменти, които API изпълнява директно, без логика на страната на клиента:
- web_search: търсене в уеб в реално време
- x_search: търсене в публикации в X (Twitter)
- code_interpreter: изпълнение на Python код
- function: извикване на персонализирани функции (function calling)
Активирате тези инструменти чрез параметъра tools на заявката.
Ключови изводи
- API обхваща текст, изображения, видео, аудио и файлове
/v1/responsesе основната крайна точка с най-пълна поддръжка- Режимът
deferredпозволява асинхронна обработка за дълги заявки - Сървърните инструменти (web_search, x_search, code_interpreter) обогатяват отговорите без допълнителен код