Convex icon

Convex

Interact with Convex API

Actions10

Storage (File) → Upload

AI-generated

Summary

Upload binary file data from the specified binary property to Convex Storage, optionally passing additional JSON arguments to save metadata.

Inputs

  • Input Binary Field (required) — The name of the binary property containing the file data to upload.
  • Additional Fields — Optional JSON arguments to pass to the Save Metadata Mutation for storing metadata about the uploaded file.

Output shape

A single JSON object with upload details including storageId, upload and download URLs, file name, MIME type, size, metadata saving result, success status, and a message.

The upload returns file information and attempts to save metadata via an optional mutation. A download URL is also fetched if available. Errors throw exceptions unless 'Continue On Fail' is enabled, in which case error details are returned per item.

Examples

Example 1: Uploading a binary file from an input field named 'data' with no additional metadata arguments to Convex Storage.

Set 'Input Binary Field' to 'data' and leave 'Additional Fields' empty. The node uploads the file and returns the storage identifier and URLs.

Links

Discussion