Создать чат-завершение

post/v1/chat/completions

Создаёт ответ модели на основе истории диалога. Поддерживаются как потоковые, так и непотоковые ответы.

Совместимо с OpenAI Chat Completions API.

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

Передавайте ключ API OLETOKEN как Bearer-токен. Ключи создаются на странице «Ключи API» в консоли.

Authorization: Bearer $OLETOKEN_API_KEY

Тело запроса

Content-Type:application/json

ПолеТипОбязательныйОписание
modelstringID модели
messagesMessage[]Сообщения диалога
rolestringsystemuserassistanttooldeveloperРоль сообщения
contentstring | MessageContent[]Содержимое сообщения
typestringtextimage_urlinput_audiofilevideo_url——
textstring——
image_urlobject——
urlstring—URL изображения или данные base64
detailstringlowhighauto——
input_audioobject——
datastring—Аудиоданные в кодировке Base64
formatstringwavmp3——
fileobject——
filenamestring——
file_datastring——
file_idstring——
video_urlobject——
urlstring——
namestring—Имя отправителя
tool_callsToolCall[]——
idstring——
typestring——
functionobject——
namestring——
argumentsstring——
tool_call_idstring—ID вызова инструмента (для сообщений с ролью tool)
reasoning_contentstring—Содержимое рассуждений
temperaturenumber0–2default: 1—Температура сэмплирования
top_pnumber0–1default: 1—Параметр nucleus sampling
ninteger≥ 1default: 1—Количество генерируемых завершений
streambooleandefault: false—Передавать ли ответ потоково
stream_optionsobject——
include_usageboolean——
stopstring | string[]—Стоп-последовательности
max_tokensinteger—Максимальное количество генерируемых токенов
max_completion_tokensinteger—Максимальное количество токенов завершения
presence_penaltynumber-2–2default: 0——
frequency_penaltynumber-2–2default: 0——
logit_biasobject——
userstring——
toolsTool[]——
typestring——
functionobject——
namestring——
descriptionstring——
parametersobject—Определения параметров в формате JSON Schema
tool_choicestring | objectnoneautorequired——
typestring——
functionobject——
namestring——
response_formatResponseFormat——
typestringtextjson_objectjson_schema——
json_schemaobject—Определение JSON Schema
seedinteger——
reasoning_effortstringlowmediumhigh—Уровень рассуждений (для моделей, поддерживающих рассуждения)
modalitiesstring[]——
audioobject——
voicestring——
formatstring——

Ответы

200Ответ создан

ПолеТипОбязательныйОписание
idstring——
objectstring——
createdinteger——
modelstring——
choicesobject[]——
indexinteger——
messageMessage——
rolestringsystemuserassistanttooldeveloperРоль сообщения
contentstring | MessageContent[]Содержимое сообщения
typestringtextimage_urlinput_audiofilevideo_url——
textstring——
image_urlobject——
urlstring—URL изображения или данные base64
detailstringlowhighauto——
input_audioobject——
datastring—Аудиоданные в кодировке Base64
formatstringwavmp3——
fileobject——
filenamestring——
file_datastring——
file_idstring——
video_urlobject——
urlstring——
namestring—Имя отправителя
tool_callsToolCall[]——
idstring——
typestring——
functionobject——
namestring——
argumentsstring——
tool_call_idstring—ID вызова инструмента (для сообщений с ролью tool)
reasoning_contentstring—Содержимое рассуждений
finish_reasonstringstoplengthtool_callscontent_filter——
usageUsage——
prompt_tokensinteger—Количество токенов запроса
completion_tokensinteger—Количество токенов завершения
total_tokensinteger—Общее количество токенов
prompt_tokens_detailsobject——
cached_tokensinteger——
text_tokensinteger——
audio_tokensinteger——
image_tokensinteger——
completion_tokens_detailsobject——
text_tokensinteger——
audio_tokensinteger——
reasoning_tokensinteger——
system_fingerprintstring——

400Недопустимые параметры запроса

ПолеТипОбязательныйОписание
errorobject——
messagestring—Сообщение об ошибке
typestring—Тип ошибки
paramstring | null—Затронутый параметр
codestring | null—Код ошибки

429Превышен лимит запросов

ПолеТипОбязательныйОписание
errorobject——
messagestring—Сообщение об ошибке
typestring—Тип ошибки
paramstring | null—Затронутый параметр
codestring | null—Код ошибки

Пример запроса

curl -X POST 'https://api.oletoken.ai/v1/chat/completions' \
  -H "Authorization: Bearer $OLETOKEN_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "gpt-4",
    "messages": []
  }'