/bynder-assets | Type: Application | PCID required: Yes
Tools
bynder_assets_add_assets_to_collection
Add assets to a collection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Collection identifier |
data | string | Yes | — | JSON array of asset IDs to add to the collection |
bynder_assets_add_tag_to_assets
Add tag to assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Tag identifier |
data | string | Yes | — | JSON array of asset IDs to tag |
bynder_assets_create_asset_usage
Create asset usage record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
additional | string | No | — | Additional information about the usage |
asset_id | string | Yes | — | Asset identifier |
integration_id | string | Yes | — | Integration identifier |
uri | string | Yes | — | URI where the asset is used |
bynder_assets_create_collection
Create a collection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | Description of the collection |
isPublic | boolean | No | — | Whether the collection is publicly accessible |
name | string | Yes | — | Name of the collection |
bynder_assets_delete_asset
Delete an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Asset identifier |
bynder_assets_delete_asset_usage
Delete asset usage record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
asset_id | string | Yes | — | Asset identifier |
integration_id | string | Yes | — | Integration identifier |
uri | string | Yes | — | URI of the usage to delete |
bynder_assets_delete_collection
Delete a collection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Collection identifier |
bynder_assets_get_asset
Retrieve a specific asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Asset identifier |
versions | boolean | No | — | Include information about the different asset media items including versions |
stats | boolean | No | — | Include views and downloads statistics information |
bynder_assets_get_asset_download_url
Retrieve asset download location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Asset identifier |
bynder_assets_get_asset_item_download_url
Retrieve specific asset item download location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Asset identifier |
itemId | string | Yes | — | Media item identifier for the specific derivative |
bynder_assets_get_asset_public_links
Get public links for an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
asset_id | string | Yes | — | UUID of the asset to retrieve adaptive streaming public links for |
bynder_assets_get_collection
Retrieve a specific collection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Collection identifier |
bynder_assets_list_asset_usage
Retrieve asset usage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
asset_id | string | No | — | Filter by asset identifier |
bynder_assets_list_assets
Retrieve assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
keyword | string | No | — | Search on filenames, tags, extensions, collection names, and other asset properties |
type | string | No | — | Filter by asset type: image, document, audio, video, or 3d |
brandId | string | No | — | Filter by brand identifier |
subBrandId | string | No | — | Filter by sub-brand identifier |
categoryId | string | No | — | Filter by category identifier |
id | string | No | — | Asset identifier to retrieve a single asset from list endpoint |
collectionId | string | No | — | Filter by collection identifier |
propertyOptionId | string | No | — | Comma-separated list of metaproperty option IDs to filter by |
ids | string | No | — | Comma-separated list of asset identifiers to retrieve specific assets |
tags | string | No | — | Comma-separated tag values to filter by |
orientation | string | No | — | Filter by asset orientation |
limited | boolean | No | — | Filter for assets marked as limited usage |
archive | boolean | No | — | Filter for archived assets |
isPublic | boolean | No | — | Filter for publicly marked assets |
dateCreated | string | No | — | Filter assets created after this ISO8601 date |
dateCreatedTo | string | No | — | End date range for dateCreated filter |
dateCreatedOn | string | No | — | Filter assets created on this specific ISO8601 date |
dateModified | string | No | — | Filter assets modified after this ISO8601 date |
dateModifiedTo | string | No | — | End date range for dateModified filter |
dateModifiedOn | string | No | — | Filter assets modified on this specific ISO8601 date |
orderBy | string | No | — | Sort results, e.g. ‘dateCreated desc’, ‘name asc’ |
limit | integer | No | — | Maximum results per page (default 50, max 1000) |
page | integer | No | — | Page number for pagination (default 1) |
count | boolean | No | — | Include count results in response |
total | boolean | No | — | Include total count of matching results |
includeMediaItems | boolean | No | — | Include all media item derivatives per asset |
includeVersionNumber | boolean | No | — | Include the active version number in each asset response |
cursor | string | No | — | Cursor mark from X-Bynder-NextCursor response header for cursor-based pagination |
bynder_assets_list_collection_assets
Retrieve assets of a collection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Collection identifier |
limit | integer | No | — | Maximum results per page |
page | integer | No | — | Page number for pagination |
bynder_assets_list_collections
Retrieve collections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
keyword | string | No | — | Search collections by name or content |
ids | string | No | — | Comma-separated collection IDs to retrieve specific collections |
isPublic | boolean | No | — | Filter by public collections only |
orderBy | string | No | — | Sort results, e.g. ‘dateCreated desc’, ‘name asc’ |
limit | integer | No | — | Maximum results per page (default 50, max 1000) |
page | integer | No | — | Page number for pagination (default 1) |
count | boolean | No | — | Include total count in response |
minCount | integer | No | — | Return only collections with at least this many assets |
bynder_assets_list_tags
Retrieve tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum results per page |
page | integer | No | — | Page number for pagination |
keyword | string | No | — | Search tags by keyword |
orderBy | string | No | — | Sort order for results |
bynder_assets_list_trashed_assets
Retrieve recently removed assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of results to return |
page | integer | No | — | Offset page for paginated results |
dateRemoved | string | No | — | Retrieve assets removed after this ISO8601 date |
field | string | No | — | Field used to sort trash results |
order | string | No | — | Sort direction |
bynder_assets_modify_asset
Modify an asset Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Asset identifier |
archive | boolean | No | — | Set the archived state of the asset |
archiveDate | string | No | — | Archive datetime in ISO8601 format |
brandId | string | No | — | Brand identifier to assign the asset to |
copyright | string | No | — | Copyright information |
datePublished | string | No | — | Publication datetime in ISO8601 format |
description | string | No | — | Asset description |
isPublic | boolean | No | — | Set the public state (WARNING - irreversible once set to true) |
limited | boolean | No | — | Set the limited usage state of the asset |
limitedDate | string | No | — | Limited usage end datetime in ISO8601 format |
metaproperty | object | No | — | Dictionary with metaproperty option values to set on the asset |
name | string | No | — | Name of the asset |
tags | string | No | — | Comma-separated tags (overwrites current tags list) |
watermarkDate | string | No | — | Watermark datetime in ISO8601 format |
bynder_assets_modify_collection
Modify a collection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Collection identifier |
description | string | No | — | Updated description of the collection |
isPublic | boolean | No | — | Whether the collection is publicly accessible |
name | string | No | — | Updated name of the collection |
bynder_assets_remove_assets_from_collection
Remove assets from a collection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Collection identifier |
deleteIds | string | Yes | — | Comma-separated asset IDs to remove from the collection |
bynder_assets_remove_tag_from_assets
Remove tag from assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Tag identifier |
deleteIds | string | Yes | — | Comma-separated asset IDs to remove the tag from |
bynder_assets_search_similar_assets
Search for similar assets Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
assetIds | string[] | No | — | List of asset IDs to search similar assets for (provide one search parameter set only) |
imageData | string | No | — | Base64-encoded image data to use for similarity search |
imageUrl | string | No | — | Public URL of an image to use for similarity search |
textQuery | string | No | — | Text query describing the desired image |
bynder_assets_share_collection
Share a collection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Collection identifier |
collectionOptions | string | No | — | Sharing options |
loginRequired | boolean | No | — | Whether login is required to access the shared collection |
recipients | string | Yes | — | Comma-separated email addresses to share with |

