Skip to main content
The Files API allows you to upload, manage, and transform files.

List Files

Retrieve all files.
Example:

Get File

Retrieve a single file.

Upload File

Upload a new file.
Using multipart/form-data:
Using JSON:

Import from URL

Import a file from a URL.
Request Body:

Update File

Update file metadata.
Request Body:

Delete File

Delete a file.

Access Files

Access uploaded files directly:

Image Transformations

Apply transformations to images:
Transform parameters:
  • width, height - Dimensions
  • fit - cover, contain, inside, outside
  • quality - 0-100
  • format - jpg, png, webp, tiff, avif
  • withoutEnlargement - Don’t upscale
  • focal_point_x, focal_point_y - Focal point (0-1)

File Properties

string
Unique file identifier (UUID)
string
Storage location name
string
Filename on disk
string
Filename for downloads
string
File title
string
MIME type (e.g., image/jpeg)
string
Folder ID
string
User ID who uploaded the file
integer
File size in bytes
integer
Image width (for images)
integer
Image height (for images)

Next Steps

Folders

Manage file folders

File Storage

Configure storage