Agent Invocations WebSocket

Establish a WebSocket connection to a hosted agent

GET /agents/{agent_name}/endpoint/protocols/invocations_ws

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.

Parámetros de la ruta de acceso

agent_name string requerido

The name of the hosted agent.

Parámetros de consulta

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 requerido

The API version to use for this operation.

Respuestas

The request has succeeded.

Encabezados

x-agent-session-id string requerido

Session ID for this WebSocket connection. Returns the provided session ID or an auto-generated one if not provided in the request.

Cuerpo

Content-Type: application/json