For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Start buildingGet support
DocumentationAPI ReferenceChangelogDiscord
  • Voices
    • POSTCreate voice
    • GETList voices
    • DELDelete voice
  • Text-to-Speech (TTS)
    • WSSStream Input
    • STREAMText-to-Speech (Streamed JSON)
    • POSTText-to-Speech (Streamed File)
    • POSTText-to-Speech (Json)
    • POSTText-to-Speech (File)
    • POSTVoice Conversion (Streamed File)
    • STREAMVoice Conversion (Streamed JSON)
  • Speech-to-speech (EVI)
    • WSSChat
      • WSSControl Plane
      • POSTSend Message
  • Expression Measurement API
Start buildingGet support
LogoLogo
LogoLogo
Speech-to-speech (EVI)Control Plane

Control Plane

WSS
wss://api.hume.ai/v0/evi/chat/:chat_id/connect
Handshake
URLwss://api.hume.ai/v0/evi/chat/chat_id/connect
MethodGET
Status101 Switching Protocols
Messages

Connects to an in-progress EVI chat session. The original chat must have been started with allow_connection=true. The connection can be used to send and receive the same messages as the original chat, with the exception that audio_input messages are not allowed.

Was this page helpful?
Previous

Send Message

Next
Built with

Handshake

WSS
wss://api.hume.ai/v0/evi/chat/:chat_id/connect

Path parameters

chat_idstringRequired
The ID of the chat to connect to.

Query parameters

access_tokenstringOptionalDefaults to

Access token used for authenticating the client. If not provided, an api_key must be provided to authenticate.

The access token is generated using both an API key and a Secret key, which provides an additional layer of security compared to using just an API key.

For more details, refer to the Authentication Strategies Guide.

Send

ControlPlanePublishEventobjectRequired

Receive

SubscribeEventobjectRequired