Chat Groups

List chat events from a specific chat_group

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.
ascending_orderbooleanOptional
Boolean to indicate if the results should be paginated in chronological order or reverse-chronological order. Defaults to true.

Response

This endpoint returns an object
id
string

Identifier for the chat group. Any chat resumed from this chat will have the same chat_group_id. Formatted as a UUID.

page_number
integer
The page number of the returned results.
page_size
integer
The number of results returned per page.
total_pages
integer
The total number of pages in the collection
pagination_direction
string
The direction of the pagination (ASC or DESC).
events_page
list of objects

List of chat_events returned for the specified page number and page size.

GET
1curl https://api.hume.ai/v0/evi/chat_groups/id/events \
2 -H "X-Hume-Api-Key: <apiKey>"
200Retrieved
1{
2 "id": "id",
3 "page_number": 1,
4 "page_size": 1,
5 "total_pages": 1,
6 "pagination_direction": "pagination_direction",
7 "events_page": [
8 {
9 "id": "id",
10 "chat_id": "chat_id",
11 "timestamp": 1,
12 "role": "role",
13 "type": "type",
14 "message_text": "message_text",
15 "emotion_features": "emotion_features",
16 "metadata": "metadata"
17 }
18 ]
19}