API referansı İngilizce yayımlanır.
Create an external identity-link intent
POST
/api/chat-endpoints/{endpointId}/principals/{principalId}/link-intentPersonal API keyAgent API keyConsole session
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.
Yetkilendirme
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. Anahtarlar nasıl çalışır.
Yol parametreleri
endpointIdstring (uuid)ZorunluThe endpoint's id.
principalIdstring (uuid)ZorunluThe principal's id.
İstek gövdesi
application/json · zorunlu
expiresInSecondsintegerİsteğe bağlı
≥ 300≤ 86400Yanıtlar
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).
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.