Skip to main content
POST
Ask the AI Assistant

Authorizations

X-API-Key
string
header
required

Path Parameters

conversation_id
string<uuid>
required

Body

application/json

Send the AI Assistant a message.

prompt
string
required
Required string length: 1 - 4000

Response

Successful Response

Both halves of one turn, as saved.

The user message too, not just the reply: the client drew its own copy before sending and reconciles it against this one.

assistant_message
WorkspaceChatMessageReadSchema · object
required

One message in a conversation, with the action cards a reply raised.

Deliberately leaves out why a failed turn failed and what it cost: the first can carry a supplier's own words, and neither is the customer's. The cards ride on the message so a transcript renders them under the right reply without a second request.

user_message
WorkspaceChatMessageReadSchema · object
required

One message in a conversation, with the action cards a reply raised.

Deliberately leaves out why a failed turn failed and what it cost: the first can carry a supplier's own words, and neither is the customer's. The cards ride on the message so a transcript renders them under the right reply without a second request.