FAQ Collections API

POST FAQ Collections API

/api/v1/ai/faq-collections

Create and store collections of FAQ items to use for high-speed semantic matching.

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

JSON 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
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

JSON Response
{
  "success": true,
  "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
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."
        }
    ]
}'

Ready to build?

Create your free account and make your first API call in minutes.