v10

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-0582185581.9 KB
Knowledge Base

Update record

Update a record's name and/or file content.

Overview:

Allows updating the display name and optionally replacing the file content. Triggers re-indexing when content changes.

Required permission:

WRITER or higher

Updating file content:

Include a new file in the request to replace the existing content. The file extension must match the original.

Side effects:

  • Updates updatedAtTimestamp
  • Increments version if file content changed
  • Triggers re-indexing for content changes
put/knowledgeBase/record/{recordId}

Path parameters

recordIdstring required

Record ID

Response

Record updated successfully

successboolean
messagestring
timestampinteger

Epoch milliseconds when the response was generated

fileUpdatedboolean
location'kb_root' | 'folder'
kbobject
userPermissionstring

Example response

{
  "record": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "recordName": "Q4 Financial Report.pdf",
    "externalRecordId": "507f1f77bcf86cd799439011",
    "recordType": "FILE",
    "origin": "UPLOAD",
    "connectorId": "conn_123456",
    "connectorName": "DRIVE",
    "orgId": "org_abc123",
    "kbId": "kb_xyz789",
    "folderId": "folder_456",
    "version": 3,
    "createdAtTimestamp": 1704153600000,
    "updatedAtTimestamp": 1704240000000,
    "indexingStatus": "COMPLETED",
    "webUrl": "https://drive.google.com/file/d/abc123",
    "mimeType": "application/pdf",
    "sizeInBytes": 1048576,
    "extension": "pdf",
    "type": "record"
  }
}