Skip to main content
GET
/
v2.0
/
knowledgestores
/
{knowledgeStoreId}
/
sources
/
{sourceId}
Get a KnowledgeSource
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'
{
  "name": "mysource",
  "description": "mysource description",
  "type": "url",
  "metaData": {
    "tags": [
      "tag1"
    ]
  },
  "chunkCount": 123,
  "status": "ready",
  "referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<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
​
sourceId
string
required

The Id of the KnowledgeSource

Required string length: 24

Response

Returns KnowledgeSource object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

​
name
string

The name of the KnowledgeSource

Example:

"mysource"

​
description
string

The description about what the knowledge source contains

Example:

"mysource description"

​
type
enum<string>

The type of source for the Knowledge store

Available options:
url,
manual,
pdf,
txt,
ctxt
​
metaData
object
​
chunkCount
integer
​
status
enum<string>
Available options:
ready,
ingesting,
disabled
​
referenceId
string<uuid>
​
_id
string
Required string length: 24
​
createdAt
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
lastChanged
integer

Unix-timestamp

Required range: 0 <= x <= 2147483647
Example:

1694518620

​
createdBy
string
Required string length: 24
​
lastChangedBy
string
Required string length: 24