Knowledge base

Get knowledge base entry by ID

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}

Request

Base URL: https://api.sensay.io
URL: https://api.sensay.io/v1/replicas/{replicaUUID}/knowledge-base/{knowledgeBaseID}
Auth: one of:
- API key in header X-ORGANIZATION-SECRET
- API key in header X-ORGANIZATION-SECRET and API key in header X-USER-ID and API key in header X-USER-ID-TYPE

Path parameters

knowledgeBaseIDnumber nullable required

The unique identifier of the knowledge base entry

Example:12345

replicaUUIDstring uuid required

The replica unique identifier (UUID)

Example:03db5651-cb61-4bdf-9ef0-89561f7c9c53

Headers

X-API-Versionstring

Example:2025-03-25

Response

The requested knowledge base entry.

idinteger required

The unique identifier for this knowledge base entry.

replicaUUIDstring uuid

The unique identifier of the replica associated to this knowledge base entry.

type'file' | 'text' | 'website' | 'youtube' required

The type of knowledge base entry, indicating how the content was added and how it should be processed.

urlstring

The URL provided during entry creation, if applicable.

The current stage in the processing pipeline. Use this to track progress and identify any issues with processing.

createdAtstring date-time required

The ISO 8601 timestamp indicating when this knowledge base entry was created.

updatedAtstring date-time required

The ISO 8601 timestamp indicating when this knowledge base entry was last updated. Useful for tracking the completion time of processing.

titlestring

Title for the knowledge base entry, to help identify the knowledge base entry in listings. This field is not used in processing or internal logic.

generatedTitlestring

Auto-generated title for the knowledge base entry based on the content.

summarystring

A concise 1-2 sentence summary of rawText, generated by the system.

language'ab' | 'aa' | 'af' | 'ak' | 'sq' | 'am' | 'ar' | 'an' | 'hy' | 'as' | 'av' | 'ae' | 'ay' | 'az' | 'ba' | 'bm' | 'eu' | 'be' | 'bn' | 'bh' | 'bi' | 'bs' | 'br' | 'bg' | 'my' | 'ca' | 'ch' | 'ce' | 'ny' | 'zh' | 'cu' | 'cv' | 'kw' | 'co' | 'cr' | 'hr' | 'cs' | 'da' | 'dv' | 'nl' | 'dz' | 'en' | 'eo' | 'et' | 'ee' | 'fo' | 'fj' | 'fi' | 'fr' | 'ff' | 'gl' | 'ka' | 'de' | 'el' | 'kl' | 'gn' | 'gu' | 'ht' | 'ha' | 'he' | 'hz' | 'hi' | 'ho' | 'hu' | 'is' | 'io' | 'ig' | 'id' | 'ia' | 'ie' | 'iu' | 'ik' | 'ga' | 'it' | 'ja' | 'jv' | 'kn' | 'kr' | 'ks' | 'kk' | 'km' | 'ki' | 'rw' | 'ky' | 'kv' | 'kg' | 'ko' | 'ku' | 'kj' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'gv' | 'mk' | 'mg' | 'ms' | 'ml' | 'mt' | 'mi' | 'mr' | 'mh' | 'mn' | 'na' | 'nv' | 'nd' | 'ne' | 'ng' | 'nb' | 'nn' | 'no' | 'ii' | 'nr' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'fa' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'sa' | 'sc' | 'sd' | 'se' | 'sm' | 'sg' | 'sr' | 'gd' | 'sn' | 'si' | 'sk' | 'sl' | 'so' | 'st' | 'es' | 'su' | 'sw' | 'ss' | 'sv' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'bo' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'cy' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zu'

The language of the knowledge base entry content. Uses ISO 639-1 language codes for language-specific processing and retrieval.

rawTextstring

The original, unmodified text content that was submitted for training. May be truncated for large entries.

generatedFactsstring[]

Generated facts related to the knowledge base entry.

successboolean required

Indicates if the request was successful

Example response

{
  "id": 12345,
  "replicaUUID": "03db5651-cb61-4bdf-9ef0-89561f7c9c53",
  "url": "http://example.com",
  "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.",
  "language": "en",
  "website": {
    "url": "https://example.com",
    "title": "Example Website Title",
    "text": "This is the main text content extracted from the website.",
    "description": "This website provides information about our company and services."
  },
  "youtube": {
    "url": "https://www.youtube.com/watch?v=VIDEO_ID",
    "title": "Example YouTube Video Title",
    "description": "This is a description of the YouTube video content.",
    "thumbnailURL": "https://i.ytimg.com/vi/VIDEO_ID/hqdefault.jpg",
    "summary": "A concise summary of the key points covered in the video.",
    "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=..."
  },
  "error": {
    "fingerprint": "12345",
    "message": "Failed to process the entry due to invalid format."
  },
  "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.",
      "chunkIndex": 0,
      "chunkTokens": 7,
      "chunkChars": 35
    },
    {
      "content": "Second part of the document content.",
      "chunkIndex": 1,
      "chunkTokens": 7,
      "chunkChars": 36
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.