Skip to content
Vimond Vimond Vimond Developer Hub

Content Images

What is Vimond Image Service?

Section titled “What is Vimond Image Service?”

The Vimond Image Service is a standalone service that can deliver dynamically generated images with the needed size/cropping of your choice

Images are organized in image packs, where each image pack can be referred to from other Vimond entities such as Asset and Categories etc.

Each image pack can contain multiple images or image locations (different size / image ratio) like thumbnail, main, splash etc.

There is both a public and admin API part of the service, the admin part here is the ability to specify some logic to the Image-packs like cropping modes.

How do I retrieve images via the API?

Section titled “How do I retrieve images via the API?”

The steps required to retrieve images are described below. We have included examples from our Demo environment, and we also refer you to some API calls you can test to see what kind of response data you can work with.

** Step 1: Get the Image information from Content Discovery API **
The image pack ID can be collected from entities such as Categories, Assets, and Lists.
Note that not all entities have an image pack, so don’t create logic where it is required for things to work.

On our demo portal we have a looping set of assets, so let’s look at how we collected this image here.

image

First, let’s retrieve all the assets we want in this loop by using this call.

GET https://sales.content-discovery.cf.eu-north-1-prod.vmnd.tv/api/v1/lists/cu3zzI8W6q
curl -X GET \
  https://sales.content-discovery.cf.eu-north-1-prod.vmnd.tv/api/v1/lists/cu3zzI8W6q \
  -H 'Accept-Language: en_US'

This gives us all content curated into the top carousel and we can see that the Top Gun movie is on top of the elements list

{
  "data": [
    {
      "id": "cu3zzI8W6q",
      "contentType": "carousel",
      "createTime": "2021-03-25T09:23:37Z",
      "updateTime": "2023-06-12T18:55:56Z",
      "paths": [
        {
          "path": "/editorial_root/84yJ07KShm/koRnrliaIp/cu3zzI8W6q",
          "parents": [
            "editorial_root",
            "84yJ07KShm",
            "koRnrliaIp"
          ],
          "level": 3
        }
      ],
      "elements": [
        {
          "id": "180337",
          "description": "After more than thirty years of service as one of the Navy's top aviators, Pete \"Maverick\" Mitchell (Tom Cruise) is where he belongs, pushing the envelope as a courageous test pilot and dodging the advancement in rank that would ground him. When he finds himself training a detachment of Top Gun graduates for a specialized mission the likes of which no living pilot has ever seen, Maverick encounters Lt. Bradley Bradshaw (Miles Teller), call sign \"Rooster\", the son of Maverick's late friend and Radar Intercept Officer Lt. Nick Bradshaw, aka \"Goose\". Facing an uncertainfuture and confronting the ghosts of his past, Maverick is drawn into a confrontation with his own deepest fears, culminating in a mission that demands the ultimate sacrifice from those who will be chosen to fly it.",
          "contentType": "asset",
          "createTime": "2023-04-12T13:56:37Z",
          "updateTime": "2023-04-12T13:57:10Z",
          "paths": [
            {
              "path": "/editorial_root/84yJ07KShm/koRnrliaIp/cu3zzI8W6q/180337",
              "parents": [
                "editorial_root",
                "84yJ07KShm",
                "koRnrliaIp",
                "cu3zzI8W6q"
              ],
              "level": 4
            }
          ],
          "content": {
            "id": "180337",
            "timestamp": "2023-05-16T08:23:18Z",
            "createTime": "2022-08-02T03:22:35Z",
            "images": {
              "defaultUrl": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/62e89a0ce4b0003c6f22b5a3-1662654467834",
              "version": "original",
              "templates": {
                "regions": [


                ],
                "locations": [
                  "portal-landscape-cover",
                  "portal-cover",
                  "portal-carousel",
                  "thumb",
                  "main"
                ],
                "withRegion": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/62e89a0ce4b0003c6f22b5a3-1662654467834?region=${REGION}",
                "withLocation": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/62e89a0ce4b0003c6f22b5a3-1662654467834?location=${LOCATION}",
                "complete": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/62e89a0ce4b0003c6f22b5a3-1662654467834?region=${REGION}&location=${LOCATION}"
              }
            },
            "category": {
              "path": "999 134318 134319 134320",
              "link": "https://sales.content-discovery.cf.eu-north-1-prod.vmnd.tv/api/v1/categories/134320",
              "id": "134320"
            },
            "labeledAsFree": true,
            "drmProtected": false,
            "duration": 0.0,
            "assetType": "movies",
            "isLive": false,
            "isParent": true,
            "transmissionTime": "2022-08-02T03:22:35Z",
            "relatedAssets": [


            ],
            "qualities": [


            ],
            "markers": [
              {
                "id": "91804",
                "title": "Opening Credits",
                "type": "intro",
                "startTime": 0.0,
                "endTime": 120.0,
                "images": {
                  "defaultUrl": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/631a1833e4b02115be88724b-1662654515638",
                  "version": "original",
                  "templates": {
                    "regions": [


                    ],
                    "locations": [
                      "portal-landscape-cover",
                      "portal-cover",
                      "portal-carousel",
                      "thumb",
                      "main"
                    ],
                    "withRegion": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/631a1833e4b02115be88724b-1662654515638?region=${REGION}",
                    "withLocation": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/631a1833e4b02115be88724b-1662654515638?location=${LOCATION}",
                    "complete": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/631a1833e4b02115be88724b-1662654515638?region=${REGION}&location=${LOCATION}"
                  }
                }
              },
              {
                "id": "91805",
                "title": "Ad Insert 1",
                "type": " ",
                "startTime": 120.0,
                "endTime": 300.0,
                "images": {
                  "defaultUrl": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/631a17c2e4b0003c6f22b8d1-1662654404673",
                  "version": "original",
                  "templates": {
                    "regions": [


                    ],
                    "locations": [
                      "portal-landscape-cover",
                      "portal-cover",
                      "portal-carousel",
                      "thumb",
                      "main"
                    ],
                    "withRegion": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/631a17c2e4b0003c6f22b8d1-1662654404673?region=${REGION}",
                    "withLocation": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/631a17c2e4b0003c6f22b8d1-1662654404673?location=${LOCATION}",
                    "complete": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/631a17c2e4b0003c6f22b8d1-1662654404673?region=${REGION}&location=${LOCATION}"
                  }
                }
              }
            ],
            "startTime": 0.0,
            "endTime": 0.0,
            "version": {
              "available": [
                "main"
              ],
              "type": "main"
            },
            "publishing": {
              "start": "2023-04-12T13:55:56Z",
              "platform": "web",
              "geoExpressions": [
                "any"
              ]
            },
            "products": [
              {
                "id": "1",
                "name": "Open Content",
                "accessType": "FREE_NOLOGIN"
              },
              {
                "id": "4272",
                "name": "Total Access to Everything",
                "accessType": "PAID"
              }
            ],
            "accessInfo": {
              "accessType": "FREE_NOLOGIN"
            },
            "description": "After more than thirty years of service as one of the Navy's top aviators, Pete Mitchell is where he belongs, pushing the envelope as a courageous test pilot and dodging the advancement in rank that would ground him.",
            "publisher-id": 2,
            "description-short": "After more than thirty years of service as one of the Navy's top aviators, Pete \"Maverick\" Mitchell (Tom Cruise) is where he belongs, pushing the envelope as a courageous test pilot and dodging the advancement in rank that would ground him. When he finds himself training a detachment of Top Gun graduates for a specialized mission the likes of which no living pilot has ever seen, Maverick encounters Lt. Bradley Bradshaw (Miles Teller), call sign \"Rooster\", the son of Maverick's late friend and Radar Intercept Officer Lt. Nick Bradshaw, aka \"Goose\". Facing an uncertainfuture and confronting the ghosts of his past, Maverick is drawn into a confrontation with his own deepest fears, culminating in a mission that demands the ultimate sacrifice from those who will be chosen to fly it.",
            "image-pack": "62e89a0ce4b0003c6f22b5a3-1662654467834",
            "container_type": " Menu",
            "title": "Top Gun: Maverick",
            "people": "Tom Cruise",
            "labels": "action"
          },
          "timestamp": "2023-06-12T18:55:59Z",
          "parentId": "cu3zzI8W6q",
          "description-short": "After more than thirty years of service as one of the Navy's top aviators, Pete \"Maverick\" Mitchell (Tom Cruise) is where he belongs, pushing the envelope as a courageous test pilot and dodging the advancement in rank that would ground him. When he finds himself training a detachment of Top Gun graduates for a specialized mission the likes of which no living pilot has ever seen, Maverick encounters Lt. Bradley Bradshaw (Miles Teller), call sign \"Rooster\", the son of Maverick's late friend and Radar Intercept Officer Lt. Nick Bradshaw, aka \"Goose\". Facing an uncertainfuture and confronting the ghosts of his past, Maverick is drawn into a confrontation with his own deepest fears, culminating in a mission that demands the ultimate sacrifice from those who will be chosen to fly it.",
          "title": "Top Gun: Maverick"
        },
        ...
      ],
      "timestamp": "2023-06-15T07:15:23Z",
      "images": {
        "defaultUrl": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/647868c2e4b0210842986c96",
        "version": "original",
        "templates": {
          "regions": [


          ],
          "locations": [
            "portal-landscape-cover",
            "portal-cover",
            "portal-carousel",
            "thumb",
            "main"
          ],
          "withRegion": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/647868c2e4b0210842986c96?region=${REGION}",
          "withLocation": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/647868c2e4b0210842986c96?location=${LOCATION}",
          "complete": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/647868c2e4b0210842986c96?region=${REGION}&location=${LOCATION}"
        }
      },
      "parentId": "koRnrliaIp",
      "title": "Main Carousel"
    }
  ]
}

** Step 2: Use the Image Information to construct Image URLs in your applcations**

As you can see inside the content section there is a images section located here that we can use for retrieving images.

           "images": {
              "defaultUrl": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/62e89a0ce4b0003c6f22b5a3-1662654467834",
              "version": "original",
              "templates": {
                "regions": [


                ],
                "locations": [
                  "portal-landscape-cover",
                  "portal-cover",
                  "portal-carousel",
                  "thumb",
                  "main"
                ],
                "withRegion": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/62e89a0ce4b0003c6f22b5a3-1662654467834?region=${REGION}",
                "withLocation": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/62e89a0ce4b0003c6f22b5a3-1662654467834?location=${LOCATION}",
                "complete": "https://sales.image-service.eu-north-1-prod.vmnd.tv/api/v2/img/62e89a0ce4b0003c6f22b5a3-1662654467834?region=${REGION}&location=${LOCATION}"
              }
            },

We can now either use the defaultUrl to serve the default image, or use the templated URLs and select a region & location combination depending on our end-user and desired image location in our app.

Retrieving Images in custom pixel sizes

Section titled “Retrieving Images in custom pixel sizes”

As shown above, the basic call to make when retrieving images is a GET https://<tenant>.image-service.<region>.vmnd.tv/api/v2/api/v2/img/:imagepackid

When you retrieve images like this, without specifying anything else, you get the default image stored in that image pack with the original resolution.

Here is a list of optional query parameters you can use to customize the retrieved image:

** Customizing size **
To customize the pixel size of the retrieved image, you can use one or both of the following query parameters:

nametypeexample valuedescription
widthnumber160requested pixel width
heightnumber80requested pixel height

If you only specify one of the size-arguments, the server will calculate the other one so that the returned image still has the original aspect-ratio.

For more details on the Image Service API, see the Vimond Image Service API reference.

For more technical information on the Image Service please see Image service