Buzzeasy integrations

Appearance

Knowledge Base API ​

The Knowledge Base API allows you to manage knowledge base entries within Buzzeasy. This API provides endpoints to create and delete knowledge base entries that can be used to enhance customer support with AI-powered responses.

API Operations ​

Create Knowledge Base Entries ​

POST /api/v1/knowledge-bases/{knowledgeBaseId}/entries

Add new question-answer pairs to a specific knowledge base. You can create up to 1,000 entries in a single request.

⚠️ Important: This endpoint does not include:

  • Duplicate detection – Entries with identical questions will be created as separate entries
  • Merge functionality – New entries will not be merged with existing similar entries
  • Update capability – To update existing entries, you must delete and recreate them

Delete Knowledge Base Entries ​

DELETE /api/v1/knowledge-bases/{knowledgeBaseId}/entries

Remove all entries from a specific knowledge base.

Use Cases ​

The Knowledge Base API can be used for various scenarios, including:

  • Content Management – Programmatically populate knowledge bases with FAQ content
  • Data Migration – Transfer existing knowledge base data from other systems
  • Bulk Updates – Efficiently manage large sets of knowledge base entries (delete all, then recreate)
  • Integration – Connect external content management systems with Buzzeasy knowledge bases
  • Automated Maintenance – Clear and refresh knowledge base content as part of automated workflows

Best Practices ​

  • Duplicate Management – Implement duplicate checking in your application before creating entries
  • Update Strategy – To update entries, delete the entire knowledge base and recreate with updated content

Entry Structure ​

Each knowledge base entry consists of two required fields that can be used flexibly:

  • Question – This field can contain:

    • A customer question (e.g., "How do I reset my password?")
    • An article title (e.g., "Password Reset Guide")
    • A topic heading (e.g., "Account Security")
    • Any searchable text that users might look for

  • Answer – This field can contain:

    • A direct answer to a question
    • Full article content
    • Detailed instructions or documentation
    • Any informational content related to the "question" field

💡 Note: While the fields are named "question" and "answer", they can be used more broadly as "title" and "content" for knowledge articles, making the API suitable for both FAQ-style entries and comprehensive knowledge base articles.

Swagger Reference ​