v10

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-0582185581.9 KB

Agents

Add message to agent conversation with streaming response

Append a user message to an existing agent conversation and stream the assistant reply over SSE.

post/agents/{agentKey}/conversations/{conversationId}/messages/stream

Path parameters

agentKeystring required

conversationIdstring objectId required

Request body

querystring required

User follow-up prompt to append to the existing agent conversation. Saved as a new user_query message before the upstream AI stream starts.

chatMode'auto' | 'quick' | 'verification' | 'deep'

Chat mode hint forwarded to the agent backend. Defaults to auto in the upstream AI payload when omitted.

auto lets the agent pick its default strategy.
quick favors low-latency answers over depth.
verification runs additional grounding/verification passes.
deep performs deeper retrieval and reasoning.

modelKeystring

AI model configuration id override for this turn. Omit to use the agent's default model.

modelNamestring

Provider model name (the underlying LLM identifier).

modelFriendlyNamestring

Friendly UI label for the selected model.

timezonestring

Client IANA timezone, such as America/New_York. Helps the agent resolve relative date references in the prompt.

currentTimestring date-time

Client time in ISO 8601 / RFC 3339 format (UTC Z or numeric offset). Sent alongside timezone for time-aware answers.

toolsstring[]

Allowed tool ids for this turn, such as jira.create_issue. Omit to let the agent use its default toolset; send [] to disable tools for this turn.

Example request

{
  "query": "can you elaborate on the latest headlines?",
  "modelKey": "5c1832f4-fa19-4167-b913-307fad3a6551",
  "modelName": "gpt-5.4-mini",
  "modelFriendlyName": "GPT 5.4 mini",
  "chatMode": "verification",
  "timezone": "Asia/Kolkata",
  "currentTime": "2026-05-19T12:58:01+05:30",
  "tools": [],
  "filters": {
    "apps": [
      "2605c882-61d4-4aa2-b480-a68c957c151d",
      "ed6d6cc4-70bd-4838-9aeb-488e910c833a"
    ],
    "kb": [
      "8747da12-4724-4a95-ac92-827b88d79647"
    ]
  },
  "appliedFilters": {
    "apps": [
      {
        "id": "2605c882-61d4-4aa2-b480-a68c957c151d",
        "name": "US Headlines, abcnews",
        "nodeType": "app",
        "connector": "RSS"
      },
      {
        "id": "ed6d6cc4-70bd-4838-9aeb-488e910c833a",
        "name": "ABC News RSS",
        "nodeType": "app",
        "connector": "RSS"
      }
    ],
    "kb": [
      {
        "id": "8747da12-4724-4a95-ac92-827b88d79647",
        "name": "Siddhant Ota's Private",
        "nodeType": "recordGroup",
        "connector": "KB"
      }
    ]
  }
}

Response

SSE stream (text/event-stream)