RealtimeAPIClientParameters
Inworld.RealtimeAPIClient parameters. Can be passed as arguments to the Inworld.createRealtimeAPIClient method.
Props
apiKey: string
The API key for the Inworld Realtime API.
authScheme: string
Optional. The authentication scheme (basic or bearer) for the Inworld Realtime API. The default value is bearer.
onWebSocketClose: (event: WebSocketEvents.CLOSE) => void
Optional. A callback function that is called when the WebSocket connection is closed.
privacy: boolean
Optional. Whether to enable the privacy functionality.
If privacy is enabled, the logging for the WebSocket connection is disabled.
NOTE: the default value is false.
sessionKey: string
The session key for the Inworld Realtime API.
statistics: boolean
Optional. Enables statistics functionality.
trace: boolean
Optional. Whether to enable the tracing functionality.
If tracing is enabled, a URL to the trace file appears in the 'websocket.created' message. The file contains all sent and received WebSocket messages in the plain text format. The file is uploaded to the S3 storage.
NOTE: enable this only for diagnostic purposes. You can provide the trace file to our support team to help investigate issues.