POST

Add FAQ Source

Adds a structured FAQ source — a list of question/answer pairs.

POSThttps://api.vantaxai.com/v1/knowledge-bases/{knowledgebase_id}/sources/faq

FAQ sources are ideal for front-desk knowledge. Each item is indexed independently so the Agent can retrieve the most relevant answer to a caller's question.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Path Parameters

knowledgebase_idstringrequired
The knowledge base to add the source to.
example: kb_71ac0

Body Parameters

titlestringrequired
A label for the FAQ source.
example: Booking FAQ
itemsarrayrequired
Array of FAQ entries. Each item is an object with `question` and `answer` strings.

Request

curl -X POST https://api.vantaxai.com/v1/knowledge-bases/kb_71ac0/sources/faq \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Booking FAQ",
  "items": []
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/knowledge-bases/kb_71ac0/sources/faq",
  {
  method: "POST",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "title": "Booking FAQ",
    "items": []
  }),
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// POST /v1/knowledge-bases/{knowledgebase_id}/sources/faq
const result = await vantax.request("POST", "/v1/knowledge-bases/{knowledgebase_id}/sources/faq", {
  "title": "Booking FAQ",
  "items": []
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# POST /v1/knowledge-bases/{knowledgebase_id}/sources/faq
result = vantax.request("POST", "/v1/knowledge-bases/{knowledgebase_id}/sources/faq", json={"title": "Booking FAQ", "items": []})

Response

{
  "success": true,
  "message": "Source added successfully",
  "data": {
    "id": "doc_8c11fa",
    "knowledgebase_id": "kb_71ac0",
    "type": "faq",
    "title": "Booking FAQ",
    "status": "processing",
    "created_at": "2026-01-14T10:30:00Z"
  }
}

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "items", "message": "items must contain at least one question/answer pair" }
  ]
}