Resource URLs

Access images and assets directly.

Bloomreach Content lets users upload images and assets and store them in the content repository. These binary resources can be referred to from within content as well as from page component configurations.

Frontend applications integrating with the Delivery API can access an image or asset directly at a resource URL starting with /delivery/resources, followed by a unique path specifying the resource and, in the case of an image, optionally the variant.

Whenever a content item or page component refers to an image or asset, any Delivery API response containing that content item or page component will always include a direct link to the corresponding resource URL.

In use cases where a frontend application needs to generate a direct link to an image or asset, use the URL patterns specified below.

👍

CDN

Bloomreach recommends serving resource URLs through a CDN as a best practice. This also enables you to allow your images and assets to be indexed by search engines (this is disallowed in the robots.txt on your *.bloomreach.io domain).

Get original image

/delivery/resources/{image_path}

Get the original image resource stored in Bloomreach Content.

Parameters

NameDescription
imagepath

string

(path)_ *
Any number of path elements can be appended to the URL to retrieve the image.

When using the default content repository, image paths always start with /content/gallery/, followed by any folders and the actual image filename.

Examples:

- /delivery/resources/content/gallery/products/tools/hammer.jpg
- /delivery/resources/content/gallery/channel-templates/referencespa/images/thumbimage_pid_4930258.png

Get image variant

/delivery/resources/{image_variant}/{image_path}

Get the specified variant of an image resource stored in Bloomreach Content.

Parameters

NameDescription
imagevariant

string

(path)_ *
One of the following available image variants:

- thumbnail
- small
- large
- smallsquare
- mediumsquare
- largesquare
- banner
imagepath

string

(path)_ *
Any number of path elements can be appended to the URL to retrieve the image in the specified variant.

When using the default content repository, image paths always start with /content/gallery/, followed by any folders and the actual image filename.

Examples:

- /delivery/resources/largesquare/content/gallery/products/tools/hammer.jpg
- /delivery/resources/thumbnail/content/gallery/channel-templates/referencespa/images/thumbimage_pid_4930258.png

Get asset

/delivery/resources/{asset_path}

Get an asset resource stored in Bloomreach Content.

Parameters

NameDescription
assetpath

string

(path)_ *
Any number of path elements can be appended to the URL to retrieve the asset.

When using the default content repository, asset paths always start with /content/assets/, followed by any folders and the actual asset filename.

Example:

- /delivery/resources/content/assets/pdfs/611187.pdf