Skip to main content
POST
Создать chat completion
Поддерживает текстовые диалоги, мультимодальные запросы (текст + изображения + аудио + видео + файлы), вызов функций и потоковую передачу.

Возможности

  • Агрегация провайдеров — автоматический выбор оптимального провайдера
  • Биллинг в рублях — точный учет стоимости
  • Reasoning Tokens — поддержка моделей с рассуждениями
  • Streaming — потоковая передача через SSE
  • Tool Calling — вызов внешних функций
  • Мультимодальность — обработка текста, изображений, аудио, видео и файлов

Параметры запроса

Обязательные

Контент

Параметры генерации

Специальные возможности

Структура сообщений

Базовый формат

Мультимодальные сообщения

Другие типы контента

Системные сообщения с кешированием

Примеры

Ответ

Успешный ответ (200)

Streaming (SSE)

При stream: true ответ приходит в формате Server-Sent Events:

Tool Calling

Определение функций

Ответ модели с вызовом функции

Response Format

JSON Schema (структурированный вывод)

Поддерживаемые типы: text, json_object, json_schema, grammar (GBNF).

Reasoning Tokens

Для моделей с рассуждениями (o1, o3, DeepSeek-R1 и другие):

Параметры reasoning

Авторизации

Authorization
string
header
обязательно

API ключ передаётся в заголовке: Authorization: Bearer <SPESHU_AI_API_KEY>

Тело

application/json
model
string
обязательно

Идентификатор модели для использования

Пример:

"openai/gpt-4o"

messages
object[]
обязательно

Массив сообщений для отправки модели (обязателен если не указан prompt)

Пример:
prompt
string

Текстовый промпт (альтернатива messages). Если указан, будет преобразован в messages с role=user

Пример:

"Напиши стихотворение про кота"

max_tokens
number

Максимальное количество токенов для генерации

Требуемый диапазон: x >= 1
Пример:

1000

max_completion_tokens
number

Максимальное количество токенов для completion (альтернатива max_tokens)

Требуемый диапазон: x >= 1
Пример:

1000

temperature
number

Температура сэмплинга (0-2). Более высокие значения делают вывод более случайным

Требуемый диапазон: 0 <= x <= 2
Пример:

1

top_p
number

Nucleus sampling: вероятностная масса для рассмотрения (0-1)

Требуемый диапазон: 0 <= x <= 1
Пример:

1

frequency_penalty
number

Штраф за частоту использования токенов (-2 до 2)

Требуемый диапазон: -2 <= x <= 2
Пример:

0

presence_penalty
number

Штраф за присутствие токенов (-2 до 2)

Требуемый диапазон: -2 <= x <= 2
Пример:

0

response_format
object

Формат ответа модели

provider
object

Настройки провайдера для роутинга и фильтрации

tools
object[]

Определения инструментов (tools) для function calling

tool_choice
object

Выбор инструмента: none, auto, required или named function

Пример:

"auto"

reasoning
object

Настройки reasoning для reasoning моделей

plugins
array

Плагины для расширения функциональности

web_search_options
object

Настройки встроенного веб-поиска (для моделей с нативной поддержкой)

user
string

Уникальный идентификатор конечного пользователя для отслеживания и предотвращения злоупотреблений

Пример:

"user-123"

stop

Последовательности, при которых модель прекращает генерацию

Пример:
seed
number

Seed для детерминированной генерации (best-effort)

Пример:

42

n
number

Количество вариантов ответа (1-10)

Требуемый диапазон: 1 <= x <= 10
Пример:

1

stream
boolean

Включить потоковую передачу ответа

Пример:

false

logprobs
boolean

Возвращать log probabilities для output токенов

Пример:

false

top_logprobs
number

Количество наиболее вероятных токенов для возврата (0-20). Требует logprobs: true

Требуемый диапазон: 0 <= x <= 20
Пример:

5

logit_bias
object

Смещение вероятностей токенов по их ID (-100 до 100)

Пример:
parallel_tool_calls
boolean

Разрешить параллельный вызов нескольких tools

Пример:

true

image_config
object

Настройки обработки изображений

Пример:
modalities
enum<string>[]

Типы вывода модели

Доступные опции:
text,
image,
audio
Пример:
audio
object

Настройки аудио выхода для моделей с поддержкой аудио (gpt-audio и др.)

Ответ

id
string
обязательно

Уникальный идентификатор генерации

Пример:

"gen_581761234567890123"

object
string
обязательно

Тип объекта

Пример:

"chat.completion"

created
number
обязательно

Временная метка создания (Unix timestamp)

Пример:

1703001234

model
string
обязательно

ID модели, которая сгенерировала ответ

Пример:

"openai/gpt-4o"

choices
object[]
обязательно

Массив вариантов ответа

system_fingerprint
string

System fingerprint от провайдера

Пример:

"fp_29330a9688"

usage
object

Информация об использовании токенов