Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

REST APIs

Updated on January 20, 2022

Pega Knowledge includes REST APIs (Integration-Services) that a web application can use to retrieve Knowledge content and related information for both articles and community discussions and posts.

Pega Knowledge Product Overview Product Overview

Knowledge articles

APIDescription
Get article by ID Returns the article whose ID is passed as a parameter
List articles by categoryReturns list of all published articles belonging to categories passed as parameter
Download article attachmentsDownloads any file attachments specified on related articles
Rate articleAllows a user to rate an article
Article intakeThe KMCreateArticle API supports intake of a new article from an external application. Supports import of file attachments (5mb or less). The API also supports the standard file attachment types (.docx, .xlsx, .pptx, and .pdf) and image attachment types (.jpg, .gif, .png, and .svg) that Pega platform supports. Configuration in the authoring portal supports rate limiting to mitigate Denial of Service attacks and specifying restricted file types. A stub/extension is also provided if an organization wants to call a virus scan service with the API request.

Community posts

APIDescription
Get community post by IDRetrieves community discussion threads by using their post ID
Get community posts by categoryRetrieves community posts by category
Get user community postRetrieves community discussions posted by a user
Download article attachmentsDownloads discussion attachments (same REST API as above)

Search

APIDescription
Get articles and postsReturns a list of articles and posts relevant to the search string

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us