Skip to main content

Post Request Object

post is accepted as a legacy alias for message.post.

Post Response Object

Assistants List Request

Assistants List Response Object

Conversations List Request

Conversations List Response Object

Favorites List Request

Favorites List Response Object

Convo Ready Event

The convo.ready event is sent proactively by the Digital Twin after the user logs in. It notifies the embedding application whether real-time voice (speech-to-speech) mode is authorized for the current user. This event is not a response to a command — it is sent automatically.
Authorization depends on the institution’s real-time voice settings and whether the user has the required role.
This event is also intercepted by the SDK itself to set the pria.isConvoReady() flag and optionally trigger convoMode auto-start. Subscribers receive it after the SDK processes it.

Convo Live Event

The convo.live event is sent once per conversation, when that conversation can actually accept text through convo.post. It is not a response to a command. convo.ready and convo.live answer different questions: the first says the user is allowed to start a voice conversation, the second says a conversation is running and ready to be spoken into. A page that starts a conversation and immediately posts into it should wait for this one.

Start Convo Request

Start Convo Response

Convo Post Request

Sends text into a conversation that is already running. role defaults to user (the learner speaking) and respond defaults to true.

Convo Post Response

delivered confirms the twin accepted the text. replied says whether it answered — some providers cannot take context without answering, and ElevenLabs cannot answer a system message on demand, so the two are reported separately.
A refusal arrives as a pria-error with the reason in content — no conversation running (Convo is not started (STS)), the twin not allowing page instructions or the sender not being the embedding page (Access Unauthorized (401)), an empty or over-long message (Invalid Request (400)), or a provider that cannot honour the request.

Stop Convo Request

Stop Convo Response