Create share link

Create a Voice Orb link so anyone with it can talk to an agent in the browser.

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

Creates a Voice Orb share link for an agent. Open url_path on the dashboard host (https://<dashboard host>/orb/<token>) to talk to the agent without logging in. Calls made from the page are billed to your workspace, so delete the link when you no longer need it. See Share a Voice Orb link.

The page itself uses the public share endpoints, which take the token instead of an API key.

Request#

Path parameters#

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

There is no body.

Example request#

curl -X POST "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", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const link = await res.json();

import os, requests

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

Response#

201 Created with the share link object.

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

The token is 12 random bytes encoded as base64url (16 characters).

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.
`404`	`Agent <agent_id> not found`.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.