Interactions
Retrieve an interaction
Retrieves the interaction with the given ID.
GET
/
interactions
/
{interaction_id}
Path Parameters
interaction_id
string
requiredThe unique identifier of the interaction
Response
200 - application/json
<p>Users communicate with agents via <i>interactions</i>. You can think of each interaction as a conversation between an agent and user.</p>
id
string
requiredThe unique identifier of the interaction
object
enum<string>
requiredThe type of the Interaction
object
Available options:
interaction
agent_id
string
requiredThe unique identifier of the agent
archived
boolean
requiredWhether the interaction has been archived by the user
created_at
integer
requiredThe time at which the object was created, measured in milliseconds since the Unix epoch
initial_turn
enum<string>
requiredIndicates who sends the first message in each interaction. Defaults to "user"
.
Available options:
user
, agent
name
string
requiredThe name of the interaction
total_message_count
integer
requiredThe total number of messages in the interaction
updated_at
integer
requiredThe time at which the object was last updated, measured in milliseconds since the Unix epoch
user_id
string
requiredThe unique identifier of the user