Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.kataven.ai/llms.txt

Use this file to discover all available pages before exploring further.

FAQs are simple title/content entries the agent can quote. Wrapped by the Python SDK and Node SDK.

​
Endpoints at a glance

MethodPathSummary
GET/api/v1/faqsList FAQs
POST/api/v1/faqsCreate an FAQ
GET/api/v1/faqs/{id}Get a single FAQ
PUT/api/v1/faqs/{id}Update an FAQ
DELETE/api/v1/faqs/{id}Delete an FAQ

​
Reference

​
GET /api/v1/faqs

List FAQs Responses
CodeDescriptionBody
200OKobject
500Database errorstring
Example 
curl https://api.kataven.ai/v1/faqs \
  -H "Authorization: Bearer $KATAVEN_API_KEY"

​
POST /api/v1/faqs

Create an FAQ Request body (application/json) Schema: handlers.FAQ. Server-set fields (id, created_at, updated_at, …) are ignored if supplied; only the user-settable fields are shown below.
FieldTypeDescription
categorystringe.g. general
contentstringe.g. We're open Monday through Friday, 9am to 6pm Pacific Time. Closed on US federal holidays.
namestringe.g. hours
summarystringe.g. Mon–Fri 9am–6pm Pacific.
tagsarray<string>e.g. ['hours', 'general']
titlestringe.g. What are your business hours?
Responses
CodeDescriptionBody
201Createdhandlers.FAQ
400Invalid bodystring
500Database errorstring
Example 
curl https://api.kataven.ai/v1/faqs \
  -X POST \
  -H "Authorization: Bearer $KATAVEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "general",
  "content": "We're open Monday through Friday, 9am to 6pm Pacific Time. Closed on US federal holidays.",
  "name": "hours",
  "summary": "Mon–Fri 9am–6pm Pacific.",
  "tags": [
    "hours",
    "general"
  ],
  "title": "What are your business hours?"
}'

​
GET /api/v1/faqs/{id}

Get a single FAQ Parameters
NameInTypeRequiredDescription
idpathstringYesFAQ id (uuid) or name
Responses
CodeDescriptionBody
200OKhandlers.FAQ
404FAQ not foundstring
Example 
curl https://api.kataven.ai/v1/faqs/agent_01HZ2N... \
  -H "Authorization: Bearer $KATAVEN_API_KEY"

​
PUT /api/v1/faqs/{id}

Update an FAQ Parameters
NameInTypeRequiredDescription
idpathstringYesFAQ id (uuid) or name
Request body (application/json) Schema: handlers.FAQ. Server-set fields (id, created_at, updated_at, …) are ignored if supplied; only the user-settable fields are shown below.
FieldTypeDescription
categorystringe.g. general
contentstringe.g. We're open Monday through Friday, 9am to 6pm Pacific Time. Closed on US federal holidays.
namestringe.g. hours
summarystringe.g. Mon–Fri 9am–6pm Pacific.
tagsarray<string>e.g. ['hours', 'general']
titlestringe.g. What are your business hours?
Responses
CodeDescriptionBody
200OKhandlers.FAQ
404FAQ not foundstring
500Database errorstring
Example 
curl https://api.kataven.ai/v1/faqs/agent_01HZ2N... \
  -X PUT \
  -H "Authorization: Bearer $KATAVEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "general",
  "content": "We're open Monday through Friday, 9am to 6pm Pacific Time. Closed on US federal holidays.",
  "name": "hours",
  "summary": "Mon–Fri 9am–6pm Pacific.",
  "tags": [
    "hours",
    "general"
  ],
  "title": "What are your business hours?"
}'

​
DELETE /api/v1/faqs/{id}

Delete an FAQ Default FAQs cannot be deleted. Parameters
NameInTypeRequiredDescription
idpathstringYesFAQ id (uuid) or name
Responses
CodeDescriptionBody
200OKobject
404FAQ not foundstring
Example 
curl https://api.kataven.ai/v1/faqs/agent_01HZ2N... \
  -X DELETE \
  -H "Authorization: Bearer $KATAVEN_API_KEY"