{ "opencollection": "1.0.0", "info": { "name": "Speech-to-speech (EVI) subpackage_configs API", "version": "1.0.0" }, "items": [ { "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)." } ] } ], "bundled": true }