Chats

List chat events

GET

Path parameters

idstringRequired
Identifier for a chat. Formatted as a UUID.

Query parameters

page_sizeintegerOptional
The maximum number of results to include per page.
page_numberintegerOptional
The page number of the results to return.

Response

This endpoint returns an object
id
string
Identifier for a chat. Formatted as a UUID.
status
string
The status of the chat. Values from the ChatStatus enum.
start_timestamp
integer
The timestamp when the chat started, formatted as a Unix epoch milliseconds.
events_page
list of objects
List of chat events with the specified page number and page size.
page_number
integer
The page number of the returned results.
page_size
integer
The number of results returned per page.
tag
stringOptional
Optional tag applied to this chat used to group chats by user, application, etc.
end_timestamp
integerOptional
The timestamp when the chat ended, formatted as a Unix epoch milliseconds.
metadata
stringOptional
Stringified JSON with additional metadata about the chat.
config
objectOptional
An id/version number for a specific config version
GET
1curl https://api.hume.ai/v0/evi/chats/id \
2 -H "X-Hume-Api-Key: <apiKey>"
200Retrieved
1{
2 "id": "id",
3 "status": "status",
4 "start_timestamp": 1,
5 "events_page": [
6 {
7 "id": "id",
8 "timestamp": 1,
9 "role": "role",
10 "type": "type",
11 "message_text": "message_text",
12 "emotion_features": "emotion_features",
13 "metadata": "metadata"
14 }
15 ],
16 "page_number": 1,
17 "page_size": 1,
18 "tag": "tag",
19 "end_timestamp": 1,
20 "metadata": "metadata",
21 "config": {
22 "id": "id",
23 "version": 1
24 }
25}