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

Documentation Index

Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

ā€‹
Accept
enum<string>

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

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
Pattern: ^[a-z0-9]{24}$

Response

Returns an array of Knowledge Connector metadata objects.

ā€‹
items
object[]
ā€‹
total
integer
Example:

1

ā€‹
next
string | null
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
previous
string | null
Required string length: 24
Pattern: ^[a-z0-9]{24}$