Get an asset

Retrieve an asset specified by its assetPath

Details

This endpoint returns the asset itself or an image thumbnail representing the asset. It is always important to set the Content-Type and Content-Length headers.

The Content-Length header should be the number of bytes of the asset.

The body of the result should be the octet stream of the binary data for the specified asset.

The Content-Type header should be appropriate for the type of asset being returned. The Content-Types supported are:

Asset TypeAsset FormatMIME Type
AudioMODaudio/x-mod
ImageJPEGimage/jpeg
ImagePNGimage/png
Video3G2video/3gpp2
Video3GPvideo/3gpp
Video3GPPvideo/3gpp
VideoASFvideo/x-ms-asf
VideoAVIvideo/x-msvideo
VideoDATDAT files can be of any video format. The underlying format should be used.
VideoDIVXvideo/divx
VideoDVvideo/x-dv
VideoF4Vvideo/x-f4v
VideoFLVvideo/x-flv
VideoM2TSvideo/mp2t
VideoM4Vvideo/x-m4v
VideoMKVvideo/webm
VideoMOVvideo/quicktime
VideoMP4video/mp4
VideoMPEvideo/mpeg4-generic
VideoMPEG MPEG4video/mpeg4-generic
VideoMPGvideo/mpeg4-generic
VideoMTSvideo/mts
VideoNSVvideo/x-nsv
VideoOGMvideo/ogg
VideoOGVvideo/ogg
VideoQTvideo/quicktime
VideoTODvideo/x-tod
VideoTSvideo/MP2T
VideoVOBvideo/x-ms-vob
VideoWMVvideo/x-ms-wmv

thumbnail Query Parameter

When true, a thumbnail of the asset should be returned. Recommended values:

  • When the asset is an image, this should be a smaller version of the image
  • When a non-imagable format, it should be an icon of the format type.

Implementors can choose to ignore this flag, but it will degrade the user’s experience while searching for an asset. Spredfast will also halt the tranfer of thumbnails if they do not transfer within a reasonable amount of time.

Responses and Response Schema

200 (Success)
The asset itself.
400 (Generic Error)

Field Name

Type

Description

error*

string

Example: ASSET_NOT_FOUND

Name of the error or code. This should be a short string or number which will make sense to the middleware or connected DAM.

message*

string

Example: The asset does not exist, please select another asset.

The message that will be relayed to the user in Khoros Marketing. This should be a human-understandable description of what happened and ideally what steps the user can take next.

401 (Authentication Failure)
Authentication method is invalid or has become de-authenticated.
401 (Not Found)
Specified resource path was not found or does not exist.
500 (Unexpected Error)

Field Name

Type

Description

error*

string

Example: ASSET_NOT_FOUND

Name of the error or code. This should be a short string or number which will make sense to the middleware or connected DAM.

message*

string

Example: The asset does not exist, please select another asset.

The message that will be relayed to the user in Khoros Marketing. This should be a human-understandable description of what happened and ideally what steps the user can take next.

Language
URL