API reference / Share links
Share links
Create a visitor link or website embed for a published Persona. Visitors use the link's consent and session flow without receiving your API key.
Owner endpoints
These routes require the signed-in Persona owner, not a streaming token or a general SDK API key.
| Method | Path | Purpose |
|---|---|---|
| GET | /auth/personas/{personaId}/links | List links |
| POST | /auth/personas/{personaId}/links | Create a link or embed |
| PATCH | /auth/personas/{personaId}/links/{linkId} | Update version, expiry, theme or allowed origins |
| DELETE | /auth/personas/{personaId}/links/{linkId} | Revoke access |
| POST | /auth/personas/{personaId}/links/{linkId}/preview | Owner preview of an embed |
Version and lifetime
kind is link or embed. version_pin is latest or a published version number. expires_at can limit the link's lifetime. A link never serves an unpublished draft. Revocation prevents new access; do not treat an unguessable URL as a substitute for revocation when access must end.
The portal's Share tab creates links and copies the correct visitor URL. Conversation availability is checked separately from publication; a link does not guarantee immediate session capacity.
Website embeds
Embeds require allowed_origins. Enter only the websites you intend to authorize; the browser enforces the embed's origin restrictions. Keep the generated integrity attribute when copying the loader snippet. See Embed a Persona on your website for supported origins, layout options and preview behavior.
SDK sessions
A Persona link is separate from an existing SDK stream. To add streaming to your own authenticated application, mint a short-lived token on your backend and connect with the JavaScript SDK.