Справочник API публикуется на английском языке.

Get decision settings, compatible connections, and manager capability

GET/api/companies/{companyId}/decision-model
Personal API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Get decision settings, compatible connections, and manager capability.

People who manage connections configure, enable and test this in the Decision model section of the organization-prefixed /company/settings/connections page; link it as a Markdown link to //company/settings/connections, not the general /company/settings page. Agent credentials cannot change or test it.

Авторизация

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Ответы

200SuccessThe request worked; the body holds the result.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Decision models