Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tavus.io/llms.txt

Use this file to discover all available pages before exploring further.

​
message_type
string

Message type indicates what product this event will be used for. In this case, the message_type will be conversation

Example:

"conversation"

​
event_type
string

This is the type of event that is being sent back. This field will always be conversation.utterance.streaming.

Example:

"conversation.utterance.streaming"

​
seq
integer

A globally monotonic sequence number assigned to each event. Use this to determine the ordering of events — a higher seq means the event was sent later. This is useful for reconciling events that may arrive out of order.

Example:

42

​
conversation_id
string

The unique identifier for the conversation.

Example:

"c123456"

​
inference_id
string

A unique identifier for the replica's current inference turn. Can be used to correlate with other events such as conversation.utterance and conversation.replica.started_speaking.

Example:

"83294d9f-8306-491b-a284-791f56c8383f"

​
turn_idx
integer

The conversation turn index. This value increments each time a conversation.respond interaction is received, and groups all events that belong to the same conversational turn. Use this to correlate events (utterances, tool calls, speaking state changes, etc.) that are part of the same turn.

Example:

3

​
properties
object

Contains the accumulated spoken text and metadata about the streaming state.