Skip to main content

WebSocket API Connection

Connect directly to NextEVI’s WebSocket API for maximum control and platform flexibility. This guide covers establishing connections, authentication, and basic message handling.

Quick Start

WebSocket URL

string
required
Unique connection identifier. Generate a UUID v4 for each new connection.

Authentication Methods

Connection Examples

Platform-Specific Examples

Connection Flow

  1. WebSocket Handshake: Client initiates WebSocket connection
  2. Authentication: Server validates API key or JWT token
  3. Connection Metadata: Server sends connection details
  4. Session Settings: Client configures audio and feature settings
  5. Ready: Connection ready for voice communication

Next Steps

Message Protocol

Learn the complete WebSocket message format

Audio Handling

See examples of sending and receiving audio

Troubleshooting

Connection Issues

  • Ensure your API key starts with oak_
  • Verify your config_id is valid
  • Check network connectivity and firewall settings

Authentication Errors

  • Double-check API key format and permissions
  • Ensure JWT token is properly formatted and not expired
  • Verify project_id matches your configuration
See Error Reference for complete error codes and solutions.