Hume AI subpackage_configs API
The subpackage_configs API from Hume AI — 3 operation(s) for subpackage_configs.
Hume AI subpackage_configs API is one of 9 APIs that Hume AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include subpackage_configs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and an AsyncAPI specification.
This API exposes 9 operations across 3 paths, and defines 66 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://api.hume.ai.
9 operations
3 paths
66 schemas
2 DELETE3 GET2 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Hume AI subpackage_configs API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Hume-Api-Key (bearerAuth).
Paths & Operations 9
Across 3 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
subpackage_configs 9
POST
/v0/evi/configs
Create config
GET
/v0/evi/configs
List configs
GET
/v0/evi/configs/{id}
List config versions
POST
/v0/evi/configs/{id}
Create config version
PATCH
/v0/evi/configs/{id}
Update config name
DELETE
/v0/evi/configs/{id}
Delete config
GET
/v0/evi/configs/{id}/version/{version}
Get config version
PATCH
/v0/evi/configs/{id}/version/{version}
Update config description
DELETE
/v0/evi/configs/{id}/version/{version}
Delete config version
Schemas 66
The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are return_config (19 properties), return_config_public (19 properties), posted_config (15 properties), posted_config_version (14 properties). Each schema is shown below with its type and property counts.
ReturnedWebhookSpecEventsItems
string
The list of events the specified URL is subscribed to. See our [webhooks guide](/docs/speech-to-speech-evi/configuration/build-a-configurationsupported-events)…
posted_ellm_model
object
A eLLM model configuration to be posted to the server
1 property
posted_config
object
A configuration to be posted to the server
15 properties
2 required
VoiceProvider
string
posted_event_message_specs
object
Collection of event messages returned by the server. Event messages are sent by the server when specific events occur during a chat session. These messages are…
3 properties
posted_config_version_description
object
A config version description to be posted to the server
1 property
ReturnPromptVersionType
string
ReturnConfigEventMessages
object
3 properties
LanguageModelType
string
PostedBuiltinToolName
string
prompt_expansion_spec
object
Configuration for prompt expansion behavior.
1 property
posted_config_prompt_spec
object
Identifies which prompt to use in a a config OR how to create a new prompt to use in the config
4 properties
return_ellm_model
object
A specific eLLM Model configuration
1 property
1 required
posted_config_version
object
A new version of an existing configuration to be posted to the server
14 properties
1 required
return_timeout_specs
object
Collection of timeout specifications returned by the server. Timeouts are sent by the server when specific time-based events occur during a chat session. These…
2 properties
2 required
ReturnUserDefinedToolVersionType
string
PostedTimeoutSpecsMaxDuration
object
2 properties
1 required
PostedTimeoutSpecsInactivity
object
2 properties
1 required
ReturnVoice
object
An Octave voice available for text-to-speech
4 properties
3 required
return_event_message_specs
object
Collection of event messages returned by the server. Event messages are sent by the server when specific events occur during a chat session. These messages are…
3 properties
ReturnConfigLanguageModel
object
3 properties
ReturnBuiltinToolToolType
string
return_event_message_spec
object
A specific event message configuration to be returned from the server
2 properties
1 required
ReturnConfigEllmModel
object
1 property
1 required
ReturnConfigNudges
object
2 properties
1 required
PostedConfigTimeouts
object
2 properties
VoiceId
object
2 properties
1 required
configs_update-config-name_Response_200
object
Empty response body
return_prompt_public
object
A specific prompt version returned from the server
9 properties
7 required
PostedEventMessageSpecsOnNewChat
object
2 properties
1 required
posted_builtin_tool
object
A configuration of a built-in tool to be posted to the server
2 properties
1 required
PostedWebhookSpecEventsItems
string
The list of events the specified URL is subscribed to. See our [webhooks guide](/docs/speech-to-speech-evi/configuration/build-a-configurationsupported-events)…
PostedEventMessageSpecsOnMaxDurationTimeout
object
2 properties
1 required
PostedEventMessageSpecsOnInactivityTimeout
object
2 properties
1 required
returned_webhook_spec
object
Collection of webhook URL endpoints to be returned from the server
2 properties
2 required
posted_config_name
object
A configuration name change to be posted to the server
1 property
1 required
return_config_public
object
A specific config version returned from the server
19 properties
posted_webhook_spec
object
URL and settings for a specific webhook to be posted to the server
2 properties
2 required
posted_interruption_spec
object
An interruption specification posted to the server
1 property
return_language_model
object
A specific LanguageModel
3 properties
PostedConfigEllmModel
object
1 property
posted_timeout_specs
object
Collection of timeout specifications returned by the server. Timeouts are sent by the server when specific time-based events occur during a chat session. These…
2 properties
posted_nudge_spec
object
A nudge specification posted to the server
2 properties
PostedConfigPrompt
object
4 properties
return_nudge_spec
object
A specific nudge configuration returned from the server
2 properties
1 required
PostedConfigLanguageModel
object
3 properties
VoiceName
object
2 properties
1 required
ModelProviderEnum
string
return_user_defined_tool
object
A specific tool version returned from the server
11 properties
8 required
PostedConfigNudges
object
2 properties
ReturnConfigTimeouts
object
2 properties
2 required
return_interruption_spec
object
An interruption configuration returned from the server
1 property
return_builtin_tool
object
A specific builtin tool version returned from the server
3 properties
2 required
ReturnUserDefinedToolToolType
string
posted_user_defined_tool_spec
object
A specific tool identifier to be posted to the server
2 properties
1 required
posted_language_model
object
A LanguageModel to be posted to the server
3 properties
return_config
object
A specific config version returned from the server
19 properties
return_turn_detection_spec
object
A turn detection configuration returned from the server
3 properties
ReturnConfigPrompt
object
8 properties
7 required
configs_delete-config-version_Response_200
object
Empty response body
return_timeout_spec
object
A specific timeout configuration to be returned from the server
2 properties
1 required
configs_delete-config_Response_200
object
Empty response body
return_paged_configs
object
A paginated list of config versions returned from the server
4 properties
1 required
PostedConfigEventMessages
object
3 properties
posted_turn_detection_spec
object
A turn detection specification posted to the server
3 properties
VoiceRef
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Hume AI 8
Other APIs Hume AI publishes across the network.
Hume AI Ai Default API
Hume AI subpackage_batch API
Hume AI subpackage_chatGroups API
Hume AI subpackage_chats API
Hume AI subpackage_controlPlane API
Hume AI subpackage_prompts API
Hume AI subpackage_tools API
Hume AI subpackage_voices API
#subpackage_configs