Skip to main content
POST
`POST /orgs/{org_id}/connectors/{connector_id}/filesystems/copy`

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required
connector_id
string
required

Body

application/json
filesystem_ref
string
required

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

kb_id
integer<int64>
required

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

directory
string | null

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

max_files
integer<int32> | null

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

Required range: x >= 0
max_total_bytes
integer<int64> | null

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

Required range: x >= 0
metadata
object

Metadata stamped onto every landed file.

parse
boolean

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

path
string

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).

recursive
boolean

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_id
string
required