Media within Responses

Access to Multimedia Assets

Responses may include references to multimedia assets within the multimedia section of the response payload. These may include images, videos and or algorithms.

Each Multimedia Entry Can Include the Following Metadata

Title – The name or caption associated with the media asset.
Copyright – Copyright attribution information.
Media URL Links – A link to the associated image, algorithm or video asset.
Additional possible fields:
- description - When available, will describe the media
- format - Indicates the media file type
- publicId - The storage location (most applications will not need this)
- alt - Alternative text to display if the image can't be rendered
- telemetryData - Used for monitoring usage

Media URL Behavior

The media URL provides access to a full-resolution image, algorithm or video.
The URL is temporary and valid for 24 hours from the time the article response is generated.
Clients must not cache the URL.

Access and Refresh

If access to the media asset is required after the 24-hour validity period, the client must re-request the response through the API to obtain a new media URL.
No additional authentication is required to retrieve the media asset once the URL has been issued.

Specifying Image and Video Sizes

Links to images, algorithms and videos of varying sizes may be returned in the article response. To specify the image or algorithm size, add one or more imageSize parameters or for videos, use posterSize query parameters. small (thumbnail size) medium (500w), large (1000w) and full image sizes are supported. Image links are returned in full size by default and are optimized for the browser making the request. The video links are always returned in full size and cannot be resized. A thumbnail of the video will display a still image of a frame from the video. To get the thumbnail for the video, be sure to add the posterSize and set it to small (other sizes are also available).

For media returning svg files, small, medium and large will be returned as png files. Full can return the svg file unless convertSvg is set to true.

Parameter Name	Description	Sizes Available
imageSize	Returns the requested size.	small, medium, large, full
posterSize	Returns the requested thumbnail of the video	small, medium, large, full
mediaLinksFormat	Returns the media in size suitable to the browser. If set to "server", it will return the media in its original size.	default is "browser"
convertSvg	Return images and algorithms that are originally in svg format as png format.	default is to return svg

Sample Search Media Response

Sample JSON is listed below showing an image and video sections of a search response. An imageSize of large and posterSize of small was requested. Dyna responses will be similar.

        "images": [
            {
                "copyright": "Copyright, EBSCO Information Services",
                "title": "Auscultation Areas of the Heart",
                "publicId": "EBSCOHealth/CCMS/NAH/images/123670983",
                "links": [
                    {
                        "rel": "external",
                        "href": "http://media.ebsco.healthcare/eis-live/image/authenticated/t_s1000/v1/EBSCOHealth/CCMS/NAH/images/123670983.jpg?__cld_token__=exp=1785256842~hmac=4e63ba539892b5b5803e4e2399028b7040bc02af00daecdbed9edef384a55440&_a=BAMAPqiu0",
                        "imageSize": "large"
                    }
                ]
            }
        ],
        "links": [
            {
                "rel": "self",
                "href": "https://ebscois-development-devqa.apigee.net/medsapi-dynamic-health/v1/content/articles/T916643"
            },
            {
                "rel": "external",
                "href": "https://www.dynahealth.com/nursing-skills/auscultating-heart-sounds-in-adults"
            }
        ]

        "videos": [
            {
                "copyright": "Copyright, EBSCO Information Services",
                "title": "Heart Auscultation: Listening for S1 and S2 Heart Sounds",
                "publicId": "EBSCOHealth/CCMS/NAH/videos/V100985",
                "links": [
                    {
                        "rel": "external",
                        "href": "http://media.ebsco.healthcare/eis-live/video/authenticated/v1/EBSCOHealth/CCMS/NAH/videos/V100985.mp4?__cld_token__=exp=1785256912~hmac=330f2635f18792cd3f4d7744297da0aae04653e8f7ea33c47149e3f388e33791&_a=BAMAPqiu0"
                    },
                    {
                        "rel": "external",
                        "href": "http://media.ebsco.healthcare/eis-live/video/authenticated/t_media_lib_thumb/f_jpg/v1/EBSCOHealth/CCMS/NAH/videos/V100985.jpg?__cld_token__=exp=1785256912~hmac=5b95e2c43b332d68d6e1d6d16733c363ab94f7e05169a8cad28d3955f55065ab&_a=BAMAPqiu0",
                        "size": "poster"
                    }
                ]
            }
        ],

Sample Article Media Response

Articles with media vary a bit from search. Media are located within the ancillary section and may include content locations. This particular response shows the size when imageSize was set to large and posterSize was set to small.

"multimedia": [
            {
                "mediaType": "video",
                "content": [
                    {
                        "links": [
                            {
                                "rel": "external",
                                "href": "http://media.ebsco.healthcare/eis-live/video/authenticated/v1/EBSCOHealth/CCMS/NAH/videos/453a94672fafe5f4ceaca7d91e5d60f1.mp4?__cld_token__=exp=1785257492~hmac=85051d915ffa9fef9e9a0c3c0f3311cd40dac57dbfe1e9dd9a8521bf46af282e&_a=BAMAPqiu0"
                            },
                            {
                                "rel": "external",
                                "href": "http://media.ebsco.healthcare/eis-live/video/authenticated/t_media_lib_thumb/f_jpg/v1/EBSCOHealth/CCMS/NAH/videos/453a94672fafe5f4ceaca7d91e5d60f1.jpg?__cld_token__=exp=1785257492~hmac=b576534e85762dd87235744d720519ecff33ca19ab4d3e878ec8ab3013f34d6e&_a=BAMAPqiu0",
                                "size": "poster"
                            }
                        ],
                        "title": "Administering Nasal Drops for Pediatric Patients",
                        "copyright": "Copyright ©2019, EBSCO Information Services",
                        "mediaHost": "cloudinary",
                        "publicId": "EBSCOHealth/CCMS/NAH/videos/453a94672fafe5f4ceaca7d91e5d60f1"
                    }
                ]
            },
            {
                "mediaType": "image",
                "content": [
                    {
                        "links": [
                            {
                                "rel": "external",
                                "href": "http://media.ebsco.healthcare/eis-live/image/authenticated/t_s1000/v1/EBSCOHealth/CCMS/NAH/images/124763774.jpg?__cld_token__=exp=1785257492~hmac=700ca26907a5c812c3f68803dc3cc342ae3f54f6cedc3c9998c283730e18b415&_a=BAMAPqiu0",
                                "imageSize": "large"
                            }
                        ],
                        "title": "Supplies for Nasal Instillation in Pediatric Patients",
                        "copyright": "Copyright, EBSCO Information Services",
                        "mediaHost": "cloudinary",
                        "publicId": "EBSCOHealth/CCMS/NAH/images/124763774"
                    }
                ]
            }
        ]