{ "opencollection": "1.0.0", "info": { "name": "Speech-to-speech (EVI) subpackage_chats API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_chats", "type": "folder" }, "items": [ { "info": { "name": "List chats", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/chats", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "page_number", "value": "", "type": "query", "description": "Specifies the page number to retrieve, enabling pagination.\n\nThis 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." }, { "name": "page_size", "value": "", "type": "query", "description": "Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.\n\nFor example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10." }, { "name": "ascending_order", "value": "", "type": "query", "description": "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." }, { "name": "config_id", "value": "", "type": "query", "description": "Filter to only include chats that used this config." }, { "name": "status", "value": "", "type": "query", "description": "Chat status to apply to the chat. String from the ChatStatus enum." } ] }, "docs": "Fetches a paginated list of **Chats**." }, { "info": { "name": "List chat events", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/chats/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Chat. Formatted as a UUID." }, { "name": "page_size", "value": "", "type": "query", "description": "Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.\n\nFor example, if `page_size` is set to 10, each page will include up to 10 items. Defaults to 10." }, { "name": "page_number", "value": "", "type": "query", "description": "Specifies the page number to retrieve, enabling pagination.\n\nThis 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." }, { "name": "ascending_order", "value": "", "type": "query", "description": "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." } ] }, "docs": "Fetches a paginated list of **Chat** events." }, { "info": { "name": "Get chat audio", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/chats/:id/audio", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Chat. Formatted as a UUID." } ] }, "docs": "Fetches the audio of a previous **Chat**. For more details, see our guide on audio reconstruction [here](/docs/speech-to-speech-evi/faq#can-i-access-the-audio-of-previous-conversations-with-evi)." } ] } ], "bundled": true }