How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys Knowledge API

Knowledge administration and search

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys Knowledge API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Knowledge. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 127 operations across 83 paths, and defines 261 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

127 operations 83 paths 261 schemas 15 DELETE48 GET16 PATCH45 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys Knowledge API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 127

Across 83 paths, the API surfaces 127 operations — 15 DELETE, 48 GET, 16 PATCH, 45 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Knowledge 127

Knowledge administration and search

GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories
Get categories
getKnowledgeKnowledgebaseCategories 10 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories
Create new category
postKnowledgeKnowledgebaseCategories 2 params → 200201400401403404408409
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}
Get category
getKnowledgeKnowledgebaseCategory 2 params → 200400401403404408409413
DELETE
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}
Delete category
deleteKnowledgeKnowledgebaseCategory 2 params → 200204400401403404408409
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId}
Update category
patchKnowledgeKnowledgebaseCategory 3 params → 200400401403404408409413
GET
/api/v2/knowledge/integrations/{integrationId}/options
Get sync options available for a knowledge-connect integration
getKnowledgeIntegrationOptions 2 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}
Get knowledge base
getKnowledgeKnowledgebase 1 param → 200400401403404408409413
DELETE
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}
Delete knowledge base
deleteKnowledgeKnowledgebase 1 param → 200204400401403404408409
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}
Update knowledge base
patchKnowledgeKnowledgebase 2 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases
Get knowledge bases
getKnowledgeKnowledgebases 9 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases
Create new knowledge base
postKnowledgeKnowledgebases 1 param → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups
Get knowledge base unanswered groups
getKnowledgeKnowledgebaseUnansweredGroups 4 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}
Get knowledge base unanswered group for a particular groupId
getKnowledgeKnowledgebaseUnansweredGroup 5 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}
Get knowledge base unanswered phrase group for a particular phraseGroupId
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup 6 params → 200400401403404408409413
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}
Update a Knowledge base unanswered phrase group
patchKnowledgeKnowledgebaseUnansweredGroupPhrasegroup 4 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}
Get label
getKnowledgeKnowledgebaseLabel 2 params → 200400401403404408409413
DELETE
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}
Delete label
deleteKnowledgeKnowledgebaseLabel 2 params → 200204400401403404408409
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId}
Update label
patchKnowledgeKnowledgebaseLabel 3 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels
Get labels
getKnowledgeKnowledgebaseLabels 6 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels
Create new label
postKnowledgeKnowledgebaseLabels 2 params → 200201400401403404408409
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources
Get Knowledge integration sources
getKnowledgeKnowledgebaseSources 4 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}
Get Salesforce Knowledge integration source
getKnowledgeKnowledgebaseSourcesSalesforceSourceId 3 params → 200400401403404408409413
PUT
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}
Update Salesforce Knowledge integration source
putKnowledgeKnowledgebaseSourcesSalesforceSourceId 3 params → 200400401403404408409413
DELETE
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}
Delete Salesforce Knowledge integration source
deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId 2 params → 204400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync
Start sync on Salesforce Knowledge integration source
postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync 3 params → 202200400401403404408409
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce
Create Salesforce Knowledge integration source
postKnowledgeKnowledgebaseSourcesSalesforce 2 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}
Get ServiceNow Knowledge integration source
getKnowledgeKnowledgebaseSourcesServicenowSourceId 3 params → 200400401403404408409413
PUT
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}
Update ServiceNow Knowledge integration source
putKnowledgeKnowledgebaseSourcesServicenowSourceId 3 params → 200400401403404408409413
DELETE
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}
Delete ServiceNow Knowledge integration source
deleteKnowledgeKnowledgebaseSourcesServicenowSourceId 2 params → 204400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync
Start synchronization on ServiceNow Knowledge integration source
postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync 3 params → 202200400401403404408409
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow
Create ServiceNow Knowledge integration source
postKnowledgeKnowledgebaseSourcesServicenow 2 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}
Get content upload from URL job status
getKnowledgeKnowledgebaseUploadsUrlsJob 2 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs
Create content upload from URL job
postKnowledgeKnowledgebaseUploadsUrlsJobs 2 params → 202400401403404408409413
POST
/api/v2/knowledge/documentuploads
Creates a presigned URL for uploading a knowledge import file with a set of documents
postKnowledgeDocumentuploads 1 param → 200409400401403404408413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers
Answer documents.
postKnowledgeKnowledgebaseDocumentsAnswers 2 params → 200400401403404408409413
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/chunks/search/{searchId}
Register chunk search result.
patchKnowledgeKnowledgebaseChunksSearchSearchId 3 params → 204400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/chunks/search
Search for chunks in a knowledge base
postKnowledgeKnowledgebaseChunksSearch 2 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}
Get document.
getKnowledgeKnowledgebaseDocument 4 params → 200400401403404408409413
DELETE
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}
Delete document.
deleteKnowledgeKnowledgebaseDocument 2 params → 204400401403404408409413
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}
Update document.
patchKnowledgeKnowledgebaseDocument 3 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}
Get document version.
getKnowledgeKnowledgebaseDocumentVersion 4 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions
Get document versions.
getKnowledgeKnowledgebaseDocumentVersions 6 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions
Creates or restores a document version.
postKnowledgeKnowledgebaseDocumentVersions 3 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents
Get documents.
getKnowledgeKnowledgebaseDocuments 12 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents
Create document.
postKnowledgeKnowledgebaseDocuments 2 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/remove
Bulk remove documents.
postKnowledgeKnowledgebaseDocumentsBulkRemove 2 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/bulk/update
Bulk update documents.
postKnowledgeKnowledgebaseDocumentsBulkUpdate 2 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/versions/bulk/add
Bulk add document versions.
postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd 2 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}
Get a variation for a document.
getKnowledgeKnowledgebaseDocumentVariation 5 params → 200400401403404408409413
DELETE
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}
Delete a variation for a document.
deleteKnowledgeKnowledgebaseDocumentVariation 3 params → 204400401403404408409413
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId}
Update a variation for a document.
patchKnowledgeKnowledgebaseDocumentVariation 4 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations
Get variations for a document.
getKnowledgeKnowledgebaseDocumentVariations 7 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations
Create a variation for a document.
postKnowledgeKnowledgebaseDocumentVariations 3 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId}
Get variation for the given document version.
getKnowledgeKnowledgebaseDocumentVersionVariation 4 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations
Get variations for the given document version.
getKnowledgeKnowledgebaseDocumentVersionVariations 6 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies
Indicate that the document was copied by the user.
postKnowledgeKnowledgebaseDocumentCopies 3 params → 204400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations
Indicate that documents were presented to the user.
postKnowledgeKnowledgebaseDocumentsPresentations 2 params → 204400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback
Get a list of feedback records given on documents in a knowledge base
getKnowledgeKnowledgebaseDocumentsFeedback 12 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}
Get a single feedback record given on a document
getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId 3 params → 200400401403404408409413
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}
Update feedback on a document
patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId 4 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback
Get a list of feedback records given on a document
getKnowledgeKnowledgebaseDocumentFeedback 13 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback
Give feedback on a document
postKnowledgeKnowledgebaseDocumentFeedback 3 params → 200201400401403404408409
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/query
Query for knowledge documents.
postKnowledgeKnowledgebaseDocumentsQuery 3 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}
Get export job report
getKnowledgeKnowledgebaseExportJob 2 params → 200202400401403404408409
DELETE
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId}
Delete export job
deleteKnowledgeKnowledgebaseExportJob 2 params → 204400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs
Create export job
postKnowledgeKnowledgebaseExportJobs 2 params → 200202400401403404408409
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}
Get import job report
getKnowledgeKnowledgebaseImportJob 3 params → 200202400401403404408409
DELETE
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}
Delete import job
deleteKnowledgeKnowledgebaseImportJob 2 params → 204400401403404408409413
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}
Start import job
patchKnowledgeKnowledgebaseImportJob 3 params → 200202400401403404408409
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs
Create import job
postKnowledgeKnowledgebaseImportJobs 2 params → 200202400401403404408409
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}
Get synchronization job report
getKnowledgeKnowledgebaseSynchronizeJob 2 params → 200400401403404408409413
DELETE
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}
Delete synchronization job
deleteKnowledgeKnowledgebaseSynchronizeJob 2 params → 204400401403404408409413
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs/{syncJobId}
Update synchronization job
patchKnowledgeKnowledgebaseSynchronizeJob 3 params → 202400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs
Create synchronization job
postKnowledgeKnowledgebaseSynchronizeJobs 2 params → 200202400401403404408409
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations
Get operations
getKnowledgeKnowledgebaseOperations 9 params → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query
Get ids of operation creator users and oauth clients
getKnowledgeKnowledgebaseOperationsUsersQuery 1 param → 200400401403404408409413
GET
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}
Get parse job report
getKnowledgeKnowledgebaseParseJob 3 params → 200202400401403404408409
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}
Send update to the parse operation
patchKnowledgeKnowledgebaseParseJob 3 params → 204400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs/{parseJobId}/import
Import the parsed articles
postKnowledgeKnowledgebaseParseJobImport 3 params → 204400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/parse/jobs
Create parse job
postKnowledgeKnowledgebaseParseJobs 2 params → 202400401403404408409413
PATCH
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId}
Update search result.
patchKnowledgeKnowledgebaseDocumentsSearchSearchId 3 params → 204400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions
Query the knowledge documents to provide suggestions for auto completion.
postKnowledgeKnowledgebaseDocumentsSearchSuggestions 2 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search
Search the documents in a knowledge base.
postKnowledgeKnowledgebaseDocumentsSearch 3 params → 200400401403404408409413
POST
/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views
Create view for a document.
postKnowledgeKnowledgebaseDocumentViews 3 params → 204400401403404408409413
GET
/api/v2/knowledge/connections/{connectionId}/options
Get connection options
getKnowledgeConnectionOptions 4 params → 200400401403404408409413
GET
/api/v2/knowledge/connections/{connectionId}
Get connection
getKnowledgeConnection 2 params → 200400401403404408409413
DELETE
/api/v2/knowledge/connections/{connectionId}
Delete connection
deleteKnowledgeConnection 1 param → 200204400401403404408409
PATCH
/api/v2/knowledge/connections/{connectionId}
Update connection
patchKnowledgeConnection 2 params → 200400401403404408409413
GET
/api/v2/knowledge/connections
Get connections
getKnowledgeConnections → 200400401403404408409413
POST
/api/v2/knowledge/connections
Create new connection
postKnowledgeConnections 1 param → 200201400401403404408409
GET
/api/v2/knowledge/settings/{knowledgeSettingId}
Get Knowledge setting.
getKnowledgeSetting 1 param → 200400401403404408409413
DELETE
/api/v2/knowledge/settings/{knowledgeSettingId}
Delete Knowledge setting.
deleteKnowledgeSetting 1 param → 204400401403404408409413
PATCH
/api/v2/knowledge/settings/{knowledgeSettingId}
Update Knowledge setting.
patchKnowledgeSetting 2 params → 200400401403404408409413
GET
/api/v2/knowledge/settings
Get Knowledge settings.
getKnowledgeSettings 7 params → 200400401403404408409413
POST
/api/v2/knowledge/settings
Create Knowledge setting.
postKnowledgeSettings 1 param → 200400401403404408409413
POST
/api/v2/knowledge/search/preview
Get Knowledge Search Preview
postKnowledgeSearchPreview 1 param → 200400401403404408409413
POST
/api/v2/knowledge/search
Get Knowledge Search
postKnowledgeSearch 1 param → 200400401403404408409413
GET
/api/v2/knowledge/sources/{sourceId}
Get source
getKnowledgeSource 2 params → 200400401403404408409413
PUT
/api/v2/knowledge/sources/{sourceId}
Update the source
putKnowledgeSource 2 params → 200400401403404408409413
DELETE
/api/v2/knowledge/sources/{sourceId}
Delete source
deleteKnowledgeSource 1 param → 204400401403404408409413
GET
/api/v2/knowledge/sources
List sources
getKnowledgeSources 1 param → 200400401403404408409413
POST
/api/v2/knowledge/sources
Create a new source
postKnowledgeSources 1 param → 200201400401403404408409
GET
/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions/{fileId}
Get a deletion entry associated with the synchronization
getKnowledgeSourceSynchronizationDeletion 3 params → 200400401403404408409413
DELETE
/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions/{fileId}
Remove a deletion entry associated with the synchronization
deleteKnowledgeSourceSynchronizationDeletion 3 params → 204400401403404408409413
GET
/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions
Get deletion entries associated with the synchronization.
getKnowledgeSourceSynchronizationDeletions 5 params → 200400401403404408409413
POST
/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/deletions
Mark a previously synced file for deletion in the synchronization.
postKnowledgeSourceSynchronizationDeletions 3 params → 201400401403404408409413
GET
/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}
Get a specific synchronization of a source.
getKnowledgeSourceSynchronization 2 params → 200400401403404408409413
PATCH
/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}
Update synchronization.
patchKnowledgeSourceSynchronization 3 params → 200400401403404408409413
GET
/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads/{fileId}
Get a file upload entry associated with the synchronization
getKnowledgeSourceSynchronizationUpload 3 params → 200400401403404408409413
DELETE
/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads/{fileId}
Remove a file upload entry associated with the synchronization
deleteKnowledgeSourceSynchronizationUpload 3 params → 204400401403404408409413
GET
/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads
Get file upload entries associated with the synchronization
getKnowledgeSourceSynchronizationUploads 5 params → 200400401403404408409413
POST
/api/v2/knowledge/sources/{sourceId}/synchronizations/{synchronizationId}/uploads
Create presigned URL for uploading a file in the synchronization.
postKnowledgeSourceSynchronizationUploads 3 params → 201400401403404408409413
GET
/api/v2/knowledge/sources/{sourceId}/synchronizations
Get synchronizations of a source.
getKnowledgeSourceSynchronizations 4 params → 200400401403404408409413
POST
/api/v2/knowledge/sources/{sourceId}/synchronizations
Start a manual synchronization from a source.
postKnowledgeSourceSynchronizations 2 params → 200202400401403404408409
GET
/api/v2/knowledge/sources/synchronizations
Get synchronizations of all sources of the organization.
getKnowledgeSourcesSynchronizations 3 params → 200400401403404408409413
POST
/api/v2/knowledge/guest/sessions/{sessionId}/documents/answers
Answer documents.
postKnowledgeGuestSessionDocumentsAnswers 2 params → 200400401403404408409413
POST
/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback
Give feedback on a document
postKnowledgeGuestSessionDocumentFeedback 3 params → 200201400401403404408409
GET
/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}
Get a knowledge document by ID.
getKnowledgeGuestSessionDocument 2 params → 200400401403404408409413
GET
/api/v2/knowledge/guest/sessions/{sessionId}/documents
Get documents.
getKnowledgeGuestSessionDocuments 3 params → 200400401403404408409413
POST
/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/copies
Indicate that the document was copied by the user.
postKnowledgeGuestSessionDocumentCopies 3 params → 204400401403404408409413
POST
/api/v2/knowledge/guest/sessions/{sessionId}/documents/presentations
Indicate that documents were presented to the user.
postKnowledgeGuestSessionDocumentsPresentations 2 params → 204400401403404408409413
POST
/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/views
Create view event for a document.
postKnowledgeGuestSessionDocumentViews 3 params → 204400401403404408409413
GET
/api/v2/knowledge/guest/sessions/{sessionId}/categories
Get categories
getKnowledgeGuestSessionCategories 10 params → 200400401403404408409413
POST
/api/v2/knowledge/guest/sessions/{sessionId}/documents/search
Search the documents in a guest session.
postKnowledgeGuestSessionDocumentsSearch 3 params → 200400401403404408409413
POST
/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions
Query the knowledge documents to provide suggestions for auto completion.
postKnowledgeGuestSessionDocumentsSearchSuggestions 2 params → 200400401403404408409413
PATCH
/api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId}
Update search result.
patchKnowledgeGuestSessionDocumentsSearchSearchId 3 params → 204400401403404408409413
POST
/api/v2/knowledge/guest/sessions
Create guest session
postKnowledgeGuestSessions 1 param → 200201400401403404408409

Schemas 261

The contract defines 261 schemas that model the data the API accepts and returns. The most detailed are KnowledgeSearchDocumentResponse (23 properties), KnowledgeDocumentQueryResult (22 properties), KnowledgeDocumentResponse (22 properties), KnowledgeDocumentSearchRequest (18 properties). Each schema is shown below with its type and property counts.

V3SourceFilter
object
2 properties 2 required
KnowledgeSearchPreviewRequest
object
8 properties 3 required
AddressableEntityRef
object
2 properties
KnowledgeImportJobSettings
object
4 properties
V3SynchronizationUploadMetadata
object
2 properties
DocumentTextProperties
object
3 properties
KnowledgeDocumentVersion
object
7 properties 1 required
DocumentListContentBlock
object
5 properties 1 required
KnowledgeBaseListing
object
4 properties
SyncStatusRequest
object
1 property 1 required
DocumentContentBlockWithHighlight
object
5 properties 1 required
UnansweredPhrase
object
3 properties
SourceBaseResponse
object
9 properties
GuestCategoryReference
object
2 properties
KnowledgeGuestDocumentVariation
object
8 properties 1 required
DocumentBodyTableRowBlockWithHighlight
object
2 properties 1 required
KnowledgeOperationSource
object
3 properties
KnowledgeDocumentFeedbackResponse
object
16 properties 2 required
CreateUploadSourceUrlJobResponse
object
2 properties
KnowledgeDocumentReq
object
9 properties 1 required
ConnectionOptionListing
object
4 properties
KnowledgeDocumentChunkRequest
object
10 properties 1 required
KnowledgeSearchClientApplication
object
4 properties 1 required
V3SourceScheduleSettings
object
2 properties 2 required
LabelResponse
object
8 properties
KnowledgeGuestDocumentVariationAnswer
object
8 properties 1 required
KnowledgeDocumentSearchVariation
object
11 properties 1 required
V3KnowledgeSearchPreviewClientApplication
object
1 property 1 required
SourceLastSync
object
4 properties
KnowledgeDocumentResponseListing
object
4 properties
DocumentBodyBlockWithHighlight
object
6 properties 1 required
DocumentVariationResponse
object
10 properties 1 required
ConnectionResponse
object
13 properties
DocumentListContentBlockWithHighlight
object
6 properties 1 required
DocumentBodyTableCellBlock
object
2 properties 1 required
KnowledgeDocumentQueryResult
object
22 properties
CategoryReference
object
4 properties 1 required
V3KnowledgeSearchClientApplication
object
3 properties 1 required
KnowledgeExportJobDocumentsFilter
object
3 properties
ChunkSearchRegisterRequest
object
3 properties 1 required
KnowledgeDocumentSearch
object
13 properties 1 required
WritableEntity
object
1 property
KnowledgeBase
object
12 properties 1 required
DocumentBodyTableCaptionBlock
object
1 property 1 required
DocumentChunkReference
object
3 properties 1 required
KnowledgeSearchResult
object
2 properties
KnowledgeDocumentSuggestionResultDocument
object
4 properties 3 required
KnowledgeGuestAnswerDocumentsResponse
object
1 property
DocumentBodyListWithHighlight
object
2 properties 1 required
KnowledgeContextReference
object
2 properties 1 required
V3SourceFolderDetails
object
3 properties
LabelCreateRequest
object
5 properties 2 required
OperationResponse
object
8 properties
UploadUrlResponse
object
3 properties
KnowledgeIntegrationOptionsResponse
object
1 property
DocumentBodyBlock
object
6 properties 1 required
V3SynchronizationUploadUrlResponse
object
7 properties
KnowledgeDocumentQuery
object
8 properties 1 required
KnowledgeImportJobReport
object
2 properties
KnowledgeAnswerGenerationResponse
object
2 properties
DocumentBodyTableRowBlockProperties
object
6 properties
V3SourceTagFilter
object
3 properties
KnowledgeDocumentPresentation
object
7 properties 2 required
KnowledgeDocumentGuestSearchRequest
object
10 properties 1 required
KnowledgeDocumentFeedback
object
16 properties 4 required
LabelUpdateRequest
object
5 properties
SalesforceSourceRequest
object
6 properties 1 required
DocumentBodyTable
object
2 properties 1 required
KnowledgeGuestSearchClientApplication
object
4 properties 1 required
KnowledgeAnswerDocumentResponse
object
4 properties
KnowledgeGuestDocumentSuggestionRequest
object
3 properties 1 required
KnowledgeDocumentFeedbackResponseListing
object
4 properties
CreateUploadSourceUrlJobRequest
object
1 property 1 required
KnowledgeConversationContextResponse
object
4 properties 1 required
KnowledgeGuestDocumentSuggestion
object
4 properties 1 required
KnowledgeV3PreviewConversationContext
object
1 property 1 required
KnowledgeDocumentSuggestionRequest
object
5 properties 1 required
DocumentBodyList
object
2 properties 1 required
KnowledgeImportJobResponse
object
14 properties 2 required
KnowledgeDocumentResponse
object
22 properties
ConnectionListing
object
1 property
GetUploadSourceUrlJobStatusResponse
object
5 properties
KnowledgeDocumentSearchResult
object
2 properties
DocumentBodyTableCellBlockWithHighlight
object
2 properties 1 required
DocumentVariationRequest
object
10 properties 1 required
DocumentBodyVideoProperties
object
5 properties
SharepointAuthenticationProperties
object
4 properties
KnowledgeSyncJobStatistics
object
16 properties
OperationCreatorUserResponse
object
3 properties
UnansweredPhraseGroup
object
6 properties
DocumentBodyTableCaptionItem
object
6 properties 1 required
CategoryResponseListing
object
4 properties
DocumentBodyTableProperties
object
11 properties
DocumentBodyParagraph
object
2 properties 1 required
KnowledgeConversationTurn
object
2 properties
KnowledgeGuestSessionContext
object
2 properties 2 required
V3SynchronizationUpdateRequest
object
1 property
UnansweredGroups
object
1 property
KnowledgeParseJobRequestImport
object
2 properties
ServiceNowSourceResponse
object
10 properties
BulkResult
object
2 properties
V3SynchronizationDeletionListing
object
4 properties
KnowledgeImportJobStatistics
object
17 properties
DocumentBodyListItemProperties
object
8 properties
V3SynchronizationRef
object
3 properties 2 required
DocumentTableContentBlock
object
7 properties 1 required
UploadUrlRequest
object
5 properties
DocumentBodyVideo
object
2 properties 1 required
KnowledgeExportJobFilter
object
3 properties 1 required
ConnectionCreateResponse
object
11 properties
CategoryResponse
object
10 properties 1 required
DocumentContentBlock
object
4 properties 1 required
KnowledgeParseJobRequest
object
2 properties 1 required
PresentedKnowledgeDocument
object
4 properties 3 required
KnowledgeGuestDocumentSuggestionResult
object
1 property
KnowledgeBaseUpdateRequest
object
2 properties
KnowledgeRetrievedReference
object
5 properties
Detail
object
4 properties
KnowledgeDocumentVersionReference
object
4 properties 2 required
KnowledgeGuestDocumentCopy
object
7 properties 2 required
KnowledgeDocumentSuggestionResult
object
2 properties
KnowledgeDocumentAlternative
object
2 properties 2 required
SalesforceSettings
object
4 properties
KnowledgeSyncJobResponse
object
12 properties
KnowledgeIntegrationFilter
object
4 properties
DocumentVariationAnswer
object
10 properties 1 required
SourceSyncResponse
object
6 properties
SalesforceSourceResponse
object
10 properties
DocumentQuery
object
2 properties 2 required
ImportStatusRequest
object
1 property 1 required
KnowledgeExportJobRequest
object
4 properties 2 required
KnowledgeSettingListing
object
4 properties
KnowledgeDocumentCopy
object
8 properties 3 required
Entity
object
1 property
KnowledgeGuestDocumentView
object
5 properties 2 required
CategoryUpdateRequest
object
6 properties
GuestCategoryResponseListing
object
5 properties
KnowledgeDocumentBulkUpdateRequest
object
1 property 1 required
DocumentChunkBlock
object
4 properties 2 required
DocumentVariationSearchChunkBlock
object
3 properties 2 required
DocumentContentHighlightIndex
object
2 properties
LabelListing
object
4 properties
KnowledgeExportJobResponse
object
14 properties 1 required
KnowledgeDocumentView
object
8 properties 3 required
KnowledgeDocumentBulkRemoveRequest
object
1 property 1 required
ServiceNowSettings
object
4 properties
KnowledgeDocumentSuggestion
object
3 properties 1 required
SearchUpdateRequest
object
4 properties 1 required
V3SynchronizationStatistics
object
2 properties
DocumentBodyParagraphWithHighlight
object
2 properties 1 required
KnowledgeDocumentBulkUpdateEntity
object
3 properties
KnowledgeGuestDocumentPresentation
object
6 properties 1 required
KnowledgeGuestDocumentVariationContext
object
2 properties 2 required
KnowledgeGuestDocumentResponseListing
object
4 properties
DocumentBodyListBlockProperties
object
2 properties
DocumentBodyWithHighlight
object
1 property 1 required
KnowledgeGuestSearchDocumentResponse
object
18 properties
DocumentBodyImage
object
3 properties 1 required
FabricTag
object
1 property
KnowledgeImportJobRequest
object
4 properties 2 required
KnowledgeSourcesSearchResponse
object
10 properties
KnowledgeV3ConversationContextResponse
object
4 properties 1 required
Limit
object
3 properties
DocumentTableContentBlockWithHighlight
object
8 properties 1 required
KnowledgeSyncRequest
object
PhraseAssociations
object
2 properties 2 required
KnowledgeGuestDocumentFeedback
object
13 properties 3 required
KnowledgeDocumentBulkVersionAddEntity
object
3 properties
DocumentQueryPredicate
object
3 properties 3 required
GuestResponseCategory
object
8 properties
KnowledgeGroupStatistics
object
3 properties
V3SourceFilterDetails
object
2 properties
KnowledgeV3ConversationContext
object
5 properties 1 required
KnowledgeSyncJobRequest
object
2 properties 1 required
KnowledgeDocumentVersionVariation
object
9 properties 1 required
CategoryCreateRequest
object
6 properties 1 required
ConnectionUpdateRequest
object
3 properties 1 required
V3SynchronizationListing
object
4 properties
EntityReference
object
1 property 1 required
DocumentBodyImageProperties
object
6 properties
KnowledgeSourcesSearchRequest
object
8 properties 2 required
KnowledgeConversationContext
object
5 properties 1 required
KnowledgeIntegrationFilterValue
object
2 properties
KnowledgeDocumentGuestSearch
object
9 properties 1 required
ConnectionOption
object
2 properties
KnowledgeSettingsRequest
object
6 properties 2 required
DocumentBodyTableCellBlockProperties
object
13 properties
DocumentBody
object
1 property 1 required
ConnectionCreateRequest
object
3 properties 2 required
V3Synchronization
object
14 properties
V3SourceExpandableListResponse
object
14 properties
V3SourceSiteDetails
object
2 properties
KnowledgeImportJobError
object
12 properties
KnowledgeContextValueReference
object
2 properties 1 required
V3StartManualSyncRequest
object
1 property
KnowledgeSettingsResponse
object
11 properties
KnowledgeGuestDocumentResponse
object
17 properties
KnowledgeGuestSessionApp
object
2 properties 2 required
DocumentElementLength
object
2 properties 2 required
UserReference
object
2 properties
KnowledgeDocumentVersionVariationListing
object
4 properties
KnowledgeGenerationSetting
object
2 properties 1 required
KnowledgeSearchDocumentResponse
object
23 properties
KnowledgeParseJobResponse
object
10 properties
UnansweredGroupSuggestedDocument
object
2 properties
KnowledgeDocumentQueryResponse
object
5 properties
KnowledgeDocumentBulkVersionAddRequest
object
1 property 1 required
KnowledgeDocumentVersionListing
object
4 properties
KnowledgeParseImportResult
object
3 properties 2 required
KnowledgeSearchPreviewResponse
object
6 properties
KnowledgeBaseReference
object
4 properties 1 required
KnowledgeDocumentsAnswerFilter
object
8 properties 1 required
KnowledgeDocumentFeedbackUpdateRequest
object
4 properties 1 required
DocumentVariationContext
object
2 properties 2 required
ErrorBody
object
11 properties
KnowledgeGuestDocumentVersionReference
object
2 properties 1 required
KnowledgeDocumentSearchRequest
object
18 properties 1 required
V3SourceExpandableResponse
object
17 properties
UnansweredPhraseGroupUpdateResponse
object
2 properties
UnansweredGroup
object
6 properties
AuthenticationProperties
object
1 property
KnowledgeDocumentGuestSearchResult
object
2 properties
SelectedAnswer
object
1 property 1 required
V3SourceLastSynchronization
object
11 properties
BulkResponse
object
3 properties
DocumentBodyListBlock
object
3 properties 2 required
V3SourceUpdateRequest
object
3 properties 2 required
V3SourceDetailedResponse
object
15 properties
V3SourceCreateRequest
object
6 properties 1 required
V3SynchronizationFileDeletionRequest
object
2 properties
DocumentText
object
4 properties 1 required
DocumentVariationQueryChunkBlock
object
2 properties 2 required
OperationListing
object
4 properties
V3SynchronizationUpload
object
5 properties
V3SourceRef
object
2 properties 1 required
V3SourceExpandableListing
object
1 property
KnowledgeDocumentQueryVariation
object
11 properties 1 required
UnansweredPhraseGroupPatchRequestBody
object
3 properties 1 required
DocumentBodyTableWithHighlight
object
2 properties 1 required
KnowledgeParseRecord
object
3 properties
DocumentBodyParagraphProperties
object
6 properties
DocumentBodyTableRowBlock
object
2 properties 1 required
V3SynchronizationDeletion
object
4 properties
DocumentBodyListBlockWithHighlight
object
3 properties 2 required
KnowledgeSyncJobReport
object
2 properties
KnowledgeGuestAnswerDocumentResponse
object
4 properties
ServiceNowSourceRequest
object
6 properties 1 required
KnowledgeDocumentChunkResponse
object
12 properties
AnswerGenerationDocument
object
3 properties
V3SynchronizationUploadUrlRequest
object
5 properties 1 required
KnowledgeGuestSession
object
6 properties 2 required
V3SynchronizationUploadListing
object
4 properties
KnowledgeDocumentReference
object
3 properties 2 required
DocumentVariationResponseListing
object
4 properties
KnowledgeBaseCreateRequest
object
4 properties 2 required
KnowledgeIntegrationReference
object
2 properties 1 required
DocumentQueryInterval
object
2 properties
KnowledgeAnswerDocumentsResponse
object
2 properties
BulkError
object
2 properties
DocumentQueryClause
object
2 properties 2 required
KnowledgeParseJobRequestPatch
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-knowledge-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Analytics API
AE Profile APIs.io
Genesys Architect API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Authorization API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
#Knowledge
← Back to G APIs
API Details
ID
genesys:genesys-knowledge-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-knowledge-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-knowledge-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Genesys Knowledge API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.