File Storage

Create Image Metadata

storage.create_image {
  access = "public"
  value = $input.file
  filename = ""
} as image_metadata

Parameter	Purpose	Example
access	Access level for the stored image	`public`, `private`
value	Source file to create image from	`$input.file`, `$file.data`
filename	Name for the stored image file	`"profile.jpg"`, `"avatar.png"`
as	Alias to reference the image metadata	`image_metadata`, `uploaded_image`

Example

storage.create_image {
  access = "public"
  value = $input.profile_photo
  filename = "user_"|add:$user.id|add:"_profile.jpg"
} as profile_image

Creates metadata about the stored image

Private Access Example

storage.create_image {
  access = "private"
  value = $input.profile_photo
  filename = "user_"|add:$user.id|add:"_private.jpg"
} as private_profile_image

Stores the image as private (requires signed URL to access)

Create Video Metadata

storage.create_video {
  access = "public"
  value = $image_metadata
  filename = ""
} as x1

Parameter	Purpose	Example
access	Access level for the stored video	`public`, `private`
value	Source file to create video from	`$input.video`, `$file.data`
filename	Name for the stored video file	`"video.mp4"`, `"recording.mov"`
as	Alias to reference the video metadata	`x1`, `video_data`

Example

storage.create_video {
  access = "public"
  value = $input.video_upload
  filename = "video_"|add:$timestamp|add:".mp4"
} as uploaded_video

Creates metadata for a video file

Create Audio Metadata

storage.create_audio {
  access = "public"
  value = $input.file
  filename = ""
} as x2

Parameter	Purpose	Example
access	Access level for the stored audio	`public`, `private`
value	Source file to create audio from	`$input.file`, `$audio.data`
filename	Name for the stored audio file	`"recording.mp3"`, `"audio.wav"`
as	Alias to reference the audio metadata	`x2`, `audio_data`

Example

storage.create_audio {
  access = "public"
  value = $input.audio_upload
  filename = "audio_"|add:$timestamp|add:".mp3"
} as uploaded_audio

Creates metadata for audio file

Create Attachment Metadata

storage.create_attachment {
  access = "public"
  value = $input.file
  filename = ""
} as x3

Parameter	Purpose	Example
access	Access level for the stored attachment	`public`, `private`
value	Source file to create attachment from	`$input.file`, `$document.data`
filename	Name for the stored attachment	`"document.pdf"`, `"spreadsheet.xlsx"`
as	Alias to reference the attachment metadata	`x3`, `file_data`

Example

storage.create_attachment {
  access = "public"
  value = $input.document
  filename = "file_"|add:$user.id|add:"_"|add:$original_filename
} as uploaded_file

Creates metadata for the attachment

Create File Resource

storage.create_file_resource {
  filename = "filename.ext"
  filedata = "filedata"
}

Parameter	Purpose	Example
filename	Name of the file to create	`"document.txt"`, `"data.json"`
filedata	Content of the file	`"Hello World"`, `$encoded_data`

Example

storage.create_file_resource {
  filename = "export_"|add:$timestamp|add:".csv"
  filedata = $processed_data|to_csv
}

Creates a file resource from provided data

Get File Resource Data

storage.read_file_resource {
  value = $input.file
} as file2

Parameter	Purpose	Example
value	File resource to read	`$input.file`, `$stored_file.id`
as	Alias to reference the file contents	`file2`, `file_contents`

Example

storage.read_file_resource {
  value = $stored_document.id
} as document_contents

Reads contents of a stored file resource

Delete File

storage.delete_file {
  pathname = "/path/to/file.ext"
}

Parameter	Purpose	Example
pathname	Path to the file to delete	`"/path/to/file.ext"`, `$file.path`

Example

storage.delete_file {
  pathname = "/uploads/"|add:$file.name
}

Deletes a file from the specified path
Requires full path to the file
Permanently removes the file
Use with caution as deletion cannot be undone

Sign Private File URL

storage.sign_private_url {
  pathname = "/path/to/privatefile.ext"
  ttl = 30
} as x4

Parameter	Purpose	Example
pathname	Path to the private file	`"/path/to/privatefile.ext"`, `$file.path`
ttl	Time-to-live in seconds for the signed URL	`30`, `3600`, `86400`
as	Alias to reference the signed URL	`x4`, `signed_url`

Example

storage.sign_private_url {
  pathname = $private_file.path
  ttl = 3600
} as temporary_url

Generates a temporary signed URL for accessing private files

Notes on Returned Metadata

All storage.create_* functions return a metadata object with fields such as:

id: Unique identifier for the file resource
name: File name
size: File size in bytes
mime: MIME type
path: Storage path
url: Public URL (if access is public)
created_at: Timestamp

Refer to the XanoScript documentation for the full schema.

Error Handling Example

If you attempt to read or delete a file that does not exist, Xano will throw an error. You can handle this with try_catch:

try_catch {
  try {
    storage.read_file_resource {
      value = $input.file
    } as file_contents
  }
  catch {
    debug.log {
      value = "File not found or could not be read."
    }
  }
}

Start

AI

References

Create Image Metadata

Create Video Metadata

Create Audio Metadata

Create Attachment Metadata

Create File Resource

Get File Resource Data

Delete File

Sign Private File URL

Notes on Returned Metadata

Error Handling Example

​ Create Image Metadata

​ Create Video Metadata

​ Create Audio Metadata

​ Create Attachment Metadata

​ Create File Resource

​ Get File Resource Data

​ Delete File

​ Sign Private File URL

​Notes on Returned Metadata

​Error Handling Example

Create Image Metadata

Create Video Metadata

Create Audio Metadata

Create Attachment Metadata

Create File Resource

Get File Resource Data

Delete File

Sign Private File URL

Notes on Returned Metadata

Error Handling Example