convex-file-storage

Manage file uploads, serving, metadata, and deletion in Convex applications.

7|Updated Feb 16, 2025
One-click install
npx skills add https://github.com/shahbaz-athwal/acadia-one --skill convex-file-storage-shahbaz-athwal
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-file-storage
Source: https://github.com/shahbaz-athwal/acadia-one/tree/main/.agents/skills/convex-file-storage
Command: npx skills add https://github.com/shahbaz-athwal/acadia-one --skill convex-file-storage-shahbaz-athwal

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables end-to-end file storage and management within Convex applications, covering uploads, serving files via URLs, and accessing file metadata for robust data integrity.

Core Features & Use Cases

  • Upload URLs and storage workflows for images, documents, and generated assets
  • Serve files via deterministic URLs and query metadata from the _storage table
  • Delete files and clean up storage and references, with previews and generated content use cases

Quick Start

Generate an upload URL, upload your file to storage, then save its metadata in your database.

Frequently Asked Questions about convex-file-storage

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I manage file storage and uploads in Convex?

To manage file storage in Convex, you can use mutations and queries to generate upload URLs, save file references, and serve files via deterministic URLs. This handles the complete upload, serve, and metadata access lifecycle for images, documents, and generated assets.

What is the best way to store generated content files in a Convex application?

The best way to store generated content in Convex is through server-side actions that save files directly to storage. You can then retrieve file metadata from the _storage table and serve the generated assets via deterministic URLs.

How do I retrieve file metadata from the Convex _storage table?

You retrieve file metadata from the Convex _storage table by running queries that access saved file references. This allows your application to query storage metadata for robust data integrity when serving images, documents, and other uploaded assets.

Can I delete files and clean up storage references in Convex?

Yes, you can delete files and clean up storage references in Convex. The system provides mutations to remove files from storage and delete their associated database references, ensuring complete end-to-end file lifecycle management and cleanup.

Does Convex file storage support end-to-end workflows for images and documents?

Convex file storage supports end-to-end workflows for images, documents, and generated assets. It covers uploading via generated URLs, serving files through deterministic URLs, accessing metadata, and deleting files for robust data integrity.