Текст

Оценка резерва текстового запроса

POST/v1/chat/quote

Право text. Та же оценка, что при приёме запроса; без резерва, вызова модели и записи в историю. Оценка токенов приблизительная. Тариф проверяется заново при отправке; max_cost_microrub ограничивает разрешённую оценку резерва.

Авторизация

Authorizationstringобязательный

Ключ API в заголовке Authorization: Bearer <ключ>. Ключ создаётся в кабинете, подробнее — в разделе Аутентификация.

Тело запроса

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

Имена функций уникальны. tool_choice с именем должен ссылаться на объявленную функцию. content:null у assistant допустим только вместе с tool_calls. Изображения, top_p, json_schema, hosted tools и неизвестные поля отклоняются до admission.

modelstringобязательныйдлина 1–200
messagesobject[]обязательныйэлементов 1–1000
Вложенные поля
Один из вариантов
role: "system" | "user"
rolestringобязательный
Значения: "system" "user"
contentstringобязательный
namestringдлина 1–256
role: "assistant"
role"assistant"обязательный
contentstring | nullобязательный
namestringдлина 1–256
tool_callsobject[]элементов 1–128
Вложенные поля
idstringобязательныйдлина 1–512
type"function"обязательный
functionobjectобязательный
Вложенные поля
namestringобязательныйшаблон ^[a-zA-Z0-9_-]{1,64}$
argumentsstringобязательныйдлина 0–100000
role: "tool"
role"tool"обязательный
contentstringобязательный
tool_call_idstringобязательныйдлина 1–512
namestringдлина 1–256
max_tokensintegerпо умолчанию 2048 · 1 … 32768
temperaturenumber0 … 2
streambooleanпо умолчанию false
toolsobject[]элементов 1–128
Вложенные поля
type"function"обязательный
functionobjectобязательный
Вложенные поля
namestringобязательныйшаблон ^[a-zA-Z0-9_-]{1,64}$
parametersobjectобязательный

Ограниченная JSON Schema: корневой type object; типы object/array/string/number/integer/boolean/null. Ключи type, description (до 2000), properties (до 100), required, additionalProperties (boolean), items, enum (до 100 примитивов). Глубина до 6. $ref, внешние ресурсы, pattern, combinators не поддерживаются. Required ссылается только на объявленные свойства.

Вложенные поля
type"object"обязательный
descriptionstringдлина 0–2000
tool_choicestring | object
Вложенные поля
Один из вариантов
type: "function"
type"function"обязательный
functionobjectобязательный
Вложенные поля
namestringобязательный
response_formatobject
Вложенные поля
typestringобязательный
Значения: "text" "json_object"

Ответы

200Оценка без платной отправки, действительная 30 секунд

application/json

modelstringобязательный
operation"chat"обязательный
currency"RUB"обязательный
unit"request"обязательный
estimated_cost_microrubintegerобязательный0 … 9007199254740991
input_tokens_estimateintegerобязательный1 … ∞
max_output_tokensintegerобязательный1 … 32768
expires_atstringобязательныйdate-time
reservation_createdfalseобязательный
estimation_onlytrueобязательный
ОшибкаДоступ запрещён, параметры не поддерживаются, превышен максимум или модель недоступна

application/json

errorobjectобязательный
Вложенные поля
codestringобязательный
messagestringобязательный
request_idstring
typestring
Esc
↑↓ выбратьEnter открытьEsc закрыть