POST
/
v2
/
conversations

Authorizations

x-api-key
string
headerrequired

Body

application/json
replica_id
string

The unique identifier for the replica that will join the conversation.

persona_id
string

The unique identifier for the persona that the replica will use in the conversation.

callback_url
string

A url that will receive webhooks with updates regarding the conversation state.

conversation_name
string

A name for the conversation.

conversational_context
string

Optional context that will be appended to any context provided in the persona, if one is provided.

custom_greeting
string

An optional custom greeting that the replica will give once a participant joines the conversation.

properties
object

Optional properties that can be used to customize the conversation.

Response

200 - application/json
conversation_id
string

A unique identifier for the conversation.

conversation_name
string

The name of the conversation.

status
string

The status of the conversation. Possible values: active, ended.

conversation_url
string

A direct link to join the conversation. This link can be used to join the conversation directly or can be embedded in a website.

replica_id
string

A unique identifier for the replica used to create this conversation.

persona_id
string

A unique identifier for the persona used to create this conversation.

created_at
string

The date and time the conversation was created.