Skip to main content

Generating a Chatbot Source Page

The chatbot source page feature allows you to generate a comprehensive list of all your Knowledge Base articles that can be fed directly to your chatbot. This makes it easy to leverage your existing…

River Sloane
Updated by River Sloane

The chatbot source page feature allows you to generate a comprehensive list of all your Knowledge Base articles that can be fed directly to your chatbot.

This makes it easy to leverage your existing documentation to power AI assistants and help your customers find answers quickly. Learn more about it over here.

Endpoint Details

To generate a chatbot source page, use the following endpoint:

GET/v1/article?format=list

This endpoint returns a list of all your published articles in a format that's optimized for chatbot consumption. You'll get a page that looks like this:

HelpDocs' User Management Guide outlines user roles like read-only, writer, editor, and owner.

Using JWT Authentication for Permissioned Content

By default, the endpoint only returns publicly accessible articles. If you want to include articles with permission restrictions, you'll need to use JWT (JSON Web Token) authentication. You can use our JWT Studio for this.

The endpoint will look something like:

/v1/article?format=listaccount_domain=your-slug&hd_jwt=firstpart.secondpart.thirdpart

JWT authentication allows you to securely provide access to permissioned articles based on the user's access level. This ensures your chatbot can access private content while maintaining your security policies.

How did we do?

Deleting an Article

Getting Article Versions

Contact

This site is protected by hCaptcha and its Privacy Policy and Terms of Service apply.