Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-1391215649.1 KB

64bfe76b130e

Agents

Regenerate agent conversation message

Regenerate the AI response for a specific message in an agent conversation and stream the new answer over Server-Sent Events.

Constraints:

  • Only the last message in the conversation can be regenerated.
  • The target message must be of type bot_response.

Request body:

chatMode: quick is required. Other fields are optional and reuse the original model/context when omitted. The body supports:

  • filters
  • chatMode
  • modelKey
  • modelName
  • modelFriendlyName
  • timezone
  • currentTime
  • tools
  • protocol
  • agentCapabilities

Streaming behavior:

The response is delivered as an AG-UI text/event-stream. Stable outcomes are RUN_FINISHED and RUN_ERROR; see AgentRegenerateSSEEvent.

Additional agent/tool lifecycle events may be forwarded by the backend and should be treated as informational updates.

Validation failures on params/body are returned as normal HTTP 400 responses before the stream starts. Valid-shape requests that fail conversation lookup or regenerate rules are reported as RUN_ERROR events after stream initialization.

post/agents/{agentKey}/conversations/{conversationId}/message/{messageId}/regenerate

Path parameters

agentKeystring required

Stable key identifying the agent that owns this conversation.

conversationIdstring objectId required

ID of the agent conversation containing the target message.

messageIdstring objectId required

ID of the bot-response message to regenerate.

Request body

modelKeystring

Identifier of the AI model configuration to use for regeneration. Typically a UUID returned by the model-management endpoints. When omitted, the model used for the original message is reused.

modelNamestring

Provider model name (e.g. the underlying LLM identifier).

modelFriendlyNamestring

Friendly display name of the selected model.

chatMode'quick' required

Chat mode used for regeneration (for example internal_search, web_search, or the universal agent mode).

timezonestring

IANA timezone identifier from the client. Used to provide time-aware context to the AI during regeneration.

currentTimestring date-time

ISO 8601 / RFC 3339 datetime from the client (UTC Z or numeric offset). Used to anchor any relative time references in the query.

toolsstring[]

Optional list of tool identifiers (fully-qualified action names such as jira.create_issue) the agent may invoke when regenerating. Applicable only in agent chat modes.

protocol'agui'

AG-UI is the only supported wire protocol. When present must be "agui". Omitting the field is equivalent — the server always uses the AG-UI vocabulary. Kept in the schema for backward compatibility with callers that already send it.

Example request

{
  "modelKey": "05438a37-68f2-4641-a8dc-6c47e63278ca",
  "modelName": "gpt-5.4-mini",
  "modelFriendlyName": "mini",
  "chatMode": "internal_search",
  "timezone": "Asia/Calcutta",
  "currentTime": "2026-05-11T15:43:21+05:30",
  "tools": [
    "jira.create_issue",
    "confluence.search_content"
  ]
}

Response

SSE stream established.

Stable event names:

  • RUN_FINISHED — { type, result }, where result contains the updated conversation and metadata
  • RUN_ERROR — { type, message, code? }, reporting lookup, authorization, or regenerate-rule failures

Forwarded lifecycle and child-run events may include runId, threadId, and parentRunId. Additional backend-defined agent/tool events may be emitted. Clients should ignore unknown event names.