К содержимому

HTTP API ​

Справочник построен из OpenAPI Orpheus. Описания переведены на русский. В блоках JSON Schema сохранён исходный контракт.

Авторизация, ошибки и повторы · Пример интеграции · Схемы данных

OpenAPI YAML

МетодАдресОперация
GET/api/v1/profilesКаталог профилей
POST/api/v1/profilesСоздание профиля
GET/api/v1/profiles/{id}Получение профиля
PATCH/api/v1/profiles/{id}Изменение профиля
DELETE/api/v1/profiles/{id}Удаление профиля
GET/api/v1/llm-accountsКаталог LLM-аккаунтов
POST/api/v1/llm-accountsСоздание LLM-аккаунта
GET/api/v1/llm-accounts/{id}Получение LLM-аккаунта
PATCH/api/v1/llm-accounts/{id}Изменение LLM-аккаунта
DELETE/api/v1/llm-accounts/{id}Удаление LLM-аккаунта
GET/api/v1/credential-storesХранилища авторизации
PUT/api/v1/llm-accounts/{id}/api-keyЗамена API-ключа аккаунта
GET/api/v1/llm-accounts/{id}/auth-fileФайл авторизации аккаунта
PUT/api/v1/llm-accounts/{id}/auth-fileЗамена файла авторизации аккаунта
GET/api/v1/templatesКаталог шаблонов
POST/api/v1/templatesРегистрация шаблона
GET/api/v1/templates/{id}Получение шаблона
PATCH/api/v1/templates/{id}Изменение шаблона
DELETE/api/v1/templates/{id}Удаление шаблона
GET/api/v1/servicesКаталог сервисов
GET/api/v1/accounts/limitsЛимиты аккаунтов
GET/api/v1/analytics/overviewОбзор аналитики
GET/api/v1/auth/sessionБраузерная сессия
GET/auth/loginВход через SSO
POST/auth/callbackОтвет SAML
POST/auth/logoutВыход
GET/saml/metadataМетаданные SAML
GET/api/v1/runsВсе запуски
GET/api/v1/sessionsСписок сессий
POST/api/v1/sessionsСоздание сессии
GET/api/v1/sessions/{sid}Получение сессии
GET/api/v1/sessions/{sid}/eventsСобытия сессии
GET/api/v1/sessions/{sid}/events/streamПоток событий SSE
GET/api/v1/sessions/{sid}/historyИстория сессии
GET/api/v1/sessions/{sid}/runsЗапуски сессии
POST/api/v1/sessions/{sid}/runsНовый запуск
GET/api/v1/sessions/{sid}/runs/{rid}Получение запуска
POST/api/v1/sessions/{sid}/runs/{rid}/cancelОтмена запуска
POST/api/v1/sessions/{sid}/runs/{rid}/messagesУточнение работающему агенту