Agent Invocations WebSocket
Establish a WebSocket connection to a hosted agent
Establishes a WebSocket connection to a hosted agent. The target agent is a
path segment and the project is taken from the endpoint, mirroring the HTTP
/invocations route. The service resolves (or creates) a session, resolves
the agent version, then relays text and binary frames bidirectionally
between the client and the agent (1 MB maximum frame size).
The client must send an HTTP GET with Upgrade: websocket headers.
Path parameters
agent_name
string
required
The name of the hosted agent.
Query parameters
agent_session_id
string
Optional session/conversation ID. Pass the same value on a subsequent connection to reattach to an existing session. If not provided, the service auto-generates one.
api-version
string
required
The API version to use for this operation.
Responses
The request has succeeded.
Headers
x-agent-session-id
string
required
Session ID for this WebSocket connection. Returns the provided session ID or an auto-generated one if not provided in the request.
Body
Request
GET /agents/{agent_name}/endpoint/protocols/invocations_ws HTTP/1.1Response
Status: 200
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json