Get FAQs - KG V2

Back to API List

Retrieves a list of questions and nodes under the Knowledge task. Supports parameters such as botId, language, mode (configured/published), and nodeName.

Method	GET
Endpoint	https://{{host}}/api/public/bot/{{botId}}/v2/faqs?state=&limit=&offset=&nodeName=&withallchild=&type=&language=en
Content Type	application/json
Authorization	auth: {{JWT}} See How to generate the JWT Token.
API Scope	Knowledge AI: Manage Knowledge Graph; Admin Console: Manage Knowledge Graph

Path Parameters

Parameter	Description	Required
host	The environment URL. For example, https://platform.kore.ai/	Required
BotId	Bot ID or Stream ID found under App Settings on the App Profile.	Required

Query Parameters

Parameter	Description	Required
state	The mode or state of the app — Published or Configured.	Required
limit	Number of records to fetch. Default and maximum is 50.	Optional
offset	Number of records to skip. Defaults to 0.	Optional
nodeName	The ID of nodes in the Knowledge tasks section.	Optional
withallchild	Whether to include child nodes. Accepts true or false.	Optional
type	Type of FAQs or tasks to fetch.	Optional
language	Bot language code (for example, en for English, de for German).	Required
search	Search the KG using a reference ID or display name.	Optional

Sample Request

curl --location 'https://localhost/api/public/bot/st-8b87fxxxxx4e90e/v2/faqs?limit=3&offset=0&search=&type=all&language=en&state=configured&nodeName=A&withallchild=true' \
--header 'auth: eyJfxxxxxI6IkpXVCJ9.eyJhcHBJZCI6ImNzLWJjZTZiMfxxxxxNTFkYS1iYjNhLWY5MzkwMDM0Mjg2ZiJ9.40rpnPhnY1CnDPwWfxxxxx'

Sample Response

{
    "faqs": [
        {
            "_id": "673d8ec3c2c0874923ad8a7a",
            "streamId": "st-8b873b9c-15cc-5167-a04a-1c801fxxxxxx",
            "conditionalResp": false,
            "questionPayload": {
                "question": "Dup AA Node1",
                "tagsPayload": []
            },
            "responseType": "message",
            "answerPayload": [
                {
                    "_id": "mt-979b11e9-7187-5d8a-918b-6b6801xxxxxx",
                    "streamId": "st-8b873b9c-15cc-5167-a04a-1c801f5xxxxx",
                    "channel": "default",
                    "createdBy": "u-83c6112b-d759-5e13-8dcf-6995fabxxxxx",
                    "createdOn": "Wed Nov 20 2024 12:54:51 GMT+0530 (India Standard Time)",
                    "lModBy": "u-83c6112b-d759-5e13-8dcf-6995fabxxxxx",
                    "lMod": "Wed Nov 20 2024 12:54:51 GMT+0530 (India Standard Time)",
                    "text": "Sample%20Ans",
                    "type": "basic"
                }
            ],
            "subQuestions": [],
            "subAnswers": [],
            "parent": "492e6eab-8da1-41b9-bc5a-09ccfxxxxxxx",
            "leafterm": "A",
            "createdOn": "2024-11-20T07:24:51.445Z",
            "createdBy": "u-83c6112b-d759-5e13-8dcf-6995fabxxxxx",
            "modifiedOn": "2024-11-20T07:24:51.445Z",
            "lastModifiedBy": "u-83c6112b-d759-5e13-8dcf-6995fabxxxxx",
            "botName": "Test5",
            "knowledgeTaskId": "673d8c93c2c0874923xxxxxx",
            "sortId": 1732087491445,
            "language": "en",
            "faqStatus": true,
            "editLocked": false,
            "isPublished": true,
            "refId": "74e7d27f-bcb1-5dab-a339-957a415xxxxx",
            "label": "Dup A Node1",
            "faqLinkedBy": [],
            "__v": 0,
            "fullPath": [
                "Test5",
                "Node1",
                "A"
            ]
        }
    ],
    "moreAvailable": true,
    "count": 41
}