Skip to main content

Documents

This category lists the 4 Runtime system commands under system.document..

1. Retrieve metadata​

Full name: system.document.metadata.get

Retrieve document metadata resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system document metadata get --file-id <uuid> [--json]

Parameters: none beyond common options such as --json.

2. Read document​

Full name: system.document.read

Read document resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system document read \
--file-id <uuid> [--start-chunk n] [--start-character n] \
[--max-chunks n] [--max-chars n] [--json]

Parameters: none beyond common options such as --json.

3. Search document​

Full name: system.document.search

Search document records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

sl system document search \
--file-id <uuid> --query value [--limit n] [--json]

Parameters: none beyond common options such as --json.

4. Convert document​

Full name: system.document.convert

Convert the document Runtime operation. This tenant-scoped command validates its input against the registered command schema. · Risk: Write

sl system document convert \
--file-id <uuid> --target-format pdf [--output-file-name value] \
[--json]

Parameters: none beyond common options such as --json.