{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Knowledge API", "version": "v2" }, "items": [ { "info": { "name": "Knowledge", "type": "folder" }, "items": [ { "info": { "name": "Get categories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/categories", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "parentId", "value": "", "type": "query", "description": "If specified, retrieves the children categories by parent category ID." }, { "name": "isRoot", "value": "", "type": "query", "description": "If specified, retrieves only the root categories." }, { "name": "name", "value": "", "type": "query", "description": "Filter to return the categories that starts with the given category name." }, { "name": "sortBy", "value": "", "type": "query", "description": "Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically" }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors." }, { "name": "includeDocumentCount", "value": "", "type": "query", "description": "If specified, retrieves the number of documents related to category." } ] }, "docs": "Get categories" }, { "info": { "name": "Create new category", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/categories", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Create new category" }, { "info": { "name": "Get category", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/categories/:categoryId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "categoryId", "value": "", "type": "path", "description": "Category ID" } ] }, "docs": "Get category" }, { "info": { "name": "Update category", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/categories/:categoryId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "categoryId", "value": "", "type": "path", "description": "Category ID" } ] }, "docs": "Update category" }, { "info": { "name": "Delete category", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/categories/:categoryId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "categoryId", "value": "", "type": "path", "description": "Category ID" } ] }, "docs": "Delete category" }, { "info": { "name": "Get sync options available for a knowledge-connect integration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/integrations/:integrationId/options", "params": [ { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" }, { "name": "knowledgeBaseIds", "value": "", "type": "query", "description": "Narrowing down filtering option results by knowledge base." } ] }, "docs": "Get sync options available for a knowledge-connect integration" }, { "info": { "name": "Get knowledge base", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Get knowledge base" }, { "info": { "name": "Update knowledge base", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Update knowledge base" }, { "info": { "name": "Delete knowledge base", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Delete knowledge base" }, { "info": { "name": "Get knowledge bases", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases", "params": [ { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "limit", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100. Deprecated in favour of pageSize" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 100." }, { "name": "name", "value": "", "type": "query", "description": "Filter by Name." }, { "name": "coreLanguage", "value": "", "type": "query", "description": "Filter by core language." }, { "name": "published", "value": "", "type": "query", "description": "Filter by published status." }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort Order." } ] }, "docs": "Get knowledge bases" }, { "info": { "name": "Create new knowledge base", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases" }, "docs": "Create new knowledge base" }, { "info": { "name": "Get knowledge base unanswered groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/unanswered/groups", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "app", "value": "", "type": "query", "description": "The app value to be used for filtering phrases." }, { "name": "dateStart", "value": "", "type": "query", "description": "The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "dateEnd", "value": "", "type": "query", "description": "The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Get knowledge base unanswered groups" }, { "info": { "name": "Get knowledge base unanswered group for a particular groupId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/unanswered/groups/:groupId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "groupId", "value": "", "type": "path", "description": "The ID of the group to be retrieved." }, { "name": "app", "value": "", "type": "query", "description": "The app value to be used for filtering phrases." }, { "name": "dateStart", "value": "", "type": "query", "description": "The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "dateEnd", "value": "", "type": "query", "description": "The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Get knowledge base unanswered group for a particular groupId" }, { "info": { "name": "Get knowledge base unanswered phrase group for a particular phraseGroupId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/unanswered/groups/:groupId/phrasegroups/:phraseGroupId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "groupId", "value": "", "type": "path", "description": "The ID of the group to be retrieved." }, { "name": "phraseGroupId", "value": "", "type": "path", "description": "The ID of the phraseGroup to be retrieved." }, { "name": "app", "value": "", "type": "query", "description": "The app value to be used for filtering phrases." }, { "name": "dateStart", "value": "", "type": "query", "description": "The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" }, { "name": "dateEnd", "value": "", "type": "query", "description": "The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd" } ] }, "docs": "Get knowledge base unanswered phrase group for a particular phraseGroupId" }, { "info": { "name": "Update a Knowledge base unanswered phrase group", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/unanswered/groups/:groupId/phrasegroups/:phraseGroupId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "groupId", "value": "", "type": "path", "description": "The ID of the group to be updated." }, { "name": "phraseGroupId", "value": "", "type": "path", "description": "The ID of the phraseGroup to be updated." } ] }, "docs": "Update a Knowledge base unanswered phrase group" }, { "info": { "name": "Get label", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/labels/:labelId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "labelId", "value": "", "type": "path", "description": "Label ID" } ] }, "docs": "Get label" }, { "info": { "name": "Update label", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/labels/:labelId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "labelId", "value": "", "type": "path", "description": "Label ID" } ] }, "docs": "Update label" }, { "info": { "name": "Delete label", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/labels/:labelId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "labelId", "value": "", "type": "path", "description": "Label ID" } ] }, "docs": "Delete label" }, { "info": { "name": "Get labels", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/labels", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "name", "value": "", "type": "query", "description": "Filter to return the labels that contains the given phrase in the name." }, { "name": "includeDocumentCount", "value": "", "type": "query", "description": "If specified, retrieves the number of documents related to label." } ] }, "docs": "Get labels" }, { "info": { "name": "Create new label", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/labels", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Create new label" }, { "info": { "name": "Get Knowledge integration sources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "type", "value": "", "type": "query", "description": "If specified, retrieves integration sources with specified integration type." }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected." }, { "name": "ids", "value": "", "type": "query", "description": "If specified, retrieves integration sources with specified IDs." } ] }, "docs": "Get Knowledge integration sources" }, { "info": { "name": "Get Salesforce Knowledge integration source", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources/salesforce/:sourceId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected." } ] }, "docs": "Get Salesforce Knowledge integration source" }, { "info": { "name": "Update Salesforce Knowledge integration source", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources/salesforce/:sourceId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" } ] }, "docs": "Update Salesforce Knowledge integration source" }, { "info": { "name": "Delete Salesforce Knowledge integration source", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources/salesforce/:sourceId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" } ] }, "docs": "Delete Salesforce Knowledge integration source" }, { "info": { "name": "Start sync on Salesforce Knowledge integration source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources/salesforce/:sourceId/sync", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" } ] }, "docs": "Start sync on Salesforce Knowledge integration source" }, { "info": { "name": "Create Salesforce Knowledge integration source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources/salesforce", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Create Salesforce Knowledge integration source" }, { "info": { "name": "Get ServiceNow Knowledge integration source", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources/servicenow/:sourceId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected." } ] }, "docs": "Get ServiceNow Knowledge integration source" }, { "info": { "name": "Update ServiceNow Knowledge integration source", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources/servicenow/:sourceId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" } ] }, "docs": "Update ServiceNow Knowledge integration source" }, { "info": { "name": "Delete ServiceNow Knowledge integration source", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources/servicenow/:sourceId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" } ] }, "docs": "Delete ServiceNow Knowledge integration source" }, { "info": { "name": "Start synchronization on ServiceNow Knowledge integration source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources/servicenow/:sourceId/sync", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" } ] }, "docs": "Start synchronization on ServiceNow Knowledge integration source" }, { "info": { "name": "Create ServiceNow Knowledge integration source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/sources/servicenow", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Create ServiceNow Knowledge integration source" }, { "info": { "name": "Get content upload from URL job status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/uploads/urls/jobs/:jobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "jobId", "value": "", "type": "path", "description": "Upload job ID" } ] }, "docs": "Get content upload from URL job status" }, { "info": { "name": "Create content upload from URL job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/uploads/urls/jobs", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Create content upload from URL job" }, { "info": { "name": "Creates a presigned URL for uploading a knowledge import file with a set of documents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/documentuploads" }, "docs": "Creates a presigned URL for uploading a knowledge import file with a set of documents" }, { "info": { "name": "Answer documents.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/answers", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Answer documents." }, { "info": { "name": "Register chunk search result.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/chunks/search/:searchId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge Base ID" }, { "name": "searchId", "value": "", "type": "path", "description": "Unique identifier of search request" } ] }, "docs": "Register chunk search result." }, { "info": { "name": "Search for chunks in a knowledge base", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/chunks/search", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge Base ID" } ] }, "docs": "Search for chunks in a knowledge base" }, { "info": { "name": "Get document.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID." }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20." }, { "name": "state", "value": "", "type": "query", "description": "\"when state is \"Draft\", draft version of the document is returned,otherwise by default published version is returned in the response." } ] }, "docs": "Get document." }, { "info": { "name": "Update document.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID." } ] }, "docs": "Update document." }, { "info": { "name": "Delete document.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID." } ] }, "docs": "Delete document." }, { "info": { "name": "Get document version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/versions/:versionId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Globally unique identifier for the knowledge base." }, { "name": "documentId", "value": "", "type": "path", "description": "Globally unique identifier for the document." }, { "name": "versionId", "value": "", "type": "path", "description": "Globally unique identifier for the document version." }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected." } ] }, "docs": "Get document version." }, { "info": { "name": "Get document versions.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/versions", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Globally unique identifier for the knowledge base." }, { "name": "documentId", "value": "", "type": "path", "description": "Globally unique identifier for the document." }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected." } ] }, "docs": "Get document versions." }, { "info": { "name": "Creates or restores a document version.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/versions", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Globally unique identifier for the knowledge base." }, { "name": "documentId", "value": "", "type": "path", "description": "Globally unique identifier for the document." } ] }, "docs": "Creates or restores a document version." }, { "info": { "name": "Get documents.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "interval", "value": "", "type": "query", "description": "Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ" }, { "name": "documentId", "value": "", "type": "query", "description": "Retrieves the specified documents, comma separated values expected." }, { "name": "categoryId", "value": "", "type": "query", "description": "If specified, retrieves documents associated with category ids, comma separated values expected." }, { "name": "includeSubcategories", "value": "", "type": "query", "description": "Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories." }, { "name": "includeDrafts", "value": "", "type": "query", "description": "If includeDrafts is true, Documents in the draft state are also returned in the response." }, { "name": "labelIds", "value": "", "type": "query", "description": "If specified, retrieves documents associated with label ids, comma separated values expected." }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected." }, { "name": "externalIds", "value": "", "type": "query", "description": "If specified, retrieves documents associated with external ids, comma separated values expected." } ] }, "docs": "Get documents." }, { "info": { "name": "Create document.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Create document." }, { "info": { "name": "Bulk remove documents.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/bulk/remove", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Bulk remove documents." }, { "info": { "name": "Bulk update documents.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/bulk/update", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Bulk update documents." }, { "info": { "name": "Bulk add document versions.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/versions/bulk/add", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Bulk add document versions." }, { "info": { "name": "Get a variation for a document.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/variations/:documentVariationId", "params": [ { "name": "documentVariationId", "value": "", "type": "path", "description": "Globally unique identifier for a document variation." }, { "name": "documentId", "value": "", "type": "path", "description": "Globally unique identifier for a document." }, { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Globally unique identifier for a knowledge base." }, { "name": "documentState", "value": "", "type": "query", "description": "The state of the document." }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected." } ] }, "docs": "Get a variation for a document." }, { "info": { "name": "Update a variation for a document.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/variations/:documentVariationId", "params": [ { "name": "documentVariationId", "value": "", "type": "path", "description": "Globally unique identifier for a document variation." }, { "name": "documentId", "value": "", "type": "path", "description": "Globally unique identifier for a document." }, { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Globally unique identifier for a knowledge base." } ] }, "docs": "Update a variation for a document." }, { "info": { "name": "Delete a variation for a document.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/variations/:documentVariationId", "params": [ { "name": "documentVariationId", "value": "", "type": "path", "description": "Globally unique identifier for a document variation." }, { "name": "documentId", "value": "", "type": "path", "description": "Globally unique identifier for a document." }, { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Globally unique identifier for a knowledge base." } ] }, "docs": "Delete a variation for a document." }, { "info": { "name": "Get variations for a document.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/variations", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Globally unique identifier for the knowledge base." }, { "name": "documentId", "value": "", "type": "path", "description": "Globally unique identifier for the document." }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "documentState", "value": "", "type": "query", "description": "The state of the document." }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected." } ] }, "docs": "Get variations for a document." }, { "info": { "name": "Create a variation for a document.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/variations", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Globally unique identifier for the knowledge base." }, { "name": "documentId", "value": "", "type": "path", "description": "Globally unique identifier for the document." } ] }, "docs": "Create a variation for a document." }, { "info": { "name": "Get variation for the given document version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/versions/:versionId/variations/:variationId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Globally unique identifier for the knowledge base." }, { "name": "documentId", "value": "", "type": "path", "description": "Globally unique identifier for the document." }, { "name": "versionId", "value": "", "type": "path", "description": "Globally unique identifier for the document version." }, { "name": "variationId", "value": "", "type": "path", "description": "Globally unique identifier for the document version variation." } ] }, "docs": "Get variation for the given document version." }, { "info": { "name": "Get variations for the given document version.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/versions/:versionId/variations", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Globally unique identifier for the knowledge base." }, { "name": "documentId", "value": "", "type": "path", "description": "Globally unique identifier for the document." }, { "name": "versionId", "value": "", "type": "path", "description": "Globally unique identifier for the document version." }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." } ] }, "docs": "Get variations for the given document version." }, { "info": { "name": "Indicate that the document was copied by the user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/copies", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID." } ] }, "docs": "Indicate that the document was copied by the user." }, { "info": { "name": "Indicate that documents were presented to the user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/presentations", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." } ] }, "docs": "Indicate that documents were presented to the user." }, { "info": { "name": "Get a list of feedback records given on documents in a knowledge base", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/feedback", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "onlyCommented", "value": "", "type": "query", "description": "If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false." }, { "name": "documentVersionId", "value": "", "type": "query", "description": "Document version ID to filter by. Supported only if onlyCommented=true is set." }, { "name": "documentVariationId", "value": "", "type": "query", "description": "Document variation ID to filter by. Supported only if onlyCommented=true is set." }, { "name": "appType", "value": "", "type": "query", "description": "Application type to filter by. Supported only if onlyCommented=true is set." }, { "name": "queryType", "value": "", "type": "query", "description": "Query type to filter by. Supported only if onlyCommented=true is set." }, { "name": "userId", "value": "", "type": "query", "description": "The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set." }, { "name": "queueId", "value": "", "type": "query", "description": "Queue ID to filter by. Supported only if onlyCommented=true is set." }, { "name": "state", "value": "", "type": "query", "description": "State to filter by. Supported only if onlyCommented=true is set. Default: Final" } ] }, "docs": "Get a list of feedback records given on documents in a knowledge base" }, { "info": { "name": "Get a single feedback record given on a document", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/feedback/:feedbackId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID." }, { "name": "feedbackId", "value": "", "type": "path", "description": "Feedback ID." } ] }, "docs": "Get a single feedback record given on a document" }, { "info": { "name": "Update feedback on a document", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/feedback/:feedbackId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID." }, { "name": "feedbackId", "value": "", "type": "path", "description": "Feedback ID." } ] }, "docs": "Update feedback on a document" }, { "info": { "name": "Get a list of feedback records given on a document", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/feedback", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID." }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "onlyCommented", "value": "", "type": "query", "description": "If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false." }, { "name": "documentVersionId", "value": "", "type": "query", "description": "Document version ID to filter by. Supported only if onlyCommented=true is set." }, { "name": "documentVariationId", "value": "", "type": "query", "description": "Document variation ID to filter by. Supported only if onlyCommented=true is set." }, { "name": "appType", "value": "", "type": "query", "description": "Application type to filter by. Supported only if onlyCommented=true is set." }, { "name": "queryType", "value": "", "type": "query", "description": "Query type to filter by. Supported only if onlyCommented=true is set." }, { "name": "userId", "value": "", "type": "query", "description": "The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set." }, { "name": "queueId", "value": "", "type": "query", "description": "Queue ID to filter by. Supported only if onlyCommented=true is set." }, { "name": "state", "value": "", "type": "query", "description": "State to filter by. Supported only if onlyCommented=true is set. Default: Final" } ] }, "docs": "Get a list of feedback records given on a document" }, { "info": { "name": "Give feedback on a document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/feedback", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID." } ] }, "docs": "Give feedback on a document" }, { "info": { "name": "Query for knowledge documents.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/query", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge Base ID" }, { "name": "expand", "value": "", "type": "query", "description": "Fields, if any, to expand for each document in the search result matching the query." } ] }, "docs": "Query for knowledge documents." }, { "info": { "name": "Get export job report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/export/jobs/:exportJobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "exportJobId", "value": "", "type": "path", "description": "Export job ID" } ] }, "docs": "Get export job report" }, { "info": { "name": "Delete export job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/export/jobs/:exportJobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "exportJobId", "value": "", "type": "path", "description": "Export job ID" } ] }, "docs": "Delete export job" }, { "info": { "name": "Create export job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/export/jobs", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Create export job" }, { "info": { "name": "Get import job report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/import/jobs/:importJobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "importJobId", "value": "", "type": "path", "description": "Import job ID" }, { "name": "expand", "value": "", "type": "query", "description": "If expand contains 'urls' downloadURL and failedEntitiesURL will be filled." } ] }, "docs": "Get import job report" }, { "info": { "name": "Start import job", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/import/jobs/:importJobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "importJobId", "value": "", "type": "path", "description": "Import job ID" } ] }, "docs": "Start import job" }, { "info": { "name": "Delete import job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/import/jobs/:importJobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "importJobId", "value": "", "type": "path", "description": "Import job ID" } ] }, "docs": "Delete import job" }, { "info": { "name": "Create import job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/import/jobs", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Create import job" }, { "info": { "name": "Get synchronization job report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/synchronize/jobs/:syncJobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "syncJobId", "value": "", "type": "path", "description": "Synchronization job ID" } ] }, "docs": "Get synchronization job report" }, { "info": { "name": "Update synchronization job", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/synchronize/jobs/:syncJobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "syncJobId", "value": "", "type": "path", "description": "Synchronization job ID" } ] }, "docs": "Update synchronization job" }, { "info": { "name": "Delete synchronization job", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/synchronize/jobs/:syncJobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "syncJobId", "value": "", "type": "path", "description": "Synchronization job ID" } ] }, "docs": "Delete synchronization job" }, { "info": { "name": "Create synchronization job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/synchronize/jobs", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Create synchronization job" }, { "info": { "name": "Get operations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/operations", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "userId", "value": "", "type": "query", "description": "If specified, retrieves operations associated with user ids, comma separated values expected." }, { "name": "type", "value": "", "type": "query", "description": "If specified, retrieves operations with specified operation type, comma separated values expected." }, { "name": "status", "value": "", "type": "query", "description": "If specified, retrieves operations with specified operation status, comma separated values expected." }, { "name": "interval", "value": "", "type": "query", "description": "Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ" }, { "name": "sourceId", "value": "", "type": "query", "description": "If specified, retrieves operations associated with source ids, comma separated values expected." } ] }, "docs": "Get operations" }, { "info": { "name": "Get ids of operation creator users and oauth clients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/operations/users/query", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Get ids of operation creator users and oauth clients" }, { "info": { "name": "Get parse job report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/parse/jobs/:parseJobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "parseJobId", "value": "", "type": "path", "description": "Parse job ID" }, { "name": "expand", "value": "", "type": "query", "description": "If expand contains 'urls' downloadURL and failedEntitiesURL will be filled." } ] }, "docs": "Get parse job report" }, { "info": { "name": "Send update to the parse operation", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/parse/jobs/:parseJobId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "parseJobId", "value": "", "type": "path", "description": "Parse job ID" } ] }, "docs": "Send update to the parse operation" }, { "info": { "name": "Import the parsed articles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/parse/jobs/:parseJobId/import", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" }, { "name": "parseJobId", "value": "", "type": "path", "description": "Parse job ID" } ] }, "docs": "Import the parsed articles" }, { "info": { "name": "Create parse job", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/parse/jobs", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID" } ] }, "docs": "Create parse job" }, { "info": { "name": "Update search result.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/search/:searchId", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The ID of knowledge base containing the documents to query." }, { "name": "searchId", "value": "", "type": "path", "description": "Search Result ID" } ] }, "docs": "Update search result." }, { "info": { "name": "Query the knowledge documents to provide suggestions for auto completion.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/search/suggestions", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The ID of knowledge base containing the documents to query." } ] }, "docs": "Query the knowledge documents to provide suggestions for auto completion." }, { "info": { "name": "Search the documents in a knowledge base.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/search", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "The ID of knowledge base containing the documents to query." }, { "name": "expand", "value": "", "type": "query", "description": "Fields, if any, to expand for each document in the search result matching the query." } ] }, "docs": "Search the documents in a knowledge base." }, { "info": { "name": "Create view for a document.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/knowledgebases/:knowledgeBaseId/documents/:documentId/views", "params": [ { "name": "knowledgeBaseId", "value": "", "type": "path", "description": "Knowledge base ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID." } ] }, "docs": "Create view for a document." }, { "info": { "name": "Get connection options", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/connections/:connectionId/options", "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "Connection ID" }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page. Minimum: 25, Maximum: 500." }, { "name": "parentId", "value": "", "type": "query", "description": "The id of the parent option whose children to be listed." } ] }, "docs": "Get connection options" }, { "info": { "name": "Get connection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/connections/:connectionId", "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "Connection ID" }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attributes will be filled. Comma separated values expected." } ] }, "docs": "Get connection" }, { "info": { "name": "Update connection", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/connections/:connectionId", "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "Connection ID" } ] }, "docs": "Update connection" }, { "info": { "name": "Delete connection", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/connections/:connectionId", "params": [ { "name": "connectionId", "value": "", "type": "path", "description": "Connection ID" } ] }, "docs": "Delete connection" }, { "info": { "name": "Get connections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/connections" }, "docs": "Get connections" }, { "info": { "name": "Create new connection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/connections" }, "docs": "Create new connection" }, { "info": { "name": "Get Knowledge setting.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/settings/:knowledgeSettingId", "params": [ { "name": "knowledgeSettingId", "value": "", "type": "path", "description": "Knowledge Setting ID." } ] }, "docs": "Get Knowledge setting." }, { "info": { "name": "Update Knowledge setting.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/settings/:knowledgeSettingId", "params": [ { "name": "knowledgeSettingId", "value": "", "type": "path", "description": "Knowledge Setting ID." } ] }, "docs": "Update Knowledge setting." }, { "info": { "name": "Delete Knowledge setting.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/settings/:knowledgeSettingId", "params": [ { "name": "knowledgeSettingId", "value": "", "type": "path", "description": "Knowledge Setting ID." } ] }, "docs": "Delete Knowledge setting." }, { "info": { "name": "Get Knowledge settings.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/settings", "params": [ { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "name", "value": "", "type": "query", "description": "Knowledge setting name to search upon." }, { "name": "sourceId", "value": "", "type": "query", "description": "Source ID to filter knowledge settings by." }, { "name": "sortBy", "value": "", "type": "query", "description": "Field to sort the knowledge settings on." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sorting order for knowledge settings." } ] }, "docs": "Get Knowledge settings." }, { "info": { "name": "Create Knowledge setting.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/settings" }, "docs": "Create Knowledge setting." }, { "info": { "name": "Get Knowledge Search Preview", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/search/preview" }, "docs": "Get Knowledge Search Preview" }, { "info": { "name": "Get Knowledge Search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/search" }, "docs": "Get Knowledge Search" }, { "info": { "name": "Get source", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "expand", "value": "", "type": "query", "description": "Optional fields to expand for the Source." } ] }, "docs": "Get source" }, { "info": { "name": "Update the source", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" } ] }, "docs": "Update the source" }, { "info": { "name": "Delete source", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" } ] }, "docs": "Delete source" }, { "info": { "name": "List sources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/sources", "params": [ { "name": "expand", "value": "", "type": "query", "description": "Optional fields to expand for the Source." } ] }, "docs": "List sources" }, { "info": { "name": "Create a new source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/sources" }, "docs": "Create a new source" }, { "info": { "name": "Get a deletion entry associated with the synchronization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations/:synchronizationId/deletions/:fileId", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "synchronizationId", "value": "", "type": "path", "description": "Synchronization ID" }, { "name": "fileId", "value": "", "type": "path", "description": "File ID" } ] }, "docs": "Get a deletion entry associated with the synchronization" }, { "info": { "name": "Remove a deletion entry associated with the synchronization", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations/:synchronizationId/deletions/:fileId", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "synchronizationId", "value": "", "type": "path", "description": "Synchronization ID" }, { "name": "fileId", "value": "", "type": "path", "description": "File ID" } ] }, "docs": "Remove a deletion entry associated with the synchronization" }, { "info": { "name": "Get deletion entries associated with the synchronization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations/:synchronizationId/deletions", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "synchronizationId", "value": "", "type": "path", "description": "Synchronization ID" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." } ] }, "docs": "Get deletion entries associated with the synchronization." }, { "info": { "name": "Mark a previously synced file for deletion in the synchronization.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations/:synchronizationId/deletions", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "synchronizationId", "value": "", "type": "path", "description": "Synchronization ID" } ] }, "docs": "Mark a previously synced file for deletion in the synchronization." }, { "info": { "name": "Get a specific synchronization of a source.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations/:synchronizationId", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "synchronizationId", "value": "", "type": "path", "description": "Synchronization ID" } ] }, "docs": "Get a specific synchronization of a source." }, { "info": { "name": "Update synchronization.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations/:synchronizationId", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "synchronizationId", "value": "", "type": "path", "description": "Synchronization ID" } ] }, "docs": "Update synchronization." }, { "info": { "name": "Get a file upload entry associated with the synchronization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations/:synchronizationId/uploads/:fileId", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "synchronizationId", "value": "", "type": "path", "description": "Synchronization ID" }, { "name": "fileId", "value": "", "type": "path", "description": "File ID" } ] }, "docs": "Get a file upload entry associated with the synchronization" }, { "info": { "name": "Remove a file upload entry associated with the synchronization", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations/:synchronizationId/uploads/:fileId", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "synchronizationId", "value": "", "type": "path", "description": "Synchronization ID" }, { "name": "fileId", "value": "", "type": "path", "description": "File ID" } ] }, "docs": "Remove a file upload entry associated with the synchronization" }, { "info": { "name": "Get file upload entries associated with the synchronization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations/:synchronizationId/uploads", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "synchronizationId", "value": "", "type": "path", "description": "Synchronization ID" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." } ] }, "docs": "Get file upload entries associated with the synchronization" }, { "info": { "name": "Create presigned URL for uploading a file in the synchronization.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations/:synchronizationId/uploads", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "synchronizationId", "value": "", "type": "path", "description": "Synchronization ID" } ] }, "docs": "Create presigned URL for uploading a file in the synchronization." }, { "info": { "name": "Get synchronizations of a source.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." } ] }, "docs": "Get synchronizations of a source." }, { "info": { "name": "Start a manual synchronization from a source.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/sources/:sourceId/synchronizations", "params": [ { "name": "sourceId", "value": "", "type": "path", "description": "Source ID" } ] }, "docs": "Start a manual synchronization from a source." }, { "info": { "name": "Get synchronizations of all sources of the organization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/sources/synchronizations", "params": [ { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." } ] }, "docs": "Get synchronizations of all sources of the organization." }, { "info": { "name": "Answer documents.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/documents/answers", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." } ] }, "docs": "Answer documents." }, { "info": { "name": "Give feedback on a document", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/documents/:documentId/feedback", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID." } ] }, "docs": "Give feedback on a document" }, { "info": { "name": "Get a knowledge document by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/documents/:documentId", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID" } ] }, "docs": "Get a knowledge document by ID." }, { "info": { "name": "Get documents.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/documents", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." }, { "name": "categoryId", "value": "", "type": "query", "description": "If specified, retrieves documents associated with category ids, comma separated values expected." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." } ] }, "docs": "Get documents." }, { "info": { "name": "Indicate that the document was copied by the user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/documents/:documentId/copies", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID" } ] }, "docs": "Indicate that the document was copied by the user." }, { "info": { "name": "Indicate that documents were presented to the user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/documents/presentations", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." } ] }, "docs": "Indicate that documents were presented to the user." }, { "info": { "name": "Create view event for a document.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/documents/:documentId/views", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." }, { "name": "documentId", "value": "", "type": "path", "description": "Document ID" } ] }, "docs": "Create view event for a document." }, { "info": { "name": "Get categories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/categories", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." }, { "name": "before", "value": "", "type": "query", "description": "The cursor that points to the start of the set of entities that has been returned." }, { "name": "after", "value": "", "type": "query", "description": "The cursor that points to the end of the set of entities that has been returned." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of entities to return. Maximum of 200." }, { "name": "parentId", "value": "", "type": "query", "description": "If specified, retrieves the children categories by parent category ID." }, { "name": "isRoot", "value": "", "type": "query", "description": "If specified, retrieves only the root categories." }, { "name": "name", "value": "", "type": "query", "description": "Filter to return the categories that starts with the given category name." }, { "name": "sortBy", "value": "", "type": "query", "description": "Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically" }, { "name": "expand", "value": "", "type": "query", "description": "The specified entity attribute will be filled. Supported value:\"Ancestors\": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors." }, { "name": "includeDocumentCount", "value": "", "type": "query", "description": "If specified, retrieves the number of documents related to category." } ] }, "docs": "Get categories" }, { "info": { "name": "Search the documents in a guest session.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/documents/search", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." }, { "name": "expand", "value": "", "type": "query", "description": "Fields, if any, to expand for each document in the search result matching the query." } ] }, "docs": "Search the documents in a guest session." }, { "info": { "name": "Query the knowledge documents to provide suggestions for auto completion.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/documents/search/suggestions", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." } ] }, "docs": "Query the knowledge documents to provide suggestions for auto completion." }, { "info": { "name": "Update search result.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions/:sessionId/documents/search/:searchId", "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "Knowledge guest session ID." }, { "name": "searchId", "value": "", "type": "path", "description": "Search Result ID" } ] }, "docs": "Update search result." }, { "info": { "name": "Create guest session", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/knowledge/guest/sessions" }, "docs": "Create guest session" } ] } ], "bundled": true }