Objects: Assets

GraphQL object types for assets, folders, repositories, video transcoding, and AI image tools in the Amplience GraphQL Management API.

Assets, folders & repositories

Asset

Asset

Implements: Node

Field	Type	Description
id	ID!	The ID of the object
metadata	AssetMetadataConnection!	Returns asset metadata Args: schemaName: String!
assetId	String!	The UUID of the asset
assetRepositoryId	ID	ID of the repository this asset belongs to
assetFolderId	ID	ID of the (sub) folder this asset belongs to
createdDate	DateTime	UTC date the asset was created
status	AssetStatus	Active status
published	Boolean	Published status
filename	String	Filename which represents the asset on the storage system
revisionNumber	Float	Revision number
label	String	Friendly label for the asset, this is what a customer will see
name	String	Unique name for the asset, this is unique across the account which is flattened for the public URL
mimeType	String	Mimetype of the asset
locale	String	Locale (IETF language tag)
localeGroup	String	Name of the locale group the asset belongs to
thumbFile	String	Name of the file used for the thumbnail
file	String	Name of the file on the storage system
thumbUrl	String	Thumbnail URL
tags	[String!]	Tags for the asset
type	AssetType	Type of the asset
workflowAssignedBy	ID	ID of the user who assigned the workflow
workflowAssignedTo	ID	ID of who the workflow is assigned to
workflowAssignedAt	DateTime	Timestamp of when the workflow was assigned
workflowStatus	WorkflowStatus	Workflow status
contents	[ID!]	ID of the contents

AssetFolder

Asset Folder

Implements: Node

Field	Type	Description
id	ID!	The ID of the object
label	String!	Friendly label for the folder
status	String!	Indicates whether the folder is active or inactive
children	[AssetFolder!]!	List of sub-folders
assets	AssetSearchConnection!	Returns assets within the folder Args: before: String, after: String, first: Int, last: Int

AssetMetadata

Asset Metadata

Field	Type	Description
id	ID!
schemaName	String!	The metadata schema name
properties	JSON!	Properties as a key/value pair

AssetRepository

Asset Repository

Implements: Node

Field	Type	Description
id	ID!	The ID of the object
assetFolders	AssetFolderConnection	Returns asset folders Args: before: String, after: String, first: Int, last: Int
imageClassificationEnabled	Boolean	Whether AI image classification is enabled
label	String	Label for the repository
isDefault	Boolean	Whether the repository is the default for asset uploads
assets	AssetSearchConnection!	Returns assets within the asset repository Args: before: String, after: String, first: Int, last: Int

AssetSearchResult

Asset

Field	Type	Description
id	ID!
metadata	AssetMetadataConnection!	Returns asset metadata Args: schemaName: String!
assetId	String!
assetRepositoryId	ID	ID of the repository this asset belongs to
name	String	Unique name for the asset, this is unique across the account which is flattened for the public URL
published	Boolean	Published status
label	String	Friendly label for the asset
filename	String	Filename which represents the asset on the storage system
file	String	Name of the file on the storage system
tags	[String!]	Tags that have been assigned to the asset
status	AssetStatus	Active status
mimeType	String	Mimetype of the asset
createdDate	DateTime	Creation date (ISO 8601)
updatedDate	DateTime	Last update date (ISO 8601)
lastPublishDate	DateTime	Last publish date (ISO 8601)
lastPublishStatus	String	Last publish status
lastSuccessfulPublishDate	DateTime	Last successful publish date (ISO 8601)
lastSuccessfulPublishStatus	String	Last successful publish status
assetFolderId	ID	ID of the (sub) folder this asset belongs to
locale	String	Locale (IETF language tag)
localeGroup	String	Name of the locale group the asset belongs to
thumbFile	String	Name of the file used for the thumbnail
thumbUrl	String	Thumbnail URL
type	AssetType	Type of asset
subType	String	Sub type of asset
workflowAssignedBy	ID	ID of the user who assigned the workflow
workflowAssignedTo	ID	ID of who the workflow is assigned to
workflowAssignedAt	DateTime	Timestamp of when the workflow was assigned
workflowStatus	WorkflowStatus	Workflow status
contents	[ID!]	ID of the contents
revisionNumber	Float	Revision number

Asset operation responses

AssetUpdatedResponse

Implements: Node

Field	Type	Description
id	ID!	The ID of the object
transcodingJobId	String

CreateFolderResponse

Implements: Node

Field	Type	Description
id	ID!	The ID of the object

UpdateAssetMetadataResponse

Implements: Node

Field	Type	Description
id	ID!	The ID of the object

PublishAssetResponse

Field	Type	Description
publishJobId	String!

UnpublishAssetResponse

Field	Type	Description
unpublishJobId	String!

AI image tools

DetectedPointOfInterestInImage

Field	Type	Description
id	String!
label	String!
center	PointOfInterestCoordinate!
bounds	PointOfInterestBounds
outline	[PointOfInterestCoordinate!]

DetectedPointsOfInterestInImage

Field	Type	Description
objects	[DetectedPointOfInterestInImage!]

PointOfInterestBounds

Field	Type	Description
topLeft	PointOfInterestCoordinate!
width	Float!
height	Float!

PointOfInterestCoordinate

Field	Type	Description
x	Float!
y	Float!

MagicEraseImageJob

Implements: Node

Field	Type	Description
id	ID!
magicEraseStatus	MagicEraseImageJobStatus!
imageUrl	String

RemoveBackgroundFromImageResponse

Field	Type	Description
imageUrl	String!

GenerateImagesFromTextResponse

Field	Type	Description
imageUrl	String!

GeneratedCaptionForImage

Field	Type	Description
caption	String!

Video transcoding

VideoTranscodingProfile

Video Transcoding Profile

Implements: Node

Field	Type	Description
id	ID!	The ID of the object
container	String
videoBitRate	Float
videoSizeWidth	String
audioNumberOfChannels	String
audioCopy	Boolean
captionsEnabled	Boolean
description	String
videoAspectMode	String
audioEnabled	Boolean
videoEnabled	Boolean
videoSizeHeight	String
qualityLabel	String
default	Boolean
audioBitRate	String
videoCodec	String
videoInterlace	String
videoOnePass	Boolean
createdDate	DateTime!
videoSpeed	Float
label	String
audioCodec	String
videoKeyFrameInterval	String
captionsLanguage	String
name	String
videoKeyFrameRate	String
videoCopy	Boolean
updatedDate	DateTime!
status	Float
videoFramerate	String
audioNormalise	Boolean

VideoTranscodingJobResponse

Field	Type	Description
transcodingJobId	String!