CI HUBCI HUB SDK
SchemasAssets

Asset Object

Schema for an asset returned by search, folder, brand, and task endpoints.

The Asset object is returned by Search, Get Folder, Get Brand Assets, and Get Task Assets.

Fields

Prop

Type

Exactly one downloadHash* field is set per asset, determined by the integration's capabilities.assetHashAlgorithm. See download hash fields below.

capabilities

Prop

Type

conversions

A rendition or format variant of the asset available for download.

Prop

Type

Metadata fields

The values array contains custom metadata fields. Each entry is one of four types, discriminated by the type field.

Text field (type: "TEXT")

Prop

Type

Rich text field (type: "DRAFT_JS")

Prop

Type

Date/time field (type: "DATE" | "DATETIME" | "TIME")

Prop

Type

Asset reference field (type: "ASSET")

Used in PRODUCT assets to embed a reference to another asset as a metadata value.

Prop

Type

Embedded asset

The value of an asset reference field.

Prop

Type

exif

EXIF image metadata. All fields are optional.

Prop

Type

iptc

IPTC press metadata. All fields are optional.

Prop

Type

xmp

XMP metadata. All fields are optional.

Prop

Type

ciHubColor

Brand color definition. Present on color assets.

Prop

Type

rgbValue

Prop

Type

cmyk

Prop

Type

Download hash fields

Exactly one downloadHash* field is present per asset. Which field appears depends on the integration's capabilities.assetHashAlgorithm.

FieldAlgorithmNotes
downloadHashMd5MD5
downloadHashSha1SHA-1
downloadHashSha256SHA-256
downloadHashSha256Split4MBSHA-256 (4 MB chunks)
downloadHashSha256First16MBSHA-256 (first 16 MB)
downloadHashSha512SHA-512
downloadHashCrc32CRC-32
downloadHashFileAttributesFile attributesJSON string: { fileSize, modified }

On this page