Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
/api/1/assets/similarity-search/
Search
All
Pages
Start typing to search…
JUMP TO
OAuth 2.0
Authorize endpoint
Authorize endpoint
get
Token endpoint
Using an authorization code or the refresh token
post
Scopes
Retrieve scopes
get
Access Rights API
/api/content_access/metaproperties/{metaproperty_id}
Retrieve metaproperty access
get
Create metaproperty access
post
Delete metaproperty access
del
Analytics API
Asset Usage V2
Retrieve asset views
get
Asset Usage V1
Retrieve asset view events
get
Retrieve asset download events
get
Retrieve asset download events
get
Retrieve asset creation events
get
Retrieve asset archive events
get
Retrieve removed asset events
get
Retrieve all events performed in a given asset
get
Search Usage
Retrieve search execution events
get
Retrieve search keyword events
get
Retrieve search keyword events in CSV format
get
User Usage
User Login
get
User Activity
get
Collection Usage
Retrieve collection view events
get
Retrieve collection view events in CSV format
get
Reporting
Retrieve asset reports
get
Retrieve specific asset report
get
Historical Data
Retrieve historical data in CSV format
get
Account API
/api/v4/account
Retrieve account information
get
/api/v4/account/derivatives
Retrieve derivatives
get
Antivirus API
/v7/quarantine/v1/assets
Retrieve a list of quarantined assets
get
/v7/quarantine/v1/assets/{asset_id}
Retrieve a quarantined asset by id
get
Update review status by id
put
/v7/quarantine/v1/antivirus-audit
Update review status by list of asset Ids
post
Download API
/api/v4/media/{id}/download
Retrieve asset download location
get
/api/v4/media/{id}/{version}/download
Retrieve asset version download location
get
/api/v4/media/{id}/download/{itemId}
Retrieve specific asset item download location
get
Upload Assets API
/api/upload/endpoint
Get closest AmazonS3 upload endpoint
get
/api/upload/init
Initialise upload
post
/api/v4/upload/{id}
Register uploaded chunk
post
/api/v4/upload/poll
Retrieve poll state
get
/api/v4/media/save/{importId}
Save as a new asset
post
/api/v4/media/{id}/save/{importId}
Save as a new asset version
post
Upload Assets API Steps
Step 1
Get closest AmazonS3 upload endpoint
get
Step 2
Initialise upload
post
Step 3
Register uploaded chunk
post
Step 4
Retrieve poll state
get
Step 5
Save as a new asset
post
Step 6
Save as a new asset version
post
Asset Usage API
Asset Usage
Retrieve asset usage
get
Create asset usage
post
Delete asset usage
del
Asset Usage Sync
Sync asset usage
post
Asset Management API
/api/v4/media/
Retrieve assets
get
/api/v4/media/{id}
Retrieve specific asset
get
Modify asset
post
Delete asset
del
/api/media/options
Add metaproperty options
post
Delete metaproperty options
del
Brands
/api/v4/brands/
Retrieve brands
get
/api/1/assets/similarity-search/
Brandstore API
/api/store/order/
Retrieve orders
get
/api/store/order/{id}/
Retrieve specific order info
get
/api/store/order/{id}/products
Retrieve specific order by id
get
Modify order
post
/api/store/orderproducts/{id}
Retrieve specific orderline
get
Modify orderline
patch
Collections API
/api/v4/collections
Retrieve collections
get
Create collection
post
/api/v4/collections/{id}
Retrieve specific collection
get
Modify collection
post
Delete collection
del
/api/v4/collections/{id}/share
Share collection
post
/api/v4/collections/{id}/media
Retrieve the assets of a specific collection
get
Add assets to a collection
post
Remove assets from a collection
del
Dynamic Asset Transformations API
/transform/{id}/{name}
Generate dynamic asset transformation
get
Groups
/api/groups/list/
Retrieve groups
get
Metaproperty Operations
Metaproperty operations
Retrieve metaproperties
get
Create metaproperty
post
Specific metaproperty operations
Retrieve specific metaproperty
get
Modify metaproperty
post
Delete metaproperty
del
Metaproperty Options API
Metaproperty options operations
Retrieve metaproperty options by ids
get
Retrieve metaproperty options
get
Create metaproperty option
post
Specific metaproperty option operations
Modify metaproperty option
post
Delete metaproperty option
del
Retrieve all metaproperty option dependencies globally
Retrieve global option dependencies
get
Retrieve all metaproperty option dependencies for a metaproperty
Retrieve metaproperty option dependencies
get
Retrieve options a metaproperty option depends on
Retrieve specific metaproperty option dependencies
get
Manage ungrouped metaproperty option dependencies
Add a dependency
post
Delete a dependency
del
Create metaproperty option dependency group
Create dependency group
post
Specific metaproperty option dependency group operations
Modify dependency group
post
Manage option dependency in dependency group
Add a dependency option to a group
post
Remove a dependency option from a group
del
Product Layer Metaproperties API
/api/pim/metaproperties
Retrieve metaproperties
get
/api/pim/metaproperties/{id}
Retrieve specific metaproperty
get
/api/pim/metaproperties/{id}/options
Retrieve metaproperty options
get
/api/pim/metapropertyoptions/{id}
Modify metaproperty option
put
Security Roles
/api/v4/profiles/
Retrieve security profiles
get
/api/v4/profiles/{id}
Retrieve specific security profile
get
Smartfilters API
/api/v4/smartfilters
Retrieve smartfilters
get
Tags API
/api/v4/tags
Retrieve tags
get
/api/v4/tags/{id}/media
Add tag to assets
post
Remove tag from assets
del
Trash API
/api/trash/media
Retrieve recently removed assets
get
Users
/api/v4/users/
Retrieve users
get
Create user
post
/api/v4/users/{id}
Retrieve specific user
get
Modify user
post
Delete user
del
/api/v4/currentUser/
Retrieve current user
get
Workflow Campaigns API
/api/workflow/campaigns
Retrieve campaigns
get
Create campaign
post
/api/workflow/campaigns/{id}
Retrieve specific campaign
get
Modify campaign
put
Delete campaign
del
Close campaign
post
Workflow Jobs API
/api/workflow/presets/job/{id}
Retrieve specific job preset
get
/api/workflow/jobs
Retrieve jobs
get
Create job
post
/api/workflow/campaigns/{id}/jobs
Retrieve the jobs of a specific campaign
get
/api/workflow/jobs/{id}
Retrieve specific job
get
Modify job
put
Delete job
del
/api/workflow/jobs/{id}/media
Retrieve media of specific job
get
/api/workflow/jobs/{id}/stages
Retrieve stages of specific job
get
/api/workflow/jobs/{id}/finish
Finish job
patch
/workflow-jobs/{id}/upload
Upload a file to a workflow job
post
Workflow Metaproperties API
/api/workflow/metaproperties
Retrieve metaproperties
get
/api/workflow/metaproperties/{id}
Retrieve specific metaproperty
get
Workflow Users and Groups API
/api/workflow/users/
Retrieve users
get
/api/workflow/users/{id}
Retrieve specific user
get
/api/workflow/groups/
Retrieve groups
get
Create group
post
/api/workflow/groups/{id}
Retrieve specific group
get
Modify group
put
Delete group
del
Adaptive Video Streaming API
/api/1/assets/{asset_id}/public-links
Get public links for an asset
get
TEA - Public API
document
getDocument
get
Webhooks API
/api/v7/webhooks/public/api/subscriptions{id}
Create a Webhook Configuration
post
Update a Webhook Configuration
put
Patch a Webhook Configuration
patch
Delete a Webhook Configuration
del
Similar Assets Search
/api/1/assets/similarity-search/
Search for similar assets
post
Modern Stack File Upload
Step 1
Prepare the upload
post
Step 2
Upload a file chunk
post
Step 3
Finalize the upload
post
Upload Assets API Steps 1 and 2
Step 1
Get closest AmazonS3 upload endpoint
get
Step 2
Initialise upload
post
Powered by
/api/1/assets/similarity-search/
