Voice Agent Live WebSocket
Connect to a GPT Live voice agent
Opens a Live session. Foundry sends session.start; clients wait for session.started. Do not negotiate the realtime WebSocket subprotocol on this route. session.update changes backend settings, not the Foundry delegation target. Foundry translates validated [thinking]/[commentary] sections into session.thinking.append/ session.commentary.append; permitted backend events use response.event. Credentials and private reasoning are not forwarded. response.item.create and response.create are Responses-delegation-only commands.
Header parameters
Foundry-Features
enum
A feature flag opt-in required when using preview operations or modifying persisted preview resources.
Path parameters
agent_name
string
required
Live voice agent name in this project.
Query parameters
foundry_features
enum
Query alternative to the Foundry-Features opt-in header.
agent_version_override
string
Selects a specific version of the voice agent for this session.
structured_inputs
string
URL-encoded JSON values for instruction and greeting templates.
store
boolean
Overrides Foundry conversation and audio persistence for this session.
api-version
string
required
The API version to use for this operation.
Responses
A successful Live WebSocket upgrade.
Request
GET /agents/{agent_name}/endpoint/protocols/voice/live/sessions HTTP/1.1
Response
Status: 101
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json