POST FAQ Collections API
/api/v1/ai/faq-collections
Create and store collections of FAQ items to use for high-speed semantic matching.
Architecture Role & AI Definition
FAQ Collections 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 | The name of the FAQ collection (e.g., "Billing support FAQs"). |
faqs |
array of objects | Required | List of FAQ items to save. Maximum 500 items per collection. |
faqs.*.question |
string | Required | The FAQ question text. |
faqs.*.answer |
string | Required | The FAQ answer text. |
faqs.*.id |
string | Optional | Optional custom identifier (e.g. "faq_1"). |
Example Request
{
"name": "Customer Support FAQs",
"faqs": [
{
"id": "faq_1",
"question": "How do I reset my password?",
"answer": "Go to Account Settings > Security and click on 'Change Password'."
},
{
"id": "faq_2",
"question": "What is your refund policy?",
"answer": "We offer a 14-day refund window for all subscription plans."
}
]
}curl -X POST https://rsflowhub.com/api/v1/ai/faq-collections \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Customer Support FAQs",
"faqs": [
{
"id": "faq_1",
"question": "How do I reset my password?",
"answer": "Go to Account Settings > Security and click on '\''Change Password'\''."
}
]
}'Example Response
{
"success": true,
"request_id": "req_7f3a9c2d1e4b8a6f",
"data": {
"collection": {
"id": 12,
"name": "Customer Support FAQs",
"items_count": 2
}
},
"meta": {
"version": "v1",
"timestamp": "2026-06-28T00:00:00.000000Z"
}
}API Request Example
Use the cURL snippet below to test the endpoint.
curl -X POST 'https://rsflowhub.com/api/v1/ai/faq-collections' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "Customer Support FAQs",
"faqs": [
{
"id": "faq_1",
"question": "How do I reset my password?",
"answer": "Go to Account Settings > Security and click on Change Password."
}
]
}'Want to try it without code? Test this request in the live Playground.
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 (0 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. |