{"id":24630,"date":"2020-09-28T08:18:43","date_gmt":"2020-09-28T07:18:43","guid":{"rendered":"https:\/\/developer.kore.ai\/v10-1\/?p=24630"},"modified":"2023-11-14T11:13:01","modified_gmt":"2023-11-14T11:13:01","slug":"get-faqs-kg","status":"publish","type":"post","link":"https:\/\/developer.kore.ai\/v10-1\/docs\/bots\/api-guide\/get-faqs-kg\/","title":{"rendered":"Get FAQs – KG"},"content":{"rendered":"

To get a list of questions and nodes under the Knowledge task.<\/p>\n\n\n\n\n\n\n\n
Method<\/b><\/td>\nGET<\/td>\n<\/tr>\n
Endpoint<\/b><\/td>\nhttps:\/\/{{host}}\/api\/public\/bot\/{{botId}}\/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&language=en<\/code><\/span><\/td>\n<\/tr>\n
Content Type<\/b><\/td>\napplication\/json<\/code><\/td>\n<\/tr>\n
Authorization<\/b><\/td>\nauth: {{JWT}}<\/code><\/p>\n

See How to generate the JWT Token<\/a>.<\/td>\n<\/tr>\n

API Scope<\/b><\/td>\n\n
    \n
  • Bot Builder: Manage Knowledge Graph<\/li>\n
  • Admin Console: Manage Knowledge Graph<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    Path Parameters<\/span><\/h2>\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/b><\/th>\n<\/tr>\n
    host<\/b><\/td>\nThe environment URL. For example, https:\/\/bots.kore.ai<\/code><\/td>\nRequired<\/td>\n<\/tr>\n
    BotId<\/b><\/td>\nBot ID<\/i> or Stream ID<\/i> can be accessed under General Settings<\/b> on the Bot Builder.<\/td>\nRequired<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    Query Parameters<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/b><\/th>\nDescription<\/b><\/th>\nMandate<\/b><\/th>\n<\/tr>\n
    ktId<\/b><\/td>\nThe Knowledge task ID<\/i> based on which the FAQs are listed.<\/p>\n

    You can retrieve the ktId<\/i> from the request of the GetFAQs<\/i> API call. Learn more<\/a>.<\/p>\n

    Note:<\/b> The ktId<\/i> values are different for both in-development and published bots.<\/td>\n

    		Required<\/td>\n<\/tr>\n
    limit<\/b><\/td>\nThe number of records to be fetched. The default count and the maximum limit is 50.<\/td>\nOptional<\/td>\n<\/tr>\n
    offset<\/b><\/td>\nThe number of records to be skipped. The default count is set 0.<\/td>\nOptional<\/td>\n<\/tr>\n
    parentId<\/b><\/td>\nThe ID of the nodes in the Knowledge tasks section.<\/p>\n

    You can retrieve the parentId<\/i> from the response of the GetFAQs<\/i> API call. Learn more<\/a>.<\/td>\n

    		Optional<\/td>\n<\/tr>\n
    withallchild<\/b><\/td>\nWhether child nodes need to be included<\/td>\nOptional<\/td>\n<\/tr>\n
    type<\/b><\/td>\nType of FAQs to be fetched.<\/td>\nOptional<\/td>\n<\/tr>\n
    language<\/b><\/td>\nThe Bot language which is identified by the language acronym. For example, en<\/em> for English and de<\/em> for German. The user can set the default language of the bot.<\/td>\nRequired<\/td>\n<\/tr>\n
    search<\/b><\/td>\nUsed to search the KG using the reference id<\/i> or display name<\/i>.<\/td>\nOptional<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    Sample Request<\/span><\/h2>\n
    curl -X GET \\\r\n  'https:\/\/{{host}}\/api\/public\/bot\/{{bot_id}}\/faqs?ktId=5afxxxxxf&limit=30&offset=0&parentId=xxxxx-xxx-xxx-xxx-xxxxx&withallchild=true&type=all&language=en' \\\r\n  -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \\\r\n  -H 'content-type: application\/json'  \r\n<\/pre>\n
    Body Parameters<\/span><\/h2>\n
    No body parameters are passed.<\/p>\n
    Sample Response<\/span><\/h2>\n
    {\r\n    \"faqs\": [\r\n        {\r\n            \"_id\": \"5exxxxxxxxxxxxxxxxxxxxxx\",\r\n            \"subAnswers\": [],\r\n            \"editLocked\": false,\r\n            \"isPublished\": true,\r\n            \"questionPayload\": {\r\n                \"question\": \"What is Bank Internet Banking?\",\r\n                \"tagsPayload\": []\r\n            },\r\n            \"answerPayload\": [\r\n                {\r\n                    \"_id\": \"mt-95xxxxxx-9xxa-5xxe-97xx-56xxxxxxxxxx\",\r\n                    \"channel\": \"default\",\r\n                    \"streamId\": \"st-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n                    \"lModBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n                    \"lMod\": \"Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)\",\r\n                    \"createdBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n                    \"createdOn\": \"Fri Jan 03 2020 13:11:03 GMT+0530 (India Standard Time)\",\r\n                    \"text\": \"Bank Internet banking is a convenient way to bank anytime, anywhere even from the comfort of your home using your PC or Tab.\",\r\n                    \"type\": \"basic\"\r\n                }\r\n            ],\r\n            \"knowledgeTaskId\": \"5axxxxxxxxxxxxxxxxxxxxxx\",\r\n            \"subQuestions\": [],\r\n            \"responseType\": \"message\",\r\n            \"referenceId\" :\"12xxx32\",\r\n            \"label\" :\"displayname\",\r\n            \"streamId\": \"st-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"parent\": \"pa-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"leafterm\": \"yes\",\r\n            \"language\": \"en\",\r\n            \"createdBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"lastModifiedBy\": \"u-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"createdOn\": \"2020-01-03T07:41:03.017Z\",\r\n            \"modifiedOn\": \"2020-01-03T07:41:03.017Z\",\r\n            \"sortId\": 1578037263017,\r\n            \"botName\": \"BankingBot\",\r\n            \"refId\": \"re-xxxxx-xxx-xxx-xxx-xxxxx\",\r\n            \"__v\": 0\r\n        }]\r\n}\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
    To get a list of questions and nodes under the Knowledge task. Method GET Endpoint https:\/\/{{host}}\/api\/public\/bot\/{{botId}}\/faqs?ktId=&limit=&offset=&parentId=&withallchild=&type=&language=en Content Type application\/json Authorization auth: {{JWT}} See How to generate the JWT Token. API Scope Bot Builder: Manage Knowledge Graph Admin Console: Manage Knowledge Graph Path Parameters Parameter Description Mandate host The environment URL. For example, https:\/\/bots.kore.ai Required BotId…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[17],"tags":[],"class_list":["post-24630","post","type-post","status-publish","format-standard","hentry","category-api-guide"],"_links":{"self":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/24630","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/comments?post=24630"}],"version-history":[{"count":36,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/24630\/revisions"}],"predecessor-version":[{"id":60094,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/posts\/24630\/revisions\/60094"}],"wp:attachment":[{"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/media?parent=24630"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/categories?post=24630"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developer.kore.ai\/v10-1\/wp-json\/wp\/v2\/tags?post=24630"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}