Required Parameters
Required Parameters
persona_id
replica_id
persona_id
replica_id
audio_only
replica_id
is required if the persona does not have a default replica.replica_id
is optional if the persona does have a default replica.- If both a default replica and
replica_id
are provided, the suppliedreplica_id
will override the default.
Authorizations
Body
The unique identifier for the replica that will join the conversation. Each request must have a valid replica_id
value that's either directly passed in or as part of a persona.
"rfe12d8b9597"
The unique identifier for the persona that the replica will use in the conversation.
- If your Persona does not have a valid
replica_id
, you must define thereplica_id
field. - If your Persona already has a valid
replica_id
and you provide one in the request, thereplica_id
provided in the request will be used instead of the one defined in your persona.
"p9a95912"
Specifies whether the interaction should be voice-only. This field is required if you want to create an audio-only conversation.
"false"
A url that will receive webhooks with updates regarding the conversation state.
"https://yourwebsite.com/webhook"
A name for the conversation.
"Improve Sales Technique"
Optional context that will be appended to any context provided in the persona, if one is provided.
"I want to improve my sales techniques. Help me practice handling common objections from clients and closing deals more effectively."
An optional custom greeting that the replica will give once a participant joines the conversation.
"Hey there!"
The memory stores to use for the conversation. The persona will have access to the existing memories in the store and will add newly made memories to the store as well. In most use cases, you will only need to pass in a single memory store.
["anna"]
The ids of the documents that the persona will be able to access during the conversation. The document_ids
are returned during the document creation process in the response of the Get Document and the Create Document endpoints.
["doc_1234567890"]
The strategy to use for document retrieval. Possible values: speed
, quality
, balanced
. Default is balanced
.
"balanced"
The tags of the documents that the replica will be able to access during the conversation. The tags are passed in the document_tags
parameter of the Create Document endpoint. The document tags do not have to be created explicitly, it is enough to pass in the tags during the document creation process.
["sales", "marketing"]
If true, the conversation will be created but the replica will not join the call. This can be used for testing the conversation creation process without incurring any costs. Additionally, the conversation will be created with a status ended
so it does not affect concurrency limits.
false
Optional properties that can be used to customize the conversation.
Response
A unique identifier for the conversation.
"c123456"
The name of the conversation.
"A Meeting with Hassaan"
The status of the conversation. Possible values: active
, ended
.
"active"
A direct link to join the conversation. This link can be used to join the conversation directly or can be embedded in a website.
"https://tavus.daily.co/c123456"
A unique identifier for the replica used to create this conversation.
"r79e1c033f"
A unique identifier for the persona used to create this conversation.
"p5317866"
The date and time the conversation was created.