Skip to content

Commit 8be9375

Browse files
committed
clarify the /events endpoint description
1 parent 1153ef7 commit 8be9375

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

lib/httpapi/server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ func (s *Server) registerRoutes() {
118118
Method: http.MethodGet,
119119
Path: "/events",
120120
Summary: "Subscribe to events",
121-
Description: "The events are sent as Server-Sent Events (SSE). Initially, the endpoint returns a list of events needed to reconstruct the current state of the conversation and the agent's status. After that, it only returns events that have occurred since the last event was sent.",
121+
Description: "The events are sent as Server-Sent Events (SSE). Initially, the endpoint returns a list of events needed to reconstruct the current state of the conversation and the agent's status. After that, it only returns events that have occurred since the last event was sent.\n\nNote: When an agent is running, the last message in the conversation history is updated frequently, and the endpoint sends a new message update event each time.",
122122
}, map[string]any{
123123
// Mapping of event type name to Go struct for that event.
124124
"message_update": MessageUpdateBody{},

0 commit comments

Comments
 (0)