Sign in
latestOpenAPI 3.1.02026-08-206635377.2 KB

dae97e8eb063

Share Links

get share link

Returns a share link by ID

get/v1/share-links/{id}

Path parameters

idstring uuid required

Share link ID

Response

Successfully retrieved share link

idstring uuid

Unique identifier for the share link.

tokenstring

Opaque token appended to the public URL.

type'LINK' | 'PLAYER_EMBED' | 'ORB_EMBED'

Kind of share link — a direct URL, a player embed, or an orb embed.

expiresAtstring date-time nullable

Timestamp after which the link no longer works, or null if the link does not expire.

usageLimitinteger nullable

Maximum number of times the link can be used, or null for unlimited.

usageCountinteger

Number of times the link has been used.

allowedOriginsstring[]

Origins permitted to load the link when embedded. Ignored when allowAllOrigins is true.

allowAllOriginsboolean

Whether the link can be embedded on any origin.

removeWatermarkboolean

Whether the persona renders without the Anam watermark. Requires a plan that permits watermark removal.

enabledboolean

Whether the link currently accepts connections.

isPrimaryboolean

Whether this is the persona's primary share link (at most one per persona).

createdAtstring date-time

Timestamp when the share link was created.

personaIdstring uuid

ID of the persona this link points to.

personaNamestring

Name of the persona at the time the link was issued.

organizationIdstring

ID of the organization that owns the link. IDs may be either UUIDs or nanoid-style strings depending on when the organization was created.