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.

Body Params

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

agent_id

string

required

The ID of the agent to chat with

enhanced_reasoning

boolean

Defaults to false

Enable enhanced reasoning capabilities, will increase latency but will also improve 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 - requires develop tier access

500

Server error

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/event-stream

200Streaming chat response