curl -X POST https://backend.talking-avatar.dev/api/talking-avatar/voice-agents/AGENT_ID/links \
-H "Authorization: Bearer $TALKING_AVATAR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Interview with Jane", "expiresAt": "2026-11-02T09:00:00Z", "maxUses": 1}'
import { createAgentLink } from "@interviewflowai/talking-avatar/server";
const link = await createAgentLink({
apiKey: process.env.TALKING_AVATAR_API_KEY,
agentId: "AGENT_ID",
name: "Interview with Jane",
expiresAt: "2026-11-02T09:00:00Z",
maxUses: 1,
});
import os, requests
response = requests.post(
"https://backend.talking-avatar.dev/api/talking-avatar/voice-agents/AGENT_ID/links",
headers={"Authorization": f"Bearer {os.environ['TALKING_AVATAR_API_KEY']}"},
json={"name": "Interview with Jane", "expiresAt": "2026-11-02T09:00:00Z", "maxUses": 1},
)
response.raise_for_status()
link = response.json()["data"]
{
"data": {
"id": "6f2c1b0e-4d7a-4a51-9a3e-2b8c7d1e9f40",
"name": "Interview with Jane",
"token": "q3N1dGh4YkVwV2Zz…",
"url": "https://app.talking-avatar.dev/agent/AGENT_ID?token=q3N1dGh4YkVwV2Zz…",
"expires_at": "2026-11-02T09:00:00+00:00",
"max_uses": 1,
"uses": 0,
"created_at": "2026-10-26T10:15:00+00:00"
},
"code": 201,
"message": "Link created"
}
{ "code": 400, "message": "expiresAt must be in the future, and within a year" }
{ "code": 404, "message": "Voice agent not found" }
Private agent links
Create a link
Make a link that lets someone call a private voice agent until it expires or runs out of calls.
POST
/
api
/
talking-avatar
/
voice-agents
/
{agentId}
/
links
curl -X POST https://backend.talking-avatar.dev/api/talking-avatar/voice-agents/AGENT_ID/links \
-H "Authorization: Bearer $TALKING_AVATAR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Interview with Jane", "expiresAt": "2026-11-02T09:00:00Z", "maxUses": 1}'
import { createAgentLink } from "@interviewflowai/talking-avatar/server";
const link = await createAgentLink({
apiKey: process.env.TALKING_AVATAR_API_KEY,
agentId: "AGENT_ID",
name: "Interview with Jane",
expiresAt: "2026-11-02T09:00:00Z",
maxUses: 1,
});
import os, requests
response = requests.post(
"https://backend.talking-avatar.dev/api/talking-avatar/voice-agents/AGENT_ID/links",
headers={"Authorization": f"Bearer {os.environ['TALKING_AVATAR_API_KEY']}"},
json={"name": "Interview with Jane", "expiresAt": "2026-11-02T09:00:00Z", "maxUses": 1},
)
response.raise_for_status()
link = response.json()["data"]
{
"data": {
"id": "6f2c1b0e-4d7a-4a51-9a3e-2b8c7d1e9f40",
"name": "Interview with Jane",
"token": "q3N1dGh4YkVwV2Zz…",
"url": "https://app.talking-avatar.dev/agent/AGENT_ID?token=q3N1dGh4YkVwV2Zz…",
"expires_at": "2026-11-02T09:00:00+00:00",
"max_uses": 1,
"uses": 0,
"created_at": "2026-10-26T10:15:00+00:00"
},
"code": 201,
"message": "Link created"
}
{ "code": 400, "message": "expiresAt must be in the future, and within a year" }
{ "code": 404, "message": "Voice agent not found" }
Make one link per person or visitor, then send them its
url, or put it in your page: the url plus &embed=1 in an iframe, or the token in the widget’s data-token. See Private agents.
The agent should be private. Public agents take calls from anyone with their share link, without a token.
string
required
Bearer tav_…, your API key.string
required
The voice agent’s ID.
string
Who or what it’s for, shown in the dashboard. Up to 120 characters.
string
When it stops working, as an ISO 8601 date-time (for example
2026-11-02T09:00:00Z). Must be in the future and at most a year away. Default: 24 hours from now.integer
How many calls it may start, from 1 to 100,000. Use
1 for a one-time link. Default: any number until it expires.Response
object
Hide link
Hide link
string
The link’s ID, for deleting it
string | null
Who or what it’s for
string
The link’s secret
string
The agent’s call page with the token: send this
string
When it stops working (ISO 8601)
integer | null
How many calls it may start;
null for any numberinteger
How many calls it has started (
0)string
When it was made (ISO 8601)
curl -X POST https://backend.talking-avatar.dev/api/talking-avatar/voice-agents/AGENT_ID/links \
-H "Authorization: Bearer $TALKING_AVATAR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Interview with Jane", "expiresAt": "2026-11-02T09:00:00Z", "maxUses": 1}'
import { createAgentLink } from "@interviewflowai/talking-avatar/server";
const link = await createAgentLink({
apiKey: process.env.TALKING_AVATAR_API_KEY,
agentId: "AGENT_ID",
name: "Interview with Jane",
expiresAt: "2026-11-02T09:00:00Z",
maxUses: 1,
});
import os, requests
response = requests.post(
"https://backend.talking-avatar.dev/api/talking-avatar/voice-agents/AGENT_ID/links",
headers={"Authorization": f"Bearer {os.environ['TALKING_AVATAR_API_KEY']}"},
json={"name": "Interview with Jane", "expiresAt": "2026-11-02T09:00:00Z", "maxUses": 1},
)
response.raise_for_status()
link = response.json()["data"]
{
"data": {
"id": "6f2c1b0e-4d7a-4a51-9a3e-2b8c7d1e9f40",
"name": "Interview with Jane",
"token": "q3N1dGh4YkVwV2Zz…",
"url": "https://app.talking-avatar.dev/agent/AGENT_ID?token=q3N1dGh4YkVwV2Zz…",
"expires_at": "2026-11-02T09:00:00+00:00",
"max_uses": 1,
"uses": 0,
"created_at": "2026-10-26T10:15:00+00:00"
},
"code": 201,
"message": "Link created"
}
{ "code": 400, "message": "expiresAt must be in the future, and within a year" }
{ "code": 404, "message": "Voice agent not found" }