Skip to main content
GET
/
v2.0
/
knowledgestores
/
{knowledgeStoreId}
/
descriptors
Get KnowledgeDescriptors
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/descriptors \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "type": "<string>",
      "label": "<string>",
      "summary": "<string>",
      "fields": [
        {
          "type": "text",
          "key": "<string>",
          "label": "<string>",
          "defaultValue": "<any>"
        }
      ],
      "sections": [
        {
          "key": "<string>",
          "value": "<any>",
          "negate": true
        }
      ],
      "form": [
        {
          "key": "<string>",
          "type": "field"
        }
      ],
      "extension": "<string>",
      "extensionImg": "<string>"
    }
  ],
  "total": 1,
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
knowledgeStoreId
string
required

The Id of the KnowledgeStore

Required string length: 24

Response

Returns array of a Knowledge Descriptor objects

​
items
object[]
​
total
integer
Example:

1

​
next
string | null
Required string length: 24
​
previous
string | null
Required string length: 24
⌘I