latestOpenAPI 3.1.02026-08-10466368560.6 KB

2b2bab8b9017

agents

Chat Stream

Stream chat events from Nova OS via SSE.

Each SSE event is a JSON object matching the Nova OS pipeline event shape: data: {"type": "text", "text": "..."} data: {"type": "tool_use", "name": "...", "input": {...}} data: {"type": "tool_result", "content": "..."} data: {"type": "thinking", "thinking": "..."} data: {"type": "done", "response": "...", "conversation_id": "..."} data: [DONE]

Falls back to a single synthetic "done" event when the agent is not registered in Nova OS or the backend is MESH_BACKEND=ang.

post/agents/v1/{api_key}/chat/stream

Path parameters

api_keystring required

Request body

messagestring required
user_identifierstring nullable
user_identifier_typestring nullable
conversation_idstring uuid nullable
extra_dataobject nullable
attachmentsobject[] nullable

Response

Successful Response

{"stackTrail":"paths:/agents/v1/{api_key}/chat/stream:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}