API overview

Talking Avatar has two APIs, both authenticated with your API key and used from your server.

Realtime avatar API (WebSocket)

Run Realistic Avatars from any language: start a session, stream your agent’s voice, interrupt, and show the avatar in browsers or your LiveKit room.

REST API

Manage a private voice agent’s links.

On Node.js, the SDK wraps both. This tab also documents the requests we send to you: tool calls and the post-call webhook, and how to verify their signatures.

Realtime avatar API

wss://api.talking-avatar.dev

One WebSocket connection per avatar session. Your API key goes in the first message. See Realtime avatar API.

REST API

Base URL

https://backend.talking-avatar.dev/api/talking-avatar

Authentication

Send your API key as a bearer token:

curl https://backend.talking-avatar.dev/api/talking-avatar/voice-agents/AGENT_ID/links \
  -H "Authorization: Bearer $TALKING_AVATAR_API_KEY"

Keys are per account. A key can only reach its own account’s agents.

Requests and responses

Send JSON bodies with Content-Type: application/json. Successful responses wrap the result in data:

{
  "data": { "id": "…" },
  "code": 201,
  "message": "Link created"
}

Errors return the HTTP status in code, and a readable message:

{ "code": 401, "message": "Invalid API key" }

Status codes

Status	Meaning
`200`, `201`	Success
`400`	The request is invalid, for example an `expiresAt` in the past or more than a year away
`401`	The API key is missing, invalid or revoked
`404`	The agent or link doesn’t exist, or belongs to another account
`5xx`	Something went wrong on our side. Retry with backoff.

Endpoints

Method	Path	Description
`POST`	`/voice-agents/{agentId}/links`	Create a link
`GET`	`/voice-agents/{agentId}/links`	List links
`DELETE`	`/voice-agents/{agentId}/links/{linkId}`	Delete a link

On Node.js, the SDK’s createAgentLink, listAgentLinks and deleteAgentLink wrap these endpoints.

Overview

Realtime avatar API

Private agent links

Requests we send you

Realtime avatar API (WebSocket)

REST API

Realtime avatar API

REST API

Base URL

Authentication

Requests and responses

Status codes

Endpoints

Realtime avatar API (WebSocket)

REST API

​Realtime avatar API

​REST API

​Base URL

​Authentication

​Requests and responses

​Status codes

​Endpoints

Realtime avatar API

REST API

Base URL

Authentication

Requests and responses

Status codes

Endpoints