List share links

List an agent's Voice Orb share links.

GEThttps://api.tried.com.au/agents/{agent_id}/share-links

Returns the agent's Voice Orb share links, newest first. A share link is a public page where anyone with the link can talk to the agent in the browser. See Share a Voice Orb link.

Request#

Path parameters#

Parameter	Type	Required	Description
`agent_id`	string	Yes	The agent.

Example request#

curl "https://api.tried.com.au/agents/agent_3f9a1c0b2d4e5f6a7b8c9d0e/share-links" \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/agents/agent_3f9a1c0b2d4e5f6a7b8c9d0e/share-links", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const links = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/agents/agent_3f9a1c0b2d4e5f6a7b8c9d0e/share-links",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
links = res.json()

Response#

200 OK with an array of share links.

[
  {
    "share_link_id": "share_8d2f4a6c1e3b5d7f9a0c2e4b",
    "agent_id": "agent_3f9a1c0b2d4e5f6a7b8c9d0e",
    "token": "q3Zx8LmN0pRtUvWy",
    "enabled": true,
    "url_path": "/orb/q3Zx8LmN0pRtUvWy",
    "created_timestamp": 1792310400000
  }
]

Field	Type	Description
`share_link_id`	string	Starts with `share_`. Use it to delete the link.
`agent_id`	string	The agent the link talks to.
`token`	string	The secret part of the link. Anyone who has it can call the agent, billed to your workspace.
`enabled`	boolean	Whether the link works. New links are enabled.
`url_path`	string	Path of the Voice Orb page on the dashboard host: `/orb/<token>`.
`created_timestamp`	integer	Unix ms.

An agent with no links, or an agent_id that is not in your workspace, returns an empty array.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `agents` scope.
`429`	Rate limit exceeded. See Rate limits.