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

Create an external identity-link intent

POST/api/chat-endpoints/{endpointId}/principals/{principalId}/link-intent
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Create an external identity-link intent.

Creates a short-lived confirmation URL for a human external identity belonging to this endpoint. The signed-in Veyra Intelligence user must confirm the link separately.

Авторизация

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.

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

endpointIdstring (uuid)ОбязательныйThe endpoint's id.
principalIdstring (uuid)ОбязательныйThe principal's id.

Тело запроса

application/json · обязательно

expiresInSecondsintegerНеобязательный≥ 300≤ 86400

Ответы

201SuccessCreated; the body holds the new resource.
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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

Chat channels