Skip to main content
Server path: /typeface-assets | Type: Application | PCID required: Yes

Tools


typeface_assets_create_asset_in_asset_catalog

Create Asset Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
assetCatalogIdintegerYesassetCatalogId
contentstringNoFile to be uploaded. Either the contentUrl or content field should be passed in a single request
contentTypestringNocontentType
contentUrlstringNoURL from where the content can be downloaded. This should be a pre-signed url
namestringNoname
typestringNotype

typeface_assets_create_asset_in_project

Project - Create Asset Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
projectIdintegerYesUnique identifier for the specific project
contentstringNoFile to be uploaded. Either the contentUrl or content field should be passed in a single request
contentTypestringNocontentType
contentUrlstringNoURL from where the content can be downloaded. This should be a pre-signed url
namestringNoname
typestringNotype

typeface_assets_create_brand_kit_in_account

Create Brand Kit Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
namestringNoname
workspaceSubTypestringNoworkspaceSubType

typeface_assets_create_stylein_brandkit

Create Brand-kit style Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
brandKitIdintegerYesUnique identifier for the specific brand-kit
styleTypestringYesStyle type of the brand kit
namestringNoname
subTypestringNosubType

typeface_assets_create_tags

Create Tags Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the account
tagsany[]YesList of tags to create

typeface_assets_delete_asset_in_asset_catalog

Delete Asset Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
assetCatalogIdintegerYesassetCatalogId
assetIdintegerYesUnique identifier for the specific asset

typeface_assets_delete_asset_in_project

Project - Delete Asset Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
projectIdintegerYesUnique identifier for the specific project
assetIdintegerYesUnique identifier for the specific asset

typeface_assets_delete_brand_kit_in_account

Delete Brand Kit Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
brandKitIdintegerYesUnique identifier for the specific brand-kit

typeface_assets_delete_tag

Delete Tag Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the account
tagIdintegerYesUnique identifier for the tag to delete

typeface_assets_get_asset_in_asset_catalog

Get Asset Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
assetCatalogIdintegerYesassetCatalogId
assetIdintegerYesUnique identifier for the specific asset

typeface_assets_get_asset_in_project

Project - Get Asset Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
projectIdintegerYesUnique identifier for the specific project
assetIdintegerYesUnique identifier for the specific asset

typeface_assets_get_metadata

Get Metadata Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
assetCatalogIdintegerYesUnique identifier for the specific workspace
assetIdintegerYesUnique identifier for the specific asset

typeface_assets_get_metadata_of_project_assets

Project - Get Metadata Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
projectIdintegerYesUnique identifier for the specific project
assetIdintegerYesUnique identifier for the specific asset

typeface_assets_get_stylein_brandkit

Get Brand-kit styles Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
brandKitIdintegerYesUnique identifier for the specific brand-kit
styleTypestringYesStyle type of the brand kit

typeface_assets_get_tag

Get Tag by ID Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the account
tagIdintegerYesUnique identifier for the tag

typeface_assets_patch_metadata

Patch Metadata Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
assetCatalogIdintegerYesUnique identifier for the specific workspace
assetIdintegerYesUnique identifier for the specific asset
operationsany[]Yesoperations

typeface_assets_patch_metadata_of_project_assets

Project - Patch Metadata Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
projectIdintegerYesUnique identifier for the specific project
assetIdintegerYesUnique identifier for the specific asset
operationsany[]Yesoperations

typeface_assets_patch_tag

Patch Tag Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the account
tagIdintegerYesUnique identifier for the tag
operationsany[]Nooperations

typeface_assets_query_assets_in_asset_catalog

List Assets Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
assetCatalogIdintegerYesassetCatalogId
contentTypestringNocontentType

typeface_assets_query_assets_in_project

Project - List Assets Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
projectIdintegerYesUnique identifier for the specific project
contentTypestringNoAllowed values are ‘IMAGE’ and ‘FILE’

typeface_assets_query_brands_in_account

List Brand Kits Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team

typeface_assets_search_assets

Search Assets Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
assetSubTypesany[]NoList of asset sub-types to filter the search results.
assetTypestringNoassetType
collectionsany[]NoList of collection IDs to filter the search results.
cursorstringNoCursor for pagination.
limitintegerNolimit
mediaTypesany[]NoMedia types to filter the search results. Defaults to [DEFAULT] is not specified any
querystringNoNatural language search query. When provided the search honors the query, if not provided anything; all assets match.
referencedByany[]NoList of entity types that reference the assets. Currently PRODUCT is only supported.
relevancenumberNorelevance
searchScopestringNoScope of the search. Defaults to ORG if not provided.
tagsany[]NoList of tags to filter the search results.
thumbnailPropertiesobjectNoProperties for generating thumbnails in the search results.
workspaceIdstringNoProject Id or Asset librarary Id

typeface_assets_search_tags

Search Tags Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the account
cursorstringNoCursor for pagination.
limitintegerNoMaximum number of tags to return.
querystringNoSearch query string. If a tag has child tags, searching for it also returns all tags under it. When omitted or empty, all tags are returned.
statusstringNoFilter tags by status. When omitted, defaults to ACTIVE. Use PENDING to list newly discovered tag candidates that have not yet been reviewed.

typeface_assets_train_brand_kit_imagestyle

Train Brand-kit image style Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
brandKitIdintegerYesUnique identifier for the specific brand-kit
styleIdintegerYesUnique identifier for the specific brand-kit style
notificationEmailstringYesnotificationEmail

typeface_assets_update_asset_in_asset_catalog

Update Asset Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
assetCatalogIdintegerYesassetCatalogId
assetIdintegerYesUnique identifier for the specific asset
contentstringNoFile to be uploaded. Either the contentUrl or content field should be passed in a single request
contentTypestringNocontentType
contentUrlstringNoURL from where the content can be downloaded. This should be a pre-signed url
namestringNoname

typeface_assets_update_asset_in_project

Project - Update Asset Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
projectIdintegerYesUnique identifier for the specific project
assetIdintegerYesUnique identifier for the specific asset
contentstringNoFile to be uploaded. Either the contentUrl or content field should be passed in a single request
contentTypestringNocontentType
contentUrlstringNoURL from where the content can be downloaded. This should be a pre-signed url
namestringNoname

typeface_assets_upload_image_in_brand_kit_style

Update or Manage Brand-kit style Parameters:
ParameterTypeRequiredDefaultDescription
accountIdstringYesUnique identifier for the specific team
brandKitIdintegerYesUnique identifier for the specific brand-kit
styleTypestringYesStyle type of the brand kit
styleIdintegerYesUnique identifier for the specific brand-kit style
contentstringNoFile to be uploaded. Either the contentUrl or content field should be passed in a single request
contentUrlstringNoURL from where the content can be downloaded. This should be a pre-signed url