Returns what a Voice Orb page needs to show before the visitor starts talking. The share token in the path is the only credential: there is no API key and no Origin check. Create tokens with Create share link. See Share a Voice Orb link.
Request#
Path parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
token |
string | Yes | The share link's token. |
Example request#
curl "https://api.tried.com.au/public/share/q3Zx8LmN0pRtUvWy"const res = await fetch("https://api.tried.com.au/public/share/q3Zx8LmN0pRtUvWy");
const share = await res.json();import requests
res = requests.get("https://api.tried.com.au/public/share/q3Zx8LmN0pRtUvWy")
share = res.json()Response#
200 OK
{
"agent_name": "Front Desk",
"workspace_name": "Harbour Dental",
"voice_id": "11labs-Adrian",
"audio_available": true
}| Field | Type | Description |
|---|---|---|
agent_name |
string | The agent's name. |
workspace_name |
string or null | The workspace that owns the agent. |
voice_id |
string or null | The agent's voice. |
audio_available |
boolean | false when the API runs without LiveKit. Voice calls are then not possible and the page should use Share link chat. |
Errors#
| Status | When |
|---|---|
404 |
This link is not active (unknown or disabled token), or the agent no longer exists. |
429 |
Per-IP rate limit exceeded. See Rate limits. |
See Errors for the body format.