For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Start buildingGet support
DocumentationAPI ReferenceChangelogDiscord
  • Voices
    • POSTCreate voice
    • GETList voices
    • DELDelete voice
  • Text-to-Speech (TTS)
    • WSSStream Input
    • STREAMText-to-Speech (Streamed JSON)
    • POSTText-to-Speech (Streamed File)
    • POSTText-to-Speech (Json)
    • POSTText-to-Speech (File)
    • POSTVoice Conversion (Streamed File)
    • STREAMVoice Conversion (Streamed JSON)
  • Speech-to-speech (EVI)
    • WSSChat
      • GETList chats
      • GETList chat events
      • GETGet chat audio
  • Expression Measurement API
Start buildingGet support
LogoLogo
LogoLogo
Speech-to-speech (EVI)Chats

List chats

GET
https://api.hume.ai/v0/evi/chats
GET
/v0/evi/chats
$curl -G https://api.hume.ai/v0/evi/chats \
>     -H "X-Hume-Api-Key: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d page_number=0 \
>     -d page_size=1 \
>     -d ascending_order=true
200Retrieved
1{
2  "chats_page": [
3    {
4      "chat_group_id": "9fc18597-3567-42d5-94d6-935bde84bf2f",
5      "id": "470a49f6-1dec-4afe-8b61-035d3b2d63b0",
6      "start_timestamp": 1716244940,
7      "status": "USER_ENDED",
8      "config": {
9        "id": "1b60e1a0-cc59-424a-8d2c-189d354db3f3",
10        "version": 2
11      },
12      "end_timestamp": 1716244958,
13      "event_count": 3,
14      "metadata": "{\"topic\":\"customer_support\",\"language\":\"en-US\"}"
15    }
16  ],
17  "page_number": 0,
18  "page_size": 1,
19  "pagination_direction": "ASC",
20  "total_pages": 1
21}

Fetches a paginated list of Chats.

Was this page helpful?
Previous

List chat events

Next
Built with

Authentication

X-Hume-Api-Keystring
API Key authentication via header

Query parameters

page_numberintegerOptionalDefaults to 0

Specifies the page number to retrieve, enabling pagination.

This parameter uses zero-based indexing. For example, setting page_number to 0 retrieves the first page of results (items 0-9 if page_size is 10), setting page_number to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.

page_sizeintegerOptional

Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.

For example, if page_size is set to 10, each page will include up to 10 items. Defaults to 10.

ascending_orderbooleanOptional

Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.

config_idstringOptionalformat: "uuid"
Filter to only include chats that used this config.
statusstringOptional
Chat status to apply to the chat. String from the ChatStatus enum.

Response

Success
chats_pagelist of objects

List of Chats and their metadata returned for the specified page_number and page_size.

page_numberinteger

The page number of the returned list.

This value corresponds to the page_number parameter specified in the request. Pagination uses zero-based indexing.

page_sizeinteger

The maximum number of items returned per page.

This value corresponds to the page_size parameter specified in the request.

pagination_directionenum
Allowed values:
total_pagesinteger
The total number of pages in the collection.