Chat Completions

Создавайте текстовые и мультимодальные ответы, а также вызовы инструментов через интерфейс Chat Completions, совместимый с OpenAI.

Интерфейс Chat Completions генерирует ответ модели по списку сообщений. Он подходит для обычного текстового диалога, мультимодального ввода, потокового и структурированного вывода, а также вызовов функций через инструменты. Поддерживаемые типы входа и расширенные параметры различаются между моделями. Ориентируйтесь на модели, доступные текущему ключу API, и фактические результаты вызовов.

POST/v1/chat/completions

Генерирует ответ модели на основе переданного списка сообщений. Интерфейс поддерживает обычные ответы и потоковую передачу SSE; расширенные возможности, включая изображения, аудио, вызовы инструментов и структурированный вывод, зависят от выбранной модели.

При смене модели сначала проверьте базовые возможности минимальным текстовым запросом, затем включайте расширенные параметры по одному.

Аутентификация

bearerAuth

АутентификацияBearer <token>

Используйте Bearer your-api-key в Header Authorization.

Расположение: header

Тело запроса

Выберите структуру запроса по входной модальности модели. Все три режима используют один endpoint Chat Completions и общие параметры генерации.

application/json

Текстовый диалог

Для обычных диалогов, генерации содержимого и текстового рассуждения. Содержимое сообщения можно передать строкой.

model: ID текстовой модели, доступной текущему аккаунту.
messages[].role: Роль сообщения, например user, system или assistant.
messages[].content: Текстовое сообщение в виде строки.

application/json

{
  "model": "MODEL_ID",
  "messages": [
    {
      "role": "user",
      "content": "Здравствуйте! Представьтесь одним предложением."
    }
  ]
}

Запрос текстового диалога. Сообщения пользователя могут быть строками или массивами содержимого только с блоками text.

model*string

ID текстовой модели. Скопируйте из каталога ID модели, доступной текущему аккаунту и поддерживающей текстовый ввод.

Длина1 <= length

messages*array<|||||>

Список сообщений текстового диалога в порядке отправки.

Элементы1 <= items

store?boolean|null

Сохранять ли результат данного ответа. Применимость зависит от выбранной модели и канала.

По умолчаниюfalse

reasoning_effort?string|null

Уровень усилий модели на рассуждение. Доступные значения зависят от модели; none явно отключает усилия на рассуждение.

По умолчанию"medium"

Допустимые значения

"none"
"minimal"
"low"
"medium"
"high"
"xhigh"
"max"
null

metadata?|null

Метаданные запроса в виде пар ключ–значение. Максимальная длина ключа — 64 символа, значения — 512 символов.

Поляproperties <= 16

modalities?array<>|null

Требуемые модальности вывода. По умолчанию генерируется только текст.

prediction?|null

Настройки предсказанного содержимого, когда большая часть ожидаемого вывода уже известна.

audio?|null

Настройки формата и голоса для аудиовывода.

temperature?number|null

Температура семплирования. Обычно следует изменять только temperature или top_p; поддержка зависит от модели.

Диапазон0 <= value <= 2

По умолчанию1

top_p?number|null

Суммарная вероятность при семплировании nucleus. Обычно следует изменять только temperature или top_p; поддержка зависит от модели.

Диапазон0 <= value <= 1

По умолчанию1

n?integer|null

Число вариантов ответа для каждого входа. Несколько вариантов увеличивают расход ресурсов.

Диапазон1 <= value <= 128

По умолчанию1

stop?string|array<string>|null

До четырёх последовательностей остановки. Поддержка и поведение зависят от модели.

max_tokens?integer|null

Устарело

Устаревший лимит выходных токенов. Рекомендуется max_completion_tokens.

Диапазон1 <= value

max_completion_tokens?integer|null

Максимальное число генерируемых токенов, включая видимый вывод и токены рассуждения.

presence_penalty?number|null

Штраф за наличие токена в предыдущем тексте для стимулирования новых тем. Поддержка зависит от модели.

Диапазон-2 <= value <= 2

По умолчанию0

frequency_penalty?number|null

Штраф за частоту появления токена для уменьшения повторений. Поддержка зависит от модели.

Диапазон-2 <= value <= 2

По умолчанию0

logit_bias?|null

Сопоставление ID токенов со значениями смещения от -100 до 100.

logprobs?boolean|null

Возвращать ли логарифмы вероятностей выходных токенов. Поддержка зависит от модели.

По умолчаниюfalse

user?string

Устарело

Устаревший ID конечного пользователя. Для контроля безопасности используйте safety_identifier, для маршрутизации кэша — prompt_cache_key.

safety_identifier?string|null

Стабильный ID конечного пользователя для контроля безопасности и злоупотреблений. Рекомендуется хэшированное значение без персональных данных.

Длинаlength <= 64

prompt_cache_key?string|null

Стабильный ключ для повышения доли попаданий в кэш при похожих запросах. Не включайте персональные или конфиденциальные данные.

prompt_cache_options?|null

Настройки кэширования промпта на уровне запроса.

prompt_cache_retention?string|null

Устарело

Устаревшая настройка срока хранения кэша. Используйте prompt_cache_options.ttl.

Допустимые значения

"in_memory"
"24h"
null

verbosity?string|null

Подробность текстового ответа. Поддержка зависит от модели.

По умолчанию"medium"

Допустимые значения

"low"
"medium"
"high"
null

moderation?|null

Настройка стратегий модерации входа и выхода.

service_tier?string|null

Запрашиваемый уровень обслуживания. Доступность зависит от аккаунта и возможностей вышестоящего сервиса.

По умолчанию"auto"

Допустимые значения

"auto"
"default"
"flex"
"scale"
"priority"
"fast"
null

stream_options?|null

Параметры потокового ответа, используемые только при stream: true.

response_format?||

Формат вывода модели. Поддержка структурированного вывода зависит от выбранной модели.

seed?integer|null

Устарело

Бета-параметр для более детерминированного семплирования; полная детерминированность не гарантируется.

tools?array<|>

Список инструментов, которые может вызывать модель.

Элементыitems <= 128

functions?array<>

Устарело

Устаревшие определения функций. Рекомендуется tools.

tool_choice?|||

Управляет выбором инструмента, включая принудительный вызов и ограниченные наборы инструментов.

function_call?|

Устарело

Устаревший параметр выбора функции. Рекомендуется tool_choice.

parallel_tool_calls?boolean

Разрешать ли модели несколько параллельных вызовов инструментов в одном ответе.

По умолчаниюtrue

stream?boolean|null

При true блоки Chat Completions передаются постепенно через Server-Sent Events.

По умолчаниюfalse

top_logprobs?integer|null

Число наиболее вероятных токенов для каждой позиции. Также задайте logprobs: true; поддержка зависит от модели.

Диапазон0 <= value <= 20

web_search_options?

Изображения и аудио доступны только моделям с поддержкой соответствующих модальностей. Учитывайте доступные вашему аккаунту модели и фактические возможности API.

Тело ответа

`application/json`

curl -X POST "https://example.com/v1/chat/completions" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "messages": [      {        "role": "user",        "content": "Здравствуйте! Представьтесь одним предложением."      }    ]  }'

{
  "id": "chatcmpl_example",
  "object": "chat.completion",
  "created": 1741569952,
  "model": "MODEL_ID",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Здравствуйте! Чем я могу вам помочь?",
        "refusal": null,
        "annotations": []
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 19,
    "completion_tokens": 10,
    "total_tokens": 29,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "audio_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  }
}

Официальная документация OpenAI Chat CompletionsСмотрите определение исходного протокола и последние изменения полей.

Аутентификация

Тело запроса

Тело ответа

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

502application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`