Appwrite icon

Appwrite

A comprehensive node for the Appwrite API

Overview

This node integrates with a cloud storage service to manage files and buckets. Specifically, the "Upload File" operation under the "Storage" resource allows users to upload binary files from n8n workflows into a specified storage bucket. This is useful for automating file backups, media uploads, or any scenario where files generated or processed in a workflow need to be stored remotely.

For example, after processing an image or generating a PDF in a workflow, you can use this node to upload that file directly to your cloud storage bucket for persistent storage or further sharing.

Properties

Name Meaning
Bucket ID Unique identifier of the storage bucket where the file will be uploaded. Use "unique()" to auto-generate when creating a new bucket. Required for all file operations.
Binary Property The name of the binary property on the incoming n8n item that contains the file data to upload. Typically, this corresponds to the output of a previous node that produces binary data (e.g., an HTTP request or file read).

Output

The node outputs JSON data representing the result of the upload operation. This typically includes metadata about the uploaded file such as its ID, name, size, and other relevant attributes returned by the storage API.

If the node is used for downloading files (not the current operation), it outputs binary data prepared for further use in the workflow. However, for the Upload File operation, the output is purely JSON describing the uploaded file.

Dependencies

  • Requires an API key credential for authenticating with the cloud storage service.
  • The node depends on the external Appwrite SDK client configured with these credentials.
  • Proper bucket setup is necessary before uploading files; either an existing bucket ID must be provided or a new bucket created beforehand.

Troubleshooting

  • Missing or incorrect Bucket ID: Ensure the bucket ID is valid and accessible. Using "unique()" only works when creating a new bucket, not for uploading files.
  • Binary Property not found or empty: Verify that the specified binary property exists on the input item and contains valid file data.
  • Authentication errors: Confirm that the API key credential is correctly set up and has permissions to access the storage buckets.
  • File size limits or unsupported formats: Check the storage service's limitations on file sizes and types.
  • Common error messages:
    • "An unknown error occurred." — Generic catch-all; check detailed error response if available.
    • API-specific errors are wrapped and surfaced with message and details; review these to adjust parameters or credentials.

Links and References

Discussion