Chat with agent (streaming)

post

https://{instanceUrl}/agent/stream-chat

Send a message to an agent and receive the response as a Server-Sent Events
(SSE) stream. Events include message_start, content_delta, tool_use,
tool_result, message_end, and error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for the streaming chat endpoint.

message

string

required

The message to send to the agent

context

string

Optional context for the conversation

session_id

string

Optional session ID for conversation continuity. Only one request may be active for a session at a time; overlapping turns for the same session return 409 Conflict.

agent_id

string

required

The ID of the agent to chat with

enhanced_reasoning

boolean

Defaults to false

Enable enhanced reasoning capabilities. Increases latency but improves response quality and reliability.

Headers

X-Phenoml-On-Behalf-Of

string

Optional header for on-behalf-of authentication. Used when making requests on behalf of another user or entity.
Must be in the format: Patient/{uuid} or Practitioner/{uuid}

X-Phenoml-Fhir-Provider

string

Optional header for FHIR provider authentication. Contains credentials in the format {fhir_provider_id}:{oauth2_token}.
Multiple FHIR provider integrations can be provided as comma-separated values.

Responses

400

Invalid request

401

Unauthorized

403

Forbidden - access denied to the requested resource

404

Agent or session not found

409

Chat session already has an active request. Retry after the in-flight turn completes.

500

Server error

504

Request timed out

200Streaming chat response. Each frame is a standard SSE record (event: line + data: JSON line). The example shows a single content_delta payload — multiple frames stream until message_end.