canonical: https://jentic.com/apis/filerun.com/filerun # FileRun API The FileRun API gives AI agents programmatic file management on a self-hosted FileRun instance. Agents browse and search a drive, upload and download files, and organize them by creating folders and moving, renaming, or deleting items. They can share files, mint or revoke web links, star items, and read file metadata and thumbnails. Administrators can also manage user accounts on the instance. Access uses OAuth 2.0 bearer tokens, while the token endpoints themselves stay open. ## For AI agents Browse, upload, download, organize, and share files on a self-hosted FileRun instance. Authenticates with an OAuth 2.0 bearer token. ## Scope Does not run the FileRun server or handle storage provisioning. Use for file, sharing, and account operations on an existing instance only. ## Capabilities - Browse and search files and folders in a FileRun drive - Upload files to and download files from the drive - Create folders and organize files by moving or renaming them - Share files or mint web links, and revoke that access - Star files and read file metadata and thumbnails - Delete files and folders or extract archives - Administer user accounts on the FileRun instance ## Use cases ### Agent File Management via Jentic AI agents manage files on a FileRun instance through Jentic without holding the OAuth token in context. An agent searches by intent, receives the matching operation schema, and browses, uploads, or shares files end to end. Jentic injects the bearer token at execution time, so the agent never sees the secret while it works with the drive. Example prompt: Search Jentic for 'upload a file to FileRun', load the PUT `/api.php/Drive/files/upload` schema, and upload with Jentic-managed credentials ### Automated Document Organization An agent keeps a shared drive tidy: it searches for files matching a pattern, creates folders for each project, and moves or renames items into place. Because FileRun exposes explicit browse, search, move, and rename operations, the agent can reorganize a large drive without a human dragging files around. Example prompt: Call POST `/api.php/Drive/files/search` to find files, then POST `/api.php/Drive/files/move` to place them into folders ### Programmatic File Sharing An agent shares a finished document by sharing it with a user or minting a web link, then revokes that access once the recipient no longer needs it. FileRun's share, weblink, and unshare operations let the agent control access to a file over its whole lifecycle. Example prompt: Call POST `/api.php/Drive/files/share` to grant access, then POST `/api.php/Drive/files/weblink` to create a shareable link ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/api.php/Drive/files/browse` | List files and folders in the drive | | POST | `/api.php/Drive/files/search` | Search files and folders | | PUT | `/api.php/Drive/files/upload` | Upload a file | | GET | `/api.php/Drive/files/download` | Download a file | | POST | `/api.php/Drive/files/createfolder` | Create a folder | | POST | `/api.php/Drive/files/share` | Share a file or folder | | POST | `/api.php/Drive/files/delete` | Delete a file or folder | ## Key resources - **Files** — Browse, search, upload, download, move, rename, delete, and read metadata for files - **Sharing** — Share and unshare files and create or remove web links - **Admin - Users** — Add, edit, and delete user accounts on the FileRun instance ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 44 / 100 - **Maturity:** Foundational - **Dimensions:** - Foundational Compliance: 73 / 100 - Developer Experience & Jentic Compatibility: 57 / 100 - AI-Readiness & Agent Experience: 21 / 100 - Agent Usability: 94 / 100 - Security: 45 / 100 - AI Discoverability: 74 / 100 - **View full report:** https://jentic.com/apis/filerun.com/filerun/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring the FileRun API by hand means running the OAuth 2.0 flow to get a bearer token, refreshing it, and sequencing the Drive file calls against your instance host yourself. Through Jentic you install once, import the FileRun API from the API Directory, store the credential, and your agent calls it. - **Permission scoping:** You choose which FileRun operations your agent may call, so a rule can allow browsing, search, and download while withholding delete, move, and user administration. Scoping is by operation, so destructive calls stay out unless you grant them. - **Credential handling:** Your FileRun OAuth token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'upload a file' or 'share a folder', and Jentic returns the matching FileRun operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Nextcloud** — Alternative self-hosted file sync and sharing platform - **Box** — Alternative cloud content management and file sharing - **Dropbox** — Alternative cloud file storage and sharing ## FAQ ### What authentication does the FileRun API use? The FileRun API uses OAuth 2.0: obtain an access token through the authorization code flow or the resource owner password flow, then send it as a bearer token in the Authorization header, per its OpenAPI spec. Through Jentic, the token is stored encrypted by your own Jentic One instance and injected at call time, so it never enters the agent's prompt or logs. ### Can I upload and share files with the FileRun API? Yes. Upload a file with PUT `/api.php/Drive/files/upload`, browse the drive with GET `/api.php/Drive/files/browse`, and share an item with POST `/api.php/Drive/files/share.` ### What are the rate limits for the FileRun API? The OpenAPI spec does not specify rate limits; check the FileRun documentation for current limits. Through Jentic, requests run from your own instance, so you control the pacing of the agent's calls. ### How do I upload a file with the FileRun API through Jentic? Search Jentic for 'upload a file to FileRun', load the returned PUT `/api.php/Drive/files/upload` operation with its input schema, and your agent uploads with credentials injected at call time. To run it on your own infrastructure, install Jentic One from its GitHub repo. ### Is there a FileRun MCP server? You don't need an MCP server to give your agent the FileRun API. Jentic connects it directly from the API Directory: import it, store your token, and your agent calls it, discovering operations on demand instead of loading a separate server's tool definitions into its context. ### Can I limit what my agent is allowed to do with the FileRun API? Yes. You choose which FileRun operations your agent may call, so you can allow browsing, searching, and downloading while withholding delete, move, and user-administration operations. The agent runs only the endpoints you approve, so anything destructive is excluded until you add it.