Assets Module

The Assets module (insites_assets) provides file and folder management for Insites instances. This guide covers the module architecture, v2 API endpoints, data structures, and integration patterns for developers.

Module Information

v2 API Endpoints

The Assets module exposes eight v2 API endpoints: five for assets, two for folders, and one that returns upload credentials (GET /asset/api/v2/credentials). All endpoints require a valid instance API key passed in the Authorization header. For full API documentation including request and response examples, visit <your instance URL>/admin/api.

Asset Endpoints

Folder Endpoints

Data Structures

Asset Object

Folder Object

Metadata Object

Rendering Assets

Assets can be rendered in your pages and templates using Liquid tags or direct URLs.

Liquid Tag

Use the asset_name_to_raw_url Liquid filter to get the URL of an asset by its name. It returns nil if there is no such asset:

{{ 'path/to/file.png' | asset_name_to_raw_url }}

You can copy this snippet from the file detail panel in the Assets admin interface.

Direct URL

Each asset has a direct CDN URL that can be used in Markdown, HTML, or external applications. The URL is available in the file detail panel under the URL field.

Event Stream Integration

The Assets module integrates with the Insites Event Stream to track all file and folder activity. Events are created server-side when files or folders are added, edited, deleted, archived, or restored. Each event records the administrator, the asset name, and a timestamp.

The Event Stream is accessible from the Assets sidebar under Event Stream.