/typeface-assets | Type: Application | PCID required: Yes
Tools
typeface_assets_create_asset_in_asset_catalog
Create Asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
assetCatalogId | integer | Yes | — | assetCatalogId |
content | string | No | — | File to be uploaded. Either the contentUrl or content field should be passed in a single request |
contentType | string | No | — | contentType |
contentUrl | string | No | — | URL from where the content can be downloaded. This should be a pre-signed url |
name | string | No | — | name |
type | string | No | — | type |
typeface_assets_create_asset_in_project
Project - Create Asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
content | string | No | — | File to be uploaded. Either the contentUrl or content field should be passed in a single request |
contentType | string | No | — | contentType |
contentUrl | string | No | — | URL from where the content can be downloaded. This should be a pre-signed url |
name | string | No | — | name |
type | string | No | — | type |
typeface_assets_create_brand_kit_in_account
Create Brand Kit Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
name | string | No | — | name |
workspaceSubType | string | No | — | workspaceSubType |
typeface_assets_create_stylein_brandkit
Create Brand-kit style Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
brandKitId | integer | Yes | — | Unique identifier for the specific brand-kit |
styleType | string | Yes | — | Style type of the brand kit |
name | string | No | — | name |
subType | string | No | — | subType |
typeface_assets_create_tags
Create Tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the account |
tags | any[] | Yes | — | List of tags to create |
typeface_assets_delete_asset_in_asset_catalog
Delete Asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
assetCatalogId | integer | Yes | — | assetCatalogId |
assetId | integer | Yes | — | Unique identifier for the specific asset |
typeface_assets_delete_asset_in_project
Project - Delete Asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
assetId | integer | Yes | — | Unique identifier for the specific asset |
typeface_assets_delete_brand_kit_in_account
Delete Brand Kit Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
brandKitId | integer | Yes | — | Unique identifier for the specific brand-kit |
typeface_assets_delete_tag
Delete Tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the account |
tagId | integer | Yes | — | Unique identifier for the tag to delete |
typeface_assets_get_asset_in_asset_catalog
Get Asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
assetCatalogId | integer | Yes | — | assetCatalogId |
assetId | integer | Yes | — | Unique identifier for the specific asset |
typeface_assets_get_asset_in_project
Project - Get Asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
assetId | integer | Yes | — | Unique identifier for the specific asset |
typeface_assets_get_metadata
Get Metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
assetCatalogId | integer | Yes | — | Unique identifier for the specific workspace |
assetId | integer | Yes | — | Unique identifier for the specific asset |
typeface_assets_get_metadata_of_project_assets
Project - Get Metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
assetId | integer | Yes | — | Unique identifier for the specific asset |
typeface_assets_get_stylein_brandkit
Get Brand-kit styles Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
brandKitId | integer | Yes | — | Unique identifier for the specific brand-kit |
styleType | string | Yes | — | Style type of the brand kit |
typeface_assets_get_tag
Get Tag by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the account |
tagId | integer | Yes | — | Unique identifier for the tag |
typeface_assets_patch_metadata
Patch Metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
assetCatalogId | integer | Yes | — | Unique identifier for the specific workspace |
assetId | integer | Yes | — | Unique identifier for the specific asset |
operations | any[] | Yes | — | operations |
typeface_assets_patch_metadata_of_project_assets
Project - Patch Metadata Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
assetId | integer | Yes | — | Unique identifier for the specific asset |
operations | any[] | Yes | — | operations |
typeface_assets_patch_tag
Patch Tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the account |
tagId | integer | Yes | — | Unique identifier for the tag |
operations | any[] | No | — | operations |
typeface_assets_query_assets_in_asset_catalog
List Assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
assetCatalogId | integer | Yes | — | assetCatalogId |
contentType | string | No | — | contentType |
typeface_assets_query_assets_in_project
Project - List Assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
contentType | string | No | — | Allowed values are ‘IMAGE’ and ‘FILE’ |
typeface_assets_query_brands_in_account
List Brand Kits Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
typeface_assets_search_assets
Search Assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
assetSubTypes | any[] | No | — | List of asset sub-types to filter the search results. |
assetType | string | No | — | assetType |
collections | any[] | No | — | List of collection IDs to filter the search results. |
cursor | string | No | — | Cursor for pagination. |
limit | integer | No | — | limit |
mediaTypes | any[] | No | — | Media types to filter the search results. Defaults to [DEFAULT] is not specified any |
query | string | No | — | Natural language search query. When provided the search honors the query, if not provided anything; all assets match. |
referencedBy | any[] | No | — | List of entity types that reference the assets. Currently PRODUCT is only supported. |
relevance | number | No | — | relevance |
searchScope | string | No | — | Scope of the search. Defaults to ORG if not provided. |
tags | any[] | No | — | List of tags to filter the search results. |
thumbnailProperties | object | No | — | Properties for generating thumbnails in the search results. |
workspaceId | string | No | — | Project Id or Asset librarary Id |
typeface_assets_search_tags
Search Tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the account |
cursor | string | No | — | Cursor for pagination. |
limit | integer | No | — | Maximum number of tags to return. |
query | string | No | — | Search 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. |
status | string | No | — | Filter 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
brandKitId | integer | Yes | — | Unique identifier for the specific brand-kit |
styleId | integer | Yes | — | Unique identifier for the specific brand-kit style |
notificationEmail | string | Yes | — | notificationEmail |
typeface_assets_update_asset_in_asset_catalog
Update Asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
assetCatalogId | integer | Yes | — | assetCatalogId |
assetId | integer | Yes | — | Unique identifier for the specific asset |
content | string | No | — | File to be uploaded. Either the contentUrl or content field should be passed in a single request |
contentType | string | No | — | contentType |
contentUrl | string | No | — | URL from where the content can be downloaded. This should be a pre-signed url |
name | string | No | — | name |
typeface_assets_update_asset_in_project
Project - Update Asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
projectId | integer | Yes | — | Unique identifier for the specific project |
assetId | integer | Yes | — | Unique identifier for the specific asset |
content | string | No | — | File to be uploaded. Either the contentUrl or content field should be passed in a single request |
contentType | string | No | — | contentType |
contentUrl | string | No | — | URL from where the content can be downloaded. This should be a pre-signed url |
name | string | No | — | name |
typeface_assets_upload_image_in_brand_kit_style
Update or Manage Brand-kit style Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | Unique identifier for the specific team |
brandKitId | integer | Yes | — | Unique identifier for the specific brand-kit |
styleType | string | Yes | — | Style type of the brand kit |
styleId | integer | Yes | — | Unique identifier for the specific brand-kit style |
content | string | No | — | File to be uploaded. Either the contentUrl or content field should be passed in a single request |
contentUrl | string | No | — | URL from where the content can be downloaded. This should be a pre-signed url |

