POST AI Support Chatbots API
/api/v1/chatbots
Build customer-facing AI support chatbots with connected knowledge bases, client-managed actions, and automatic conversation context.
Architecture Role & AI Definition
AI Support Chatbots API provides low-latency, deterministic REST execution for production engineering workflows. It processes structured payloads with strict schema validation, returns uniform JSON envelopes, and is secured via SHA-256 API key authentication with atomic credit pre-authorization locks.
Production Reliability Guidelines
Configure a hard client timeout of 5 to 8 seconds. If network latency spikes, cancel connection to avoid holding open sockets in worker pools.
Upon receiving 429 Rate Limit or transient 5xx, pause with exponential backoff:
wait = min(max_backoff, base * 2^attempt + jitter).
RSFlowHub acquires an atomic lock verifying base credits before model invocation. If validation fails, zero credits are deducted.
Request Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Required | Name of the Chatbot (e.g. "Customer Assistant") |
mode |
string | Optional | Mode: support, faq, sales, or general. Default is support. |
knowledge_base_ids |
array of integers | Optional | Array of linked Knowledge Base IDs for grounded RAG answers. |
description |
string | Optional | Optional description of the assistant role and goals. |
Privacy-First Client-Managed Actions
Your backend credentials and private databases remain 100% private. When a customer query requires a private business action (e.g. get_order_status), the API returns a response of type action_required containing the extracted action parameters. Execute the action inside your own secure infrastructure and submit the result back via POST /api/v1/chatbots/{id}/conversations/{conversation_id}/actions/{action_call_id}/result.
End-to-End Integration Flow
- Create Knowledge Base & Add FAQs/Documents:
POST /api/v1/knowledge-bases - Create Chatbot & Link KB:
POST /api/v1/chatbots - Define Optional Actions:
POST /api/v1/chatbots/{id}/actions - Send Message:
POST /api/v1/chatbots/{id}/messages - Handle Normal Message Response or Action Required Response: If
type == "action_required", execute private action and post result.
Example Message Request
{
"message": "Hi, what is the status of my order ORD-9821?"
}curl -X POST https://rsflowhub.com/api/v1/chatbots/1/messages \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"message": "Hi, what is the status of my order ORD-9821?"
}'Example Action Required Response
{
"success": true,
"data": {
"type": "action_required",
"conversation_id": "conv_a81f92c3...",
"action_call": {
"id": "action_call_71a2b9...",
"name": "get_order_status",
"arguments": {
"order_id": "ORD-9821"
}
},
"usage": {
"credits_used": 1,
"credits_remaining": 999
}
}
}Common Failure Modes & Troubleshooting Matrix
| HTTP Code | Error Code | Root Cause | Recommended Remediation |
|---|---|---|---|
| 400 | bad_request |
Malformed JSON syntax or missing required top-level parameters. | Validate JSON payload with Content-Type: application/json and ensure all required fields are present. |
| 401 | unauthorized |
Missing, revoked, or incorrectly formatted x-api-key header. |
Verify API key exists in Dashboard → API Keys and pass in x-api-key or Authorization: Bearer. |
| 402 | insufficient_credits |
Account credit balance is lower than the base required credits (4 credits). | Top up credits in billing settings or enable auto-recharge to prevent pipeline interruption. |
| 422 | validation_error |
Input failed parameter constraints (e.g., character length exceeded or invalid array types). | Review parameters table above and adjust payload length, types, or structure accordingly. |
| 429 | rate_limit_exceeded |
Concurrency limit (60 requests/minute default) reached for this endpoint key. | Back off and retry using the timestamp in Retry-After response header, or batch requests. |