Document AI — Storage Mounts

Add Storage Mount

Add an external storage mount (SFTP example). Required: name, host, username, and credentials (password or ssh_key). BYOS mounts also require encryption_key.

post/storage_mounts/add

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/storage_mounts/add
  • Auth: HTTP bearer

Request body

namestring required

Display name for the mount.

hoststring required

Remote host (SFTP/FTP).

connector_type'sftp' | 's3' | 'azure_blob' | 'webdav' | 'google_drive' | 'onedrive' | 'dropbox' | 'box' | 'imap'

Storage connector type.

mount_purpose'byos' | 'connector' required

Mount purpose: 'byos' (Bring Your Own Storage) or 'connector' (data source). Immutable after creation.

descriptionstring

Optional description of the mount.

portinteger

Port (default 22 for SFTP).

usernamestring required

Login username.

passwordstring

Password for SFTP/FTP login (or use ssh_key for key-based auth).

ssh_keystring

SSH private key (stored encrypted).

api_tokenstring

API token (stored encrypted).

base_pathstring

Base path on the remote server. Parent-directory segments (..) are not allowed.

encryption_keystring

BYOS encryption key when required by plan.

connection_optionsobject

Additional connection options as JSON (e.g. S3 region, IMAP folder).

icon_urlstring

Optional URL for a custom icon.

Response

Success

processing_timestring required

Processing time (format: 123.45ms)

mount_idstring

Mount id

typestring

Type

statusstring

Request status (ok/error)

Changes

No recorded changes to this operation across all 1 revision of this API.