{ "opencollection": "1.0.0", "info": { "name": "Speech-to-speech (EVI)", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_controlPlane", "type": "folder" }, "items": [ { "info": { "name": "Send Message", "type": "http" }, "http": { "method": "POST", "url": "https://api.hume.ai/v0/evi/chat/:chat_id/send", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "chat_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Send a message to a specific chat." } ] }, { "info": { "name": "subpackage_configs", "type": "folder" }, "items": [ { "info": { "name": "List configs", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/configs", "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": "restrict_to_most_recent", "value": "", "type": "query", "description": "By default, `restrict_to_most_recent` is set to true, returning only the latest version of each config. To include all versions of each config in the list, set `restrict_to_most_recent` to false." }, { "name": "name", "value": "", "type": "query", "description": "Filter to only include configs with this name." } ] }, "docs": "Fetches a paginated list of **Configs**.\n\nFor more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration)." }, { "info": { "name": "Create config", "type": "http" }, "http": { "method": "POST", "url": "https://api.hume.ai/v0/evi/configs", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a **Config** which can be applied to EVI.\n\nFor more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration)." }, { "info": { "name": "List config versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/configs/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Config. Formatted as a UUID." }, { "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": "restrict_to_most_recent", "value": "", "type": "query", "description": "By default, `restrict_to_most_recent` is set to true, returning only the latest version of each config. To include all versions of each config in the list, set `restrict_to_most_recent` to false." } ] }, "docs": "Fetches a list of a **Config's** versions.\n\nFor more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration)." }, { "info": { "name": "Create config version", "type": "http" }, "http": { "method": "POST", "url": "https://api.hume.ai/v0/evi/configs/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Config. Formatted as a UUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a **Config** by creating a new version of the **Config**.\n\nFor more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration)." }, { "info": { "name": "Update config name", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.hume.ai/v0/evi/configs/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Config. Formatted as a UUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the name of a **Config**.\n\nFor more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration)." }, { "info": { "name": "Delete config", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.hume.ai/v0/evi/configs/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Config. Formatted as a UUID." } ] }, "docs": "Deletes a **Config** and its versions.\n\nFor more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration)." }, { "info": { "name": "Get config version", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/configs/:id/version/:version", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Config. Formatted as a UUID." }, { "name": "version", "value": "", "type": "path", "description": "Version number for a Config.\n\nConfigs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number." } ] }, "docs": "Fetches a specified version of a **Config**.\n\nFor more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration)." }, { "info": { "name": "Update config description", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.hume.ai/v0/evi/configs/:id/version/:version", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Config. Formatted as a UUID." }, { "name": "version", "value": "", "type": "path", "description": "Version number for a Config.\n\nConfigs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the description of a **Config**.\n\nFor more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration)." }, { "info": { "name": "Delete config version", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.hume.ai/v0/evi/configs/:id/version/:version", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Config. Formatted as a UUID." }, { "name": "version", "value": "", "type": "path", "description": "Version number for a Config.\n\nConfigs, Prompts, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine configurations and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Config. Each update to the Config increments its version number." } ] }, "docs": "Deletes a specified version of a **Config**.\n\nFor more details on configuration options and how to configure EVI, see our [configuration guide](/docs/speech-to-speech-evi/configuration)." } ] }, { "info": { "name": "subpackage_prompts", "type": "folder" }, "items": [ { "info": { "name": "List prompts", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/prompts", "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": "restrict_to_most_recent", "value": "", "type": "query", "description": "By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false." }, { "name": "name", "value": "", "type": "query", "description": "Filter to only include prompts with name." } ] }, "docs": "Fetches a paginated list of **Prompts**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt." }, { "info": { "name": "Create prompt", "type": "http" }, "http": { "method": "POST", "url": "https://api.hume.ai/v0/evi/prompts", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a **Prompt** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt." }, { "info": { "name": "List prompt versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/prompts/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "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": "restrict_to_most_recent", "value": "", "type": "query", "description": "By default, `restrict_to_most_recent` is set to true, returning only the latest version of each prompt. To include all versions of each prompt in the list, set `restrict_to_most_recent` to false." } ] }, "docs": "Fetches a list of a **Prompt's** versions.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt." }, { "info": { "name": "Create prompt version", "type": "http" }, "http": { "method": "POST", "url": "https://api.hume.ai/v0/evi/prompts/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Prompt. Formatted as a UUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a **Prompt** by creating a new version of the **Prompt**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt." }, { "info": { "name": "Update prompt name", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.hume.ai/v0/evi/prompts/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Prompt. Formatted as a UUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the name of a **Prompt**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt." }, { "info": { "name": "Delete prompt", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.hume.ai/v0/evi/prompts/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Prompt. Formatted as a UUID." } ] }, "docs": "Deletes a **Prompt** and its versions.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt." }, { "info": { "name": "Get prompt version", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/prompts/:id/version/:version", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Prompt. Formatted as a UUID." }, { "name": "version", "value": "", "type": "path", "description": "Version number for a Prompt.\n\nPrompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number." } ] }, "docs": "Fetches a specified version of a **Prompt**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt." }, { "info": { "name": "Update prompt description", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.hume.ai/v0/evi/prompts/:id/version/:version", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Prompt. Formatted as a UUID." }, { "name": "version", "value": "", "type": "path", "description": "Version number for a Prompt.\n\nPrompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the description of a **Prompt**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt." }, { "info": { "name": "Delete prompt version", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.hume.ai/v0/evi/prompts/:id/version/:version", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Prompt. Formatted as a UUID." }, { "name": "version", "value": "", "type": "path", "description": "Version number for a Prompt.\n\nPrompts, Configs, Custom Voices, and Tools are versioned. This versioning system supports iterative development, allowing you to progressively refine prompts and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Prompt. Each update to the Prompt increments its version number." } ] }, "docs": "Deletes a specified version of a **Prompt**.\n\nSee our [prompting guide](/docs/speech-to-speech-evi/guides/phone-calling) for tips on crafting your system prompt." } ] }, { "info": { "name": "subpackage_tools", "type": "folder" }, "items": [ { "info": { "name": "List tools", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/tools", "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": "restrict_to_most_recent", "value": "", "type": "query", "description": "By default, `restrict_to_most_recent` is set to true, returning only the latest version of each tool. To include all versions of each tool in the list, set `restrict_to_most_recent` to false." }, { "name": "name", "value": "", "type": "query", "description": "Filter to only include tools with name." } ] }, "docs": "Fetches a paginated list of **Tools**.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI." }, { "info": { "name": "Create tool", "type": "http" }, "http": { "method": "POST", "url": "https://api.hume.ai/v0/evi/tools", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a **Tool** that can be added to an [EVI configuration](/reference/speech-to-speech-evi/configs/create-config).\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI." }, { "info": { "name": "List tool versions", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/tools/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "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": "restrict_to_most_recent", "value": "", "type": "query", "description": "By default, `restrict_to_most_recent` is set to true, returning only the latest version of each tool. To include all versions of each tool in the list, set `restrict_to_most_recent` to false." } ] }, "docs": "Fetches a list of a **Tool's** versions.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI." }, { "info": { "name": "Create tool version", "type": "http" }, "http": { "method": "POST", "url": "https://api.hume.ai/v0/evi/tools/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Tool. Formatted as a UUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a **Tool** by creating a new version of the **Tool**.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI." }, { "info": { "name": "Update tool name", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.hume.ai/v0/evi/tools/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Tool. Formatted as a UUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the name of a **Tool**.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI." }, { "info": { "name": "Delete tool", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.hume.ai/v0/evi/tools/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Tool. Formatted as a UUID." } ] }, "docs": "Deletes a **Tool** and its versions.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI." }, { "info": { "name": "Get tool version", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/tools/:id/version/:version", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Tool. Formatted as a UUID." }, { "name": "version", "value": "", "type": "path", "description": "Version number for a Tool.\n\nTools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number." } ] }, "docs": "Fetches a specified version of a **Tool**.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI." }, { "info": { "name": "Update tool description", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.hume.ai/v0/evi/tools/:id/version/:version", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Tool. Formatted as a UUID." }, { "name": "version", "value": "", "type": "path", "description": "Version number for a Tool.\n\nTools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the description of a specified **Tool** version.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI." }, { "info": { "name": "Delete tool version", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.hume.ai/v0/evi/tools/:id/version/:version", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Tool. Formatted as a UUID." }, { "name": "version", "value": "", "type": "path", "description": "Version number for a Tool.\n\nTools, Configs, Custom Voices, and Prompts are versioned. This versioning system supports iterative development, allowing you to progressively refine tools and revert to previous versions if needed.\n\nVersion numbers are integer values representing different iterations of the Tool. Each update to the Tool increments its version number." } ] }, "docs": "Deletes a specified version of a **Tool**.\n\nRefer to our [tool use](/docs/speech-to-speech-evi/features/tool-use#function-calling) guide for comprehensive instructions on defining and integrating tools into EVI." } ] }, { "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)." } ] }, { "info": { "name": "subpackage_chatGroups", "type": "folder" }, "items": [ { "info": { "name": "List chat_groups", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/chat_groups", "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": "The unique identifier for an EVI configuration.\n\nFilter Chat Groups to only include Chats that used this `config_id` in their most recent Chat." } ] }, "docs": "Fetches a paginated list of **Chat Groups**." }, { "info": { "name": "Get chat_group", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/chat_groups/:id", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Chat Group. Formatted as a UUID." }, { "name": "status", "value": "", "type": "query", "description": "Chat status to apply to the chat. String from the ChatStatus enum." }, { "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 **ChatGroup** by ID, including a paginated list of **Chats** associated with the **ChatGroup**." }, { "info": { "name": "Get chat group audio", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/chat_groups/:id/audio", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Chat Group. Formatted as a UUID." }, { "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." } ] }, "docs": "Fetches a paginated list of audio for each **Chat** within the specified **Chat Group**. 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)." }, { "info": { "name": "List chat events from a specific chat_group", "type": "http" }, "http": { "method": "GET", "url": "https://api.hume.ai/v0/evi/chat_groups/:id/events", "headers": [ { "name": "X-Hume-Api-Key", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Identifier for a Chat Group. 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 associated with a **Chat Group**." } ] } ], "bundled": true }