Skip to main content
POST
Interact with agent (REST, non-streaming)

Response modes

Lean response

Verbose response

Returns turns, lastBotMessage, debugMessages, and metadata (token usage, KB sources, variables) — the previous default shape.

Example

Use lean for MCP / agent-creator iteration so tool results stay in context. Switch to verbose only when debugging tooling or node switches.

Body

application/json
agentId
string
required

The agent ID to interact with

convoId
string
required

Conversation ID - use the same ID to continue a conversation

bucket
enum<string>
required

Region bucket

Available options:
voiceglow-eu,
(default)
prompt
string
required

The user message/prompt to send

sessionId
string

Optional session ID for LangChain message tracking

agentData
object

Optional agent configuration override

turnsHistory
any[]

Optional previous turns (loaded from Firebase if not provided)

workspaceData
any

Optional workspace data

lightConvoData
any

Optional conversation metadata (user info, origin, etc.)

disableUiEngine
boolean

Disable UI Engine responses

disableRecordHistory
boolean

Skip saving to Firebase

isTest
boolean

Mark as test interaction

kbPreview
boolean

Include KB sources in response

messageType
enum<string>

Message type

Available options:
text,
visual
visualPayload
object

Structured payload for visual uploads

initNodesOptions
object

Override tools, variables, or messages

v2
boolean
lgMessages
any[]

LangChain messages history for context

timeout
number

Request timeout in ms (default: 60000)

responseMode
enum<string>
default:lean

lean (default): assistantText + uiEngineSummary + kbDocsRetrieved + imagesShown. verbose: full turns/debug/metadata dump.

Available options:
lean,
verbose

Response

Successful response

success
boolean
required
assistantText
string
required
uiEngineSummary
object[]
required
kbDocsRetrieved
string[]
required
imagesShown
string[]
required
error
string