Assets

Query

asset

Open full page ↗Raw SDL

Retrieve Asset details by Id.

Returns

Asset

Arguments

id:ID!Required: Asset Id.

Response fields

1 selected

Toggle fields to tailor the query and response.

alternativeTextString
attachments[AssetAttachment]
- nameString
- filenameString
- idID!
- createdAtDateTime!
- downloadUrlUrl
- extensionString
- creatorUser!
  - nameString
  - idID!
- modifierUser
  - nameString
  - idID!
authorString
availabilityDateTimeRange!
- fromDateTime
- toDateTime
commentsAssetCommentItems
- totalInt!
- pageInt!
- limitInt!
- hasNextPageBoolean!
- items[AssetComment]
  - idID!
  - contentString!
  - createdAtDateTime!
  - isResolvedBoolean!
  - creatorUser!
    - idID!
  - currentUserPermissionsAssetCommentUserPermissions!
    - canDeleteBoolean!
copyrightCopyright
- noticeString
- statusCopyrightStatus!
createdAtDateTime!
creatorUser!
- nameString
- idID!
currentUserPermissionsAssetUserPermissions!
- canCommentBoolean!
- canDeleteBoolean!
- canDownloadBoolean!
- canEditBoolean!
customMetadata[CustomMetadata!]!
- propertyCustomMetadataProperty!
  - nameString!
  - idID!
  - createdAtDateTime!
  - defaultValueAny
  - creatorUser!
    - idID!
  - dependencyCustomMetadataPropertyDependency
    - propertyIdID!
- … on CustomMetadataValue
  - valueAny
- … on CustomMetadataValues
  - values[Any]!
descriptionString
expiresAtDateTime
externalIdID
idID!
licenses[License]
- titleString!
- idID!
- addByDefaultBoolean!
- licenseString!
- requireConsensusBoolean!
locationAssetLocation!
- brandAssetLocationBrand
  - nameString!
  - idID!
- folderAssetLocationFolder
  - nameString!
  - idID!
  - breadcrumbs[Breadcrumb!]!
    - idID
- libraryAssetLocationLibrary
  - nameString
  - idID!
- workspaceProjectAssetLocationWorkspaceProject
  - nameString
  - idID!
modifiedAtDateTime
modifierUser
- nameString
- idID!
previewBackgroundColorRgbaColor
- alphaPercent!
- blueRgbColorChannel!
- greenRgbColorChannel!
- redRgbColorChannel!
provenanceAssetProvenance
- certExpiresAtDateTime
- certIssuedAtDateTime
- certIssuerString
- certStatusAssetProvenanceCertStatus
- certSubjectString
- contentOriginAssetProvenanceContentOrigin
relatedAssetsAssetItems!
- totalInt!
- pageInt!
- limitInt!
- hasNextPageBoolean!
- items[Asset]
  - titleString!
  - idID!
  - alternativeTextString
  - authorString
  - attachments[AssetAttachment]
    - idID!
  - availabilityDateTimeRange!
    - fromDateTime
  - … on Audio
    - previewUrlUrl!
    - thumbnailUrlUrl
    - filenameString
    - downloadUrlUrl
  - … on Document
    - previewUrlUrl!
    - thumbnailUrlUrl
    - filenameString
    - downloadUrlUrl
  - … on EmbeddedContent
    - previewUrlUrl!
    - thumbnailUrlUrl
    - isDecorativeBoolean!
  - … on File
    - previewUrlUrl!
    - thumbnailUrlUrl
    - filenameString
    - downloadUrlUrl
  - … on Image
    - previewUrlUrl!
    - thumbnailUrlUrl
    - filenameString
    - downloadUrlUrl
  - … on Video
    - previewUrlUrl!
    - thumbnailUrlUrl
    - filenameString
    - bitrateInt!
revisionsAssetRevisionItems!
- totalInt!
- pageInt!
- limitInt!
- hasNextPageBoolean!
- items[AssetRevision!]!
  - idID!
  - createdAtDateTime!
  - creatorUser!
    - idID!
statusAssetStatusType!
tags[Tag]
- sourceTagSource
- valueString!
targets[Target]
- nameString
- idID!
titleString!
variantsAssetVariantItems
- totalInt!
- pageInt!
- limitInt!
- hasNextPageBoolean!
- items[AssetVariant]!
  - filenameString
  - downloadUrlUrl
  - keyID!
workflowTaskWorkflowTask
- titleString
- idID!
- descriptionString
- assetAsset
  - titleString!
  - idID!
  - alternativeTextString
  - authorString
  - attachments[AssetAttachment]
    - idID!
  - availabilityDateTimeRange!
    - fromDateTime
  - … on Audio
    - previewUrlUrl!
    - thumbnailUrlUrl
    - filenameString
    - downloadUrlUrl
  - … on Document
    - previewUrlUrl!
    - thumbnailUrlUrl
    - filenameString
    - downloadUrlUrl
  - … on EmbeddedContent
    - previewUrlUrl!
    - thumbnailUrlUrl
    - isDecorativeBoolean!
  - … on File
    - previewUrlUrl!
    - thumbnailUrlUrl
    - filenameString
    - downloadUrlUrl
  - … on Image
    - previewUrlUrl!
    - thumbnailUrlUrl
    - filenameString
    - downloadUrlUrl
  - … on Video
    - previewUrlUrl!
    - thumbnailUrlUrl
    - filenameString
    - bitrateInt!
- assignedUsers[User]!
  - nameString
  - idID!
- checklistItemWorkflowChecklistItems!
  - totalInt!
  - pageInt!
  - limitInt!
  - hasNextPageBoolean!
  - items[WorkflowChecklistItem]
    - idID!
- statusWorkflowStatus!
  - nameString!
  - idID!
  - enterRules[WorkflowStatusEnterRule]!
  - assignedUsers[User]!
    - idID!
  - checklistPresets[WorkflowChecklistPreset]!
    - idID!
… on Audio
- previewUrlUrl!
- thumbnailUrlUrl
- filenameString
- downloadUrlUrl
… on Document
- previewUrlUrl!
- thumbnailUrlUrl
- filenameString
- downloadUrlUrl
… on EmbeddedContent
- previewUrlUrl!
- thumbnailUrlUrl
- isDecorativeBoolean!
… on File
- previewUrlUrl!
- thumbnailUrlUrl
- filenameString
- downloadUrlUrl
… on Image
- previewUrlUrl!
- thumbnailUrlUrl
- filenameString
- downloadUrlUrl
… on Video
- previewUrlUrl!
- thumbnailUrlUrl
- filenameString
- bitrateInt!

Example

query Asset {
  asset(
    id: 
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "asset": {
      "__typename": "Audio",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Query

Open full page ↗Raw SDL

Retrieve Assets details by Ids.

Returns

[Asset]

Arguments

ids:[ID!]!Required: Asset Ids.

Response fields

1 selected

Toggle fields to tailor the query and response.

Example

query Assets {
  assets(
    ids: []
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "assets": [
      {
        "__typename": "Audio",
        "id": "eyJXXXXXXXX…"
      }
    ]
  }
}

MutationDeprecated

addAssetMetadataFieldValue

Open full page ↗Raw SDL

Add a new relation between an existing Asset and an existing MetadataField with its value. The value will be automatically created and linked to its MetadataField. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

AddAssetMetadataFieldValue

Arguments

input:AddAssetMetadataFieldValueInput!Required: AddAssetMetadataFieldValue input argument.; RequiredassetId: ID!, metadataFieldId: ID!, value: String!

Response fields

1 selected

Toggle fields to tailor the query and response.

Example

mutation AddAssetMetadataFieldValue {
  addAssetMetadataFieldValue(
    input: {
      assetId: 
      metadataFieldId: 
      value: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "addAssetMetadataFieldValue": {
      "__typename": "AddAssetMetadataFieldValue",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

addAssetPreviewImage

Open full page ↗Raw SDL

Add new Asset preview image. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

AddAssetPreviewImage

Arguments

input:AddAssetPreviewImageInput!Required: AddAssetPreviewImage input argument.; RequiredassetId: ID!, fileId: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

jobAssetPreviewProcessingJob!
- assetIdID!

Example

mutation AddAssetPreviewImage {
  addAssetPreviewImage(
    input: {
      assetId: 
      fileId: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "addAssetPreviewImage": {
      "__typename": "AddAssetPreviewImage"
    }
  }
}

Mutation

addAssetRelations

Open full page ↗Raw SDL

Relate existing Assets. The relatedAssetIds input field list is limited to 100 ids per request and cannot contain the same assetId input field value. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

AddAssetRelations

Arguments

input:AddAssetRelationsInput!Required: AddAssetRelations input argument.; RequiredassetId: ID!, relatedAssetIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation AddAssetRelations {
  addAssetRelations(
    input: {
      assetId: 
      relatedAssetIds: []
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "addAssetRelations": {
      "__typename": "AddAssetRelations"
    }
  }
}

Mutation

addAssetTags

Open full page ↗Raw SDL

Add new Asset tags. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

AddAssetTags

Arguments

input:AddAssetTagsInput!Required: AddAssetTags input argument.; Requiredid: ID!; Optionaltags: [TagInput]

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation AddAssetTags {
  addAssetTags(
    input: {
      id: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "addAssetTags": {
      "__typename": "AddAssetTags"
    }
  }
}

Mutation

createAsset

Open full page ↗Raw SDL

Create a new Asset. Requires basic:write scope to be accessible and Project permission level EDIT.

Returns

CreateAsset

Arguments

input:CreateAssetInput!Required: CreateAsset input argument.; RequiredfileId: ID!, title: String!; OptionalalternativeText: String, isDecorative: Boolean, description: String, externalId: ID, copyright: CreateCopyrightInput, tags: [TagInput], skipFileMetadata: Boolean, directory: [String], parentId: ID, availability: DateTimeRangeInput, expiresAt: DateTime, author: String, previewBackgroundColor: RgbaColorInput

Response fields

0 selected

Toggle fields to tailor the query and response.

jobAssetProcessingJob!
- assetIdID!

Example

mutation CreateAsset {
  createAsset(
    input: {
      fileId: 
      title: 
      
      
      
      
      
      
      
      
      
      
      
      
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createAsset": {
      "__typename": "CreateAsset"
    }
  }
}

Mutation

createAssetVariant

Open full page ↗Raw SDL

Create a new AssetVariant. Only supported for assets in icon and logo libraries. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

CreateAssetVariant

Arguments

input:CreateAssetVariantInput!Required: CreateAssetVariant input argument.; RequiredfileId: ID!, assetId: ID!, key: String!

Response fields

0 selected

Toggle fields to tailor the query and response.

jobAssetVariantProcessingJob!
- variantIdID!

Example

mutation CreateAssetVariant {
  createAssetVariant(
    input: {
      fileId: 
      assetId: 
      key: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createAssetVariant": {
      "__typename": "CreateAssetVariant"
    }
  }
}

Mutation

createAssetWorkflowTask

Open full page ↗Raw SDL

Create a new WorkflowTask for an Asset in a given WorkflowStatus. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

CreateAssetWorkflowTask

Arguments

input:CreateAssetWorkflowTaskInput!RequiredBeta: CreateAssetWorkflowTask input argument.; RequiredassetId: ID!, workflowStatusId: ID!; OptionalassigneeUserIds: [ID!], statusEnterMessage: String

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation CreateAssetWorkflowTask {
  createAssetWorkflowTask(
    input: {
      assetId: 
      workflowStatusId: 
      
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createAssetWorkflowTask": {
      "__typename": "CreateAssetWorkflowTask"
    }
  }
}

Mutation

createAttachment

Open full page ↗Raw SDL

Create a new Attachment. Attachments require a valid parent ID string. This mutation currently only supports attachments for parents of Asset type. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

CreateAttachment

Arguments

input:CreateAttachmentInput!Required: CreateAttachment input argument.; RequiredparentId: ID!, fileId: ID!, name: String!; OptionalexternalId: ID

Response fields

0 selected

Toggle fields to tailor the query and response.

jobAttachmentProcessingJob!
- attachmentIdID!

Example

mutation CreateAttachment {
  createAttachment(
    input: {
      parentId: 
      fileId: 
      name: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createAttachment": {
      "__typename": "CreateAttachment"
    }
  }
}

Mutation

createExternalAsset

Open full page ↗Raw SDL

Create a new External Asset from a url. Requires basic:write scope to be accessible and Project permission level EDIT.

Returns

CreateExternalAsset

Arguments

input:CreateExternalAssetInput!Required: CreateExternalAsset input argument.; RequiredprojectId: ID!, url: Url!, title: String!; Optionaldescription: String, width: Int, height: Int, allowInteractions: Boolean, externalId: ID, copyright: CreateCopyrightInput, directory: [String], expiresAt: DateTime, author: String

Response fields

0 selected

Toggle fields to tailor the query and response.

jobAssetProcessingJob!
- assetIdID!

Example

mutation CreateExternalAsset {
  createExternalAsset(
    input: {
      projectId: 
      url: 
      title: 
      
      
      
      
      
      
      
      
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createExternalAsset": {
      "__typename": "CreateExternalAsset"
    }
  }
}

Mutation

deleteAsset

Open full page ↗Raw SDL

Delete an existing Asset. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

DeleteAsset

Arguments

input:DeleteAssetInput!Required: DeleteAsset input argument.; Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation DeleteAsset {
  deleteAsset(
    input: {
      id: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "deleteAsset": {
      "__typename": "DeleteAsset",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

deleteAssetVariant

Open full page ↗Raw SDL

Delete an existing AssetVariant. Only supported for assets in icon and logo libraries. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

DeleteAssetVariant

Arguments

input:DeleteAssetVariantInput!Required: DeleteAssetVariant input argument.; RequiredassetId: ID!, key: String!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation DeleteAssetVariant {
  deleteAssetVariant(
    input: {
      assetId: 
      key: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "deleteAssetVariant": {
      "__typename": "DeleteAssetVariant",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

deleteAttachment

Open full page ↗Raw SDL

Delete an existing Attachment. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

DeleteAttachment

Arguments

input:DeleteAttachmentInput!Required: DeleteAttachment input argument.; Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation DeleteAttachment {
  deleteAttachment(
    input: {
      id: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "deleteAttachment": {
      "__typename": "DeleteAttachment",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

moveAssets

Open full page ↗Raw SDL

Move existing Asset item(s) to the given Library, Workspace or Folder destination. Only moves within the same Library/Workspace are supported by this operation. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

MoveAssets

Arguments

input:MoveAssetsInput!Required: MoveAssets input argument.; RequiredassetIds: [ID!]!, destinationId: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation MoveAssets {
  moveAssets(
    input: {
      assetIds: []
      destinationId: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "moveAssets": {
      "__typename": "MoveAssets"
    }
  }
}

Mutation

removeAssetPreviewImage

Open full page ↗Raw SDL

Remove existing Asset preview image. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

RemoveAssetPreviewImage

Arguments

input:RemoveAssetPreviewImageInput!Required: RemoveAssetPreviewImage input argument.; Requiredid: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation RemoveAssetPreviewImage {
  removeAssetPreviewImage(
    input: {
      id: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeAssetPreviewImage": {
      "__typename": "RemoveAssetPreviewImage"
    }
  }
}

Mutation

removeAssetRelations

Open full page ↗Raw SDL

Remove existing relations between Asset items. The relatedAssetIds input field list is limited to 100 ids per request and cannot contain the same assetId input field value. Requires basic:write scope to be accessible and Asset permission level EDIT.

Beta

Returns

RemoveAssetRelations

Arguments

input:RemoveAssetRelationsInput!RequiredBeta: RemoveAssetRelations input argument.; RequiredassetId: ID!, relatedAssetIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation RemoveAssetRelations {
  removeAssetRelations(
    input: {
      assetId: 
      relatedAssetIds: []
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeAssetRelations": {
      "__typename": "RemoveAssetRelations"
    }
  }
}

Mutation

removeAssetTags

Open full page ↗Raw SDL

Remove existing Asset tags. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

RemoveAssetTags

Arguments

input:RemoveAssetTagsInput!Required: RemoveAssetTags input argument.; Requiredid: ID!; Optionaltags: [TagInput]

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation RemoveAssetTags {
  removeAssetTags(
    input: {
      id: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeAssetTags": {
      "__typename": "RemoveAssetTags"
    }
  }
}

Mutation

replaceAsset

Open full page ↗Raw SDL

Replace an existing Asset. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

ReplaceAsset

Arguments

input:ReplaceAssetInput!Required: ReplaceAsset input argument.; RequiredassetId: ID!, fileId: ID!; OptionalskipFileMetadata: Boolean

Response fields

0 selected

Toggle fields to tailor the query and response.

jobAssetProcessingJob!
- assetIdID!

Example

mutation ReplaceAsset {
  replaceAsset(
    input: {
      assetId: 
      fileId: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "replaceAsset": {
      "__typename": "ReplaceAsset"
    }
  }
}

Mutation

replaceAssetVariant

Open full page ↗Raw SDL

Replace an existing AssetVariant. Only supported for assets in icon and logo libraries. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

ReplaceAssetVariant

Arguments

input:ReplaceAssetVariantInput!Required: ReplaceAssetVariant input argument.; RequiredfileId: ID!, assetId: ID!, key: String!

Response fields

0 selected

Toggle fields to tailor the query and response.

jobAssetVariantProcessingJob!
- variantIdID!

Example

mutation ReplaceAssetVariant {
  replaceAssetVariant(
    input: {
      fileId: 
      assetId: 
      key: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "replaceAssetVariant": {
      "__typename": "ReplaceAssetVariant"
    }
  }
}

Mutation

syncAssetTags

Open full page ↗Raw SDL

Sync Asset tags. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

SyncAssetTags

Arguments

input:SyncAssetTagsInput!Required: SyncAssetTags input argument.; Requiredid: ID!; Optionaltags: [TagInput]

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation SyncAssetTags {
  syncAssetTags(
    input: {
      id: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "syncAssetTags": {
      "__typename": "SyncAssetTags"
    }
  }
}

Mutation

updateAsset

Open full page ↗Raw SDL

Update an existing Asset. Requires basic:write scope to be accessible and Asset permission level EDIT.

Returns

UpdateAsset

Arguments

input:UpdateAssetInput!Required: UpdateAsset input argument.; Requiredid: ID!, data: UpdateAssetDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation UpdateAsset {
  updateAsset(
    input: {
      id: 
      data: {
        
        
        
        
        
        
        
        
        
        
      }
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateAsset": {
      "__typename": "UpdateAsset"
    }
  }
}

Mutation

updateAssets

Open full page ↗Raw SDL

Update many Assets in one call, where each asset carries its own values. Changes apply independently: assets and fields that cannot be updated fail individually without rolling back the rest.

Beta

Returns

UpdateAssets

Arguments

input:UpdateAssetsInput!RequiredBeta: RequiredprojectId: ID!, assets: [AssetUpdateEntryInput!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation UpdateAssets {
  updateAssets(
    input: {
      projectId: 
      assets: [
        {
          id: 
          data: {
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
            
          }
        }
        
      ]
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateAssets": {
      "__typename": "UpdateAssets"
    }
  }
}

Mutation

uploadFile

Open full page ↗Raw SDL

Upload a new file. Requires basic:write scope to be accessible Creates a temporary unique file Id and returns presigned URLs for uploading a binary file in multiple parts. After the upload is completed, this Id can be used (once only) to permanently link the file to a specific type (e.g., Asset, Attachment, Revision) via another mutation. When chunkSize is provided as null (to be the future default), the number of upload parts and thus their corresponding part size will be computed dynamically based on the specified file size, following these rules: - Maxmum of 1000 parts. - For files of 5TB (maximum): 1000 parts of 5GB each. - For files less than 15MB: 1 single part of 15MB. - Otherwise: an inclusive range of [1, 1000] parts of [15MB, 5GB] each.

Returns

UploadFile

Arguments

input:UploadFileInput!Required: UploadFile input argument.; Requiredfilename: String!, size: BigInt!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!
urls[Url]!

Example

mutation UploadFile {
  uploadFile(
    input: {
      filename: 
      size: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "uploadFile": {
      "__typename": "UploadFile",
      "id": "eyJXXXXXXXX…"
    }
  }
}