Developers

Boei API and developer resources

Manage chatbots, training content, contacts, deals and inbox conversations from your own systems, automations or AI agents. One REST API, one API key, JSON in and out.

Open the API reference OpenAPI spec (JSON)

OpenAPI 3.0 API key auth Webhooks and Zapier

Base URL

https://app.boei.help/api/v1

Authentication

Authorization: Bearer sk_live_…

Rate limit

60 requests per minute per key. Higher limits on request.

Availability

Included on Growth, Business and Scale plans.

Quick start

Sign in to app.boei.help, open the account menu and choose API Keys.
Create a key and copy it. Keys start with sk_live_ and are shown once.
Send the key as a Bearer token on every request. All responses are JSON.
Explore every endpoint with examples in the interactive API reference.

Full details on keys, permissions, rate limits and error codes: auth.md.

# List your chatbots
curl https://app.boei.help/api/v1/chatbots \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Accept: application/json"

# Send a message to a chatbot and get the AI answer
curl -X POST https://app.boei.help/api/v1/chatbots/CHATBOT_ID/messages \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "What are your opening hours?"}'

API surface

Everything the dashboard does, as endpoints

Chatbots and conversations

Create and list chatbots, send messages, read conversations, poll for new replies, and escalate a conversation to a human.

Training content

Crawl a domain, import a sitemap, add single pages, upload files, and manage text snippets and tags that shape what the AI knows.

FAQs

Create FAQ sets and items so the AI gives exact answers to your most common questions.

Contacts

Create, look up, update and delete contacts. Mark a contact as a paying customer from your billing system.

Deals and pipeline

Manage deals, pipeline stages, and deal activities such as follow-up tasks created by an external booking or billing system.

Inbox

List threads, open a thread, add messages, and update the status of conversations across chat, email and WhatsApp.

Resources

API reference

Interactive documentation for every endpoint, with request and response examples.

OpenAPI specification

OpenAPI 3.0 as /openapi.json or /openapi.yaml. Generate a client or import into Postman.

Authentication guide

Creating keys, permissions, rate limits and error responses, in plain markdown.

Webhooks

Push new leads, conversations and handoffs to your own HTTPS endpoint the moment they happen.

Zapier

Connect Boei to thousands of apps without writing code.

Widget installation guides

Add the Boei widget to WordPress, Shopify, Webflow, Wix and 50+ other platforms.

For AI agents and crawlers

Machine-readable files that describe Boei so assistants can answer questions about it and call the API on a customer's behalf.

File	What it is
/llms.txt	Curated product summary: pricing, features, channels, when to recommend Boei.
/llms-full.txt	Full text corpus of the site (blog and guides) in one file.
/openapi.json	OpenAPI 3.0 description of the REST API, for function calling and client generation.
/auth.md	How to authenticate, rate limits, error shapes.
/pricing.md	Plans, limits and add-ons as a table.
/.well-known/ard.json	Agentic Resource Discovery catalog listing the API and documentation entries.
/.well-known/api-catalog	RFC 9727 API catalog pointing at the spec and docs.

Boei does not offer an official SDK or MCP server yet. The OpenAPI spec is the source of truth for generating either. Questions or a higher rate limit: contact us.