Search documentation
karat

+

K

User Documentation ↗

Get Media Item Reference

GET/api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/reference
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Gets the media reference for this media item.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:mediasets-read.

Path parameters

mediaSetRid
string

The RID of the media set.

mediaItemRid
string

The RID of the media item.

Query parameters

preview
boolean
optional

A boolean flag that, when set to true, enables the use of beta features in preview mode.

Response body

MediaReference
object

The representation of a media reference.

Hide child attributes

Hide child attributes

mimeType
string

The media type of the file or attachment. Examples: application/json, application/pdf, application/octet-stream, image/jpeg

reference
union

A union of the types supported by media reference properties.

Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/reference?preview=true"