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.

FAQsClient is reachable on every Kataven client as client.faqs. Each method maps to one HTTP endpoint on the Hub API; links to the underlying spec entry are inline below. FAQs are simple title/content entries the agent can quote verbatim. Attach to an agent via client.agents.attach_faq.

​
Methods at a glance

MethodHTTPSummary
listGET /api/faqsList FAQs
getGET /api/faqs/{faq_id_or_name}Get a single FAQ
createPOST /api/faqsCreate an FAQ
updatePUT /api/faqs/{faq_id_or_name}Update an FAQ
deleteDELETE /api/faqs/{faq_id_or_name}Delete an FAQ

​
Reference

​
client.faqs.list(...)

List FAQs HTTP — GET /api/faqs · API reference → 
    def list(self) -> Dict[str, Any]:

​
client.faqs.get(...)

Get a single FAQ HTTP — GET /api/faqs/{id} · API reference → 
    def get(self, faq_id_or_name: str) -> Dict[str, Any]:

​
client.faqs.create(...)

Create an FAQ HTTP — POST /api/faqs · API reference → 
    def create(
        self,
        name: str,
        category: str,
        title: str,
        content: str,
        summary: str = "",
        tags: Optional[List[str]] = None,
    ) -> Dict[str, Any]:

​
client.faqs.update(...)

Update an FAQ HTTP — PUT /api/faqs/{id} · API reference → 
    def update(self, faq_id_or_name: str, **kwargs) -> Dict[str, Any]:

​
client.faqs.delete(...)

Delete an FAQ HTTP — DELETE /api/faqs/{id} · API reference → 
    def delete(self, faq_id_or_name: str) -> Dict[str, Any]:
Default FAQs cannot be deleted.