OrlimeGateway
МоделиДокументацияЗащита данныхКонтакты
Войти
Документация API

Начало работы

Быстрый стартАвторизация и заголовки

Работа с API

Потоковые ответыВызов инструментовРассуждения моделиПродолжение диалоговТокены и стоимостьОшибки и повтор запросов

Текст и данные

Список моделейGETChat CompletionsPOSTResponsesPOSTEmbeddingsPOSTРанжированиеPOSTКлассификацияPOST

Изображения, аудио и видео

Генерация изображенийPOSTСинтез речиPOSTТранскрибацияPOSTСоздание видеоPOSTСтатус видеоGETСкачивание видеоGET
Базовый адресgateway.orlime.ru/v1Открыть каталог моделей

ORLIME GATEWAY / API REFERENCE

Responses API

Единый ответ в виде элементов output: сообщения, вызовы функций, reasoning и результаты встроенных инструментов, поддерживаемых выбранной моделью.

POST/v1/responses
ЗаголовкиПараметрыПример запросаОтветОшибки

Заголовки #

AuthorizationBearer <API_KEY>Обязательно
Ключ компании из раздела «API-ключи». Храните на сервере или в переменной окружения. Не вставляйте секретный ключ в браузерный код.
Content-Typeapplication/jsonДля JSON-тела
Кодировка UTF-8. Для файлов используйте multipart/form-data; curl и SDK сами добавят boundary. Для GET и DELETE без тела не нужен.
Acceptapplication/json | text/event-streamНеобязательно
Ожидаемый формат ответа. Для включения SSE нужно также передать stream: true в JSON. Синтез речи и скачивание видео возвращают бинарные данные.

Адрес метода: https://gateway.orlime.ru/v1/responses

Входные параметры #

modelstringОбязательно
Публичный ID из GET /v1/models. Возможности и допустимые параметры смотрите в карточке модели.
inputstring | arrayОбязательно
Текущий текст или история элементов. Для продолжения с полным контекстом включайте предыдущие входные и выходные элементы.
instructionsstringНеобязательно
Отдельные инструкции для модели.
max_output_tokensinteger > 0Необязательно
Максимальное число выходных токенов вместе с reasoning.
streambooleanПо умолчанию false
false возвращает один JSON; true — поток Server-Sent Events.
reasoningobjectПри поддержке модели
effort задаёт глубину; summary — способ выдачи сводки. Набор значений зависит от модели.
includearray of stringsПри поддержке модели
Например ["reasoning.encrypted_content"] для продолжения без хранения состояния на стороне модели.
toolsarrayНеобязательно
Функция: {type:"function",name,description,parameters,strict}. В отличие от Chat Completions нет вложенного объекта function.
tool_choicestring | objectНеобязательно
auto, none, required либо {type:"function",name:"lookup"}.
parallel_tool_callsbooleanНеобязательно
Разрешение параллельных вызовов инструментов.
text.formatobjectПри поддержке модели
Структурированный ответ: {type:"json_schema",name,strict,schema}.
storebooleanПри поддержке маршрута
Запрос на хранение состояния. Для передачи полной истории используйте false. Этот параметр не включает поддержку previous_response_id в Gateway.
previous_response_idstring | nullНе поддерживается
Продолжение по ID не поддерживается. Не передавайте ID предыдущего ответа; передавайте полную историю в input.
temperature / top_pnumberПри поддержке модели
Параметры разнообразия; передавайте только поддерживаемые моделью значения.

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

cURL
curl --fail-with-body https://gateway.orlime.ru/v1/responses \
  -H "Authorization: Bearer $ORLIME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "openai/gpt-6.1-sol",
  "input": "Объясни, что такое API, в одном предложении.",
  "max_output_tokens": 2048,
  "reasoning": {
    "effort": "medium"
  },
  "stream": false
}'

Ответ #

idstringВ ответе
Идентификатор ответа Gateway. Для текстовых запросов совпадает с заголовком x-request-id. Используйте для обращения в поддержку.
object"response"Всегда
Тип ответа.
model / created_at / completed_atstring / number / number | nullПо доступности
Публичная модель и Unix-время.
statusstringЕсли доступно
completed, in_progress, queued, incomplete, failed или cancelled.
outputarrayВсегда
Типизированные элементы. Не предполагается, что первый элемент обязательно содержит текст.
output[].typestringВсегда у элемента
message, reasoning, function_call, custom_tool_call и поддерживаемые встроенные вызовы: web_search_call, file_search_call, computer_call, code_interpreter_call, image_generation_call, mcp_*.
output[].contentarrayДля message
Текст находится в частях {type:"output_text",text,annotations}. Отказ — в части refusal.
output[].call_id / name / argumentsstringДля function_call
Связь вызова с результатом функции, её имя и JSON-строка аргументов.
output[].summary / encrypted_contentarray / string | nullДля reasoning
Сводка рассуждений и непрозрачные данные продолжения. Не редактируйте encrypted_content, подпись или формат.
previous_response_idstring | nullВсегда
При передаче полной истории в input возвращается null. Продолжение по ID не поддерживается.
error / incomplete_detailsobject | nullПо состоянию
Ошибка либо причина неполного ответа: max_output_tokens или content_filter.
usageobject | nullЕсли доступно
input_tokens, output_tokens, total_tokens и вложенные детали кэша и reasoning.
usage.cost_rubstringЕсли расчёт завершён
Сумма фактического списания в рублях за весь запрос. Десятичная строка с 12 знаками после запятой. Отсутствие поля не означает бесплатный запрос.
JSON
{
  "id": "d2075c15-6fde-4ba8-bfd7-a246f58bce11",
  "object": "response",
  "model": "openai/gpt-6.1-sol",
  "status": "completed",
  "previous_response_id": null,
  "error": null,
  "output": [
    {
      "id": "msg_example",
      "type": "message",
      "role": "assistant",
      "status": "completed",
      "content": [
        {
          "type": "output_text",
          "text": "API связывает программы.",
          "annotations": []
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 24,
    "output_tokens": 12,
    "total_tokens": 36,
    "cost_rub": "0.012345678900"
  }
}
Заголовки ответа
x-request-idstringОтвет Gateway
ID операции для поиска в журнале и обращения в поддержку. В Chat Completions и Responses совпадает с верхнеуровневым id ответа.
Content-TypestringОтвет Gateway
application/json, text/event-stream или MIME-тип аудио/видео. Ошибки файловых методов могут возвращаться как JSON.
Retry-AfterintegerЕсли возвращён
Число секунд до рекомендуемого повтора. Отсутствие заголовка не означает, что запрос следует немедленно повторять.

Особенности #

  • У элемента output свой ID. Он отличается от ID всего ответа; сохраняйте его и call_id без изменений.
  • Поле output_text в некоторых SDK является удобным вычисляемым свойством. В HTTP JSON читайте output[].content[].text.
  • Неизвестный тип результата не передаётся клиенту произвольно: Gateway сообщает об ошибке обработки. Поддержка встроенного инструмента дополнительно зависит от модели.
Также смотрите потоковые ответы, цикл работы с инструментами и продолжение диалога.

Ошибки #

Ошибки возвращаются в объекте error с полями message, type, code и param. Сохраните x-request-id для поиска запроса. Формат и справочник ошибок

Предыдущий разделChat CompletionsСледующий раздел Embeddings
© 2026 Orlime Gateway
ДокументацияКонтактыTelegramЗащита данныхПолитика конфиденциальностиСогласие на обработку персональных данныхПубличная офертаФайлы cookie