# Asset
> Interface in domain **Assets**
- HTML: [Asset.html](Asset.html)
- Raw SDL: [Asset.sdl](Asset.sdl)
- Covered by: [llms.txt](../llms.txt)
`AssetInterface` for `Asset` returnable types.
## Fields
- `id`: `ID!` — `Asset` id.
- `creator`: `User!` — The `creator` is the `User` who created the asset on Frontify.
- `createdAt`: `DateTime!` — DateTime of the `Asset` creation.
- `modifier`: `User` — The `modifier` is the `User` who last modified the asset on Frontify.
- `modifiedAt`: `DateTime` — DateTime of the `Asset`'s last modification.
- `title`: `String!` — Title of the `Asset`.
- `description`: `String` — Description of the `Asset`.
- `alternativeText`: `String` — Alternative text for the `Asset`. Used by screen readers when the asset is not decorative.
- `externalId`: `ID` — External Id of the `Asset`.
- `tags`: `[Tag]` — List of `Asset`'s tags.
- `copyright`: `Copyright` — `Asset` copyright details.
- `availability`: `DateTimeRange!` — `Asset` will be available only during the defined `DateTime` range.When `null` it represents an unspecified start and/or open-ended date.
- `expiresAt`: `DateTime` — `Asset` available until date.
- `metadataValues`: `[MetadataValue]` _(deprecated)_ — Metadata values details.
- `author`: `String` — Represents the Author of the `Asset`. Example: Photographer Name.
- `status`: `AssetStatusType!` — Represents the conversion status of the `Asset`. Example: FINISHED.
- `relatedAssets` (`limit`: `Int`, `page`: `Int`): `AssetItems!` — Paginated list of `Asset` items related to `Asset`.
- `revisions` (`limit`: `Int`, `page`: `Int`): `AssetRevisionItems!` — Paginated list of `AssetRevision` items for `Asset`, newest first.
- `comments` (`limit`: `Int`, `page`: `Int`, `query`: `AssetCommentQueryInput`): `AssetCommentItems` — Paginated list of `AssetComment` items for `Asset`.
- `currentUserPermissions`: `AssetUserPermissions!` — `Asset` permissions of the current `User`.
- `customMetadata`: `[CustomMetadata!]!` — List of `CustomMetadataProperty` items and values associated to `Asset`.
- `workflowTask`: `WorkflowTask` _(beta)_ — The `WorkflowTask` this `Asset` is linked to.
- `variants` (`limit`: `Int`, `page`: `Int`): `AssetVariantItems` — `AssetVariant` items of the asset. Only available for assets in icon and logo libraries.
- `location`: `AssetLocation!` — `Location` of the `Asset`.
- `previewBackgroundColor`: `RgbaColor` _(beta)_ — Background color of the `Asset` preview.
- `attachments`: `[AssetAttachment]` — List of `Asset`'s `Attachments`.
- `provenance`: `AssetProvenance` _(beta)_ — AI provenance read from the asset's current file, or `null` if none has been extracted yet.
- `licenses`: `[License]` — List of `Asset`'s licenses.
- `targets`: `[Target]` _(beta)_ — List of `Target` items linked to `Asset`
## Related mutations
- [`addAssetLicense`](../mutation/addAssetLicense.md)
- [`addAssetPreviewImage`](../mutation/addAssetPreviewImage.md)
- [`addAssetRelations`](../mutation/addAssetRelations.md)
- [`addAssetTags`](../mutation/addAssetTags.md)
- [`addCollectionAssets`](../mutation/addCollectionAssets.md)
- [`addLibraryAssetTargets`](../mutation/addLibraryAssetTargets.md)
- [`createAsset`](../mutation/createAsset.md)
- [`createAssetWorkflowTask`](../mutation/createAssetWorkflowTask.md)
- [`createExternalAsset`](../mutation/createExternalAsset.md)
- [`deleteAsset`](../mutation/deleteAsset.md)
- [`moveAssets`](../mutation/moveAssets.md)
- [`removeAssetLicense`](../mutation/removeAssetLicense.md)
- [`removeAssetPreviewImage`](../mutation/removeAssetPreviewImage.md)
- [`removeAssetRelations`](../mutation/removeAssetRelations.md)
- [`removeAssetTags`](../mutation/removeAssetTags.md)
- [`removeCollectionAssets`](../mutation/removeCollectionAssets.md)
- [`removeLibraryAssetTargets`](../mutation/removeLibraryAssetTargets.md)
- [`replaceAsset`](../mutation/replaceAsset.md)
- [`setCollectionAssets`](../mutation/setCollectionAssets.md)
- [`setLibraryAssetTargets`](../mutation/setLibraryAssetTargets.md)
- [`syncAssetTags`](../mutation/syncAssetTags.md)
- [`updateAsset`](../mutation/updateAsset.md)
- [`updateAssets`](../mutation/updateAssets.md)
## Reach via
Example queries that can return this type from the root `Query`.
### `assets`
```graphql
query Assets {
assets(ids: "…") {
__typename
alternativeText
attachments {
name
filename
id
createdAt
downloadUrl
extension
creator {
__typename
name
id
}
modifier {
__typename
name
id
}
}
author
availability {
from
to
}
comments {
total
page
limit
hasNextPage
items {
id
content
createdAt
isResolved
creator { id }
currentUserPermissions { canDelete }
}
}
copyright {
notice
status
}
createdAt
creator {
__typename
name
id
}
currentUserPermissions {
canComment
canDelete
canDownload
canEdit
}
customMetadata {
__typename
property {
name
id
createdAt
defaultValue
creator { id }
dependency { propertyId }
}
... on CustomMetadataValue {
value
}
... on CustomMetadataValues {
values
}
}
description
expiresAt
externalId
id
licenses {
title
id
addByDefault
license
requireConsensus
}
location {
brand {
name
id
}
folder {
name
id
breadcrumbs { id }
}
library {
name
id
}
workspaceProject {
name
id
}
}
modifiedAt
modifier {
__typename
name
id
}
previewBackgroundColor {
alpha
blue
green
red
}
provenance {
certExpiresAt
certIssuedAt
certIssuer
certStatus
certSubject
contentOrigin
}
relatedAssets {
total
page
limit
hasNextPage
items {
__typename
title
id
alternativeText
author
attachments { id }
availability { from }
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
}
revisions {
total
page
limit
hasNextPage
items {
id
createdAt
creator { id }
}
}
status
tags {
source
value
}
targets {
name
id
}
title
variants {
total
page
limit
hasNextPage
items {
filename
downloadUrl
key
}
}
workflowTask {
title
id
description
asset {
__typename
title
id
alternativeText
author
attachments { id }
availability { from }
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
assignedUsers {
__typename
name
id
}
checklistItem {
total
page
limit
hasNextPage
items { id }
}
status {
name
id
enterRules
assignedUsers { id }
checklistPresets { id }
}
}
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
}
```
Raw: [`Assets.sdl`](../examples/Assets.sdl)
### `asset`
```graphql
query Asset {
asset(id: "…") {
__typename
alternativeText
attachments {
name
filename
id
createdAt
downloadUrl
extension
creator {
__typename
name
id
}
modifier {
__typename
name
id
}
}
author
availability {
from
to
}
comments {
total
page
limit
hasNextPage
items {
id
content
createdAt
isResolved
creator { id }
currentUserPermissions { canDelete }
}
}
copyright {
notice
status
}
createdAt
creator {
__typename
name
id
}
currentUserPermissions {
canComment
canDelete
canDownload
canEdit
}
customMetadata {
__typename
property {
name
id
createdAt
defaultValue
creator { id }
dependency { propertyId }
}
... on CustomMetadataValue {
value
}
... on CustomMetadataValues {
values
}
}
description
expiresAt
externalId
id
licenses {
title
id
addByDefault
license
requireConsensus
}
location {
brand {
name
id
}
folder {
name
id
breadcrumbs { id }
}
library {
name
id
}
workspaceProject {
name
id
}
}
modifiedAt
modifier {
__typename
name
id
}
previewBackgroundColor {
alpha
blue
green
red
}
provenance {
certExpiresAt
certIssuedAt
certIssuer
certStatus
certSubject
contentOrigin
}
relatedAssets {
total
page
limit
hasNextPage
items {
__typename
title
id
alternativeText
author
attachments { id }
availability { from }
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
}
revisions {
total
page
limit
hasNextPage
items {
id
createdAt
creator { id }
}
}
status
tags {
source
value
}
targets {
name
id
}
title
variants {
total
page
limit
hasNextPage
items {
filename
downloadUrl
key
}
}
workflowTask {
title
id
description
asset {
__typename
title
id
alternativeText
author
attachments { id }
availability { from }
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
assignedUsers {
__typename
name
id
}
checklistItem {
total
page
limit
hasNextPage
items { id }
}
status {
name
id
enterRules
assignedUsers { id }
checklistPresets { id }
}
}
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
}
```
Raw: [`Asset.sdl`](../examples/Asset.sdl)
### `assets › relatedAssets`
```graphql
query AssetsRelatedAssets {
assets(ids: "…") {
... on Audio {
relatedAssets(limit: 25, page: 1) {
items {
__typename
alternativeText
attachments {
name
filename
id
createdAt
downloadUrl
extension
creator {
__typename
name
id
}
modifier {
__typename
name
id
}
}
author
availability {
from
to
}
comments {
total
page
limit
hasNextPage
items {
id
content
createdAt
isResolved
creator { id }
currentUserPermissions { canDelete }
}
}
copyright {
notice
status
}
createdAt
creator {
__typename
name
id
}
currentUserPermissions {
canComment
canDelete
canDownload
canEdit
}
customMetadata {
__typename
property {
name
id
createdAt
defaultValue
creator { id }
dependency { propertyId }
}
... on CustomMetadataValue {
value
}
... on CustomMetadataValues {
values
}
}
description
expiresAt
externalId
id
licenses {
title
id
addByDefault
license
requireConsensus
}
location {
brand {
name
id
}
folder {
name
id
breadcrumbs { id }
}
library {
name
id
}
workspaceProject {
name
id
}
}
modifiedAt
modifier {
__typename
name
id
}
previewBackgroundColor {
alpha
blue
green
red
}
provenance {
certExpiresAt
certIssuedAt
certIssuer
certStatus
certSubject
contentOrigin
}
relatedAssets {
total
page
limit
hasNextPage
items {
__typename
title
id
alternativeText
author
attachments { id }
availability { from }
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
}
revisions {
total
page
limit
hasNextPage
items {
id
createdAt
creator { id }
}
}
status
tags {
source
value
}
targets {
name
id
}
title
variants {
total
page
limit
hasNextPage
items {
filename
downloadUrl
key
}
}
workflowTask {
title
id
description
asset {
__typename
title
id
alternativeText
author
attachments { id }
availability { from }
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
assignedUsers {
__typename
name
id
}
checklistItem {
total
page
limit
hasNextPage
items { id }
}
status {
name
id
enterRules
assignedUsers { id }
checklistPresets { id }
}
}
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
}
}
}
}
```
Raw: [`AssetsRelatedAssets.sdl`](../examples/AssetsRelatedAssets.sdl)
### `asset › relatedAssets`
```graphql
query AssetRelatedAssets {
asset(id: "…") {
... on Audio {
relatedAssets(limit: 25, page: 1) {
items {
__typename
alternativeText
attachments {
name
filename
id
createdAt
downloadUrl
extension
creator {
__typename
name
id
}
modifier {
__typename
name
id
}
}
author
availability {
from
to
}
comments {
total
page
limit
hasNextPage
items {
id
content
createdAt
isResolved
creator { id }
currentUserPermissions { canDelete }
}
}
copyright {
notice
status
}
createdAt
creator {
__typename
name
id
}
currentUserPermissions {
canComment
canDelete
canDownload
canEdit
}
customMetadata {
__typename
property {
name
id
createdAt
defaultValue
creator { id }
dependency { propertyId }
}
... on CustomMetadataValue {
value
}
... on CustomMetadataValues {
values
}
}
description
expiresAt
externalId
id
licenses {
title
id
addByDefault
license
requireConsensus
}
location {
brand {
name
id
}
folder {
name
id
breadcrumbs { id }
}
library {
name
id
}
workspaceProject {
name
id
}
}
modifiedAt
modifier {
__typename
name
id
}
previewBackgroundColor {
alpha
blue
green
red
}
provenance {
certExpiresAt
certIssuedAt
certIssuer
certStatus
certSubject
contentOrigin
}
relatedAssets {
total
page
limit
hasNextPage
items {
__typename
title
id
alternativeText
author
attachments { id }
availability { from }
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
}
revisions {
total
page
limit
hasNextPage
items {
id
createdAt
creator { id }
}
}
status
tags {
source
value
}
targets {
name
id
}
title
variants {
total
page
limit
hasNextPage
items {
filename
downloadUrl
key
}
}
workflowTask {
title
id
description
asset {
__typename
title
id
alternativeText
author
attachments { id }
availability { from }
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
assignedUsers {
__typename
name
id
}
checklistItem {
total
page
limit
hasNextPage
items { id }
}
status {
name
id
enterRules
assignedUsers { id }
checklistPresets { id }
}
}
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
}
}
}
}
```
Raw: [`AssetRelatedAssets.sdl`](../examples/AssetRelatedAssets.sdl)
### `library › assets`
```graphql
query LibraryAssets {
library(id: "…") {
assets(limit: 25, page: 1) {
items {
__typename
alternativeText
attachments {
name
filename
id
createdAt
downloadUrl
extension
creator {
__typename
name
id
}
modifier {
__typename
name
id
}
}
author
availability {
from
to
}
comments {
total
page
limit
hasNextPage
items {
id
content
createdAt
isResolved
creator { id }
currentUserPermissions { canDelete }
}
}
copyright {
notice
status
}
createdAt
creator {
__typename
name
id
}
currentUserPermissions {
canComment
canDelete
canDownload
canEdit
}
customMetadata {
__typename
property {
name
id
createdAt
defaultValue
creator { id }
dependency { propertyId }
}
... on CustomMetadataValue {
value
}
... on CustomMetadataValues {
values
}
}
description
expiresAt
externalId
id
licenses {
title
id
addByDefault
license
requireConsensus
}
location {
brand {
name
id
}
folder {
name
id
breadcrumbs { id }
}
library {
name
id
}
workspaceProject {
name
id
}
}
modifiedAt
modifier {
__typename
name
id
}
previewBackgroundColor {
alpha
blue
green
red
}
provenance {
certExpiresAt
certIssuedAt
certIssuer
certStatus
certSubject
contentOrigin
}
relatedAssets {
total
page
limit
hasNextPage
items {
__typename
title
id
alternativeText
author
attachments { id }
availability { from }
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
}
revisions {
total
page
limit
hasNextPage
items {
id
createdAt
creator { id }
}
}
status
tags {
source
value
}
targets {
name
id
}
title
variants {
total
page
limit
hasNextPage
items {
filename
downloadUrl
key
}
}
workflowTask {
title
id
description
asset {
__typename
title
id
alternativeText
author
attachments { id }
availability { from }
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
assignedUsers {
__typename
name
id
}
checklistItem {
total
page
limit
hasNextPage
items { id }
}
status {
name
id
enterRules
assignedUsers { id }
checklistPresets { id }
}
}
... on Audio {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Document {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on EmbeddedContent {
previewUrl
thumbnailUrl
isDecorative
}
... on File {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Image {
previewUrl
thumbnailUrl
filename
downloadUrl
}
... on Video {
previewUrl
thumbnailUrl
filename
bitrate
}
}
}
}
}
```
Raw: [`LibraryAssets.sdl`](../examples/LibraryAssets.sdl)