Skip to main content

Send message

Sends a message to an agent and receives its AI-generated reply using the agent’s knowledge base. Each call consumes AI credits from your plan; the amount depends on the agent’s model (see AI models and credits).
Required scope: chat:write

Path parameters


Request body

Example — first message

Example — continue a conversation

Example — message with an attachment


Attachments

One attachment per message is supported: a PNG, JPEG, WebP or GIF image (up to 5 MB) or a PDF (up to 15 MB). The message field is still required.
  • Images: the agent sees them if its model supports images. If not, it knows there was an attachment it couldn’t see and may ask for it to be described.
  • PDF: depending on the model, the agent reads the full document or the text extracted from the PDF. A scanned PDF without selectable text may not be readable for some models.
Only files uploaded with Upload attachment are processed. The attachment is saved in the conversation.

Response

Response fields

contact_capture


How context works

Each request that includes the same conversation_id keeps the history of the conversation’s last 10 messages. This enables coherent multi-turn conversations. Without conversation_id, each call is an independent conversation with no previous context.

Common errors