Creating a knowledge base using custom API


Users can create and manage knowledge base using custom API, enabling the option to write a script to pull content from any external system and push that content into the Zoom knowledge base. It is a good alternative for customers who cannot use Zoom Virtual Agent’s native knowledge base integrations such as CRM-based integrations, web sync, and manual.

This article covers:

Prerequisites for managing knowledge base articles using custom API

How to create a custom API knowledge base

  1. Sign in to the Zoom web portal.
  2. In the navigation menu, click AI Management then Knowledge Base.
  3. Click Add Knowledge Base.
    A pop-up window will appear.
  4. Expand the drop-down list to select a connector type.
  5. Under Other, select Custom API Connection.
  6. Under Details, enter a display name for your knowledge base.
  7. Under Customization, select the checkboxes if you want to:
    • Include images in articles
    • Include videos in articles
    • Highlight answers in the original article URL
    • Use complete article as answers
  8. Click Create.
  9. Copy the Knowledge base ID.
  10. Click View knowledge base.

How to set up an OAuth App in the Marketplace

Make sure you have the right permission to access developer tools and the marketplace, and create apps. Learn more about adding and removing Marketplace Apps.

  1. Sign in to the Zoom App Marketplace as an admin or owner.
  2. At the top right, click Develop then Build App.
  3. Select OAuth then click Create.
  4. In the Create an OAuth App window, provide the following:
    • App name: Enter a name for your OAuth App.
    • Under Choose app type, click User-managed app.
    • Make sure the toggle next to By publishing to Marketplace, your app will be available to external users to add and use is off.
  5. Click Create.
    You will be taken to the newly-created OAuth app page.
  6. Copy the Client ID and Client Secret to be used later for API calls.
  7. Enter the same URL to Redirect URL for OAuth and Add Allow List fields.
    For example, add https://oauth.pstm.io/v1/callback if using Postman.
  8. In the Scopes tab, click Add Scopes.
  9. Under App scopes, select Zoom Virtual Agent.
  10. On the right panel, select the boxes next to View your knowledge bases and articles and View and manage your knowledge bases.
  11. Click Done.
    This will activate the app.

After setting up your custom API-based knowledge base and configuring the necessary OAuth App in the Zoom App Marketplace, the next step involves making API requests to interact with the knowledge base. While the previous steps have provided the foundation for integrating the API, you'll need to write code in your preferred programming language or utilize your favorite API platform to initiate the actual API requests. Whether you're comfortable with Python, JavaScript, or any other language, or you prefer working with tools like Postman, this step is crucial to fully utilize the custom API and integrate it effectively with your knowledge base management.