API Reference
Overview
Connection Flow
Basic Flow
WebSocket Handshake
Authorizations
AuthorizationstringRequired
Raw API key as used by client (no 'Bearer ').
Query parameters
config_idstringRequired
Configuration ID for the persona (e.g., oris config).
Header parameters
AuthorizationstringRequiredExample:
Raw API key used by client (no 'Bearer ' prefix).
<API_KEY>Responses
101
Switching Protocols: WebSocket upgrade
401
Unauthorized (invalid or missing API key)
get
/No content
Messages Reference
Session Messages
Interaction Messages
Error Messages
Message Details
InteractionInput (Client → Server)
InteractionResponse (Server → Client)
EndInteraction vs CancelInteraction
Message
Purpose
Server Behavior
Use Case
Rate Limits & Constraints
Error Codes
Code
Description
Best Practices
1. Audio Chunking
2. Buffer Management
3. Idle Frame Handling
4. Error Handling
5. Rate Limiting
6. Interruption Handling
7. Frame Synchronization
Troubleshooting
Complete Example
Last updated
Was this helpful?