REST API

The Boei API allows you to programmatically manage your chatbots, training content, tags, and conversations. This is useful for integrating Boei into your applications, building custom interfaces, or automating chatbot interactions.

How to get there: Go to Settings → API Keys in the left menu.

Authentication

All API requests require authentication using an API key.

Getting Your API Key

  1. Log in to your Boei account
  2. Go to Settings → API Keys in the left menu
  3. Create a new API key
  4. Copy the key — you won't be able to see it again

Important: Store your API key securely. It provides full access to your account.

Using Your API Key

Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Base URL

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

API Documentation

For a full list of available endpoints, request/response examples, and interactive testing, visit the API Documentation.

The interactive docs let you:

  • Browse all available endpoints
  • See request and response schemas
  • Try out API calls directly from the browser
  • View code examples in multiple languages

Choosing a follow-up form

PUT /api/v1/chatbots/{chatbot_id} accepts handoff_followup_form_id. Use the ID of an enabled AI-condition form owned by that agent, or null to clear the choice. A selected form must have a success message. Choosing a form turns off Ask for email, just like the Handoff screen. Clearing the form does not turn email collection on automatically.

This uses the same stored setting as Handoff > Follow-up. Edit the form's message in Forms or the Follow-up card. The API rejects forms from another agent and leaves the current choice unchanged.

Rate Limits

  • Requests per minute: 60
  • Monthly messages: Based on your plan (check usage in API responses)

If you exceed rate limits, you'll receive a 429 status code. Wait before retrying.

Support

Need help with the API?

  • Check the interactive API docs for endpoint details
  • Review error messages for specific guidance
  • Contact support with your API request details (never share your API key)
Powered by ProductLift