curl --request GET \
--url https://api.anam.ai/v1/share-links/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.anam.ai/v1/share-links/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.anam.ai/v1/share-links/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anam.ai/v1/share-links/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.anam.ai/v1/share-links/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.anam.ai/v1/share-links/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anam.ai/v1/share-links/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}get share link
Returns a share link by ID
curl --request GET \
--url https://api.anam.ai/v1/share-links/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.anam.ai/v1/share-links/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.anam.ai/v1/share-links/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anam.ai/v1/share-links/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.anam.ai/v1/share-links/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.anam.ai/v1/share-links/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anam.ai/v1/share-links/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
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.
Unique identifier for the share link.
Opaque token appended to the public URL.
Kind of share link — a direct URL, a player embed, or an orb embed.
LINK, PLAYER_EMBED, ORB_EMBED Timestamp after which the link no longer works, or null if the link does not expire.
Maximum number of times the link can be used, or null for unlimited.
Number of times the link has been used.
Origins permitted to load the link when embedded. Ignored when allowAllOrigins is true.
Whether the link can be embedded on any origin.
Whether the persona renders without the Anam watermark. Requires a plan that permits watermark removal.
Whether the link currently accepts connections.
Whether this is the persona's primary share link (at most one per persona).
Timestamp when the share link was created.
ID of the persona this link points to.
Name of the persona at the time the link was issued.
ID of the organization that owns the link. IDs may be either UUIDs or nanoid-style strings depending on when the organization was created.
Was this page helpful?

