Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Get Media Item Metadata

GET/api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata
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 detailed metadata about the media item, including type-specific information such as dimensions for images, duration for audio/video, page count for documents, etc.

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

MediaItemMetadata
union

Detailed metadata about a media item, including type-specific information such as dimensions for images, duration for audio/video, page count for documents, etc.

Hide child attributes

Hide child attributes

document
object
optional

Metadata for document media items.

Show child attributes

Show child attributes

imagery
object
optional

Metadata for imagery (image) media items.

Show child attributes

Show child attributes

spreadsheet
object
optional

Metadata for spreadsheet media items.

Show child attributes

Show child attributes

untyped
object
optional

Metadata for untyped media items (media items without a recognized type).

Show child attributes

Show child attributes

audio
object
optional

Metadata for audio media items.

Show child attributes

Show child attributes

video
object
optional

Metadata for video media items.

Show child attributes

Show child attributes

dicom
object
optional

Metadata for DICOM (Digital Imaging and Communications in Medicine) media items.

Show child attributes

Show child attributes

Examples

Request

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

Response

Copied!
1 2 3 4 5 6 7 8 9 { "type": "imagery", "format": "PNG", "dimensions": { "width": 1920, "height": 1080 }, "sizeBytes": 2048576 }