Knowledge Base

Get record by ID

Retrieve detailed information about a specific record.

Overview:

Returns complete record metadata including name, type, indexing status, storage information, and version history.

File conversion:

Use the optional convertTo parameter to request file format conversion (e.g., PDF to text). Supported conversions include PPT to PDF and PPTX to PDF.

get/knowledgeBase/record/{recordId}

Path parameters

recordIdstring required

Record ID

Query parameters

convertTostring

Example:txt

Optional format to convert the file to (e.g., PDF to text). Supported conversions include PPT to PDF and PPTX to PDF.

Response

Successful operation

Example response

{
  "record": {
    "connectorName": "DRIVE",
    "recordType": "FILE"
  }
}

Changes

Changed in 3 of the 15 revisions of this API.1825

Aug 12, 20265798f431973a1823See the full diff
- ▲
  the response property record/fileRecord/mimeType became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/fileRecord/sizeInBytes became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/fileRecord/webUrl became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/isDirty became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/isLatestVersion became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/isVLMOcrProcessed became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/lastSyncTimestamp became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/md5Checksum became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/mimeType became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/sizeInBytes became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/virtualRecordId became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/webUrl became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property record/fileRecord/mimeType became optional for the status 200
  response-property-became-optional
- ▲
  the response property record/fileRecord/sizeInBytes became optional for the status 200
  response-property-became-optional
- ▲
  the response property record/fileRecord/webUrl became optional for the status 200
  response-property-became-optional
- ▲
  the response property record/isDirty became optional for the status 200
  response-property-became-optional
- ▲
  the response property record/isLatestVersion became optional for the status 200
  response-property-became-optional
- ▲
  the response property record/lastSyncTimestamp became optional for the status 200
  response-property-became-optional
- ○
  added the optional property record/deletedByUserId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/externalParentId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/externalRevisionId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/fileRecord/crc32Hash to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/fileRecord/ctag to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/fileRecord/etag to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/fileRecord/md5Checksum to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/fileRecord/quickXorHash to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/fileRecord/sha1Hash to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/fileRecord/sha256Hash to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/hideWeburl to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/isDependentNode to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/isInternal to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/isPlaceholder to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/isShared to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/parentNodeId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/parsingStatus to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/previewRenderable to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/processingStartedAt to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/reason to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/recordGroupId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/storageDocumentId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property record/summaryDocumentId to the response with the 200 status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 30, 2026059c619e9b991See the full diff
- ○
  added the non-success response with the status 404
  response-non-success-status-added
Jun 29, 2026911a57b55d181See the full diff
- ○
  endpoint added
  endpoint-added

Full history