Sign in

v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01206322659.2 KB
connectors

`POST /orgs/{org_id}/connectors/{connector_id}/filesystems/copy`

Copy a file or directory tree from a connector filesystem root into a knowledge base's document store. Store-only by default (parse: true to opt in). Requires fs:copy (0.1.27+).

post/orgs/{org_id}/connectors/{connector_id}/filesystems/copy

Path parameters

org_idstring required
connector_idstring required

Request body

directorystring nullable

KB directory files land under (root when omitted). A recursive copy recreates the tree below it.

filesystem_refstring required

Filesystem root ref on the node (from /browse/filesystems).

kb_idinteger required

Target KB (numeric id, same as the /k2 routes).

max_filesinteger nullable

Job cap on files shipped. Omit for the node default (5000).

max_total_bytesinteger nullable

Job cap on aggregate raw bytes. Omit for the node default (2 GiB).

metadataobject

Metadata stamped onto every landed file.

parseboolean

Parse + embed after storing. Default false — copy is store-only; the KB's auto-processing setting never applies to connector copies.

pathstring

Path relative to the root: a file, or a directory when recursive. Empty / omitted / whitespace = the filesystem root (same as the connector's CopyFileJob / browse verbs).

recursiveboolean

true = path is a directory: walk it and stream every regular file (symlinks skipped). Copying a directory without it is refused node-side.

Response

Copy job accepted and dispatched

job_idstring required