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
Scopes
- Retrieve scopesget
- Retrieve scopesget

Security Roles

Profiles
- Retrieve security profilesget
- Retrieve specific security profileget

Users

Users
- Retrieve usersget
- Create userpost
Users ID
Current User
- Retrieve current userget

Groups

Groups
- Retrieve groupsget

Download API

Media download

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

Smartfilters API

Smartfilters
- Retrieve smartfiltersget

Tags API

Tags

Access Rights API

Access rights

Asset Usage API

Asset Usage
Asset Usage Sync
- Sync asset usagepost

Account API

Account
- Retrieve account informationget
- Retrieve derivativesget

Collections API

Collections
- Retrieve collectionsget
- Create collectionpost
Collections ID
Share collection
- Share collectionpost
Collections assets

Trash API

Trash
- Retrieve recently removed assetsget

Workflow Users and Groups API

Users
- Retrieve usersget
- Retrieve specific userget
Groups

Workflow Metaproperties API

Metaproperties
- Retrieve metapropertiesget
- Retrieve specific metapropertyget

Workflow Campaigns API

Campaigns

Product Layer Metaproperties API

Metaproperties
- Retrieve metapropertiesget
- Retrieve specific metapropertyget
Options
- Retrieve metaproperty optionsget
- Modify metaproperty optionput

Brands

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

Dynamic Asset Transformations API

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

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

TEA - Public API

document
- getDocumentget

Modern Stack File Upload

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

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

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

Workflow Jobs API

Presets
- Retrieve specific job presetget
Jobs
Campaign jobs
- Retrieve the jobs of a specific campaignget
Job media
- Retrieve media of specific jobget
File upload
- Upload a file to a workflow jobpost
Finish
- Finish jobpatch
Job stages
- Retrieve stages of specific jobget

Antivirus API

Quarantine

Brandstore API

Orders

Webhooks API

Configurations

Group Upload Assets API Steps

Step 1 Get closest AmazonS3 upload endpoint
- Get closest Amazon S3 upload endpointget
Step 2 Initialise upload
- Initialise uploadpost
Step 3A Upload file in chunks
- Upload file in chunkspost
Step 3B Register uploaded chunk
- Register uploaded chunkpost
Step 4 EITHER Finalise uploaded file
- Finalise an uploaded filepost
Step 4 OR Finalize and save an additional uploaded file as a new asset.
- Finalize additional filepost
Step 5 Poll for processing status
- Retrieve poll stateget
Step 6 EITHER Save as a new asset
- Save as a new assetpost
Step 6 OR Save uploaded file to existing asset
- Save uploaded file to existing assetpost

Asset Management API

Media
- Retrieve assetsget
Media ID
Media options
- Add metaproperty optionspost
- Delete metaproperty optionsdel

Access Rights and Optiops API

Access rights
Options

Adaptive Video Streaming API

Public links
- Get public links for an assetget

Similar Assets Search API

Search
- Search for similar assetspost

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!