Widget API v1

API Documentation

Integrate Kadefy AI Chat Builder into any application. Use our Widget API to create sessions, send messages, capture leads, and more.

Getting Started

The Widget API lets you integrate Kadefy AI Chat Builder chatbots into any application. Use it to programmatically create chat sessions, send messages with streaming AI responses, capture visitor leads, and collect feedback.

WordPress Plugin coming soon. We're building an official WordPress plugin that uses this same API. Stay tuned for a one-click integration.

Authentication

No authentication is required for widget endpoints. These endpoints are designed to be called from client-side code (browsers, mobile apps, etc.) without exposing API keys. Rate limits are enforced per the chatbot owner's subscription plan for the message endpoint, and per-IP for all other endpoints.

Base URL

This is the base URL for the Kadefy AI Chat Builder API. All endpoint paths below are relative to this URL.

https://chatbot.kadefy.ai

Endpoints

Click any endpoint to expand its documentation, including request/response schemas and code examples.

Rate Limits & Quotas

API access is available on all plans, including Free. Rate limits vary by endpoint type. When a rate limit is exceeded, the API returns a 429 status code.

Plan-Based Limits (Message Endpoint Only)

These limits apply only to POST /api/widget/message. They are tied to the chatbot owner's subscription plan, not the visitor's IP.

PlanPriceRate LimitMessages / Month
FreeFree10 req/min50
Starter$9/mo30 req/min500
Pro$19/mo60 req/min2,500
Business$49/mo120 req/min10,000
Enterprise$99/mo120 req/min25,000

Fixed Endpoint Limits (All Plans)

These limits are per-IP and apply to all users regardless of plan. They protect endpoints from abuse.

EndpointLimitWindowScope
GET /api/widget/config/:id60 requests1 minutePer IP
POST /api/widget/session10 requests15 minutesPer IP
POST /api/widget/lead5 requests15 minutesPer IP
POST /api/widget/feedback30 requests15 minutesPer IP
POST /api/widget/transcript3 requests15 minutesPer IP

Admin REST API

Coming Soon

A fully authenticated REST API for managing chatbots, knowledge bases, analytics, and webhooks programmatically. Requires API key authentication. Ideal for integrations and automation.

Chatbot Management

  • GET/api/v1/chatbots
  • POST/api/v1/chatbots
  • GET/api/v1/chatbots/:id
  • PUT/api/v1/chatbots/:id
  • DELETE/api/v1/chatbots/:id

Knowledge Base

  • GET/api/v1/chatbots/:id/sources
  • POST/api/v1/chatbots/:id/sources
  • DELETE/api/v1/chatbots/:id/sources/:sourceId
  • POST/api/v1/chatbots/:id/retrain

Analytics & Leads

  • GET/api/v1/chatbots/:id/sessions
  • GET/api/v1/chatbots/:id/leads
  • GET/api/v1/chatbots/:id/stats

Webhooks

  • GET/api/v1/webhooks
  • POST/api/v1/webhooks
  • DELETE/api/v1/webhooks/:id
    API Documentation | Kadefy AI Chat Builder | Kadefy AI Chat Builder