Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Chat Engine home page

Dashboard
Dashboard

Chat Engine API

Knowledge Base API

Join our Community
GitHub

agents

GET
Get public agent details by ID
GET
Get all agents
POST
Create a new agent
GET
Get agents default values
GET
Get an agent by id
DEL
Delete an agent
PATCH
Update an agent
DEL
Remove tool from agent
DEL
Remove knowledge store from agent
POST
Generates agent questions
DEL
Remove voice config from agent

agents-v2

GET
Get all agents
POST
Create a new agent

models

GET
Get all models
POST
Create a new model/models
GET
Get a model by id
DEL
Delete a model
PATCH
Update a model
PATCH
Update a model pricing

chat

GET
List chat sessions
POST
Create a new chat session
GET
List all messages of the chat
POST
Send a message to the chat
GET
Get a chat session by ID
PATCH
Close a chat session
GET
Get chat by agent Id
GET
List all Events of the chat

meters

GET
Get meters
POST
Ingest event for model usage
GET
Get model usage meters

Webhooks

GET
Retrieve all applications
POST
Create New Application
GET
List webhook endpoints
POST
Create webhook endpoint with events
DEL
Delete webhook endpoint
PATCH
Update webhook endpoint with events
GET
Get Event types for webhook
POST
Create Event types for webhook
DEL
Delete Event type for webhook
PATCH
Update Event type for webhook
POST
Broadcast event to all endpoints
GET
Information about webhook endpoint

tools

GET
Get Tool default configurations
GET
Get all tools
POST
Create a new tool
GET
Get a tool by ID
DEL
Delete a tool
PATCH
Update an existing tool

API Reference

GET
Get apiv1health
GET
Get all user stats for usage meter
GET
Get all agent summary stats for usage meter
POST
Post apiv1whatsappreceive
GET
Get apiv1whatsapp
POST
Create a new voice session
POST
Send a voice message as text

whatsapp-tenant-configs

POST
Post apiv1whatsapp tenant configstypetwilio
GET
Get apiv1whatsapp tenant configs
GET
Get apiv1whatsapp tenant configs 1
DEL
Delete apiv1whatsapp tenant configs
PATCH
Patch apiv1whatsapp tenant configs

onboarding

POST
Generate onboarding code
GET
Retrieve onboarding record by code
POST
Onboard twilio whatsapp account

Phone Numbers

GET
Get all phone numbers
POST
Create a new phone number
DEL
Delete a phone number
PATCH
Map a phone number to an agent
POST
Start an outbound call

Webhooks

Create New Application

This creates a new application for configuring webhooks, mainly used for multi tenancy purpose Note: This is a management API and requires api-key

Retrieve all applications List webhook endpoints

⌘I

github linkedin

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform