Skip to main content
GET
/
v1
/
share-links
/
{id}
get share link
curl --request GET \
  --url https://api.anam.ai/v1/share-links/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "token": "sh_2kL9pQxYzR4vN8mBwHfJc",
  "type": "LINK",
  "expiresAt": "2026-04-27T10:00:00.000Z",
  "usageLimit": 10,
  "usageCount": 3,
  "allowedOrigins": [],
  "allowAllOrigins": false,
  "removeWatermark": false,
  "enabled": true,
  "isPrimary": false,
  "createdAt": "2026-04-20T10:00:00.000Z",
  "personaId": "00000000-0000-0000-0000-000000000000",
  "personaName": "Cara",
  "organizationId": "00000000-0000-0000-0000-000000000000"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Share link ID

Response

Successfully retrieved share link

A share link as returned by list and get endpoints — includes persona details for the link's target.

​
id
string<uuid>

Unique identifier for the share link.

​
token
string

Opaque token appended to the public URL.

​
type
enum<string>

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

Available options:
LINK,
PLAYER_EMBED,
ORB_EMBED
​
expiresAt
string<date-time> | null

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

​
usageLimit
integer | null

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

​
usageCount
integer

Number of times the link has been used.

​
allowedOrigins
string[]

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

​
allowAllOrigins
boolean

Whether the link can be embedded on any origin.

​
removeWatermark
boolean

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

​
enabled
boolean

Whether the link currently accepts connections.

​
isPrimary
boolean

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

​
createdAt
string<date-time>

Timestamp when the share link was created.

​
personaId
string<uuid>

ID of the persona this link points to.

​
personaName
string

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

​
organizationId
string

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

Last modified on April 22, 2026