Genesys

Genesys Knowledge API

Knowledge administration and search

GitHub OpenAPI
Business capability
Self-Service Management BC-430.40

Operations 127

GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories Get categories #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories Create new category #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId} Get category #
DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId} Delete category #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId} Update category #
GET /api/v2/knowledge/integrations/{integrationId}/options Get sync options available for a knowledge-connect integration #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId} Get knowledge base #
DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId} Delete knowledge base #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId} Update knowledge base #
GET /api/v2/knowledge/knowledgebases Get knowledge bases #
POST /api/v2/knowledge/knowledgebases Create new knowledge base #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups Get knowledge base unanswered groups #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId} Get knowledge base unanswered group for a particular groupId #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId} Get knowledge base unanswered phrase group for a particular phraseGroupId #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId} Update a Knowledge base unanswered phrase group #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId} Get label #
DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId} Delete label #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId} Update label #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels Get labels #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels Create new label #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources Get Knowledge integration sources #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId} Get Salesforce Knowledge integration source #
PUT /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId} Update Salesforce Knowledge integration source #
DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId} Delete Salesforce Knowledge integration source #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync Start sync on Salesforce Knowledge integration source #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce Create Salesforce Knowledge integration source #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId} Get ServiceNow Knowledge integration source #
PUT /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId} Update ServiceNow Knowledge integration source #
DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId} Delete ServiceNow Knowledge integration source #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync Start synchronization on ServiceNow Knowledge integration source #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow Create ServiceNow Knowledge integration source #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId} Get content upload from URL job status #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs Create content upload from URL job #
POST /api/v2/knowledge/documentuploads Creates a presigned URL for uploading a knowledge import file with a set of… #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers Answer documents #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/chunks/search/{searchId} Register chunk search result #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/chunks/search Search for chunks in a knowledge base #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId} Get document #
DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId} Delete document #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId} Update document #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId} Get document version #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions Get document versions #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions Creates or restores a document version #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents Get documents #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents Create document #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove Bulk remove documents #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update Bulk update documents #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add Bulk add document versions #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId} Get a variation for a document #
DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId} Delete a variation for a document #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId} Update a variation for a document #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations Get variations for a document #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations Create a variation for a document #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId} Get variation for the given document version #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations Get variations for the given document version #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies Indicate that the document was copied by the user #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations Indicate that documents were presented to the user #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback Get a list of feedback records given on documents in a knowledge base #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId} Get a single feedback record given on a document #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId} Update feedback on a document #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback Get a list of feedback records given on a document #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback Give feedback on a document #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/query Query for knowledge documents #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId} Get export job report #
DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId} Delete export job #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs Create export job #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId} Get import job report #
DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId} Delete import job #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId} Start import job #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs Create import job #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId} Get synchronization job report #
DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId} Delete synchronization job #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId} Update synchronization job #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs Create synchronization job #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations Get operations #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query Get ids of operation creator users and oauth clients #
GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId} Get parse job report #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId} Send update to the parse operation #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}/import Import the parsed articles #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs Create parse job #
PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId} Update search result #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions Query the knowledge documents to provide suggestions for auto completion #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search Search the documents in a knowledge base #
POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views Create view for a document #
GET /api/v2/knowledge/connections/{connectionId}/options Get connection options #
GET /api/v2/knowledge/connections/{connectionId} Get connection #
DELETE /api/v2/knowledge/connections/{connectionId} Delete connection #
PATCH /api/v2/knowledge/connections/{connectionId} Update connection #
GET /api/v2/knowledge/connections Get connections #
POST /api/v2/knowledge/connections Create new connection #
GET /api/v2/knowledge/settings/{knowledgeSettingId} Get Knowledge setting #
DELETE /api/v2/knowledge/settings/{knowledgeSettingId} Delete Knowledge setting #
PATCH /api/v2/knowledge/settings/{knowledgeSettingId} Update Knowledge setting #
GET /api/v2/knowledge/settings Get Knowledge settings #
POST /api/v2/knowledge/settings Create Knowledge setting #
POST /api/v2/knowledge/search/preview Get Knowledge Search Preview #
POST /api/v2/knowledge/search Get Knowledge Search #
GET /api/v2/knowledge/sources/{sourceId} Get source #
PUT /api/v2/knowledge/sources/{sourceId} Update the source #
DELETE /api/v2/knowledge/sources/{sourceId} Delete source #
GET /api/v2/knowledge/sources List sources #
POST /api/v2/knowledge/sources Create a new source #
GET /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions/{fileId} Get a deletion entry associated with the synchronization #
DELETE /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions/{fileId} Remove a deletion entry associated with the synchronization #
GET /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions Get deletion entries associated with the synchronization #
POST /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions Mark a previously synced file for deletion in the synchronization #
GET /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId} Get a specific synchronization of a source #
PATCH /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId} Update synchronization #
GET /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads/{fileId} Get a file upload entry associated with the synchronization #
DELETE /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads/{fileId} Remove a file upload entry associated with the synchronization #
GET /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads Get file upload entries associated with the synchronization #
POST /api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads Create presigned URL for uploading a file in the synchronization #
GET /api/v2/knowledge/sources/{sourceId}/synchronizations Get synchronizations of a source #
POST /api/v2/knowledge/sources/{sourceId}/synchronizations Start a manual synchronization from a source #
GET /api/v2/knowledge/sources/synchronizations Get synchronizations of all sources of the organization #
POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/answers Answer documents #
POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback Give feedback on a document #
GET /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId} Get a knowledge document by ID #
GET /api/v2/knowledge/guest/sessions/{sessionId}/documents Get documents #
POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/copies Indicate that the document was copied by the user #
POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/presentations Indicate that documents were presented to the user #
POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/views Create view event for a document #
GET /api/v2/knowledge/guest/sessions/{sessionId}/categories Get categories #
POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/search Search the documents in a guest session #
POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions Query the knowledge documents to provide suggestions for auto completion #
PATCH /api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId} Update search result #
POST /api/v2/knowledge/guest/sessions Create guest session #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-knowledge-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys-knowledge-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

genesys-knowledge-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Knowledge API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:


# --- truncated at 32 KB (1192 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-knowledge-api-openapi.yml