Jump to Content

v1.0

API Reference

v1.0API Reference

All

Pages

Start typing to search…

OAuth 2.0

Authorize endpoint
- Authorize endpointget
Token endpoint
- Using an authorization code or the refresh tokenpost
Scopes
- Retrieve scopesget

Access Rights API

/api/content_access/metaproperties/{metaproperty_id}

Analytics API

Asset Usage V2
- Retrieve asset viewsget
Asset Usage V1
Search Usage
User Usage
- User Loginget
- User Activityget
Collection Usage
- Retrieve collection view eventsget
- Retrieve collection view events in CSV formatget
Reporting
- Retrieve asset reportsget
- Retrieve specific asset reportget
Historical Data
- Retrieve historical data in CSV formatget

Account API

/api/v4/account
- Retrieve account informationget
/api/v4/account/derivatives
- Retrieve derivativesget

Antivirus API

/v7/quarantine/v1/assets
- Retrieve a list of quarantined assetsget
/v7/quarantine/v1/assets/{asset_id}
- Retrieve a quarantined asset by idget
- Update review status by idput
/v7/quarantine/v1/antivirus-audit
- Update review status by list of asset Idspost

Download API

/api/v4/media/{id}/download
- Retrieve asset download locationget
/api/v4/media/{id}/{version}/download
- Retrieve asset version download locationget
/api/v4/media/{id}/download/{itemId}
- Retrieve specific asset item download locationget

Upload Assets API

/api/upload/endpoint
- Get closest AmazonS3 upload endpointget
/api/upload/init
- Initialise uploadpost
/api/v4/upload/{id}
- Register uploaded chunkpost
/api/v4/upload/poll
- Retrieve poll stateget
/api/v4/media/save/{importId}
- Save as a new assetpost
/api/v4/media/{id}/save/{importId}
- Save as a new asset versionpost

Asset Usage API

Asset Usage
Asset Usage Sync
- Sync asset usagepost

Asset Management API

/api/v4/media/
- Retrieve assetsget
/api/v4/media/{id}
/api/media/options
- Add metaproperty optionspost
- Delete metaproperty optionsdel

Brands

/api/v4/brands/
- Retrieve brandsget
/api/1/assets/similarity-search/

Brandstore API

/api/store/order/
- Retrieve ordersget
/api/store/order/{id}/
- Retrieve specific order infoget
/api/store/order/{id}/products
- Retrieve specific order by idget
- Modify orderpost
/api/store/orderproducts/{id}
- Retrieve specific orderlineget
- Modify orderlinepatch

Collections API

/api/v4/collections
- Retrieve collectionsget
- Create collectionpost
/api/v4/collections/{id}
/api/v4/collections/{id}/share
- Share collectionpost
/api/v4/collections/{id}/media

Dynamic Asset Transformations API

/transform/{id}/{name}
- Generate dynamic asset transformationget

Groups

/api/groups/list/
- Retrieve groupsget

Metaproperty Operations

Metaproperty operations
- Retrieve metapropertiesget
- Create metapropertypost
Specific metaproperty operations

Metaproperty Options and Operations API

Metaproperty options operations
Specific metaproperty option operations
- Modify metaproperty optionpost
- Delete metaproperty optiondel
Retrieve all metaproperty option dependencies globally
- Retrieve global option dependenciesget
Retrieve all metaproperty option dependencies for a metaproperty
- Retrieve metaproperty option dependenciesget
Retrieve options a metaproperty option depends on
- Retrieve specific metaproperty option dependenciesget
Manage ungrouped metaproperty option dependencies
- Add a dependencypost
- Delete a dependencydel
Create metaproperty option dependency group
- Create dependency grouppost
Specific metaproperty option dependency group operations
- Modify dependency grouppost
Manage option dependency in dependency group
- Add a dependency option to a grouppost
- Remove a dependency option from a groupdel

Product Layer Metaproperties API

/api/pim/metaproperties
- Retrieve metapropertiesget
/api/pim/metaproperties/{id}
- Retrieve specific metapropertyget
/api/pim/metaproperties/{id}/options
- Retrieve metaproperty optionsget
/api/pim/metapropertyoptions/{id}
- Modify metaproperty optionput

Security Roles

/api/v4/profiles/
- Retrieve security profilesget
/api/v4/profiles/{id}
- Retrieve specific security profileget

Smartfilters API

/api/v4/smartfilters
- Retrieve smartfiltersget

Tags API

/api/v4/tags
- Retrieve tagsget
/api/v4/tags/{id}/media
- Add tag to assetspost
- Remove tag from assetsdel

Trash API

/api/trash/media
- Retrieve recently removed assetsget

Users

/api/v4/users/
- Retrieve usersget
- Create userpost
/api/v4/users/{id}
/api/v4/currentUser/
- Retrieve current userget

Workflow Campaigns API

/api/workflow/campaigns
- Retrieve campaignsget
- Create campaignpost
/api/workflow/campaigns/{id}

Workflow Jobs API

/api/workflow/presets/job/{id}
- Retrieve specific job presetget
/api/workflow/jobs
- Retrieve jobsget
- Create jobpost
/api/workflow/campaigns/{id}/jobs
- Retrieve the jobs of a specific campaignget
/api/workflow/jobs/{id}
/api/workflow/jobs/{id}/media
- Retrieve media of specific jobget
/api/workflow/jobs/{id}/stages
- Retrieve stages of specific jobget
/api/workflow/jobs/{id}/finish
- Finish jobpatch
/workflow-jobs/{id}/upload
- Upload a file to a workflow jobpost

Workflow Metaproperties API

/api/workflow/metaproperties
- Retrieve metapropertiesget
/api/workflow/metaproperties/{id}
- Retrieve specific metapropertyget

Workflow Users and Groups API

/api/workflow/users/
- Retrieve usersget
/api/workflow/users/{id}
- Retrieve specific userget
/api/workflow/groups/
- Retrieve groupsget
- Create grouppost
/api/workflow/groups/{id}

Adaptive Video Streaming API

/api/1/assets/{asset_id}/public-links
- Get public links for an assetget

TEA - Public API

document
- getDocumentget

Webhooks API

/api/v7/webhooks/public/api/subscriptions{id}

Similar Assets Search

/api/1/assets/similarity-search/
- Search for similar assetspost

Modern Stack File Upload

Step 1
- Prepare the uploadpost
Step 2
- Upload a file chunkpost
Step 3
- Finalize the uploadpost

Upload Assets API Steps 1 and 2

Step 1
Step 2

Taxonomy

Options V1
- /api/1/taxonomy/metaproperties/{metapropertyId}/optionsget

Derivative Presets API

/api/1/derivative-presets/
- Retrieve all configured derivative presets.get
/api/1/derivative-presets/{preset_id}
- Retrieve a specific configured derivative preset.get

automation-workflow-svc API

Automation Workflow Rules
Automation Workflow Triggers
- List Automation Workflow Triggersget
Automation Workflow Conditions
- List Automation Workflow Conditionsget
Automation Workflow Actions
- List Automation Workflow Actionsget

Group Upload Assets API Steps

Step 1 Get closest AmazonS3 upload endpoint
- GetclosestAmazonS3uploadendpointget
Step 2 Initialise upload
- initialiseUploadpost
Step 3A Upload file in chunks
- Uploadfileinchunkspost
Step 3B Register uploaded chunk
- registerUploadedChunkpost
Step 4A Finalise uploaded file
- Step4AFinaliseanuploadedfilepost
Step 4B Finalize and save an additional uploaded file as a new asset.
- finalizeAdditionalFilepost
Step 5 Poll for processing status
- Retrievepollstateget
Step 6A Save as a new asset
- Saveasanewassetpost
Step 6B Save uploaded file to existing asset
- Saveuploadedfiletoexistingassetpost

Metaproperty Options and Operations API TEST

Metaproperty options operations
Specific metaproperty option operations
- Modify metaproperty optionpost
- Delete metaproperty optiondel
Retrieve all metaproperty option dependencies globally
- Retrieve global option dependenciesget
Retrieve all metaproperty option dependencies for a metaproperty
- Retrieve metaproperty option dependenciesget
Retrieve options a metaproperty option depends on
- Retrieve specific metaproperty option dependenciesget
Manage ungrouped metaproperty option dependencies
- Add a dependencypost
- Delete a dependencydel
Create metaproperty option dependency group
- Create dependency grouppost
Specific metaproperty option dependency group operations
- Modify dependency grouppost
Manage option dependency in dependency group
- Add a dependency option to a grouppost
- Remove a dependency option from a groupdel

Powered by

Edit Automation Workflow Rule

put https://example.com/rules/{ruleId}

Edit an existing automation workflow rule.

Language

Credentials

Bearer

Click Try It! to start a request and see the response here!