companyId?

string | undefined

(Optional) The unique identifier of the tenant when a service token is used.

content?

string | undefined

(Optional) Optional document content in plain text or markdown format. For file uploads, can be the document content.

dataSourceId

string

Unique identifier of the data source

description?

string | undefined

(Optional) Optional detailed description of the document content and purpose. Helps users understand what the document is about.

metadata?

__DocumentType | undefined

(Optional) Additional metadata of the document. Example: \{ 'createdAt': '2025-01-01T00:00:00Z', 'updatedAt': '2025-05-01T00:00:00Z', 'createdBy': 'user@example.com' \}

originalFormat

string

File format/extension of the original document for reference. Examples: 'pdf', 'docx', 'md', 'html', 'txt'. Helps identify source document type

originalId?

string | undefined

(Optional) Original ID from the source system, preserving the reference to the source document. Examples: 'confluence-page-1234567890' (for Confluence), 'gdrive-file-abc123' (for Google Drive), sha1(original-file-content) (for file uploads)

originalName

string

Original filename or identifier of the source document. Preserves the source document name. Examples: 'product-knowledge-base.pdf', 'installation-guide.docx'

title

string

Display title of the document used in search results and UI. Can differ from originalName. Examples: 'Product Installation Guide', 'API Documentation'. Length: 2-100 characters

url?

string | undefined

(Optional) Optional URL where the document can be accessed or viewed. Used for providing direct links to the source. Example: https://confluence.company.com/wiki/Product\_Documentation