Get knowledge base entry by ID
Beta
Retrieves detailed information about a specific knowledge base entry using its ID. This endpoint returns the complete entry data including its type, status, content, and metadata. You can use this to check the processing status of your training content, view the raw and processed text, and see when it was created and last updated. This is useful for monitoring the progress of your training data as it moves through the processing pipeline.
GET
/v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}
curl \
--request GET 'https://api.sensay.io/v1/replicas/03db5651-cb61-4bdf-9ef0-89561f7c9c53/knowledge-base/12345' \
--header "X-ORGANIZATION-SECRET: $API_KEY" \
--header "X-API-Version: 2025-03-25"
Response examples (200)
{
"id": 12345,
"replicaUUID": "03db5651-cb61-4bdf-9ef0-89561f7c9c53",
"type": "file",
"url": "http://example.com",
"status": "NEW",
"createdAt": "2025-04-15T08:11:00.093761+00:00",
"updatedAt": "2025-04-15T08:15:05.299349+00:00",
"title": "Company information",
"generatedTitle": "Company information and business hours",
"summary": "Basic company details including founding date, business focus, and operating hours.",
"website": {
"url": "https://example.com",
"html": "<html>...</html>",
"text": "This is the main text content extracted from the website.",
"links": [
"https://example.com",
"https://another-example.com"
],
"title": "Example Website Title",
"description": "Example Website Description",
"screenshotURL": "https://example.com/screenshot.webp"
},
"youtube": {
"url": "https://www.youtube.com/watch?v=VIDEO_ID",
"title": "Example YouTube Video Title",
"summary": "A concise summary of the key points covered in the video.",
"description": "This is a description of the YouTube video content.",
"thumbnailURL": "https://i.ytimg.com/vi/VIDEO_ID/hqdefault.jpg",
"transcription": "This is the complete transcript of the video content...",
"visualTranscription": "Visual elements and scenes described in text format"
},
"file": {
"name": "company_handbook.pdf",
"size": 204800,
"mimeType": "application/epub+zip",
"downloadURL": "https://example.com/download/company_handbook.pdf?signed=...",
"screenshotURL": "https://example.com/screenshot.webp"
},
"error": {
"message": "Failed to process the entry due to invalid format.",
"fingerprint": "12345"
},
"rawText": "Our company was founded in 2020. We specialize in AI-powered customer service solutions. Our business hours are Monday to Friday, 9 AM to 5 PM Eastern Time.",
"generatedFacts": [
"The company was founded in 2020.",
"We specialize in AI-powered customer service solutions."
],
"rawTextChunks": [
{
"content": "First part of the document content.",
"chunkChars": 35,
"chunkIndex": 0,
"chunkTokens": 7
},
{
"content": "Second part of the document content.",
"chunkChars": 36,
"chunkIndex": 1,
"chunkTokens": 7
}
],
"success": true
}
Response examples (400)
{
"error": "A text representation of the error",
"success": false,
"request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
"fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}
Response examples (401)
{
"error": "A text representation of the error",
"success": false,
"request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
"fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}
Response examples (404)
{
"error": "A text representation of the error",
"success": false,
"request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab"
}
Response examples (415)
{
"error": "A text representation of the error",
"success": false,
"request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
"fingerprint": "14fceadd84e74ec499afe9b0f7952d6b"
}
Response examples (500)
{
"error": "A text representation of the error",
"success": false,
"request_id": "xyz1::reg1:reg1::ab3c4-1234567890123-0123456789ab",
"fingerprint": "14fceadd84e74ec499afe9b0f7952d6b",
"inner_exception": {
"name": "Server overheated",
"cause": "Request too complicated",
"stack": "Error: Server overheated due to an unexpected situation\n at Object.eval (eval at <anonymous>...",
"message": "The server overheated due to an unexpected situation"
}
}