Авторизация и заголовки
Авторизация API-ключом, заголовки запросов и ответов, идентификаторы для поддержки и форматы передачи данных.
Адрес API
https://gateway.orlime.ru/v1Все обращения выполняются по HTTPS. В примерах ключ читается из переменной окружения ORLIME_API_KEY. Ключ относится к компании и имеет собственные ограничения, которые настраиваются в личном кабинете.
Заголовки запроса
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. Синтез речи и скачивание видео возвращают бинарные данные.
Заголовки ответа
x-request-idstringОтвет Gateway- ID операции для поиска в журнале и обращения в поддержку. В Chat Completions и Responses совпадает с верхнеуровневым id ответа.
Content-TypestringОтвет Gateway- application/json, text/event-stream или MIME-тип аудио/видео. Ошибки файловых методов могут возвращаться как JSON.
Retry-AfterintegerЕсли возвращён- Число секунд до рекомендуемого повтора. Отсутствие заголовка не означает, что запрос следует немедленно повторять.
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
x-request-id: d2075c15-6fde-4ba8-bfd7-a246f58bce11Форматы данных
JSON передаётся в UTF-8. Даты API в числовом виде — Unix-секунды. Цены в рублях возвращаются десятичными строками; не округляйте их до копеек перед суммированием. Необязательное поле может отсутствовать, а nullable-поле — содержать null.
Поддержка параметров зависит от модели: наличие поля в общем API не гарантирует, что его принимает каждая модель. Выбирайте модель и её возможности в каталоге.
