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 та авторизація не змінювалися.