Manage Multimedia Files

If you want to upload files to your Azure Blob Storage Subscriptions enabled in the application settings directly from hooks, this is how you can do it

const multimediaService = require("./utils/multimediaService");

//upload from a buffer
await multimediaService.uploadFileBufferToAzureAsync(file);


//upload from a stream
await multimediaService.uploadFileStreamToAzureAsync(stream, file);

//remove a file from azure storage
await multimediaService.deleteFileFromAzureAsync("filename");

The file param should have the following attributes

{
    mimetype, // string | required
    buffer // required if you are using uploadFileBufferToAzureAsync method
    filename
    originalname // required if you are not passing the filename
}

The returned object after calling any of those methods will have the next data

{
    mimetype, 
    buffer 
    filename
    originalname,
    url, // this will be where you can find your file (only present for public files, see below)
    storage //azure by default if enabled
}

Additional Parameter for uploadFileStreamToAzureAsync and uploadFileBufferToAzureAsync omitPrefix (boolean, optional): When set to true, the uploaded file’s name will be set to the original name or the provided filename without a timestamp prefix. If set to false, the filename will include a timestamp prefix.

const multimediaService = require("./utils/multimediaService");
//upload from a buffer 
await multimediaService.uploadFileBufferToAzureAsync(file, true); // omitPrefix 
//upload from a stream 
await multimediaService.uploadFileStreamToAzureAsync(stream, file, true); // omitPrefix 

{
    "mimetype": "text/plain",
    "filename": "_file",
    "url": "https://urlazure/app/app/_file",
    "storage": "azure"
}

Public vs private files

Every application has an access-level switch (multimediaAccessLevel, public or private) that controls whether new multimedia files are stored publicly (direct, non-expiring URL) or privately (isolated container, only accessible through a short-lived signed URL). This switch is set at the application level, not per file — existing apps keep working exactly as before (public) until an app owner opts into private. When a hook uploads a file, it can let the app’s switch decide, or explicitly force one behavior with the accessLevel parameter — the last argument of the upload/delete functions. Accepted values are "public" and "private"; anything else (including omitting it) falls back to the app’s switch.

const multimediaService = require("./utils/multimediaService");

// upload from a buffer — force private regardless of the app's switch
await multimediaService.uploadFileBufferToAzureAsync(file, false, true, "private");
// (file, omitPrefix, isCompressImageRequired, accessLevel)

// upload from a stream — force private
await multimediaService.uploadFileStreamToAzureAsync(stream, file, false, "private");
// (stream, file, omitPrefix, accessLevel)

// delete a file — accessLevel must match how it was uploaded, so the hook knows which container to look in
await multimediaService.deleteFileFromAzureAsync("filename", "private");
// (filename, accessLevel)

If the app’s switch is set to private, requesting accessLevel: "public" from a hook will not make the file public unless the app owner has also enabled the separate “allow public override” setting for that app. This is a security floor: it stops an unauthenticated caller (Codenull’s multimedia upload endpoint doesn’t require login, since some anonymous features depend on it) from forcing a file that should stay private into a public, permanent URL. A hook can always tighten access to private on an otherwise-public app — that never needs any extra setting.

Response shape for private files

A private upload does not return a url — there is no permanent public URL for a private file. Instead you get a path (the blob’s location inside the private container) and accessLevel: "private":

{
    "mimetype": "text/plain",
    "filename": "a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c-_file",
    "path": "a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c-_file",
    "accessLevel": "private",
    "storage": "azure"
}

Save the path if you need to reference the file later (e.g. to delete it). To let a user view/download a private file, request a short-lived signed URL through GET /api/multimedia/sas?path=<path> rather than trying to build a URL by hand — private files live in a container with no anonymous/direct access. The signed URL expires 2 minutes after it’s issued by default; this is configurable per application (not exposed in the UI yet, ask support/engineering to adjust it if a longer window is genuinely needed).

Get Started

Configurations

Agents

Environments

Reference

Manage Multimedia Files

Public vs private files

Response shape for private files

​Public vs private files

​Response shape for private files

Public vs private files

Response shape for private files