Authorizations
Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"
Path Parameters
Unique id of the chat to be retrieved
"16b980523634a6dc504898cda492e939"
Response
Successfully retrieved an chat.
Unique id of the chat.
"Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6"
Corresponding chat agent id of this chat.
"oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD"
Status of chat.
-
ongoing
: Chat session is ongoing, chat agent can receive new message and generate response. -
ended
: Chat session has ended can not generate new response. -
error
: Chat encountered error.
ongoing
, ended
, error
"ongoing"
Add optional dynamic variables in key value pairs of string that injects into your Response Engine prompt and tool description. Only applicable for Response Engine.
{ "customer_name": "John Doe" }
Dynamic variables collected from the chat. Only available after the chat ends.
{ "last_node_name": "Test node" }
Begin timestamp (milliseconds since epoch) of the chat. Available after chat starts.
1703302407333
End timestamp (milliseconds since epoch) of the chat. Available after chat ends.
1703302428855
Transcription of the chat.
"Agent: hi how are you doing?\nUser: Doing pretty well. How are you?\nAgent: That's great to hear! I'm doing well too, thanks! What's up?\nUser: I don't have anything in particular.\nAgent: Got it, just checking in!\nUser: Alright. See you.\nAgent: have a nice day\n"
Transcript of the chat weaved with tool call invocation and results.
An arbitrary object for storage purpose only. You can put anything here like your internal customer id associated with the chat. Not used for processing. You can later get this field from the chat object.
Post chat analysis that includes information such as sentiment, status, summary, and custom defined data to extract. Available after chat ends. Subscribe to chat_analyzed
webhook event type to receive it once ready.