Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Get a Knowledge Source
Gets a Knowledge Source from a Knowledge Store.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId} \
--header 'X-API-Key: <api-key>'{
"name": "mysource",
"description": "mysource description",
"type": "url",
"metaData": {
"tags": [
"tag1"
]
},
"data": {
"_id": "x4xU6hMntv23p",
"sys_CreatedAt": "2019-12-16T11:40:45.7212",
"sys_UpdatedAt": "2025-10-01T07:46:04.5932",
"Type": "FAQ"
},
"chunkCount": 123,
"status": "ready",
"connectorReference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<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
Supply the API Key in the HTTP-Header
Headers
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.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The Id of the KnowledgeStore
24^[a-z0-9]{24}$The Id of the KnowledgeSource
24^[a-z0-9]{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.
The name of the KnowledgeSource
"mysource"
The description about what the knowledge source contains
"mysource description"
The type of source for the Knowledge store
url, manual, pdf, txt, ctxt, extension Show child attributes
Show child attributes
Custom metadata object to store additional information in the KnowledgeSource
{
"_id": "x4xU6hMntv23p",
"sys_CreatedAt": "2019-12-16T11:40:45.7212",
"sys_UpdatedAt": "2025-10-01T07:46:04.5932",
"Type": "FAQ"
}
ready, ingesting, disabled The connector Id associated with the KnowledgeSource. This is only applicable for KnowledgeSources of type "extension"
24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/knowledgestores/{knowledgeStoreId}/sources/{sourceId} \
--header 'X-API-Key: <api-key>'{
"name": "mysource",
"description": "mysource description",
"type": "url",
"metaData": {
"tags": [
"tag1"
]
},
"data": {
"_id": "x4xU6hMntv23p",
"sys_CreatedAt": "2019-12-16T11:40:45.7212",
"sys_UpdatedAt": "2025-10-01T07:46:04.5932",
"Type": "FAQ"
},
"chunkCount": 123,
"status": "ready",
"connectorReference": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}