There were major breaking changes in version 0.7.0 of the SDK. If upgrading from a previous version, please
View the Migration Guide. That release deprecated several interfaces and moved them to the hume[legacy] package extra. The legacy extra was removed in 0.9.0. The last version to include legacy was 0.8.6.
API reference documentation is available here.
The Hume Python SDK is compatible across several Python versions and operating systems.
- For the Empathic Voice Interface, Python versions
3.9through3.13are supported on macOS and Linux. - For Text-to-speech (TTS), Python versions
3.9through3.13are supported on macOS, Linux, and Windows.
Below is a table which shows the version and operating system compatibilities by product:
| Python Version | Operating System | |
|---|---|---|
| Empathic Voice Interface | 3.9, 3.10, 3.11, 3.12, 3.13 | macOS, Linux |
| Text-to-speech (TTS) | 3.9, 3.10, 3.11, 3.12, 3.13 | macOS, Linux, Windows |
pip install hume
# or
poetry add hume
# or
uv add humefromhume.clientimportHumeClientclient=HumeClient(api_key="YOUR_API_KEY")
client.empathic_voice.configs.list_configs()Starter projects that use this SDK:
- EVI Python quickstart — Empathic Voice Interface
- TTS Python quickstart — Text-to-speech
The SDK also exports an async client so that you can make non-blocking calls to our API.
importasynciofromhume.clientimportAsyncHumeClientclient=AsyncHumeClient(api_key="YOUR_API_KEY")
asyncdefmain() ->None:
awaitclient.empathic_voice.configs.list_configs()
asyncio.run(main())This SDK contains the APIs for empathic voice and tts. Even if you do not plan on using more than one API to start, the SDK provides easy access in case you would like to use additional APIs in the future.
Each API is namespaced accordingly:
fromhume.clientimportHumeClientclient=HumeClient(api_key="YOUR_API_KEY")
client.empathic_voice. # APIs specific to Empathic Voiceclient.tts. # APIs specific to Text-to-speechAll errors thrown by the SDK will be subclasses of ApiError.
fromhume.clientimportHumeClientfromhume.coreimportApiErrorclient=HumeClient(api_key="YOUR_API_KEY")
try:
client.empathic_voice.configs.list_configs()
exceptApiErrorase:
print(e.status_code)
print(e.body)Paginated requests will return a SyncPager or AsyncPager, which can be used as generators for the underlying object. For example, list_tools will return a generator over ReturnUserDefinedTool and handle the pagination behind the scenes:
fromhume.clientimportHumeClientclient=HumeClient(api_key="YOUR_API_KEY")
fortoolinclient.empathic_voice.tools.list_tools():
print(tool)you could also iterate page-by-page:
forpageinclient.empathic_voice.tools.list_tools().iter_pages():
print(page.items)or manually:
pager=client.empathic_voice.tools.list_tools()
# First pageprint(pager.items)
# Second pagepager=pager.next_page()
print(pager.items)We expose a websocket client for interacting with the EVI API.
When interacting with these clients, you can use them very similarly to how you'd use the common websockets library:
importosfromhumeimportAsyncHumeClientfromhume.empathic_voice.typesimportUserInputclient=AsyncHumeClient(api_key=os.getenv("HUME_API_KEY"))
asyncwithclient.empathic_voice.chat.connect() ashume_socket:
awaithume_socket.send_user_input(message=UserInput(text="Hello!"))The underlying connection, in this case hume_socket, will support intellisense/autocomplete for the different functions that are available on the socket!
The Hume SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit.
A request is deemed retriable when any of the following HTTP status codes is returned:
Use the max_retries request option to configure this behavior.
fromhume.clientimportHumeClientfromhume.coreimportRequestOptionsclient=HumeClient(...)
# Override retries for a specific methodclient.empathic_voice.configs.list_configs(
request_options=RequestOptions(max_retries=5)
)By default, requests time out after 60 seconds. You can configure this with a timeout option at the client or request level.
fromhume.clientimportHumeClientfromhume.coreimportRequestOptionsclient=HumeClient(
# All timeouts are 20 secondstimeout=20.0,
)
# Override timeout for a specific methodclient.empathic_voice.configs.list_configs(
request_options=RequestOptions(timeout_in_seconds=20)
)You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.
importhttpxfromhume.clientimportHumeClientclient=HumeClient(
http_client=httpx.Client(
proxies="http://my.test.proxy.example.com",
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
),
)While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!