Skip to main content
GET
OpenAI-compatible realtime session (WebSocket)

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Query Parameters

model
enum<string>
default:pyai-omni-realtime
required

Realtime model. pyai-omni-realtime (Omni, agentic voice) is the default and the model served on this surface.

Available options:
pyai-omni-realtime
session_label
string

Omni only. Optional opaque tag echoed to your own kb_endpoint (PyAI stores no per-agent state). Nothing to pre-create; the session is authorized by your key's org.

agent_id
string

Omni only. Deprecated alias for session_label; prefer session_label. If both are present, session_label wins.

Response

Switching Protocols, the duplex WebSocket is open.