Chatbot Messages

Send Message

Send a message to a chatbot and get an AI-generated response.

post/chatbots/{chatbot_id}/messages

Request

  • Base URL
    https://app.boei.help/api/v1
  • Auth
    HTTP bearer

Request body

messagestring required

The user's message (max 250 characters).

conversation_idstring nullable

Optional UUID to continue existing conversation. If not provided or doesn't exist, creates new conversation.

domain_idinteger nullable

Explicit domain the assertion is signed under. Optional: falls back to the caller's single-domain default if unambiguous. The <code>id</code> of an existing record in the domains table.

source_tagsstring[]

Optional tags to filter which training sources are searched.

languagestring nullable

Optional 2-character language code.

response_format'plaintext' | 'markdown' | 'html' nullable
is_testboolean nullable

Example request

{
  "message": "What's your pricing?",
  "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
  "contact": {
    "email": "john@example.com",
    "name": "John Doe",
    "phone": "+1234567890",
    "company": "Acme Corp",
    "custom": [
      "n"
    ],
    "jwt": "i"
  },
  "domain_id": 16,
  "source_tags": [
    "enterprise",
    "pricing"
  ],
  "language": "en",
  "response_format": "html",
  "current_page": {
    "url": "example.com/trainings/leadership",
    "title": "Leadership Training May 2026"
  },
  "is_test": true,
  "attachments": [
    {
      "url": "http://breitenberg.com/nostrum-aut-adipisci-quidem-nostrum.html",
      "name": "l",
      "size": 20,
      "mime": "q"
    }
  ]
}

Response

message_idstring
conversation_idstring
responsestring
created_atstring

Example response

{
  "message_id": "msg_abc123",
  "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
  "response": "Our pricing starts at $99/month...",
  "sources": [
    {
      "title": "Pricing Page",
      "url": "https://example.com/pricing",
      "type": "webpage"
    }
  ],
  "usage": {
    "credits_used": 1,
    "monthly_remaining": 9500,
    "monthly_limit": 10000
  },
  "created_at": "2026-01-29T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.