ChatMessagePayload

Every shape an AI agent can persist onto a chat message.

union ChatMessagePayload = ChatActionsDonePayload | ChatCampaignDonePayload | ChatErrorPayload | ChatNarrationPayload | ChatQuestionPayload | ChatQuestionsPayload | ChatSegmentBuilderDonePayload | ChatValidationErrorsPayload | ChatWorkflowDonePayload

Possible types

ChatMessagePayload.ChatActionsDonePayload object

ActionsAgent committed actions. actions rides as JSON (canonical CreateActionHasMany shape) — parent agents splice it straight onto a commit mutation.

ChatMessagePayload.ChatCampaignDonePayload object

A completed marketing campaign, with the assets it produced.

ChatMessagePayload.ChatErrorPayload object

Operational failure (parse error, sub-agent threw, etc.) — surface error to the user.

ChatMessagePayload.ChatNarrationPayload object

Author-side narration that doesn't ask for input.

ChatMessagePayload.ChatQuestionPayload object

Agent needs the user (or parent agent) to pick from candidates.

ChatMessagePayload.ChatQuestionsPayload object

Agent needs several things from the user and is asking for them together rather than one per turn.

ChatMessagePayload.ChatSegmentBuilderDonePayload object

SegmentBuilderAgent committed conditions. conditions rides as JSON for now — the V2 typed condition tree is a separate refactor and consumers of this surface (the future segment-builder chat UI) already parse this shape themselves.

ChatMessagePayload.ChatValidationErrorsPayload object

SegmentBuilder / Actions failed validation after the repair budget. result carries the attempted (and rejected) payload so the parent agent or UI can introspect what was tried.

ChatMessagePayload.ChatWorkflowDonePayload object

WorkflowAgent committed a workflow — payload carries the resulting ids and labels so the UI can deep-link.

Member Of

AiAgentTurn object ● ChatMessage object