Media
Tools for managing media files in the Revel Digital library. Media includes images (JPG, PNG, GIF), videos (MP4, WebM), PDFs, web pages, and other content types uploaded for playback on devices.
list_media
List media files in the account. Returns media objects with id, name, file type, group assignment, tags, and availability dates.
| Parameter | Type | Required | Description |
|---|---|---|---|
group_id |
string or string[] | No | Filter by media group ID(s) |
group_name |
string or string[] | No | Filter by media group name(s) |
take |
number | No | Results per page |
page |
number | No | Page number (1-based) |
get_media
Get detailed information about a specific media file by ID. Returns name, file type, size, URL, group assignment, tags, availability dates, and sharing status.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The media item ID |
update_media
Update a media item’s metadata. This does not replace the media file itself — only its properties.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The media item ID |
name |
string | No | Updated display name |
group_id |
string | No | Move to this group |
tags |
string | No | Comma-separated tags |
is_shared |
boolean | No | Share across organizations |
start_date |
string | No | ISO 8601 date when available for playback |
end_date |
string | No | ISO 8601 date when media expires |
delete_media
Permanently delete a media file. This action cannot be undone. If the media is referenced by playlists or templates, those references will become invalid.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
string | Yes | The media item ID |
import_media
Import a media file from an external URL. The server fetches the file and adds it to the media library.
| Parameter | Type | Required | Description |
|---|---|---|---|
url |
string | Yes | Public URL of the media file to import |
group_id |
string | No | Media group ID to place the file in |