--- title: "Asset Metadata Payload Structure" slug: "asset-metadata-payload-structure" tags: ["Metadata", "Asset metadata", "Payload", "Syndigo API"] updated: 2024-10-15T16:20:27Z published: 2024-10-15T16:20:27Z canonical: "docx.syndigo.com/asset-metadata-payload-structure" --- > ## Documentation Index > Fetch the complete documentation index at: https://docx.syndigo.com/llms.txt > Use this file to discover all available pages before exploring further. # Asset Metadata Payload Structure Below you can see how the Asset metadata is structured. **GET** #### Headers **Authorization**: Specify required Auth Token in the header. ### Request Parameters **Expand to see the parameters and description** | **Parameter** | **Parameter Type** | **Data Type** | **Accepted Values** | **Description** | | --- | --- | --- | --- | --- | | Name | Required | String | An asset filename. | Specifies the asset's filename. | | Tags | Optional | Array of Strings | Any tags desired. | Provides an array of tags applicable to an asset. | | BinaryAssetId | Required | String | GUID | Binary asset identifier. | | CollectionCount | Optional | Integer | Collection count | A number of collections. | | UploadDate | Required | Integer | YYYY-MM-DD | Determines an upload date. | | SourceUrl | Required | String | An asset's source URL | Ensures the asset is not duplicated. | | Stats | Required | Array of Strings | Asset details | Includes information about the asset file. | | Id | Part of Stats | String | An asset GUID | It's an asset identifier. | | BinaryId | Part of Stats | String | The binary file GUID | Identifier of a binary file. | | Hash | Part of Stats | String | Checksum used for validation | Contains a hash for the validation of assets. | | Description | Part of Stats | String | A file name | Describes a file name. | | Height | Part of Stats | Integer | Height in pixels | Defines an asset height. | | Width | Part of Stats | Integer | Width in pixels | Defines an asset width. | | Format | Part of Stats | String | A file format | Defines a file format for example: jpg, png, jpeg. | | FileSize | Part of Stats | Integer | Size in bytes | Gives info about the file size. | | DPI | Part of Stats | Float | DPI of an asset. | Provides info about an asset DPI. | | HasClippingPath | Part of Stats | Boolean | True/False | Defines if an asset has a clipping path included. | | Frames | Part of Stats | Integer | Default is 1 | | | Duration | Part of Stats | Float | Default is 0.0 | | | Codec | Part of Stats | String | Codec type e.g. mjpeg | Sets a codec type of an image. | | IsArchived | Optional | Boolean | True/False | Defines if an asset is archived. | | AltText | Optional | Array of Strings | Includes a locale and a description. | Used for accessibility purposes. | | Id | Required | String | Asset GUID. | It's an asset identifier. | | DataOwner | Required | String | GUID | Company ID GUID | | AuditInfo | Optional | Array of Strings | Examples: CreateDate, CreatorName. | Provides audit data. | | ContextId | Part of AuditInfo | String | Context GUID | | | CreateDate | Part of AuditInfo | String | YYYY-MM-DD | Provides a create date. | | CreatorId | Part of Auditnfo | String | Creator GUID | Provides the creator identifier. | | CreatorName | Part of AuditInfo | String | Creator first & last name | Provides info on the creator of the asset. | | LastModifiedDate | Part of AuditInfo | String | YYYY-MM-DD | Shows the last modified date. | | PrincipleId | Part of AuditInfo | String | Principle GUID | An identifier of the principle. | | PrincipleName | Part of AuditInfo | String | Principle first & last name | | | MachineName | Part of AuditInfo | String | Machine Id | | | Properties | Required | Array of Strings | Asset properties | Provides you with information about the asset properties. | | SpecialPurpose | Part of Properties | String | Example: Ad, Marketing | Used for specifying the purpose of an asset. | | Variant | Part of Properties | String | TBA | Makes it easy to set variants for assets. | | CPVIdentifier | Part of Properties | String | Identifier | TBA | | ContentDescription | Part of Properties | String | A description of the asset's content | TBA | | FileFormatDescription | Part of Properties | String | File format description. | | | FileOptimalViewerName | Part of Properties | String | | | | FileOriginCountry | Part of Properties | String | Country of origin | | | FileCameraPerspective | Part of Properties | String | Example: Front | Provides information about the camera perspective. | | IsPrimaryFile | Part of Properties | Boolean | True/False | Defines if the file is primary. | | IsBackgroundTransparent | Part of Properties | Boolean | True/False | Marks if the background of an asset is transparent. | | AssetMetadataIsLocked | Part of Properties | Boolean | True/False | | ![image.png](https://cdn.document360.io/381abf0c-f631-4d76-a7c0-e955ad2c7aa6/Images/Documentation/image%28194%29.png?sv=2026-02-06&spr=https&st=2026-11-03T18%3A22%3A28Z&se=2026-11-03T19%3A22%3A28Z&sr=c&sp=r&sig=VGl6REtagnh65Yf9TcqrlgYjZIr8Kes59d0JNzWfnL0%3D) #### Response **200 OK** ``` { "Name": "Banana.jpg", "Tags": [ "Banana Fruit Exotic Yellow Fresh" ], "BinaryAssetId": "d15b778e-55a4-42d5-b20d-8bedc141fbc9", "CollectionCount": 0, "UploadDate": "2023-04-24T21:19:48.9275248Z", "SourceUrl": "https://images.unsplash.com/photo-1587132137056-bfbf0166836e", "Stats": { "id": "d15b778e-55a4-42d5-b20d-8bedc141fbc9", "BinaryId": "d15b778e-55a4-42d5-b20d-8bedc141fbc9", "Hash": "0d2900fd4a16d7c80dbf2902db996923b5bcf62d017fa10d08ccd5655c9ff0ba", "Description": "Banana.jpg", "Height": 4048, "Width": 4048, "Format": "jpeg", "FileSize": 2537487, "ExifInfo": [ "ImageWidth (Short): 3923", "ImageLength (Short): 3923", "BitsPerSample (Short): ImageMagick.ExifShortArray", "Compression (Short): Adobe Deflate", "PhotometricInterpretation (Short): RGB", "Make (String): Canon", "Model (String): Canon EOS 6D", "Orientation (Short): Horizontal (normal)", "SamplesPerPixel (Short): 3", "XResolution (Rational): 3000000/10000", "YResolution (Rational): 3000000/10000", "PlanarConfiguration (Short): Chunky", "ResolutionUnit (Short): Inches", "Software (String): Adobe Photoshop 21.0 (Windows)", "DateTime (String): 2020:04:16 17:52:40", "ExposureTime (Rational): 1/4", "FNumber (Rational): 14", "ExposureProgram (Short): Manual", "ISOSpeedRatings (Short): ImageMagick.ExifShortArray", "SensitivityType (Short): Recommended Exposure Index", "RecommendedExposureIndex (Long): 100", "ExifVersion (Undefined): ImageMagick.ExifByteArray", "DateTimeOriginal (String): 2019:07:28 22:53:18", "DateTimeDigitized (String): 2019:07:28 22:53:18", "ShutterSpeedValue (SignedRational): 2", "ApertureValue (Rational): 761471/100000", "ExposureBiasValue (SignedRational): 0", "MaxApertureValue (Rational): 3", "MeteringMode (Short): Center-weighted average", "Flash (Short): Off, Did not fire", "FocalLength (Rational): 100", "SubsecTimeOriginal (String): 6", "ColorSpace (Short): sRGB", "PixelXDimension (Short): 4048", "PixelYDimension (Short): 4048", "FocalPlaneXResolution (Rational): 49807360/32768", "FocalPlaneYResolution (Rational): 49807360/32768", "FocalPlaneResolutionUnit (Short): Centimeter", "CustomRendered (Short): 0", "ExposureMode (Short): Manual", "WhiteBalance (Short): Manual", "SceneCaptureType (Short): Standard", "SerialNumber (String): 122128000061", "LensInfo (Rational): ImageMagick.ExifRationalArray", "LensModel (String): EF100mm f/2.8L Macro IS USM", "LensSerialNumber (String): 000005743a" ], "Dpi": { "X": 300.0, "Y": 300.0 }, "HasClippingPath": false }, "IsArchived": false, "AltText": {}, "id": "d15b778e-55a4-42d5-b20d-8bedc141fbc9", "DataOwner": "3b904928-20b7-413e-bda6-28edf4b2ff31", "AuditInfo": { "ContextId": "a12e464b-ed2c-49b8-8ed1-87b962547d50", "CreateDate": "2023-04-24T21:19:48.942789Z", "CreatorId": "d8c859b9-f622-40b6-8565-87e0175bcb5f", "CreatorName": "Admin", "CreatorImpersonator": { "Id": "d946ce82-88e8-453e-9a77-e056b33082ea", "Name": "Service User" }, "LastModifiedDate": "2024-10-15T16:10:17.9336624Z", "PrincipleId": "a56dcfe1-b1e8-465c-af6d-625f32302258", "PrincipleName": "Admin", "MachineName": "assetservice-55c645866-xdvjd" }, "Properties": { "Angle": "C", "Facing": "1", "ImageType": "A", "State": "0", "Variant": "First", "ContentDescription": "The image contains a banana.", "FileFormatDescription": "jpg", "FileOptimalViewerName": "90 degrees", "FileOriginCountry": "Internet", "IsPrimaryFile": "true", "IsBackgroundTransparent": "true", "AssetMetadataIsLocked": "true" }, "Partition": "d15b778e-55a4-42d5-b20d-8bedc141fbc9", "Type": "Asset" } ``` ## Related - [Asset Get Metadata](/asset-get-metadata.md) - [Asset Update Metadata](/asset-update-metadata.md)