Realtime WebSocket

WebSocket endpoint for realtime voice agent communication. The client must send an HTTP Upgrade request; a successful connection returns 101 Switching Protocols. OpenAPI 3.1 does not natively support WebSocket, so this is documented descriptively.

GET /v3/realtime/{name}

Realtime WebSocket

cURL

curl --request GET \
  --url https://api.opper.ai/v3/realtime/{name} \
  --header 'Authorization: Bearer <token>'

400

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

Authorization · string · header · required

API key authentication. Pass your API key as a Bearer token.

Path Parameters

name · string · required

Function name

Response

101

Switching Protocols – WebSocket connection established