Query Endpoint
Send messages to your chatbot and receive AI-powered responses using our query API endpoint.
Endpoint Overview
Method
POSTURL
/api/chatbot/queryContent-Type
application/jsonRequest Parameters
Request Body (JSON)
Parameter
Type
Required
Description
message
string
Yes
The user's message/question
chatbotId
string
Yes
Your chatbot's unique identifier
sessionId
string
No
Session ID for conversation context
mode
string
No
Response mode: standard, productivity, creative
Query Modes
standard
HighDefault AI-powered responses using vector search
800-1200ms
productivity
Very HighOptimized for business queries and task completion
600-900ms
creative
HighEnhanced responses for creative and open-ended questions
1000-1500ms
Example Request
curl -X POST https://your-domain.com/api/chatbot/query \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"message": "How do I customize the widget colors?",
"chatbotId": "chatbot_abc123",
"sessionId": "sess_xyz789",
"mode": "productivity"
}'Response Format
Success Response (200)
{
"response": "To customize widget colors, go to Settings → Appearance in your dashboard. You can modify the primary color, background colors, and text colors to match your brand.",
"confidence": 0.94,
"sources": [
"https://docs.example.com/widget-customization",
"https://help.example.com/styling-guide"
],
"sessionId": "sess_xyz789",
"responseTime": 847,
"usage": {
"promptTokens": 156,
"completionTokens": 89,
"totalTokens": 245
}
}Response Fields
responsestring
The AI-generated response text
confidencenumber
Confidence score between 0.0 and 1.0
sourcesarray
URLs of source documents used for the response
sessionIdstring
Unique session identifier for conversation tracking
responseTimenumber
Response time in milliseconds
Error Response (400/401/500)
{
"error": "Invalid chatbot ID",
"code": "CHATBOT_NOT_FOUND",
"message": "The specified chatbot ID does not exist or is not accessible"
}Rate Limits
Free Plan
100 requests/hour
Pro Plan
1,000 requests/hour
Enterprise
Custom limits