Documentation Index

Получите полный индекс документации по адресу: https://api.vega.chat/docs/llms.txt Используйте этот файл, чтобы узнать все доступные страницы перед дальнейшим изучением.

Как версионируется API VEGA, что мы считаем критическим изменением и как сообщаются устаревания.

Текущая версия

API VEGA имеет единственную стабильную версию v1, выбираемую по пути URL:

https://openrouter.ai/api/v1

Заголовков версии нет и нет привязки к дате. Все конечные точки, задокументированные в Справочнике API, являются частью v1.

Как развивается API

API меняется постоянно, а не в нумерованных выпусках. Каждое изменение отражено в спецификации OpenAPI, и каждый выпуск, изменяющий спецификацию, создает запись в Журнале изменений API.

Неблокирующие изменения выпускаются без предварительного уведомления. К ним относятся:

• Новые конечные точки
• Новые необязательные параметры запросов
• Новые поля в ответах
• Новые коды статуса ответов
• Новые схемы, а также новые необязательные свойства или варианты объединения в существующих схемах

Пишите клиентские приложения оборонительно: игнорируйте поля ответов, которые вы не распознаёте, и не вызывайте ошибку при неизвестных значениях перечислений.

Критические изменения проверяются человеком перед публикацией и появляются в журнале изменений под тегом Breaking с примечаниями по миграции. К ним относятся:

• Удаление или переименование конечной точки, параметра или поля ответа
• Изменение типа поля
• Расширение поля ответа, позволяющее null, когда ранее оно всегда присутствовало
• Превращение необязательного параметра в обязательный

Поля ответа, допускающие null

Поле ответа, которое присутствует, но имеет значение null, означает, что значение действительно отсутствует. Считайте null как «не задано» и обрабатывайте его явно. Не подставляйте значение по умолчанию и не предполагайте, что null подразумевает какое‑то конкретное резервное значение.

Например, workspace_id имеет значение null у учётных данных BYOK, которые не привязаны к какому‑либо рабочему пространству (они действуют на уровне аккаунта), а также у ограничений, созданных до появления привязки к рабочим пространствам. В обоих случаях null представляет собой отдельное состояние, отличное от привязки к вашему рабочему пространству по умолчанию. Не воспринимайте null как значение по умолчанию и не предполагайте, что ограничение с null применяется ко всем рабочим пространствам.

Поскольку клиент, предполагающий, что поле всегда присутствует, может выйти из строя, расширение поля ответа, позволяющее null, рассматривается как критическое изменение (см. список выше) и объявляется в журнале изменений с примечаниями по миграции.

Устаревание

Когда часть API помечается как устаревшая, об этом объявляется в Журнале изменений API, а затронутая конечная точка или поле помечаются как устаревшие в Справочнике API. Удаление устаревшей функции является критическим изменением и следует процессу критических изменений, описанному выше.

Доступность моделей отдельна от версионирования API: модели добавляются и удаляются провайдерами независимо. См. раздел Модели для получения списка текущих доступных моделей.

Как быть в курсе обновлений

• Следите за Журналом изменений API, который генерируется автоматически из различий спецификации OpenAPI при каждом выпуске
• Подпишитесь на RSS‑ленту для получения записей журнала изменений
• Фильтруйте записи журнала по тегу Breaking, чтобы просматривать только изменения, влияющие на совместимость