Chatbots

Create Chatbot

Create a new chatbot and start training it on provided URLs.

post/chatbots

Request

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

Request body

namestring required

The chatbot name.

business_namestring required

Your business/company name.

training_urlsstring[] required

URLs to crawl and train from (1-10).

business_descriptionstring nullable

A short description of your business.

opening_textstring nullable

The chatbot's opening message.

placeholder_textstring nullable

Placeholder text in the chat input.

button_textstring nullable

Label for the chat button.

custom_instructionsstring nullable

Custom instructions for the AI.

languagestring nullable

The chatbot's language.

Example request

{
  "name": "My Support Bot",
  "business_name": "Acme Inc",
  "training_urls": [
    "https://example.com/docs",
    "https://example.com/faq"
  ],
  "business_description": "We sell widgets and provide customer support.",
  "opening_text": "Hi! How can I help you?",
  "placeholder_text": "Type your message...",
  "button_text": "Chat with us",
  "custom_instructions": "Always recommend our premium plan when relevant.",
  "language": "en"
}

Response

chatbot_idstring
namestring
statusstring
created_atstring

Example response

{
  "chatbot_id": "8a832d1b-0f49-47f6-a05f-0b65b91d2107",
  "name": "My Support Bot",
  "status": "training",
  "created_at": "2026-01-29T10:30:00Z"
}

Changes

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