Appearance
chat.conversation.send-message.return-payload ​
Assemble the canonical send-message response payload
Echo the assembled chat turn back as the DAG's final step output.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-chat |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
conversation_uuid | uuid | Yes | — | — |
user_message_uuid | uuid | Yes | — | Public uuid of the user-turn ChatMessage |
assistant_message_uuid | uuid | Yes | — | Public uuid of the assistant-turn ChatMessage |
assistant_message | json | Yes | — | — |
workflow_run_uuid | uuid | No | — | — |
workflow_run_id | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
assistant_message | json | Yes | — | Final assistant payload returned to the API caller |
conversation_uuid | uuid | No | — | — |
user_uuid | uuid | No | — | — |
organization_uuid | uuid | No | — | — |
user_message | string | No | — | — |
provided_inputs | json | No | — | — |
confirmed_action | json | No | — | — |
llm_connection_uuid | uuid | No | — | — |
stream | boolean | No | — | — |
deep_reasoning | boolean | No | — | — |
proactive | boolean | No | — | — |
workflow_run_uuid | uuid | No | — | — |
workflow_run_id | string | No | — | — |
last_message_preview | string | No | — | — |
dgi_workflow_uuid | uuid | No | — | — |
user_message_uuid | uuid | No | — | — |
assistant_message_uuid | uuid | No | — | — |
failure_reason | string | No | — | Engine-stamped human-readable failure reason |
failed_at_state | string | No | — | Engine-stamped state when the workflow failed |
failed_step | string | No | — | Engine-stamped step name (DAG path) |
failed_layer | integer | No | — | Engine-stamped layer index (DAG path) |
error | string | No | — | Engine-stamped exception message |
error_type | string | No | — | Engine-stamped exception class name |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "chat.conversation.send-message.return-payload",
"initial_data": {
"conversation_uuid": "value",
"user_message_uuid": "value",
"assistant_message_uuid": "value",
"assistant_message": "value"
}
}