Knowledge

sim knowledge is also spelled sim kb.

These commands accept the global options.

Knowledge bases

List knowledge bases

Code

sim knowledge list [options]

Options

Option	Required	Description
`--scope <value>`	No	Lifecycle scope: active or archived knowledge bases. Use Restore knowledge base to recover archived entries. Folder paths resolve only active folders, so filtering by an archived folder returns no matches. Defaults to "active". Accepted values: `active`, `archived`.
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.
`--search <value>`	No	Case-insensitive substring match against the resource name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "createdAt". Accepted values: `name`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listKnowledgeBases.

Get knowledge base

Code

sim knowledge get <knowledgeBaseId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

API request and response schemas: getKnowledgeBase.

Create knowledge base

Code

sim knowledge create [options]

Options

Option	Required	Description
`--name <value>`	Yes	Human-readable knowledge base name.
`--description <value>`	No	Optional knowledge base description.
`--chunking-config <json\|@file>`	No	Chunking configuration; defaults are applied when omitted. (JSON, or @path / @- to read a file or stdin).
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.

API request and response schemas: createKnowledgeBase.

Update knowledge base

Code

sim knowledge update <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--name <value>`	No	New knowledge base name.
`--description <value>`	No	New knowledge base description.
`--chunking-config <json\|@file>`	No	New document chunking configuration. (JSON, or @path / @- to read a file or stdin).
`--folder <value>`	No	Folder path as shown in the app; the leading / is optional.

API request and response schemas: updateKnowledgeBase.

Move a knowledge base to a folder

Code

sim knowledge mv <knowledgeBaseId> <folder>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`folder`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: updateKnowledgeBase.

Delete knowledge base

This archives the knowledge base and every document in it; restore with knowledge restore.

Code

sim knowledge delete <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeBase.

Restore an archived knowledge base

Code

sim knowledge restore <knowledgeBaseId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

API request and response schemas: restoreKnowledgeBase.

Search

Search knowledge

Code

sim knowledge search [options]

Options

Option	Required	Description
`--kb <value...>`	Yes	Knowledge base ID (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--query <value>`	No	Text to search for.
`--top-k <value>`	No	Maximum number of search results to return. Must be a whole number between 1 and 100. Defaults to 10.
`--tag-filters <json\|@file>`	No	Tag filters as [{"tagName":"...","operator":"...","value":"..."}] (JSON, or @path / @- to read a file or stdin).
`--search-mode <value>`	No	Search algorithm. Accepted values: `vector`, `hybrid`.
`--reranker-enabled`	No	Reorder retrieved chunks with a reranking model before truncating to `topK`. Ignored for tag-only searches. A completed reranking call adds a search unit. If reranking is unavailable, results keep their retrieval order; check `rerankerStatus`.
`--no-reranker-enabled`	No	Send --reranker-enabled as false.
`--reranker-model <value>`	No	Reranking model to use when `rerankerEnabled` is true. Defaults to `rerank-v4.0-fast`. Accepted values: `rerank-v4.0-pro`, `rerank-v4.0-fast`, `rerank-v3.5`.
`--reranker-input-count <value>`	No	How many candidate chunks to retrieve before reranking. Defaults to four times `topK`, capped at 100. A larger pool costs more retrieval work but gives the reranker more to choose from.

API request and response schemas: searchKnowledge.

Export and import

Export a knowledge base as a .simkb.zip bundle

Code

sim knowledge export <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base to export

Options

Option	Required	Description
`-o, --output-file <path>`	No	Write the bundle to this path instead of the name the server suggests; pass - to stream it to stdout.
`--force`	No	Overwrite --output-file if it already exists.
`--no-vectors`	No	Leave chunk vectors out of the bundle, so an import re-embeds every chunk.

API request and response schemas: exportKnowledgeBase.

Create a knowledge base from an exported .simkb.zip bundle

Code

sim knowledge import <path> [options]

Arguments

Argument	Required	Description
`path`	Yes	Bundle archive written by `sim knowledge export`

Options

Option	Required	Description
`--name <name>`	No	Name for the new knowledge base; defaults to the bundle's own name.
`--no-wait`	No	Return once the import is started instead of watching it.

API request and response schemas: createKnowledgeImport, createKnowledgeImportPartUrls, completeKnowledgeImport, cancelKnowledgeImport, getKnowledgeImport.

Get knowledge base import

Code

sim knowledge imports get <importId>

Arguments

Argument	Required	Description
`importId`	Yes	Unique knowledge-base import identifier.

API request and response schemas: getKnowledgeImport.

Stop a running import

Code

sim knowledge imports cancel <importId>

Arguments

Argument	Required	Description
`importId`	Yes	Unique knowledge-base import identifier.

API request and response schemas: cancelKnowledgeImport.

Documents

List documents

Code

sim knowledge documents list <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--search <value>`	No	Case-insensitive substring match against the document filename.
`--enabled-filter <value>`	No	Filter by whether documents are enabled for search. Defaults to "all". Accepted values: `all`, `enabled`, `disabled`.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `filename`. Defaults to "uploadedAt". Accepted values: `filename`, `fileSize`, `tokenCount`, `chunkCount`, `uploadedAt`, `processingStatus`, `enabled`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.
`--tag-filters <value>`	No	A JSON-encoded array of at most 10 tag filters, using the same display-name shape as knowledge search: `[{"tagName":"category","operator":"eq","value":"billing"}]`. Every filter must hold, including two that name the same tag. A name that is not defined in this knowledge base is rejected, never ignored.

API request and response schemas: listKnowledgeDocuments.

Get document

Code

sim knowledge documents get <knowledgeBaseId> <documentId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

API request and response schemas: getKnowledgeDocument.

Upload a document to a knowledge base

Code

sim knowledge documents upload <knowledgeBaseId> <path> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base to upload into
`path`	Yes	Local file to upload

Options

Option	Required	Description
`--name <name>`	No	Store it under a different name.
`--tag <value...>`	No	Document tags, in tag1 through tag7 order.
`--recipe <name>`	No	Document processing recipe. Accepted values: `default`, `plain`, `markdown`, `code`.
`--lang <code>`	No	Document language tag: hyphen-separated letter and digit subtags, for example en or en-US.

API request and response schemas: createKnowledgeDocumentUpload, createKnowledgeDocumentUploadPartUrls, completeKnowledgeDocumentUpload, abortKnowledgeDocumentUpload.

Update document

OAuth login or personal API key required.

Code

sim knowledge documents update <knowledgeBaseId> <documentId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

Options

Option	Required	Description
`--filename <value>`	No	New filename for the document.
`--enabled`	No	Whether the document participates in search. Disabling keeps it indexed.
`--no-enabled`	No	Send --enabled as false.
`--tag1 <value>`	No	New value for tag slot 1.
`--tag2 <value>`	No	New value for tag slot 2.
`--tag3 <value>`	No	New value for tag slot 3.
`--tag4 <value>`	No	New value for tag slot 4.
`--tag5 <value>`	No	New value for tag slot 5.
`--tag6 <value>`	No	New value for tag slot 6.
`--tag7 <value>`	No	New value for tag slot 7.
`--number1 <value>`	No	New value for number tag slot 1.
`--number2 <value>`	No	New value for number tag slot 2.
`--number3 <value>`	No	New value for number tag slot 3.
`--number4 <value>`	No	New value for number tag slot 4.
`--number5 <value>`	No	New value for number tag slot 5.
`--date1 <value>`	No	New value for date tag slot 1, formatted YYYY-MM-DD.
`--date2 <value>`	No	New value for date tag slot 2, formatted YYYY-MM-DD.
`--boolean1`	No	New value for boolean tag slot 1.
`--no-boolean1`	No	Send --boolean1 as false.
`--boolean2`	No	New value for boolean tag slot 2.
`--no-boolean2`	No	Send --boolean2 as false.
`--boolean3`	No	New value for boolean tag slot 3.
`--no-boolean3`	No	Send --boolean3 as false.
`--retry-processing`	No	Requeue a failed or stuck document for processing. Send it alone — no other field may accompany it — and it answers with a queue acknowledgement rather than the document.

API request and response schemas: updateKnowledgeDocument.

Enable or disable every matching document

OAuth login or personal API key required.

Code

sim knowledge documents batch-update <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--operation <value>`	Yes	Whether the selected documents become enabled or disabled for search. Accepted values: `enable`, `disable`.
`--document <value...>`	No	Documents to update, by identifier. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`--select-all`	No	Apply to every document in the knowledge base.
`--enabled-filter <value>`	No	With `selectAll`, restrict the update to documents in this state. Accepted values: `all`, `enabled`, `disabled`.

API request and response schemas: bulkUpdateKnowledgeDocuments.

Delete a document from a knowledge base

This deletes the document and its embeddings.

Code

sim knowledge documents delete <knowledgeBaseId> <documentId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeDocument.

Index files the workspace already stores

OAuth login or personal API key required.

Code

sim knowledge from-workspace-files create <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--file <value...>`	Yes	Workspace file ID or canonical files/<folder>/<name> path (repeatable) (space-separated, or @path / @- with one value per line; @@value for a literal leading @).

API request and response schemas: addWorkspaceFilesToKnowledgeBase.

Chunks

List chunks

OAuth login or personal API key required.

Code

sim knowledge chunks list <knowledgeBaseId> <documentId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

Options

Option	Required	Description
`--search <value>`	No	Case-insensitive substring match against chunk content.
`--enabled <value>`	No	Restrict to enabled or disabled chunks. `all` returns both. Defaults to "all". Accepted values: `true`, `false`, `all`.
`--sort-by <value>`	No	Field used to sort the result. Defaults to "chunkIndex". Accepted values: `chunkIndex`, `tokenCount`, `enabled`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.

API request and response schemas: listKnowledgeChunks.

Get chunk

OAuth login or personal API key required.

Code

sim knowledge chunks get <knowledgeBaseId> <documentId> <chunkId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.
`chunkId`	Yes	Unique chunk identifier.

API request and response schemas: getKnowledgeChunk.

Create chunk

OAuth login or personal API key required.

Code

sim knowledge chunks create <knowledgeBaseId> <documentId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

Options

Option	Required	Description
`--content <value>`	Yes	Text embedded before the response. Search includes it when the chunk and document are enabled and the document has completed processing.
`--enabled`	No	Whether the new chunk participates in search. Defaults to true.
`--no-enabled`	No	Send --enabled as false.

API request and response schemas: createKnowledgeChunk.

Update chunk

OAuth login or personal API key required.

Code

sim knowledge chunks update <knowledgeBaseId> <documentId> <chunkId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.
`chunkId`	Yes	Unique chunk identifier.

Options

Option	Required	Description
`--content <value>`	No	Replacement text. Changing it re-embeds the chunk and re-derives its token and character counts.
`--enabled`	No	Whether the chunk participates in search. Disabling keeps it indexed.
`--no-enabled`	No	Send --enabled as false.

API request and response schemas: updateKnowledgeChunk.

Enable, disable, or delete many chunks at once

OAuth login or personal API key required.

This applies --operation to every named chunk; with --operation delete it deletes them and their embeddings, which cannot be undone.

Code

sim knowledge chunks batch-update <knowledgeBaseId> <documentId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.

Options

Option	Required	Description
`--operation <value>`	Yes	What to do with the selected chunks. Accepted values: `enable`, `disable`, `delete`.
`--chunk <value...>`	Yes	Chunks to operate on, by identifier. An id naming no chunk in the document is reported in errors and does not fail the request. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: bulkUpdateKnowledgeChunks.

Delete chunk

OAuth login or personal API key required.

This deletes the chunk and its embedding.

Code

sim knowledge chunks delete <knowledgeBaseId> <documentId> <chunkId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`documentId`	Yes	Unique knowledge document identifier.
`chunkId`	Yes	Unique chunk identifier.

Options

Option	Required	Description
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeChunk.

Option	Required	Description
`--display-name <value>`	Yes	Name tag filters and document reads use for this tag.
`--field-type <value>`	No	Value type stored in the slot; it decides which slots are usable and which filter operators apply. Defaults to text, so a number, date, or boolean slot must name its type here. Slot capacity per type: text 7, number 5, date 2, boolean 3. Accepted values: `text`, `number`, `date`, `boolean`.
`--tag-slot <value>`	No	Slot to store the tag in. Omit to take the next free slot for the field type; a slot that does not belong to the field type, or one already in use, is rejected. Accepted values: `tag1`, `tag2`, `tag3`, `tag4`, `tag5`, `tag6`, `tag7`, `number1`, `number2`, `number3`, `number4`, `number5`, `date1`, `date2`, `boolean1`, `boolean2`, `boolean3`.

Option	Required	Description
`--definitions <json\|@file>`	Yes	Tag definitions: [{"tagSlot":"tag1","displayName":"category","fieldType":"text"}] (JSON, or @path / @- to read a file or stdin).

Option	Required	Description
`--display-name <value>`	No	New tag display name.
`--field-type <value>`	No	New value type for the tag. Accepted values: `text`, `number`, `date`, `boolean`.

Option	Required	Description
`--field-type <value>`	Yes	Value type stored in the slot; it decides which slots are usable and which filter operators apply. Slot capacity per type: text 7, number 5, date 2, boolean 3. Accepted values: `text`, `number`, `date`, `boolean`.

Connectors

List knowledge connectors

OAuth login or personal API key required.

Code

sim knowledge connectors list <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--sort-by <value>`	No	Field used to sort the result. Defaults to "createdAt". Accepted values: `connectorType`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "desc". Accepted values: `asc`, `desc`.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `0`.

API request and response schemas: listKnowledgeConnectors.

Get knowledge connector

OAuth login or personal API key required.

Code

sim knowledge connectors get <knowledgeBaseId> <connectorId>

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

API request and response schemas: getKnowledgeConnector.

Create knowledge connector

OAuth login or personal API key required.

Code

sim knowledge connectors create <knowledgeBaseId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.

Options

Option	Required	Description
`--connector-type <value>`	Yes	Registered connector type.
`--credential-id <value>`	No	OAuth credential identifier for connector types whose `auth.mode` is `oauth` (see connector types); omit it for `apiKey` connectors.
`--api-key <value>`	No	Write-only API key for connector types whose `auth.mode` is `apiKey` (see connector types), or a personal access token for an OAuth connector that also accepts one, such as GitHub. Send it instead of `credentialId`. Pass a raw key, or a secret reference written as the whole value `{{SECRET_NAME}}`, which the server resolves; `$SECRET_NAME` is not a reference.
`--source-config <json\|@file>`	Yes	Connector-specific source selection and filtering configuration. (JSON, or @path / @- to read a file or stdin).
`--sync-interval-minutes <value>`	No	Scheduled synchronization interval in minutes; zero disables scheduling. Defaults to 1440.

API request and response schemas: createKnowledgeConnector.

Update knowledge connector

OAuth login or personal API key required.

Code

sim knowledge connectors update <knowledgeBaseId> <connectorId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

Options

Option	Required	Description
`--source-config <json\|@file>`	No	Replacement source selection and filtering configuration. Updating a runnable connector queues synchronization; paused connectors remain paused. (JSON, or @path / @- to read a file or stdin).
`--sync-interval-minutes <value>`	No	New scheduled synchronization interval in minutes.
`--status <value>`	No	New connector state. Accepted values: `active`, `paused`.

API request and response schemas: updateKnowledgeConnector.

Queue a knowledge connector synchronization

OAuth login or personal API key required.

Code

sim knowledge connectors sync <knowledgeBaseId> <connectorId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

Options

Option	Required	Description
`--rehydrate`	No	Re-fetch and re-index every existing connector document. Defaults to false.
`--no-rehydrate`	No	Send --rehydrate as false.

API request and response schemas: syncKnowledgeConnector.

List knowledge connector documents

OAuth login or personal API key required.

Code

sim knowledge connectors documents list <knowledgeBaseId> <connectorId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

Options

Option	Required	Description
`--include-excluded`	No	Include documents explicitly excluded by a user.
`--no-include-excluded`	No	Send --include-excluded as false.
`--limit <n>`	No	Maximum items to return (0 for everything). Defaults to `100`.
`--cursor <value>`	No	Continue from nextCursor returned by a previous result.

API request and response schemas: listKnowledgeConnectorDocuments.

Update knowledge connector documents

OAuth login or personal API key required.

Code

sim knowledge connectors documents update <knowledgeBaseId> <connectorId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

Options

Option	Required	Description
`--operation <value>`	Yes	Whether to restore or exclude the selected documents. Accepted values: `restore`, `exclude`.
`--document <value...>`	Yes	Connector document identifiers to update. (space-separated, or @path / @- with one value per line; @@value for a literal leading @).

API request and response schemas: updateKnowledgeConnectorDocuments.

Delete knowledge connector

OAuth login or personal API key required.

This deletes the connector; --delete-documents also deletes its synchronized documents.

Code

sim knowledge connectors delete <knowledgeBaseId> <connectorId> [options]

Arguments

Argument	Required	Description
`knowledgeBaseId`	Yes	Knowledge base that owns the connector.
`connectorId`	Yes	Connector selected for the operation.

Options

Option	Required	Description
`--delete-documents`	No	Also permanently delete documents produced by this connector.
`--no-delete-documents`	No	Send --delete-documents as false.
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeConnector.

Folders

List knowledge resources and child folders together

Code

sim knowledge ls [path] [options]

Arguments

Argument	Required	Description
`path`	No	Folder path to list; defaults to the root folder

Options

Option	Required	Description
`--search <text>`	No	Filter folders and resources by name.
`--limit <n>`	No	Maximum combined items to return (0 for everything). Defaults to `0`.

API request and response schemas: listKnowledgeBases, listKnowledgeFolders.

List knowledge folders

Code

sim knowledge folders list [options]

Also available as sim knowledge folders ls.

Options

Option	Required	Description
`--parent <value>`	No	Direct parent folder path.
`--search <value>`	No	Case-insensitive substring match against the folder name.
`--sort-by <value>`	No	Field used to sort the result. Do not rely on case-insensitive ordering when sorting by `name`. Defaults to "name". Accepted values: `name`, `createdAt`, `updatedAt`.
`--sort-order <value>`	No	Sort direction. Defaults to "asc". Accepted values: `asc`, `desc`.

API request and response schemas: listKnowledgeFolders.

Create a knowledge folder at a path

Code

sim knowledge folders create <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: createKnowledgeFolder.

Delete folder

This archives the knowledge folder and, when recursive, everything inside it.

Code

sim knowledge folders delete <path> [options]

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional

Options

Option	Required	Description
`--recursive`	No	Archive the folder and its descendants. Defaults to "false".
`-y, --yes`	Yes	Confirm this operation.

API request and response schemas: deleteKnowledgeFolder.

Rename or move a knowledge folder

Code

sim knowledge folders move <path> <destination>

Also available as sim knowledge folders mv.

Arguments

Argument	Required	Description
`path`	Yes	Folder path as shown in the app; the leading / is optional
`destination`	Yes	Folder path as shown in the app; the leading / is optional

API request and response schemas: relocateKnowledgeFolder.

Create a knowledge directory at a path

Code

sim knowledge mkdir <path>

Arguments

Argument	Required	Description
`path`	Yes	Folder path to create; the leading / is optional

API request and response schemas: createKnowledgeFolder.

Argument	Required	Description
`knowledgeBaseId`	Yes	Unique knowledge base identifier.
`tagId`	Yes	Unique tag definition identifier.

Option	Required	Description
`--unused`	No	Whether to remove only the tag definitions no document in the knowledge base still carries a value for. Defaults to true. Pass --no-unused to delete every definition on the knowledge base, which also clears its slot on every document and chunk and is not recoverable.
`--no-unused`	No	Send --unused as false.
`-y, --yes`	Yes	Confirm this operation.

Knowledge bases

List knowledge bases

Get knowledge base

Create knowledge base

Update knowledge base

Move a knowledge base to a folder

Delete knowledge base

Restore an archived knowledge base

Search

Search knowledge

Export and import

Export a knowledge base as a .simkb.zip bundle

Create a knowledge base from an exported .simkb.zip bundle

Get knowledge base import

Stop a running import

Documents

List documents

Get document

Upload a document to a knowledge base

Update document

Enable or disable every matching document

Delete a document from a knowledge base

Index files the workspace already stores

Chunks

List chunks

Get chunk

Create chunk

Update chunk

Enable, disable, or delete many chunks at once

Delete chunk

Tags

List tags

Create tag

Declare the tag definitions a knowledge base needs

Update tag

Show how many documents and chunks carry each tag

Show which tag slot a create would take for a field type

Delete tag

Remove tag definitions no document still uses

Connectors

List knowledge connectors

Get knowledge connector

Create knowledge connector

Update knowledge connector

Queue a knowledge connector synchronization

List knowledge connector documents

Update knowledge connector documents

Delete knowledge connector

Folders

List knowledge resources and child folders together

List knowledge folders

Create a knowledge folder at a path

Delete folder

Rename or move a knowledge folder

Create a knowledge directory at a path

Related docs