Skip to main content

Virtual filesystem service for AI agents with LangChain integration

Project description

AI Filesystem

A virtual filesystem API for AI agents. Users can easily provide their agents with siloed filesystems to use as long term memory, scratchpads, or general purpose storage.

How It Works

  1. API Server: FastAPI backend that stores files in PostgreSQL
  2. User Isolation: Each user can only see/modify their own files (enforced by database)
  3. Multiple Filesystems: A user can have multiple filesystems and provide their agents with access to different, or the same filesystems.

[Beta] Quick Start

Creating an account on the Filesystem

  1. Navigate here and sign up for an account on the Filesystem.
  2. Create an API key and save it someplace secure!

Giving your agent access to the Filesystem

  1. Set your API key as an environment variable for your agent: AGENT_FS_API_KEY=<api_key>
  2. Specify the URL for the filesystem. If you're using our hosted solution, it is AGENT_FS_URL=agent-file-system-production.up.railway.app
  3. Instantiate the filesystem client, and give your agent access to the tools
from ai_filesystem import AIFilesystemClient

client = AIFilesystemClient(
  filesystem="nicks-agent-filesystem"
)
filesystem_tools = client.create_tools()  # list files, read file, create new file, and edit file
agent.bind_tools(filesystem_tools)
  1. In your agent's system prompt, make sure to specify how you want the agent to use the filesystem. Common use cases include as long-term memory, to store learnings and mistakes, or to save work products.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_filesystem-0.1.2.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_filesystem-0.1.2-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file ai_filesystem-0.1.2.tar.gz.

File metadata

  • Download URL: ai_filesystem-0.1.2.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for ai_filesystem-0.1.2.tar.gz
Algorithm Hash digest
SHA256 d7b0ac98b63f60d8a3bc8e5c2b99faba257e26ce382c90de97e3d8c84a62a1f8
MD5 6d9b05545db8d9fcd30e33a28618dca2
BLAKE2b-256 3c74ced42600f311f9f0234f520691b10e93492200f0c2c882d07bd6dcb4531c

See more details on using hashes here.

File details

Details for the file ai_filesystem-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: ai_filesystem-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for ai_filesystem-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e702afdfe912fd7179ece0dfdcbe2c543edea3cc5209a485d01544300eb96da6
MD5 fdfa11c6ec3f4e78603551cb79a20fac
BLAKE2b-256 21d31c39a0063f2a1649c65f2a15555ee45d0c8b5a1cf4033616eec533541871

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page