Skip to main content
The sendUserMessage mutation sends a user’s message or question to an existing conversation, triggering AI-powered analysis and response generation.

Signature

Arguments

String!
required
The unique identifier of the conversation to send the message to.
String!
required
The unique identifier of the domain containing the conversation.
DeltaInput!
required
The user’s message content. See DeltaInput.
Boolean
Whether to create a hidden conversation if needed. Defaults to false.
ToolSelection
Specific tools to use for processing the message.
  • Use TABULAR_DATA to enable querying databases.
  • Use TEXTUAL_DATA to enable querying unstructured documents.
See ToolSelection.
String
The name of the AI model to use for response generation.
Boolean
Whether this message is part of user onboarding. Defaults to false.
Boolean
Whether to enable artifact editing mode. Defaults to false.
ChatThinkingEffort
The level of thinking effort to apply. See ChatThinkingEffort.
Boolean
Whether to disable clarification questions. Defaults to false.
Boolean
Whether to enable deep analysis mode. Defaults to false.
Boolean
Whether this is an evaluation trigger. Defaults to false.

Response

Returns a ResponseStatus object indicating the success or failure of the operation. See ResponseStatus for the schema.

Usage example

Send a question about sales data to a conversation:

Subscribe Conversation

Listen for real-time response updates