v1

latestOpenAPI 3.1.02026-08-047777149.4 KB

Workspace Chat

Start or continue a workspace chat (SSE)

Stream an AI investigation turn as Server-Sent Events. This is the endpoint the RunWhen UI and MCP workspace_chat tool use. Set sessionId to null on the first turn; reuse the sessionId from the response stream on follow-ups. To invoke a saved slash-command programmatically, set message to a markdown link [command-name](http://chat-command/{commandId}) — the same format the UI sends.

post/api/v1/workspaces/{workspace}/chat-pro-sse

Path parameters

workspacestring required

Workspace short name

Request body

userIdstring email required

Caller identity — sessions are keyed on this value

messagestring required

User message for this turn

sessionIdstring nullable required

Existing session id, or null to start a new session

personaNamestring nullable

Assistant (persona) short name. Omit for the workspace default.

workspaceNamestring

Optional when workspace is in the URL path

source'ui' | 'slack' | 'teams'

Chat surface — affects prompt-hub override resolution

enableScrubbingboolean

kbSearchEnabledboolean

autoApproveReadonlyboolean

When true and sessionId is null, seed auto-approve for read-only task runs on the new session

Response

SSE stream of ChatSseEvent JSON objects