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

Read the experimental Dot agent connection and event readiness

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

Read the experimental Dot agent connection and event readiness.

Авторизация

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.
agentIdstringОбязательныйThe agent's id.

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
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. Подробнее: ошибки и ограничения.

Agents