Version 2.0

Get Media Item Metadata

GET/api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata

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.

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

cad

objectoptional

Metadata for CAD media items.

Show child attributes

document

objectoptional

Metadata for document media items.

Show child attributes

imagery

objectoptional

Metadata for imagery (image) media items.

Show child attributes

spreadsheet

objectoptional

Metadata for spreadsheet media items.

Show child attributes

untyped

objectoptional

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

Show child attributes

audio

objectoptional

Metadata for audio media items.

Show child attributes

model3d

objectoptional

Metadata for 3D model media items.

Show child attributes

video

objectoptional

Metadata for video media items.

Show child attributes

dicom

objectoptional

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

Show child attributes

objectoptional

Metadata for email media items.

Show child attributes

Examples

Request

Copied!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}/metadata"

Response

Copied!

{
  "type": "imagery",
  "format": "PNG",
  "dimensions": {
    "width": 1920,
    "height": 1080
  },
  "sizeBytes": 2048576
}