Skip to content

Адреса API ​

С AGNT2-552 у API Agentfy та же схема адресов, что у всех продуктов на ядре (Bonsite, Securify, Shiffty, Store Deputy).

  • Все бизнес-маршруты отвечают под /v1: /v1/agents/…, /v1/teams/:teamId/…, /v1/auth/…, /v1/admin/…. Партнёрский API остался ровно там же: /v1/orgs/….
  • Swagger UI — на /docs, его JSON — на /docs-json.
  • Несколько точек входа — без версии: их адрес записан вне этого репозитория — в пробе, в кабинете платёжного провайдера, в уже выданной ссылке, на сервере клиента. Они перечислены с причиной в NEUTRAL_ROUTES (api/src/slices/setup/core/routing/apiRoute.ts), а тест сверяет этот список с роутером в обе стороны:
МаршрутПочему без версии
GET /healthпробы готовности и живости, .orca/verify.sh, демо
POST /billing/webhookадрес вебхука у платёжного провайдера
POST /a2a/v1/agents/:idA2A-адрес внутри карточек агентов (v1 здесь — версия протокола)
GET /agent-cards/:token, GET /agents/:id/card/well-knownссылки на карточку, которые читают чужие агенты
POST /agents/:id/channels/bridle/visitorвыпуск билета по embed-ключу, его вызывает бэкенд вашего сайта
GET /files/:id/contentуже отправленные подписанные ссылки на файлы
GET /canvases/…, GET /published/…уже выданные подписанные ссылки на артефакты и опубликованные страницы

Канал воркера (/runtime/control, /runtime/device — WebSocket) и хаб Bridle (/visitor, /ws/client на своём порту) — не маршруты Nest, они не переезжали.

Старые адреса ​

До 2026-12-31 безверсионные адреса продолжают отвечать: /agents/… читается как /v1/agents/…, /admin/v1/orgs/… — как /v1/admin/orgs/…, /api — как /docs. Ответ — ответ нового маршрута, плюс два заголовка:

Deprecation: true
Link: </v1/agents/…>; rel="successor-version"

API пишет в лог каждый старый маршрут один раз. Чтобы перевести клиента, добавьте /v1 перед путём; тела ответов, конверт ошибок, id и авторизация не менялись.