Create an interaction

Body

application/json

The data with which an interaction is created.

agent_id

string

required

The unique identifier of the agent

Response

200 - application/json

An object that contains the initial interaction data including the Interaction object itself and the initial messages associated with it.

interaction

object

required

<p>Users communicate with agents via <i>interactions</i>. You can think of each interaction as a conversation between an agent and user.</p>

interaction.agent_id

string

required

The unique identifier of the agent

interaction.archived

boolean

required

Whether the interaction has been archived by the user

interaction.created_at

integer

required

The time at which the object was created, measured in milliseconds since the Unix epoch

interaction.id

string

required

The unique identifier of the interaction

interaction.initial_turn

enum<string>

required

Indicates who sends the first message in each interaction. Defaults to "user".

Available options:

user,

agent

interaction.name

string

required

The name of the interaction

interaction.object

enum<string>

required

The type of the Interaction object

Available options:

interaction

interaction.total_message_count

integer

required

The total number of messages in the interaction

interaction.updated_at

integer

required

The time at which the object was last updated, measured in milliseconds since the Unix epoch

interaction.user_id

string

required

The unique identifier of the user

messages

object[]

required

messages.content

string

required

The content of the message

messages.created_at

integer

required

The time at which the object was created, measured in milliseconds since the Unix epoch

messages.depth

integer

required

The depth of the message node in the interaction tree. This will be 0 for all root-level messages that mark the beginning of the interaction and increase as the conversation grows longer.

messages.id

string

required

The unique identifier of the message

messages.interaction_id

string

required

The unique identifier of the interaction

messages.object

enum<string>

required

The type of the Message object

Available options:

message

messages.sent_by

enum<string>

required

Represents the type of the participant in a given interaction. As an example, message are created by interaction participants so the sent_by property of a Message object must be an InteractionParticipant.

Available options:

user,

agent

messages.parent_id

string | null

The ID of the message that directly precedes a given message within a particular conversation.

Client API

Agents

Interactions

Messages

Users

Body

Response