Media Meta API

Reading the DiBox and ViBox metadata of uploaded media by diamond, project or setup preset.

The Media Meta API returns the metadata that DiBox and ViBox recorded for media uploaded to Cutwise. A vendor uses it to find the media of one diamond by its StoneID, its project or the setup preset.

Example

GET https://cutwise.com/api/v2/mediameta?access_token={TOKEN}&filters[orientation]=Crown&filters[setupPreset]=10&filters[b2bSid]=CUSHION0&limit=1

This request returns the metadata of the most recently added ASET Black media (setup preset 10) of the diamond CUSHION0, where the Orientation attribute is Crown.

Get media metadata

  • Method and path: GET https://cutwise.com/api/v2/mediameta
  • Auth: access token in the access_token query parameter. See Authorization.
  • Request: filters and limit as query parameters, see the table below
  • Response: JSON array of metadata entries, newest first
Parameter Description
filters[b2bSid] StoneID of the diamond whose media you look for. The API compares it with the b2bSid field of the product in the Cutwise database, not with the StoneID metadata field. The two values can differ.
filters[orientation] Value of the Orientation field in the DiBox or ViBox metadata. Case-sensitive.
filters[projectId] Value of the ProjectID field in the DiBox or ViBox metadata. Case-sensitive.
filters[setupPreset] Setup preset ID, as listed at https://cutwise.com/api/v2/setuppresets. Custom media can be hard to find by preset. For custom media, prefer filters[projectId].
limit Maximum number of entries in the response.

Response

  • The API returns metadata as JSON, not in the original XML format. Base64 entities are decoded into strings.
  • Entries are sorted by the time the media was added to the Cutwise database, from newest to oldest.
  • The response includes all metadata, also for media whose processing has not started yet or ended with an error.
  • The X-Total-Count response header holds the total number of entries before limit is applied.

Response example:

[
    {
        "id": 125654,
        "metaData": {
            "MovieMetaData": {
                "Z": "3.9000000131609779366734",
                "Gain": "1",
                "WB_B": "1.63857",
                "WB_R": "1.24243",
                "WB_G1": "0.915797",
                "WB_G2": "0.90683",
                "StoneID": "Cushion0",
                "XCenter": "-3.4",
                "YCenter": "1.0",
                "@version": "1",
                "Exposure": "7.5",
                "Hardware": "DiBox 2.0",
                "IsStereo": "1",
                "Software": "DiBox",
                "FrameRate": "25",
                "ProjectID": "24f89208-c01d-491e-98ee-345bf30cc58b",
                "XAmplitude": "5",
                "YAmplitude": "3",
                "FramesCount": "200",
                "Orientation": "Crown",
                "SetupPreset": "v1",
                "StereoAngle": "2.5",
                "LightingName": "Officelight black",
                "LDRImageIndex": "1",
                "RawPresetName": "Default",
                "HDRImagesCount": "2",
                "TrajectoryName": "Eight",
                "MetadataVersion": "2",
                "SoftwareVersion": "5.4.0.0",
                "StageHardwareType": "Gimbal",
                "IsOneWayTrajectory": "0",
                "ImagesToAverageCount": "3",
                "IsRear_1LightEnabled": "0",
                "IsRear_2LightEnabled": "0",
                "IsRing_1LightEnabled": "1",
                "IsRing_2LightEnabled": "1",
                "IsRing_3LightEnabled": "1",
                "IsRing_4LightEnabled": "1",
                "IsRing_6LightEnabled": "1",
                "IsRing_7LightEnabled": "1",
                "IsRing_8LightEnabled": "1",
                "IsRing_9LightEnabled": "1",
                "LightRing_1Brightness": "100",
                "LightRing_2Brightness": "100",
                "LightRing_3Brightness": "100",
                "LightRing_4Brightness": "100",
                "LightRing_6Brightness": "100",
                "LightRing_7Brightness": "10",
                "LightRing_8Brightness": "10",
                "LightRing_9Brightness": "100",
                "IsUV_365nmLightEnabled": "0",
                "IsUV_385nmLightEnabled": "0",
                "TonemappingAlgorithmVersion": "1.0"
            }
        }
    },
    {
        "id": 125642,
        "metaData": {
            "MovieMetaData": {
                "Z": "3.9000000131609779366734",
                "Gain": "1",
                "WB_B": "1.63857",
                "WB_R": "1.24243",
                "WB_G1": "0.915797",
                "WB_G2": "0.90683",
                "StoneID": "Cushion0",
                "XCenter": "-3.4",
                "YCenter": "1.0",
                "@version": "1",
                "Exposure": "30",
                "Hardware": "DiBox 2.0",
                "IsStereo": "1",
                "Software": "DiBox",
                "FrameRate": "25",
                "ProjectID": "24f89208-c01d-491e-98ee-345bf30cc58b",
                "XAmplitude": "5",
                "YAmplitude": "3",
                "FramesCount": "200",
                "Orientation": "Crown",
                "SetupPreset": "v1",
                "StereoAngle": "2.5",
                "LightingName": "Officelight black",
                "LDRImageIndex": "0",
                "RawPresetName": "Default",
                "HDRImagesCount": "2",
                "TrajectoryName": "Eight",
                "MetadataVersion": "2",
                "SoftwareVersion": "5.4.0.0",
                "StageHardwareType": "Gimbal",
                "IsOneWayTrajectory": "0",
                "ImagesToAverageCount": "3",
                "IsRear_1LightEnabled": "0",
                "IsRear_2LightEnabled": "0",
                "IsRing_1LightEnabled": "1",
                "IsRing_2LightEnabled": "1",
                "IsRing_3LightEnabled": "1",
                "IsRing_4LightEnabled": "1",
                "IsRing_6LightEnabled": "1",
                "IsRing_7LightEnabled": "1",
                "IsRing_8LightEnabled": "1",
                "IsRing_9LightEnabled": "1",
                "LightRing_1Brightness": "100",
                "LightRing_2Brightness": "100",
                "LightRing_3Brightness": "100",
                "LightRing_4Brightness": "100",
                "LightRing_6Brightness": "100",
                "LightRing_7Brightness": "10",
                "LightRing_8Brightness": "10",
                "LightRing_9Brightness": "100",
                "IsUV_365nmLightEnabled": "0",
                "IsUV_385nmLightEnabled": "0",
                "TonemappingAlgorithmVersion": "1.0"
            }
        }
    },
    {
        "id": 125598,
        "metaData": {
            "MovieMetaData": {
                "Z": "3.9000000131609779366734",
                "Gain": "1",
                "WB_B": "1.63857",
                "WB_R": "1.24243",
                "WB_G1": "0.915797",
                "WB_G2": "0.90683",
                "HDRMode": "EF",
                "StoneID": "Cushion0",
                "XCenter": "-3.4",
                "YCenter": "1.0",
                "@version": "1",
                "Exposure": "30",
                "Hardware": "DiBox 2.0",
                "IsStereo": "1",
                "Software": "DiBox",
                "FrameRate": "25",
                "ProjectID": "24f89208-c01d-491e-98ee-345bf30cc58b",
                "XAmplitude": "5",
                "YAmplitude": "3",
                "FramesCount": "200",
                "Orientation": "Crown",
                "SetupPreset": "v1",
                "StereoAngle": "2.5",
                "LightingName": "Officelight black",
                "RawPresetName": "Default",
                "HDRImagesCount": "2",
                "TrajectoryName": "Eight",
                "MetadataVersion": "2",
                "SoftwareVersion": "5.4.0.0",
                "StageHardwareType": "Gimbal",
                "IsOneWayTrajectory": "0",
                "ImagesToAverageCount": "3",
                "IsRear_1LightEnabled": "0",
                "IsRear_2LightEnabled": "0",
                "IsRing_1LightEnabled": "1",
                "IsRing_2LightEnabled": "1",
                "IsRing_3LightEnabled": "1",
                "IsRing_4LightEnabled": "1",
                "IsRing_6LightEnabled": "1",
                "IsRing_7LightEnabled": "1",
                "IsRing_8LightEnabled": "1",
                "IsRing_9LightEnabled": "1",
                "LightRing_1Brightness": "100",
                "LightRing_2Brightness": "100",
                "LightRing_3Brightness": "100",
                "LightRing_4Brightness": "100",
                "LightRing_6Brightness": "100",
                "LightRing_7Brightness": "10",
                "LightRing_8Brightness": "10",
                "LightRing_9Brightness": "100",
                "IsUV_365nmLightEnabled": "0",
                "IsUV_385nmLightEnabled": "0",
                "TonemappingAlgorithmVersion": "1.0"
            }
        }
    }
]

Errors and limits

  • The API returns HTTP 403 when the user does not have the ROLE_VENDOR role, or is not linked to any B2B (business-to-business) company account.
  • The error body format is on the Error handling page.

Related pages