Skip to main content
POST
/
v2
/
embeddings
Create Embed V2
curl --request POST \
  --url https://api.liveavatar.com/v2/embeddings \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "context_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "voice_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "DEFAULT",
  "max_session_duration": 123,
  "default_language": "<string>",
  "is_sandbox": false,
  "orientation": "horizontal"
}
'
{
  "code": 100,
  "data": {
    "embed_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "url": "<string>",
    "script": "<string>",
    "orientation": "horizontal"
  },
  "message": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Cookies

​
la_session
string

Body

application/json
​
avatar_id
string<uuid>
required
​
context_id
string<uuid>
​
voice_id
string<uuid>
​
voice_agent_id
string<uuid>

Resolve voice / context from a stored voice_agent (the new primitive). Mutually exclusive with voice_id / context_id.

​
type
enum<string>
default:DEFAULT
Available options:
DEFAULT,
WIDGET
​
max_session_duration
integer

Max session duration in seconds

​
default_language
string

Default language code (e.g. 'en', 'es', 'multi')

Maximum string length: 5
​
is_sandbox
boolean
default:false

Whether to enable sandbox mode for sessions

​
orientation
enum<string>
default:horizontal

Embed orientation: horizontal (16:9) or vertical (9:16)

Available options:
horizontal,
vertical

Response

Successful Response

​
code
integer
default:100
​
data
CreateEmbedV2ResponseSchema · object
​
message
string