API Reference

Introduction

The ChatBotify API allows you to programmatically manage your chatbots, knowledge bases, and conversations. You can use the API to integrate ChatBotify with your existing systems or build custom applications on top of our platform.

All API requests should be made to the following base URL:

Authentication

To authenticate with the ChatBotify API, you need to include your API key in the Authorization header of your requests:

You can generate an API key in the ChatBotify dashboard under Settings > API Keys.

Rate Limits

The ChatBotify API has the following rate limits:

• Free plan: 100 requests per minute
• Pro plan: 500 requests per minute
• Business plan: 2000 requests per minute

If you exceed the rate limit, you will receive a 429 Too Many Requests response.

Errors

The ChatBotify API uses conventional HTTP response codes to indicate the success or failure of an API request:

• 2xx: Success
• 4xx: Client error (e.g., invalid request)
• 5xx: Server error

Error responses include a JSON object with more information:

{
  "error": {
    "code": "invalid_request",
    "message": "The request was invalid",
    "details": "The 'name' field is required"
  }
}

Chatbots

The Chatbots API allows you to create, update, and manage your chatbots.

List Chatbots

Create Chatbot

Get Chatbot

Update Chatbot

Delete Chatbot

Knowledge Bases

The Knowledge Bases API allows you to manage the knowledge bases that power your chatbots.

List Knowledge Bases

Create Knowledge Base

Get Knowledge Base

Update Knowledge Base

Delete Knowledge Base

Conversations

The Conversations API allows you to retrieve and manage conversations between users and your chatbots.

List Conversations

Get Conversation

Send Message

Analytics

The Analytics API allows you to retrieve usage and performance data for your chatbots.

Get Chatbot Analytics

Get User Satisfaction

Get Top Questions