mirror of
https://github.com/simstudioai/sim.git
synced 2026-02-10 14:45:16 -05:00
6cb3977dd9
* fix(visibility): updated visibility for non-sensitive tool params from user only to user or llm * update docs * updated docs script
137 lines
5.9 KiB
Plaintext
137 lines
5.9 KiB
Plaintext
---
|
||
title: OneDrive
|
||
description: Create, upload, download, list, and delete files
|
||
---
|
||
|
||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||
|
||
<BlockInfoCard
|
||
type="onedrive"
|
||
color="#E0E0E0"
|
||
/>
|
||
|
||
{/* MANUAL-CONTENT-START:intro */}
|
||
[OneDrive](https://onedrive.live.com) is Microsoft’s cloud storage and file synchronization service that allows users to securely store, access, and share files across devices. Integrated deeply into the Microsoft 365 ecosystem, OneDrive supports seamless collaboration, version control, and real-time access to content across teams and organizations.
|
||
|
||
Learn how to integrate the OneDrive tool in Sim to automatically pull, manage, and organize your cloud files within your workflows. This tutorial walks you through connecting OneDrive, setting up file access, and using stored content to power automation. Ideal for syncing essential documents and media with your agents in real time.
|
||
|
||
With OneDrive, you can:
|
||
|
||
- **Store files securely in the cloud**: Upload and access documents, images, and other files from any device
|
||
- **Organize your content**: Create structured folders and manage file versions with ease
|
||
- **Collaborate in real time**: Share files, edit them simultaneously with others, and track changes
|
||
- **Access across devices**: Use OneDrive from desktop, mobile, and web platforms
|
||
- **Integrate with Microsoft 365**: Work seamlessly with Word, Excel, PowerPoint, and Teams
|
||
- **Control permissions**: Share files and folders with custom access settings and expiration controls
|
||
|
||
In Sim, the OneDrive integration enables your agents to directly interact with your cloud storage. Agents can upload new files to specific folders, retrieve and read existing files, and list folder contents to dynamically organize and access information. This integration allows your agents to incorporate file operations into intelligent workflows — automating document intake, content analysis, and structured storage management. By connecting Sim with OneDrive, you empower your agents to manage and use cloud documents programmatically, eliminating manual steps and enhancing automation with secure, real-time file access.
|
||
{/* MANUAL-CONTENT-END */}
|
||
|
||
|
||
## Usage Instructions
|
||
|
||
Integrate OneDrive into the workflow. Can create text and Excel files, upload files, download files, list files, and delete files or folders.
|
||
|
||
|
||
|
||
## Tools
|
||
|
||
### `onedrive_upload`
|
||
|
||
Upload a file to OneDrive
|
||
|
||
#### Input
|
||
|
||
| Parameter | Type | Required | Description |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `fileName` | string | Yes | The name of the file to upload \(e.g., "report.pdf", "data.xlsx"\) |
|
||
| `file` | file | No | The file to upload \(binary\) |
|
||
| `content` | string | No | The text content to upload \(if no file is provided\) |
|
||
| `mimeType` | string | No | The MIME type of the file to create \(e.g., text/plain for .txt, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet for .xlsx\) |
|
||
| `folderSelector` | string | No | Folder ID to upload the file to \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||
| `manualFolderId` | string | No | Manually entered folder ID \(advanced mode\) |
|
||
|
||
#### Output
|
||
|
||
| Parameter | Type | Description |
|
||
| --------- | ---- | ----------- |
|
||
| `success` | boolean | Whether the file was uploaded successfully |
|
||
| `file` | object | The uploaded file object with metadata including id, name, webViewLink, webContentLink, and timestamps |
|
||
|
||
### `onedrive_create_folder`
|
||
|
||
Create a new folder in OneDrive
|
||
|
||
#### Input
|
||
|
||
| Parameter | Type | Required | Description |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `folderName` | string | Yes | Name of the folder to create \(e.g., "My Documents", "Project Files"\) |
|
||
| `folderSelector` | string | No | Parent folder ID to create the folder in \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||
| `manualFolderId` | string | No | Manually entered parent folder ID \(advanced mode\) |
|
||
|
||
#### Output
|
||
|
||
| Parameter | Type | Description |
|
||
| --------- | ---- | ----------- |
|
||
| `success` | boolean | Whether the folder was created successfully |
|
||
| `file` | object | The created folder object with metadata including id, name, webViewLink, and timestamps |
|
||
|
||
### `onedrive_download`
|
||
|
||
Download a file from OneDrive
|
||
|
||
#### Input
|
||
|
||
| Parameter | Type | Required | Description |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `fileId` | string | Yes | The ID of the file to download \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||
| `fileName` | string | No | Optional filename override \(e.g., "report.pdf", "data.xlsx"\) |
|
||
|
||
#### Output
|
||
|
||
| Parameter | Type | Description |
|
||
| --------- | ---- | ----------- |
|
||
| `file` | file | Downloaded file stored in execution files |
|
||
|
||
### `onedrive_list`
|
||
|
||
List files and folders in OneDrive
|
||
|
||
#### Input
|
||
|
||
| Parameter | Type | Required | Description |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `folderSelector` | string | No | Folder ID to list files from \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||
| `manualFolderId` | string | No | The manually entered folder ID \(advanced mode\) |
|
||
| `query` | string | No | Filter files by name prefix \(e.g., "report", "invoice_2024"\) |
|
||
| `pageSize` | number | No | Maximum number of files to return \(e.g., 10, 50, 100\) |
|
||
|
||
#### Output
|
||
|
||
| Parameter | Type | Description |
|
||
| --------- | ---- | ----------- |
|
||
| `success` | boolean | Whether files were listed successfully |
|
||
| `files` | array | Array of file and folder objects with metadata |
|
||
| `nextPageToken` | string | Token for retrieving the next page of results \(optional\) |
|
||
|
||
### `onedrive_delete`
|
||
|
||
Delete a file or folder from OneDrive
|
||
|
||
#### Input
|
||
|
||
| Parameter | Type | Required | Description |
|
||
| --------- | ---- | -------- | ----------- |
|
||
| `fileId` | string | Yes | The ID of the file or folder to delete \(e.g., "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36M"\) |
|
||
|
||
#### Output
|
||
|
||
| Parameter | Type | Description |
|
||
| --------- | ---- | ----------- |
|
||
| `success` | boolean | Whether the file was deleted successfully |
|
||
| `deleted` | boolean | Confirmation that the file was deleted |
|
||
| `fileId` | string | The ID of the deleted file |
|
||
|
||
|