Models Hub
API ReferenceAudio & Others

Realtime WebSocket connection

Establish a WebSocket connection for realtime conversations. **Note**: This is a WebSocket endpoint and must be connected using the WebSocket protocol. Example connection URL: `wss://api.example.com/v1/realtime?model=gpt-4o-realtime`

Edit this page
GET
/v1/realtime

Authorization

bearerAuth
AuthorizationBearer <token>

Authenticate using an Authorization Bearer API Key.

In: header

Query Parameters

model?string

The model to use

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/realtime"
Empty
{
  "success": true,
  "message": "string",
  "data": null
}
{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}