Use the Knowledge block to search a Sim knowledge base and manage its documents and chunks from a workflow. The reference below also covers tags, connector inspection, and connector sync. See Using knowledge in workflows for configuration and examples.

Use the block

Search knowledge bases and list, retrieve, create, upsert, or delete documents. Upload, list, update, or delete chunks, list tag definitions, and set document tags during creation or upsert. Inspect connectors and trigger syncs.

Actions

Knowledge Search

Search for similar content in a knowledge base by relevance

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base to search in
query	string	No	Search query text (optional when using tag filters)
topK	number	No	Number of most similar results to return (1-100)
tagFilters	array	No	Array of tag filters with tagName and tagValue properties
searchMode	string	No	Retrieval mode: 'hybrid' fuses a full-text leg with semantic similarity, 'vector' uses semantic similarity only; omit for the workspace's default
rerankerEnabled	boolean	No	Whether to apply Cohere reranking to vector search results
rerankerModel	string	No	Cohere rerank model to use (one of: rerank-v4.0-pro, rerank-v4.0-fast, rerank-v3.5)
rerankerInputCount	number	No	Number of vector results sent to the Cohere reranker (1–100). Defaults to topK × 4 capped at 100.
apiKey	string	No	Cohere API key for reranker (self-hosted deployments only)

Output

Parameter	Type	Description
results	array	Array of search results from the knowledge base
↳ documentId	string	Document ID
↳ documentName	string	Document name
↳ sourceUrl	string	URL to the original source document (e.g., Confluence page, Google Doc, Notion page). Null for documents without an external source.
↳ content	string	Content of the result
↳ chunkIndex	number	Index of the chunk within the document
↳ similarity	number	Cosine similarity between the query and the chunk (1 - cosine distance) in every search mode; 1 for tag-only matches. Not the ordering key in hybrid mode
↳ rankScore	number	Score the results are ordered by, descending: the reciprocal-rank-fusion score in hybrid mode, the cosine similarity in vector mode, or the reranker score when a reranker ordered the results
↳ rank	number	1-based position in the returned order
↳ metadata	object	Metadata of the result, including tags
query	string	The search query that was executed
totalResults	number	Total number of results found
cost	object	Cost information for the search operation

Knowledge Upload Chunk

Upload a new chunk to a document in a knowledge base

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base containing the document
documentId	string	Yes	ID of the document to upload the chunk to
content	string	Yes	Content of the chunk to upload

Output

Parameter	Type	Description
data	object	Information about the uploaded chunk
↳ chunkId	string	Chunk ID
↳ chunkIndex	number	Index of the chunk within the document
↳ content	string	Content of the chunk
↳ contentLength	number	Length of the content in characters
↳ tokenCount	number	Number of tokens in the chunk
↳ enabled	boolean	Whether the chunk is enabled
↳ createdAt	string	Creation timestamp
↳ updatedAt	string	Last update timestamp
message	string	Success or error message describing the operation result
documentId	string	ID of the document the chunk was added to
documentName	string	Name of the document the chunk was added to
cost	object	Cost information for the upload operation

Knowledge Create Document

Create a new document in a knowledge base

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base containing the document
name	string	Yes	Name of the document
content	string	Yes	Content of the document
documentTags	object	No	Document tags

Output

Parameter	Type	Description
data	object	Information about the created document
↳ documentId	string	Document ID
↳ documentName	string	Document name
↳ type	string	Document type
↳ enabled	boolean	Whether the document is enabled
↳ createdAt	string	Creation timestamp
↳ updatedAt	string	Last update timestamp
message	string	Success or error message describing the operation result
documentId	string	ID of the created document

Knowledge Upsert Document

Create or update a document in a knowledge base. If a document with the given ID or filename already exists, it will be replaced with the new content.

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base containing the document
documentId	string	No	Optional ID of an existing document to update. If not provided, lookup is done by filename.
name	string	Yes	Name of the document
content	string	Yes	Content of the document
documentTags	json	No	Document tags

Output

Parameter	Type	Description
data	object	Information about the upserted document
↳ documentId	string	Document ID
↳ documentName	string	Document name
↳ type	string	Document type
↳ enabled	boolean	Whether the document is enabled
↳ isUpdate	boolean	Whether an existing document was replaced
↳ previousDocumentId	string	ID of the document that was replaced, if any
↳ createdAt	string	Creation timestamp
↳ updatedAt	string	Last update timestamp
message	string	Success or error message describing the operation result
documentId	string	ID of the upserted document

Knowledge List Tags

List all tag definitions for a knowledge base

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base to list tags for

Output

Parameter	Type	Description
knowledgeBaseId	string	ID of the knowledge base
tags	array	Array of tag definitions for the knowledge base
↳ id	string	Tag definition ID
↳ tagSlot	string	Internal tag slot (e.g. tag1, number1)
↳ displayName	string	Human-readable tag name
↳ fieldType	string	Tag field type (text, number, date, boolean)
↳ createdAt	string	Creation timestamp
↳ updatedAt	string	Last update timestamp
totalTags	number	Total number of tag definitions

Knowledge List Documents

List documents in a knowledge base with optional filtering, search, and pagination

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base to list documents from
search	string	No	Search query to filter documents by filename
enabledFilter	string	No	Filter by enabled status: "all", "enabled", or "disabled"
limit	number	No	Maximum number of documents to return (default: 50)
offset	number	No	Number of documents to skip for pagination (default: 0)

Output

Parameter	Type	Description
knowledgeBaseId	string	ID of the knowledge base
documents	array	Array of documents in the knowledge base
↳ id	string	Document ID
↳ filename	string	Document filename
↳ fileSize	number	File size in bytes
↳ mimeType	string	MIME type of the document
↳ enabled	boolean	Whether the document is enabled
↳ processingStatus	string	Processing status (pending, processing, completed, failed)
↳ chunkCount	number	Number of chunks in the document
↳ tokenCount	number	Total token count across chunks
↳ uploadedAt	string	Upload timestamp
↳ updatedAt	string	Last update timestamp
↳ connectorId	string	Connector ID if document was synced from an external source
↳ connectorType	string	Connector type (e.g. notion, github, confluence) if synced
↳ sourceUrl	string	Original URL in the source system if synced from a connector
totalDocuments	number	Total number of documents matching the filter
limit	number	Page size used
offset	number	Offset used for pagination

Knowledge Get Document

Get full details of a single document including tags, connector metadata, and processing status

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base the document belongs to
documentId	string	Yes	ID of the document to retrieve

Output

Parameter	Type	Description
id	string	Document ID
filename	string	Document filename
fileSize	number	File size in bytes
mimeType	string	MIME type of the document
enabled	boolean	Whether the document is enabled
processingStatus	string	Processing status (pending, processing, completed, failed)
processingError	string	Error message if processing failed
chunkCount	number	Number of chunks in the document
tokenCount	number	Total token count across chunks
characterCount	number	Total character count
uploadedAt	string	Upload timestamp
updatedAt	string	Last update timestamp
connectorId	string	Connector ID if document was synced from an external source
sourceUrl	string	Original URL in the source system if synced from a connector
externalId	string	External ID from the source system
tags	object	Tag values keyed by tag slot (tag1-7, number1-5, date1-2, boolean1-3)

Knowledge Delete Document

Delete a document from a knowledge base

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base containing the document
documentId	string	Yes	ID of the document to delete

Output

Parameter	Type	Description
documentId	string	ID of the deleted document
message	string	Confirmation message

Knowledge List Chunks

List chunks for a document in a knowledge base with optional filtering and pagination

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base
documentId	string	Yes	ID of the document to list chunks from
search	string	No	Search query to filter chunks by content
enabled	string	No	Filter by enabled status: "true", "false", or "all" (default: "all")
limit	number	No	Maximum number of chunks to return (1-100, default: 50)
offset	number	No	Number of chunks to skip for pagination (default: 0)

Output

Parameter	Type	Description
knowledgeBaseId	string	ID of the knowledge base
documentId	string	ID of the document
chunks	array	Array of chunks in the document
↳ id	string	Chunk ID
↳ chunkIndex	number	Index of the chunk within the document
↳ content	string	Chunk text content
↳ contentLength	number	Content length in characters
↳ tokenCount	number	Token count for the chunk
↳ enabled	boolean	Whether the chunk is enabled
↳ createdAt	string	Creation timestamp
↳ updatedAt	string	Last update timestamp
totalChunks	number	Total number of chunks matching the filter
limit	number	Page size used
offset	number	Offset used for pagination

Knowledge Update Chunk

Update the content or enabled status of a chunk in a knowledge base

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base
documentId	string	Yes	ID of the document containing the chunk
chunkId	string	Yes	ID of the chunk to update
content	string	No	New content for the chunk
enabled	boolean	No	Whether the chunk should be enabled or disabled

Output

Parameter	Type	Description
documentId	string	ID of the parent document
id	string	Chunk ID
chunkIndex	number	Index of the chunk within the document
content	string	Updated chunk content
contentLength	number	Content length in characters
tokenCount	number	Token count for the chunk
enabled	boolean	Whether the chunk is enabled
updatedAt	string	Last update timestamp

Knowledge Delete Chunk

Delete a chunk from a document in a knowledge base

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base
documentId	string	Yes	ID of the document containing the chunk
chunkId	string	Yes	ID of the chunk to delete

Output

Parameter	Type	Description
chunkId	string	ID of the deleted chunk
documentId	string	ID of the parent document
message	string	Confirmation message

Knowledge List Connectors

List all connectors for a knowledge base, showing sync status, type, and document counts

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base to list connectors for

Output

Parameter	Type	Description
knowledgeBaseId	string	ID of the knowledge base
connectors	array	Array of connectors for the knowledge base
↳ id	string	Connector ID
↳ connectorType	string	Type of connector (e.g. notion, github, confluence)
↳ status	string	Connector status (active, paused, syncing)
↳ syncIntervalMinutes	number	Sync interval in minutes (0 = manual only)
↳ lastSyncAt	string	Timestamp of last sync
↳ lastSyncError	string	Error from last sync if failed
↳ lastSyncDocCount	number	Number of documents synced in last sync
↳ nextSyncAt	string	Timestamp of next scheduled sync
↳ consecutiveFailures	number	Number of consecutive sync failures
↳ createdAt	string	Creation timestamp
↳ updatedAt	string	Last update timestamp
totalConnectors	number	Total number of connectors

Knowledge Get Connector

Get detailed connector information including recent sync logs for monitoring sync health

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base the connector belongs to
connectorId	string	Yes	ID of the connector to retrieve

Output

Parameter	Type	Description
connector	object	Connector details
↳ id	string	Connector ID
↳ connectorType	string	Type of connector
↳ status	string	Connector status (active, paused, syncing)
↳ syncIntervalMinutes	number	Sync interval in minutes
↳ lastSyncAt	string	Timestamp of last sync
↳ lastSyncError	string	Error from last sync if failed
↳ lastSyncDocCount	number	Docs synced in last sync
↳ nextSyncAt	string	Next scheduled sync timestamp
↳ consecutiveFailures	number	Consecutive sync failures
↳ createdAt	string	Creation timestamp
↳ updatedAt	string	Last update timestamp
syncLogs	array	Recent sync log entries
↳ id	string	Sync log ID
↳ status	string	Sync status
↳ startedAt	string	Sync start time
↳ completedAt	string	Sync completion time
↳ docsAdded	number	Documents added
↳ docsUpdated	number	Documents updated
↳ docsDeleted	number	Documents deleted
↳ docsUnchanged	number	Documents unchanged
↳ errorMessage	string	Error message if sync failed

Knowledge Trigger Sync

Trigger a manual sync for a knowledge base connector

Inputs and outputs

Input

Parameter	Type	Required	Description
knowledgeBaseId	string	Yes	ID of the knowledge base the connector belongs to
connectorId	string	Yes	ID of the connector to trigger sync for

Output

Parameter	Type	Description
connectorId	string	ID of the connector that was synced
message	string	Status message from the sync trigger