Sim

SFTP

Transfer files via SFTP (SSH File Transfer Protocol)

SFTP (SSH File Transfer Protocol) is a secure network protocol that enables you to upload, download, and manage files on remote servers. SFTP operates over SSH, making it ideal for automated, encrypted file transfers and remote file management within modern workflows.

With SFTP tools integrated into Sim, you can easily automate the movement of files between your AI agents and external systems or servers. This empowers your agents to manage critical data exchanges, backups, document generation, and remote system orchestration—all with robust security.

Key functionality available via SFTP tools:

  • Upload Files: Seamlessly transfer files of any type from your workflow to a remote server, with support for both password and SSH private key authentication.
  • Download Files: Retrieve files from remote SFTP servers directly for processing, archiving, or further automation.
  • List & Manage Files: Enumerate directories, delete or create files and folders, and manage file system permissions remotely.
  • Flexible Authentication: Connect using either traditional passwords or SSH keys, with support for passphrases and permissions control.
  • Large File Support: Programmatically manage large file uploads and downloads, with built-in size limits for safety.

By integrating SFTP into Sim, you can automate secure file operations as part of any workflow, whether it’s data collection, reporting, remote system maintenance, or dynamic content exchange between platforms.

The sections below describe the key SFTP tools available:

  • sftp_upload: Upload one or more files to a remote server.
  • sftp_download: Download files from a remote server to your workflow.
  • sftp_list: List directory contents on a remote SFTP server.
  • sftp_delete: Delete files or directories from a remote server.
  • sftp_create: Create new files on a remote SFTP server.
  • sftp_mkdir: Create new directories remotely.

See the tool documentation below for detailed input and output parameters for each operation.

Usage Instructions

Upload, download, list, and manage files on remote servers via SFTP. Supports both password and private key authentication for secure file transfers.

Tools

sftp_upload

Upload files to a remote SFTP server

Input

ParameterTypeRequiredDescription
hoststringYesSFTP server hostname or IP address
portnumberYesSFTP server port (default: 22)
usernamestringYesSFTP username
passwordstringNoPassword for authentication (if not using private key)
privateKeystringNoPrivate key for authentication (OpenSSH format)
passphrasestringNoPassphrase for encrypted private key
remotePathstringYesDestination directory on the remote server
filesfile[]NoFiles to upload
fileContentstringNoDirect file content to upload (for text files)
fileNamestringNoFile name when using direct content
overwritebooleanNoWhether to overwrite existing files (default: true)
permissionsstringNoFile permissions (e.g., 0644)

Output

ParameterTypeDescription
successbooleanWhether the upload was successful
uploadedFilesjsonArray of uploaded file details (name, remotePath, size)
messagestringOperation status message

sftp_download

Download a file from a remote SFTP server

Input

ParameterTypeRequiredDescription
hoststringYesSFTP server hostname or IP address
portnumberYesSFTP server port (default: 22)
usernamestringYesSFTP username
passwordstringNoPassword for authentication (if not using private key)
privateKeystringNoPrivate key for authentication (OpenSSH format)
passphrasestringNoPassphrase for encrypted private key
remotePathstringYesPath to the file on the remote server
encodingstringNoOutput encoding: utf-8 for text, base64 for binary (default: utf-8)

Output

ParameterTypeDescription
successbooleanWhether the download was successful
fileNamestringName of the downloaded file
contentstringFile content (text or base64 encoded)
sizenumberFile size in bytes
encodingstringContent encoding (utf-8 or base64)
messagestringOperation status message

sftp_list

List files and directories on a remote SFTP server

Input

ParameterTypeRequiredDescription
hoststringYesSFTP server hostname or IP address
portnumberYesSFTP server port (default: 22)
usernamestringYesSFTP username
passwordstringNoPassword for authentication (if not using private key)
privateKeystringNoPrivate key for authentication (OpenSSH format)
passphrasestringNoPassphrase for encrypted private key
remotePathstringYesDirectory path on the remote server
detailedbooleanNoInclude detailed file information (size, permissions, modified date)

Output

ParameterTypeDescription
successbooleanWhether the operation was successful
pathstringDirectory path that was listed
entriesjsonArray of directory entries with name, type, size, permissions, modifiedAt
countnumberNumber of entries in the directory
messagestringOperation status message

sftp_delete

Delete a file or directory on a remote SFTP server

Input

ParameterTypeRequiredDescription
hoststringYesSFTP server hostname or IP address
portnumberYesSFTP server port (default: 22)
usernamestringYesSFTP username
passwordstringNoPassword for authentication (if not using private key)
privateKeystringNoPrivate key for authentication (OpenSSH format)
passphrasestringNoPassphrase for encrypted private key
remotePathstringYesPath to the file or directory to delete
recursivebooleanNoDelete directories recursively

Output

ParameterTypeDescription
successbooleanWhether the deletion was successful
deletedPathstringPath that was deleted
messagestringOperation status message

sftp_mkdir

Create a directory on a remote SFTP server

Input

ParameterTypeRequiredDescription
hoststringYesSFTP server hostname or IP address
portnumberYesSFTP server port (default: 22)
usernamestringYesSFTP username
passwordstringNoPassword for authentication (if not using private key)
privateKeystringNoPrivate key for authentication (OpenSSH format)
passphrasestringNoPassphrase for encrypted private key
remotePathstringYesPath for the new directory
recursivebooleanNoCreate parent directories if they do not exist

Output

ParameterTypeDescription
successbooleanWhether the directory was created successfully
createdPathstringPath of the created directory
messagestringOperation status message

Notes

  • Category: tools
  • Type: sftp
On this page

On this page

Start building today
Trusted by over 60,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started