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

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

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

Работа с API

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

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

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

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

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

ORLIME GATEWAY / API REFERENCE

Chat Completions

Текстовый диалог в формате messages. Подходит для существующих интеграций Chat Completions, потокового текста и моделей с поддержкой функций.

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

Заголовки #

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/chat/completions

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

modelstringОбязательно
Публичный ID из GET /v1/models. Возможности и допустимые параметры смотрите в карточке модели.
messagesarrayОбязательно
История и текущий запрос. Порядок сообщений имеет значение.
messages[].rolestringОбязательно
system/developer — инструкции, user — пользователь, assistant — модель, tool — результат функции. Поддержка ролей зависит от модели.
messages[].contentstring | array | nullПо типу сообщения
Текст или массив частей: {type:"text",text:"…"}, {type:"image_url",image_url:{url:"…"}}. Для вызова инструмента content может быть null. Изображения должны содержать действительные данные поддерживаемого формата.
messages[].tool_calls / tool_call_idarray / stringДля инструментов
Передайте assistant.tool_calls из ответа и связанное tool-сообщение с тем же tool_call_id.
max_completion_tokens / max_tokensinteger > 0Необязательно
Предел выходных токенов. Выберите параметр, поддерживаемый моделью; не передавайте противоречащие лимиты. Reasoning входит в этот бюджет.
streambooleanПо умолчанию false
false возвращает один JSON; true — поток Server-Sent Events.
stream_options.include_usagebooleanНеобязательно
Запрашивает статистику в финальном блоке SSE. Gateway также добавляет итоговую стоимость, когда она подтверждена.
temperature / top_pnumberПри поддержке модели
Управление разнообразием. Обычно меняют один параметр. Некоторые reasoning-модели их не принимают.
toolsarrayНеобязательно
Функции в формате {type:"function",function:{name,description,parameters,strict}}. parameters — JSON Schema.
tool_choicestring | objectНеобязательно
auto, none, required или {type:"function",function:{name:"lookup"}}. Доступность зависит от модели.
parallel_tool_callsbooleanНеобязательно
Разрешение нескольких вызовов функций за один ответ.
reasoning_effortstringПри поддержке модели
Глубина рассуждений, например medium. Допустимые уровни зависят от модели.
response_formatobjectПри поддержке модели
Структурированный результат: {type:"json_schema",json_schema:{name,strict,schema}}; для простого JSON — {type:"json_object"}.
cache_controlobjectПри поддержке моделью
У Claude: {type:"ephemeral",ttl:"5m"} или ttl:"1h" на запросе, текстовом блоке или инструменте. Кэшируется повторяемый префикс достаточной длины.

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

cURL
curl --fail-with-body https://gateway.orlime.ru/v1/chat/completions \
  -H "Authorization: Bearer $ORLIME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "openai/gpt-6.1-sol",
  "messages": [
    {
      "role": "user",
      "content": "Объясни, что такое API, в одном предложении."
    }
  ],
  "max_completion_tokens": 2048,
  "stream": false
}'

Ответ #

idstringВ ответе
Идентификатор ответа Gateway. Для текстовых запросов совпадает с заголовком x-request-id. Используйте для обращения в поддержку.
objectstringВсегда
chat.completion для JSON; chat.completion.chunk для SSE.
created / modelinteger / stringЕсли доступно / всегда
Unix-время создания и публичный ID модели.
choicesarrayВсегда
Варианты ответа; в финальном блоке статистики SSE массив пустой.
choices[].indexintegerЕсли доступно
Номер варианта.
choices[].messageobjectВ JSON
role, content, refusal, tool_calls. Возможны audio, annotations, images при поддержке модели.
choices[].deltaobjectВ SSE
Только очередное изменение сообщения. Части content и function.arguments необходимо собирать по порядку.
choices[].finish_reasonstring | nullЕсли доступно
stop, length, tool_calls, function_call, content_filter; null означает, что генерация продолжается.
choices[].logprobsobject | nullЕсли запрошено и поддерживается
Вероятности токенов content/refusal и альтернативы top_logprobs.
message.reasoning / reasoning_content / reasoning_detailsstring | array | nullПри поддержке модели
Рассуждения и непрозрачные блоки для продолжения диалога. Сохраняйте reasoning_details без изменений.
usageobjectЕсли доступно
prompt_tokens, completion_tokens, total_tokens; детали кэша и reasoning — во вложенных *_tokens_details.
usage.cost_rubstringЕсли расчёт завершён
Сумма фактического списания в рублях за весь запрос. Десятичная строка с 12 знаками после запятой. Отсутствие поля не означает бесплатный запрос.
JSON
{
  "id": "d2075c15-6fde-4ba8-bfd7-a246f58bce11",
  "object": "chat.completion",
  "created": 1795161600,
  "model": "openai/gpt-6.1-sol",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "API — интерфейс для обмена данными между программами."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 24,
    "completion_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Если возвращён
Число секунд до рекомендуемого повтора. Отсутствие заголовка не означает, что запрос следует немедленно повторять.

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

  • Для вызова функций у моделей, требующих Responses API, используйте /v1/responses.
Также смотрите потоковые ответы, цикл работы с инструментами и продолжение диалога.

Ошибки #

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

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