Version 1.0
Connector Overview: This page documents all 232 actions for the Overcasthqconnector v1.0.
General (2)
GET /v1/assets/{uuid}/metadata/export
/v1/assets/{uuid}/metadata/export
Export metadata for a specific asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the asset whose metadata should be exported. |
|
|
The response format expected from the API (e.g. application/json). |
POST /v1/auth/code
/v1/auth/code
Initiate the authentication code flow to obtain an authorization code.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Account Settings
GET Get list of account settings
/v1/accounts/{uuid}/settings
Get account settings for the account specified in the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Taxonomy field unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Accounts (19)
POST Account create
/v1/accounts
Creates an account based on the provided data in the request body. If the package selected is “Team” or “Pro”, an AWS S3 bucket will be created. If the package selected is “Free”, no new bucket is created in AWS S3 and the default common bucket will be used for that account.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (23)
|
Option Name |
Description |
|---|---|
|
|
Confirmation token |
|
|
Name |
|
|
Sub domain |
|
|
Storage region |
|
|
Storage bucket |
|
|
Package |
|
|
Status |
|
|
Contact name |
|
|
Contact phone |
|
|
Contact email |
|
|
Address 1 |
|
|
Address 2 |
|
|
City |
|
|
County |
|
|
ISO3166-1 Alpha 2 Country code. eg.: IE or US |
|
|
Postal code |
|
|
Is trial |
|
|
Home view |
|
|
Theme change allow |
|
|
Thee default |
|
|
Theme colors |
|
|
Meta title |
|
|
Meta description |
DELETE Delete account email logo
/v1/accounts/{uuid}/logo-email
Deletes a logo which for the email templates for the specified account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete account image background
/v1/accounts/{uuid}/image-background
Delete the account image background for the specified account uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete account image dashboard
/v1/accounts/{uuid}/image-dashboard
Delete the account image dashboard for the specified account uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete account image favicon
/v1/accounts/{uuid}/image-favicon
Delete the account image favicon for the specified account uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete account logo
/v1/accounts/{uuid}/logo
Delete the account logo for the specified account uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete account logo background
/v1/accounts/{uuid}/logo-background
Delete the account logo background for the specified account uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit an account
/v1/accounts/{uuid}
Edit the details for the account with the specified uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (22)
|
Option Name |
Description |
|---|---|
|
|
Name |
|
|
Sub domain |
|
|
Storage region |
|
|
Storage bucket |
|
|
Package |
|
|
Status |
|
|
Contact name |
|
|
Contact phone |
|
|
Contact email |
|
|
Address 1 |
|
|
Address 2 |
|
|
City |
|
|
County |
|
|
ISO3166-1 Alpha 2 Country code. eg.: IE or US |
|
|
Postal code |
|
|
Is trial |
|
|
Home view |
|
|
Theme change allow |
|
|
Thee default |
|
|
Theme colors |
|
|
Meta title |
|
|
Meta description |
GET Get an account details
/v1/accounts/{uuid}
Retrieves details for one account based on the requested uuid parameter from path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an account info
/v1/accounts/info
Retrieves the info for one account based on the requested sub_domain parameter from query.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Accounts subdomain name |
|
|
The response format expected from the API (e.g. application/json). |
GET List accounts
/v1/accounts
List all the available accounts. This can be accessed only by users that have the necessary permissions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Name |
|
|
Keyword |
|
|
Is account trial |
|
|
Start date |
|
|
End date |
|
|
Offset |
|
|
Limit |
|
|
The response format expected from the API (e.g. application/json). |
POST Sign up a new account
/v1/accounts/signup
Creates an account based on the provided data in the request body. If the package selected is “Team” or “Pro”, an AWS S3 bucket will be created. If the package selected is “Free”, no new bucket is created in AWS S3 and the default common bucket will be used for that account. After this endpoint is called a confirmation email will be sent to the provided email address.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
First name |
|
|
Last name |
|
|
|
|
|
Phone |
|
|
Password |
|
|
Company |
|
|
Sub domain |
|
|
Package |
POST Upload account background image
/v1/accounts/{uuid}/image-background
Upload an account background image for the specified account uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Image file (png or jpg) |
POST Upload account background logo
/v1/accounts/{uuid}/logo-background
Upload an account background logo for the specified account uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Logo file (png or jpg) |
POST Upload account dashboard image
/v1/accounts/{uuid}/image-dashboard
Upload an account dashboard image for the specified account uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Image file (png or jpg) |
POST Upload account email logo
/v1/accounts/{uuid}/logo-email
Uploads a logo which will be used for the email templates for the specified account
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The logo file which we want to save |
POST Upload account favicon image
/v1/accounts/{uuid}/image-favicon
Upload an account favicon image for the specified account uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Image file (png or jpg) |
POST Upload account logo
/v1/accounts/{uuid}/logo
Uploads an account logo for the specified account uuid. The logo will overwrite the existing one.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Account identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Logo file (png or jpg) |
POST Validate an account
/v1/accounts/confirmation/validate
Activates the account and the main user related to that account. This endpoint should be called after receiving confirmation token from a signup request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Confirmation token |
Activity log
GET Get list of activity log entries
/v1/activity-logs
Get list of activity log entries based on the optional parameters sent to the endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Search for keyword |
|
|
types: 1 = accounts, 2 = clients, 3 = users, 4 = projects, 5 = assets |
|
|
List items start date |
|
|
List items end date |
|
|
Comma separated activity types. Numbers between 1 and 32 |
|
|
Comma separated asset types: 1 = Image, 2 = Video, 3 = Audio, 4 = Document, 6 = Other |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
The response format expected from the API (e.g. application/json). |
Api Key (11)
POST Create new api key
/v1/api-key
Creates a new API key with the introduced name via the name parameter (optional).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Name of new api key |
POST Create new api key restriction
/v1/api-key/{uuid}/restriction
Create new restriction for API key with uuid specified in url.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Api key identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
IPv4 address or IPv4 CIDR block |
DELETE Delete api key
/v1/api-key/{uuid}
Delete the API key with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Api key identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete api key restriction
/v1/api-key/restriction/{uuid}
Deletes the API key with the specified uuid in the url.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Api key restriction identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit api key details
/v1/api-key/{uuid}
Modify the details of the API key with the defined uuid in the url.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Api key identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Name of api key |
|
|
Status (1 = enabled, 2 = disabled) |
POST Edit api key restriction details
/v1/api-key/restriction/{uuid}
Modify the restriction details of an API key, which has the specified uuid in the url.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Api key restriction identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
IPv4 address or IPv4 CIDR block |
GET Get an api key details
/v1/api-key/{uuid}
Get the details of the API key specified in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Api key identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an api key restriction details
/v1/api-key/restriction/{uuid}
Retrieves the restriction details of an API key, which has the specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Api key restriction identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of api keys
/v1/api-key
Returns a list of API keys based on the optional filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter to specified name |
|
|
Search for keyword |
|
|
List items start date |
|
|
List items end date |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
The response format expected from the API (e.g. application/json). |
GET Regenerate an existing api key
/v1/api-key/{uuid}/regenerate
Regenerate the existing API with the specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Api key identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Remove api key
/v1/api-key/{uuid}/remove
Remove the API key with the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Api key identifier |
|
|
The response format expected from the API (e.g. application/json). |
Asset Approve (3)
POST Asset approve
/v1/assets/{uuid}/approve
Asset approve endpoint for the user's who received the permission to this action.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
User's approve token |
|
|
Comment message |
|
|
2: approve, 3: reject |
|
|
Comment parent's uuid |
|
|
Video's time frame in HH:MM:SS format |
GET Get an asset's available users to send approve request
/v1/assets/{uuid}/approve/users
Requests the list of users available to send an asset approval request to, relating to the asset in uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Send an asset approve request
/v1/assets/{uuid}/approve/send
Send an asset approve request for the user's defined in the users parameter, which are related to the asset with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Comma-separated list of users uuid |
|
|
E-mail subject |
|
|
Message for users |
|
|
From avid |
Asset Comments (5)
POST Add a new comment
/v1/assets/{uuid}/comments
Create a new comment for the asset specified in uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Message text |
|
|
Comment parent's uuid |
|
|
Posted at time (at video/audio) in seconds format(1.2345) |
|
|
Annotation - Base point(X,Y) (at video, image) in percentage format(35.1234,67.1234) |
|
|
Annotation - Start time (at video/audio) in seconds format(1.2345) |
|
|
Annotation - End time (at video/audio) in seconds format(1.2345) |
|
|
Annotation - Page number (at image) if it is multipage image(pdf,doc,psd) |
GET Comment search
/v1/assets/{uuid}/comments/search
Returns comments for the specified asset in uuid based on the provided filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
Search for keyword |
|
|
Comma-separated list of statuses. (1: enabled, 2: disabled). If this param is not used, it will list all available statuses. |
|
|
List items start date |
|
|
List items end date |
|
|
Comma-separated list of comment types. (1: normal, 2: approved, 3: rejected, 4 annotation). If this param is not used, it will list all available comment types. |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete an asset comment
/v1/assets/comments/{uuid}
Deletes the assets comment, where the comment uuid is the specified one from the uuid parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset comment identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit an asset's comment
/v1/assets/comments/{uuid}
Changes a comment of an asset with the comment uuid defined in the parameter uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset comment identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Message text |
|
|
1: enabled, 2: disabled |
GET Get an asset's comments list
/v1/assets/{uuid}/comments
Retrieves the list of asset's comments in tree view for asset defined in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
Comma-separated list of comment types. (1: normal, 2: approved, 3: rejected). If this param is not used, it will list all available comment types. |
|
|
Start listing from value |
|
|
Items per page |
|
|
The response format expected from the API (e.g. application/json). |
Asset Downloads (2)
GET Download an asset in specified format
/v1/assets/{uuid}/download/{presetUuid}
Downloads the asset specified in uuid parameter in desired format, defined in presetUuid param.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
Preset identifier |
|
|
Burn subtitle to video (0: no, 1: yes) |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an asset's available download formats
/v1/assets/{uuid}/download
Retrieves the possible download formats for the asset specified in uuid parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Asset Keywords (2)
GET Get an asset's available image keywords
/v1/assets/{uuid}/keywords
Get the keywords for the asset defined in the parameter uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Request new keywords for asset
/v1/assets/{uuid}/keywords
Request new keywords for the asset defined in the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Asset Labels (2)
DELETE Delete an asset's label
/v1/assets/{uuid}/labels/{keyword}
Delete the label defined in the keyword parameter for the asset with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
Label keyword |
|
|
The response format expected from the API (e.g. application/json). |
GET Get asset's detected labels
/v1/assets/{uuid}/labels
Retrieves all the detected labels for the asset which is specified in the uuid parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Asset Metadata (5)
POST Create a new asset metadata
/v1/assets/{uuid}/metadata
Create new custom asset metadata for the asset specified in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Custom meta data key |
|
|
Custom meta data value |
DELETE Delete an asset's metadata
/v1/assets/metadata/{uuid}
Delete the metadata with the specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit an asset's metadata
/v1/assets/metadata/{uuid}
Edit the metadata details of the asset defined in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Custom meta data key |
|
|
Custom meta data value |
GET Get an asset meta data details
/v1/assets/{uuid}/metadata
Retrieves a specified asset's (in uuid param) meta data details.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Upload custom asset metadata
/v1/assets/{uuid}/metadata-upload
Upload custom asset metadata for multiple assets in the same project. The project has to be defined in uuid parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
CSV file |
Asset Publish (2)
GET Get an asset's publish log
/v1/assets/{uuid}/publish-logs
Retrieves the publish log of one asset, defined in url with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Send an asset share to specified platform
/v1/assets/{uuid}/publish
Share the asset with uuid on a specified platform
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Platform id. 1: Youtube, 2: Facebook, 3: Twitter |
|
|
Share's title |
|
|
Share's description |
Asset Review (2)
GET Get an asset's available users to send review request
/v1/assets/{uuid}/review
Get an asset's - defined in the parameter uuid - available users to send review request email to them.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Send an asset review request
/v1/assets/{uuid}/review
Send an asset review request email to the available users related to the asset specified in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Comma-separated list of user uuids |
|
|
E-mail subject |
|
|
Message |
|
|
From avid |
Asset Stack (5)
POST Create an asset stack
/v1/assets/stack
Create a new asset stack.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Name |
|
|
Stack type |
|
|
Lead asset uuid |
DELETE Delete an asset stack
/v1/assets/stack/{uuid}
Deletes the asset stack with the defined uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset stack identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit an asset stack
/v1/assets/stack/{uuid}
Edit the asset stack with the specified uuid parameter from url.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset stack identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Name |
|
|
Stack type |
|
|
Lead asset uuid |
GET Get an asset stack
/v1/assets/stack/{uuid}
Retrieves a specific asset stack with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset stack identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get asset stack list
/v1/assets/stack
Retrieves a list of asset stacks.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Lead asset uuid |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
The response format expected from the API (e.g. application/json). |
Asset Thumbnails (2)
POST Create a new thumbnail
/v1/assets/{uuid}/thumbnail
Create a new thumbnail for the asset defined in uuid from time frame defined in the parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Time frame (HH:MM:SS.u) |
POST Upload an image for thumbnail
/v1/assets/{uuid}/thumbnail-upload
Upload a specific image for thumbnail for the asset defined in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Thumbnail image (jpg or png) |
Asset Transcode Logs (2)
GET Get a transcode entry
/v1/assets/transcode/{uuid}
Retrieves a specified transcode log entry with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Transcode unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of asset's transcode log entries
/v1/assets/{uuid}/transcode
Retrieves the transcode log entries for asset with the uuid defined in the url, based on the filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
Search for keyword |
|
|
Search for asset |
|
|
Search for pipeline |
|
|
Search for job |
|
|
Search for job_type |
|
|
Search for job_status |
|
|
List items start date |
|
|
List items end date |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
The response format expected from the API (e.g. application/json). |
Asset Transcript (5)
DELETE Delete an asset's transcript
/v1/assets/{uuid}/transcript
Delete the saved transcription for the asset specified in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete one word from asset's transcript
/v1/assets/{uuid}/transcript/words/{word_uuid}
Delete the word with the uuid sent in word_uuid from asset with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
Word identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit one word from asset's transcript
/v1/assets/{uuid}/transcript/words/{word_uuid}
Modifies only a single word with word_uuid from the existing transcriptions for the asset with uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
Word identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Word's text |
|
|
Subtitle row's number |
POST Generate a new subtitle from stored words
/v1/assets/{uuid}/subtitle
Starts a regeneration from the stored words for the asset with the defined uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an asset's available voice recognize data (transcripts)
/v1/assets/{uuid}/transcript
Retrieves for the specified asset in uuid the currently available recognized data (transcription).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Asset Versions (5)
POST Create an asset version
/v1/assets/version
Create a new asset version with the specified parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Asset1 uuid |
|
|
Asset2 uuid |
DELETE Delete an asset version
/v1/assets/version/{uuid}
Deletes the specified asset version with the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit an asset version
/v1/assets/version/{uuid}
Edit the asset version with the defined uuid based on the parameter sent.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Asset version |
GET Get an asset version
/v1/assets/version/{uuid}
Retrieves an asset version with the specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get asset versions list
/v1/assets/version
Get all possible asset version list.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
The response format expected from the API (e.g. application/json). |
Asset Video Cut (2)
POST Create a new subclip from video asset
/v1/assets/{uuid}/video-cut
Create a new subclip from video asset with uuid based on the parameters sent.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Start time in second.millisecond format |
|
|
End time in second.millisecond format |
|
|
Title of new subclip |
|
|
Description of new subclip |
|
|
Projects uuid where you want to store |
|
|
Folder uuid where you want to store |
GET Get an asset's available projects list for video cut
/v1/assets/{uuid}/video-cut
Retrieves the available project list for the defined asset in uuid for a video cut.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Asset View Cps (3)
GET Get an asset's available users to send view-cps request
/v1/assets/{uuid}/view-cps
Get an asset's available users to send view-cps request
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Send an asset view-cps request
/v1/assets/{uuid}/view-cps
Send an asset view-cps request
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
List of user uuids |
|
|
Subject of the email |
|
|
Message of the email |
POST Signup request for an asset view-cps
/v1/assets/{uuid}/view-cps/signup-request
Signup request for an asset view-cps
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Request name |
|
|
Name of the organisation |
|
|
Request email |
|
|
Message |
Assets (16)
POST Create an asset
/v1/assets
Create an asset based on the parameters received.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Project id |
|
|
File name |
|
|
File type (mime type). E.g.: image/jpeg |
|
|
File size (in bytes) |
|
|
Remote url |
|
|
Keywords |
|
|
Origin Asset uuid |
DELETE Delete an asset
/v1/assets/{uuid}
Delete test specified asset with the sent uuid in the parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a specified asset detail
/v1/assets/{uuid}
Retrieves the asset's detail for the specified uuid in parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an asset stats
/v1/assets/{uuid}/stats
Get the asset's statistics with the specified uuid in the parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an asset's available projects list for copy
/v1/assets/{uuid}/copy
Get the projects list of the asset, available for copy.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an asset's available projects list for move
/v1/assets/{uuid}/move
Get the available projects list for the asset defined in the uuid where that can be moved.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get asset's embed list
/v1/assets/{uuid}/embed
Retrieves the embed list for the asset specified in uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get assets current status
/v1/assets/status
Retrieves the status and other related info (eg. upload progress, asset type, file size, file type, etc.) of the assets requested in the parameter array
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Comma-separated list of asset uuids |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of assets
/v1/assets
Get all the assets based on the provided filters
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset name |
|
|
Search for keyword |
|
|
Search term |
|
|
Search type: any = Any of the term words, contains = Contains all, exact = Exact term |
|
|
Comma-separated list: name = Asset name, metadata = Asset metadata,comment = Asset comments, subtitle = Asset subtitle, recognition = Image recognition, folder = Folder, label = Label |
|
|
The field name of searched metadata. The search term will be searched related to this field |
|
|
The field value of searched metadata. The search term will be searched related to this field |
|
|
Asset pixel size(Format: widthxheight) |
|
|
Asset pixel search method: larger = larger than, smaller = smaller than, exact = exact size |
|
|
List items from file size(byte) |
|
|
List items to file size(byte) |
|
|
List items from duration(miliseconds) |
|
|
List items to duration(miliseconds) |
|
|
Comma-separated integer list of asset types. It will be list all types, if not used. |
|
|
Project uuid |
|
|
Folder uuid |
|
|
Comma-separated list of label uuids. It will be list all labels, if not used. |
|
|
Comma-separated integer list of asset statuses. It will be list all statueses, if not used. |
|
|
List items start date |
|
|
List items end date |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
Comma-separated list of response fields what you want. If this param is not used, it will list all available fields. |
|
|
The response format expected from the API (e.g. application/json). |
POST Make an asset copy
/v1/assets/{uuid}/copy
Make an asset copy for the asset sent in uuid to a specified project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Project uuid |
|
|
Folder uuid |
POST Move asset to a specified project
/v1/assets/{uuid}/move
Moves the asset with uuid to the specified project sent in the request body
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Project uuid |
|
|
Folder uuid |
POST Regenerate the asset detail
/v1/assets/{uuid}/regenerate
Regenerate the specified asset's detail in uuid for the specified regeneration type sent in request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Regenerate type |
POST Set Adobe panel role
/v1/assets/upload/adobe
Sets an Adobe panel role based on the sent parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Region |
|
|
Bucket to upload |
|
|
Object key |
POST Set storage files ACL
/v1/assets/{uuid}/acl
Set asset's visibility to public or private based on the sent public parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Change this asset to public: [0: private, 1: public] |
POST Set upload progress percentage
/v1/assets/{uuid}/upload_progress
Set the upload progress percentage for the defined asset in uuid to the value which was sent through percent parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Current status in percent (0-100) |
GET Sign an asset upload.
/v1/assets/upload/sign
Sign an asset upload based on the introduced to_sign and datetime parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
String to sign |
|
|
DateTime |
|
|
The response format expected from the API (e.g. application/json). |
Authorization
POST JWT based user authorization
/v1/auth/login
User authentication based on JWT token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Email address |
|
|
Password |
Clients (8)
POST Create a new client
/v1/clients
Create a new client based on the parameters sent.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (12)
|
Option Name |
Description |
|---|---|
|
|
Name of new client |
|
|
Custom Name of new client |
|
|
Contact name |
|
|
Contact's phone number |
|
|
Contact's e-mail address |
|
|
Contact's address 1 line |
|
|
Contact's address 2 line |
|
|
Contact's postal code |
|
|
Contact's city |
|
|
Contact's county |
|
|
Contact's ISO3166-1 Alpha 2 Country code. eg.: IE or US |
|
|
Is default? |
DELETE Delete client
/v1/clients/{uuid}
Delete the client with the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Client unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit a client details
/v1/clients/{uuid}
Edit the details of the client with the specified uuid in url.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Client unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (12)
|
Option Name |
Description |
|---|---|
|
|
Name of new client |
|
|
Custom Name of new client |
|
|
Contact name |
|
|
Contact's phone number |
|
|
Contact's e-mail address |
|
|
Contact's address 1 line |
|
|
Contact's address 2 line |
|
|
Contact's postal code |
|
|
Contact's city |
|
|
Contact's county |
|
|
Contact's ISO3166-1 Alpha 2 Country code. eg.: IE or US |
|
|
Is default? |
GET Get Youtube social granting
/v1/clients/{uuid}/granting_url
Retrieves the Youtube social granting URL for client with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Client unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a client details
/v1/clients/{uuid}
Get the details of the specified client in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Client unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of clients
/v1/clients
Retrieves a list of clients based on the filters sent.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter to specified name |
|
|
Filter to specified custom_name |
|
|
Search for keyword |
|
|
Comma-separated integer list of statuses. (1: enabled, 2: disabled, 3: deleted [only for admins]). If this param is not used, it will list all available statuses. |
|
|
List items start date |
|
|
List items end date |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
Comma-separated list of response fields what you want. If this param is not used, it will list all available fields. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Remove client
/v1/clients/{uuid}/remove
Remove the client with the defined uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Client unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Send an asset share
/v1/clients/{uuid}/granting
Send an asset share to specified platforms in the parameters for the client defined with uuid in the url.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Client unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Platform id. 1: Youtube, 2: Facebook, 3: Twitter |
|
|
Sharing id |
|
|
Sharing e-mail |
Default (7)
GET Get api messages
/v1/release/messages
Returns the API messages.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get api ui version
/v1/release/version/ui
Returns the API UI version of the project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get api version
/v1/version
Returns the version of the API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get api version
/v1/release/version/api
Return the version of the API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the main path
/v1/
Get the main path
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
POST Set api messages
/v1/release/messages
Create the API messages based on the sent parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Messages |
GET Test API notification email sending
/v1/api-notification-test
Test API notification email sending
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Folder Review (2)
GET Get a folder's available users to send review request
/v1/folders/{uuid}/review
Get a folders's - defined in the parameter uuid - available users to send review request email to them.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Send a folder review request
/v1/folders/{uuid}/review
Send a folder review request email to the available users related to the folder specified in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Comma-separated list of user uuids |
|
|
E-mail subject |
|
|
Message |
Folders (16)
POST Create a folder
/v1/folders
Create a new folder with the specified parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Folder name |
|
|
Project's uuid |
|
|
Folder parent's uuid |
POST Create folder asset(s)
/v1/folders/{uuid}/asset
Create one or more folder asset into the folder uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Comma separated list of asset's uuids |
DELETE Delete a folder
/v1/folders/{uuid}
Delete the specified folder which has uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete a folder asset
/v1/folders/{uuid}/asset/{assetUuid}
Delete a folder asset for folder with uuid and asset wtih assetUuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder unique identifier |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete folder's thumbnail
/v1/folders/{uuid}/thumbnail
Delete the folder's thumbnail which has uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit a folder
/v1/folders/{uuid}
Edit the details of the defined folder in uuid based on the sent parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Folder name |
|
|
Folder parent's uuid |
GET Get a folder
/v1/folders/{uuid}
Get the details of the specified folder in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a folder's available projects list for copy
/v1/folders/{uuid}/copy
Get the projects list of the folder, available for copy.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a folder's available projects list for move
/v1/folders/{uuid}/move
Get the available projects list for the folder defined in the uuid where that can be moved.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an assets folders
/v1/folders/asset/{uuid}
Retrieves the asset's folders for the asset defined in the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get folder's assets
/v1/folders/{uuid}/asset
Retrieves the assets for the associated folder defined with uuid from url.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get folders list in tree view
/v1/folders
Get folders list in tree view based on the parameters sent.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project uuid related to the folder |
|
|
Parent uuid |
|
|
The response format expected from the API (e.g. application/json). |
GET Get folders thumbnail
/v1/folders/thumbnails
Retrieves the thumbnails of the folders.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
POST Make a folder copy
/v1/folders/{uuid}/copy
Make an folder copy for the folder sent in uuid to a specified project.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Project uuid |
|
|
Folder uuid |
POST Move folder to a specified project
/v1/folders/{uuid}/move
Moves the folder with uuid to the specified project sent in the request body
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Project uuid |
|
|
Folder uuid |
POST Upload folder thumbnail
/v1/folders/{uuid}/thumbnail
Upload a thumbnail for the folder specified in uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Thumbnail file |
Jira Service Desk
POST Create new Jira ticket
/v1/new-jira-ticket
Create new Jira ticket using Jira API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Name of the organisation |
|
|
Type of the feedback |
|
|
Summary of the Jira task |
|
|
Description of the Jira task |
|
|
Priority level of the Jira task |
|
|
URL of the affected page |
|
|
The device where the issue was noticed |
|
|
Attachment file |
Job
POST Create new job
/v1/job
Create a new job entry.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Type of the job |
|
|
Value of the job |
Labels (9)
POST Create a new label
/v1/labels
Create a new label from request body data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Label name |
|
|
Label parent's uuid |
DELETE Delete a label
/v1/labels/{uuid}
Delete label with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Label unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete an asset label
/v1/labels/{uuid}/asset/{assetUuid}
Delete for asset with assetUuid the label with uuid
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Label unique identifier |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit a label
/v1/labels/{uuid}
Edit label that has the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Label unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Label name |
|
|
Label parent's uuid |
GET Get a label
/v1/labels/{uuid}
Get a label that has the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Label unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a labels assets
/v1/labels/{uuid}/asset
Get assets for label with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Label unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an assets labels
/v1/labels/asset/{uuid}
Get labels for asset with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get labels list in tree view
/v1/labels
Get labels list in tree view
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Parent uuid |
|
|
The response format expected from the API (e.g. application/json). |
POST New label asset
/v1/labels/{uuid}/asset
New label asset from request body data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Label unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Comma separated list of Asset's uuids |
Live Channels Schedule (4)
POST Create a new live channel schedule
/v1/livechannels/{uuid}/schedule
Create a new live channel schedule for the provided Live Channel uuid with the data sent in request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the live channel to create a schedule for. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Type of scheduling (1 = simple / 2 = custom) |
|
|
Start time in case of single type selected |
|
|
End time in case of single type selected |
|
|
Start time in case of custom type selected |
|
|
End time in case of custom type selected |
|
|
Array with days abbreviation in case of custom type selected, eg. ["Mon", "Tue"] |
DELETE Delete a live channel schedule
/v1/livechannels/{uuid}/schedule/{scheduleUuid}/delete
Delete live channel schedule with scheduleUuid existing for live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel schedule unique identifier |
|
|
The unique identifier of the schedule to delete. |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit a live channel schedule details
/v1/livechannels/{uuid}/schedule/{scheduleUuid}
Edit details of live channel schedule with scheduleUuid, existing for live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel schedule unique identifier |
|
|
The unique identifier of the schedule to edit. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Type of scheduling (1 = simple / 2 = custom) |
|
|
Start time in case of single type selected |
|
|
End time in case of single type selected |
|
|
Start time in case of custom type selected |
|
|
End time in case of custom type selected |
|
|
Array with days abbreviation in case of custom type selected, eg. ["Mon", "Tue"] |
GET Get list of live channel schedules
/v1/livechannels/schedule
Get list of live channel schedules filtered by request parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter to specified live channel uuid |
|
|
Search for a specific schedule type |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
Comma-separated list of response fields what you want. If this param is not used, it will list all available fields. |
|
|
The response format expected from the API (e.g. application/json). |
Live Channels (13)
GET Archive a live channel
/v1/livechannels/{uuid}/archive
Archive live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Create a new live channel
/v1/livechannels
Create a new live channel based on the data from the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Name of the new live channel |
|
|
Description of the new live channel |
|
|
Ingest type of the new live channel(1 - Live Stream; 2 - Prerecorded) |
|
|
Is public available the new live channel (true / false) |
|
|
Full archive is enabled? (true / false) |
|
|
Archiving in parts is enabled? (true / false) |
|
|
Duration of parts in seconds |
|
|
Uuid of the project to archive |
|
|
Uuid of the folder to archive |
|
|
Uuid of the folder to archive |
DELETE Delete a live channel
/v1/livechannels/{uuid}
Delete live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit a live channel details
/v1/livechannels/{uuid}
Edit details of live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
Name of a live channel |
|
|
Description of a live channel |
|
|
Status of a live channel |
|
|
Live channel is public? (true / false) |
|
|
Full archive is enabled? (true / false) |
|
|
Archiving in parts is enabled? (true / false) |
|
|
Duration of parts in seconds |
|
|
Uuid of the project to archive |
|
|
Uuid of the folder to archive |
|
|
Uuid of the folder to archive |
POST Edit a live channel input stream details
/v1/livechannels/{uuid}/inputs/stream
Edit input stream details for live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Inputs in array |
POST Edit a live channel input vod details
/v1/livechannels/{uuid}/inputs/vod
Edit input vod details for live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Inputs in array |
GET Get a live channel details
/v1/livechannels/{uuid}
Get details for live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a live channel public info
/v1/livechannels/{uuid}/info
Get details for public live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a public live channel details
/v1/livechannels/{uuid}/public
Get details for public live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of live channels
/v1/livechannels
Get list of live channels filtered by request parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter to specified name |
|
|
Search for keyword |
|
|
Comma-separated list of statuses. (1: enabled, 2: disabled, 3: deleted [only for admins]). If this param is not used, it will list all available statuses. |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
Comma-separated list of response fields what you want. If this param is not used, it will list all available fields. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Remove a live channel
/v1/livechannels/{uuid}/remove
Remove live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Start a live channel
/v1/livechannels/{uuid}/start
Start live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Stop a live channel
/v1/livechannels/{uuid}/stop
Stop live channel with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Live channel unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Notifications (3)
DELETE Delete a notification
/v1/users/me/notifications/{uuid}
Delete notification with the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Notification unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of user message entries
/v1/users/me/notifications
Get list of user message entries.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Search for keyword |
|
|
Comma-separated list of statuses. (1: enabled, 2: disabled, 3: deleted [only for admins]). If this param is not used, it will list all available statuses. |
|
|
List items from date |
|
|
List items end date |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
The response format expected from the API (e.g. application/json). |
POST Set notification status to read
/v1/users/me/notifications/{uuid}/read
Set status to read for the notification with the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Notification unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Packages
GET Get list of packages
/v1/packages
Get list of packages.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter to specified name |
|
|
Search for keyword |
|
|
Comma-separated list of statuses. (1: enabled, 2: disabled, 3: deleted [only for admins]). If this param is not used, it will list all available statuses. |
|
|
0: not available for sale, 1: available for sale |
|
|
List items from date |
|
|
List items end date |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
The response format expected from the API (e.g. application/json). |
Players (6)
POST Create a new player
/v1/players
Create a new player based on data from request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Name of new player |
|
|
Type of provider: 1: Overcast, 2: JWPlayer |
|
|
0: disabled, 1: enabled |
|
|
0: disabled, 1: enabled |
|
|
Google Analytics code |
|
|
JWPlayer licence key |
|
|
JWPlayer player key |
DELETE Delete a player
/v1/players/{uuid}
Delete player with the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Player unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit player
/v1/players/{uuid}
Edit player with the uuio.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Player unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Name of player |
|
|
Type of provider: 1: Overcast, 2: JWPlayer |
|
|
Player status |
|
|
0: disabled, 1: enabled |
|
|
0: disabled, 1: enabled |
|
|
Google Analytics code |
|
|
JWPlayer licence key |
|
|
JWPlayer player key |
GET Get a player details
/v1/players/{uuid}
Get details for player with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Player unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of players
/v1/players
Get list of players filtered by request parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter to specified name |
|
|
Search for keyword |
|
|
Comma-separated list of statuses. (1: enabled, 2: disabled, 3: deleted [only for admins]). If this param is not used, it will list all available statuses. |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
Comma-separated list of response fields what you want. If this param is not used, it will list all available fields. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Remove a player
/v1/players/{uuid}/remove
Remove player with the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Player unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Playlists (11)
POST Add an asset to the playlist
/v1/playlists/{uuid}/asset
Add an asset to playlist with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Playlist unique identifier |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Create a new playlist
/v1/playlists
Create a new playlist from the data provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Name of new playlist |
|
|
Description of new playlist |
|
|
Playlist is public? |
|
|
Playlist is default? |
DELETE Delete a playlist
/v1/playlist/{uuid}
Delete playlist with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Playlist unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit a playlist details
/v1/playlists/{uuid}
Edit details for playlist with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Playlist unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Name of playlist |
|
|
Description of playlist |
|
|
Playlist is public? |
GET Get a playlist details
/v1/playlists/{uuid}
Get details for playlist with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Playlist unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a playlist public details
/v1/playlists/{uuid}/public
Get public details for playlist with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Playlist unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an asset playlist entries
/v1/playlists/{uuid}/entries
Get playlist entries for the asset with the uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of playlists
/v1/playlists
Get list of playlists based on the filter parameters from request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter to specified name |
|
|
Search for keyword |
|
|
Comma-separated list of statuses. (1: enabled, 2: disabled, 3: deleted [only for admins]). If this param is not used, it will list all available statuses. |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
Comma-separated list of response fields what you want. If this param is not used, it will list all available fields. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get the default playlist
/v1/playlists/default
Get the default playlist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Remove a playlist
/v1/playlists/{uuid}/remove
Remove playlist with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Playlist unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Remove an asset from the playlist
/v1/playlists/{uuid}/asset/{assetUuid}
Remove an asset from the playlist with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Playlist unique identifier |
|
|
Asset unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Projects (13)
POST Create a new project
/v1/projects
Create a new project based on the data provided in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Name of project |
|
|
Custom Name of new project |
|
|
Client uuid |
|
|
Description of project |
|
|
1: active, 2: inactive |
|
|
Project is locked? |
DELETE Delete a project (move to trash)
/v1/projects/{uuid}
Delete(move to trash) the project with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete project's thumbnail
/v1/projects/{uuid}/thumbnail
Delete thumbnail for the project with the specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit a project DEM details
/v1/projects/{uuid}/dem
Edit DEM details for the project with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (12)
|
Option Name |
Description |
|---|---|
|
|
Case id of project |
|
|
1: Assigned, 2: Pending, 3: Filed |
|
|
Sensitive data: 0: No, 1: Yes |
|
|
Owner uuid of case |
|
|
Incident date of case |
|
|
Location Address 1 |
|
|
Location Address 2 |
|
|
Location City |
|
|
Location Postal Code |
|
|
Location County |
|
|
Location Country |
|
|
Location GPS coordinates |
POST Edit a project details
/v1/projects/{uuid}
Edit details for the project with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Name of project |
|
|
Custom name of project |
|
|
Client uuid |
|
|
Description of project |
|
|
1: active, 2: inactive |
|
|
Project is locked? |
POST Edit a project permissions
/v1/projects/{uuid}/permissions
Edit permissions for the project with the specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
Uuid of user |
|
|
Can this user view this project assets? |
|
|
Can this user download from this project? |
|
|
Can this user upload to this project? |
|
|
Can this user view metadata in this project? |
|
|
Can this user cut video in this project? |
|
|
Can this user image transform in this project? |
|
|
Can this user manage folders in this project? |
|
|
Can this user manage labels in this project? |
GET Get a project details
/v1/projects/{uuid}
Get details for the project with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a project stats
/v1/projects/{uuid}/stats
Get stats for the project with the specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of projects
/v1/projects
Get list of projects based on filter parameters from request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Search for keyword |
|
|
Name of project |
|
|
Filter to specified custom_name |
|
|
Comma-separated list of statuses. (1: enabled, 2: disabled, 3: deleted [only for admins]). If this param is not used, it will list all available statuses. |
|
|
List items start date |
|
|
List items end date |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
Comma-separated list of response fields what you want. If this param is not used, it will list all available fields. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get project's thumbnail
/v1/projects/thumbnails
Get thumbnails for the projects with the specified identifiers from the requested list.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
POST Invite a collaborator to project
/v1/projects/{uuid}/invites
Invite a collaborator to project with specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
E-mail address |
|
|
User can download |
|
|
User can upload |
|
|
User can view metadata |
|
|
User can cut video |
|
|
User can image tranform |
|
|
User can manage folder |
|
|
User can manage label |
DELETE Remove a project
/v1/projects/{uuid}/remove
Remove project with specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Upload project's thumbnail
/v1/projects/{uuid}/thumbnail
Upload thumbnail for the project with the specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Thumbnail file |
Services
GET Get endpoints URLs
/v1/services
The following endpoint returns all the available API GW endpoints from the environment
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Statistics (10)
GET Get activities statistics
/v1/stats/activities
Statistics about activities.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get asset statistics
/v1/stats/assets
Statistics about assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get download statistics
/v1/stats/downloads
Statistics about download.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get platform statistics
/v1/stats
General platform statistics.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get platform statistics total
/v1/stats/total
Platform statistics total.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get project statistics
/v1/stats/projects
Statistics about projects.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get storage statistics
/v1/stats/storage
Statistics about storage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get transcode statistics
/v1/stats/transcode
Statistics about transcode.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get upload statistics
/v1/stats/uploads
Statistics about uploads.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get user statistics
/v1/stats/users
Statistics about users.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Taxonomy (8)
POST Create a new taxonomy field option
/v1/taxonomy/option
Create a new taxonomy field option based on the parameters sent.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Field's uuid |
|
|
Name of the taxonomy field option |
|
|
The position of the field option |
POST Create a taxonomy field
/v1/taxonomy/field
Create a new taxonomy field with the specified parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Parent field's uuid |
|
|
Parent field option's uuid |
|
|
Name of the taxonomy field |
|
|
The field is required or not (True / False) |
|
|
The status of the field |
|
|
The position of the field |
|
|
The input type of the field |
|
|
The list of asset types |
DELETE Delete a taxonomy field
/v1/taxonomy/field/{uuid}
Deletes the taxonomy field with uuid and all the related tree what is below it.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Taxonomy field unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete a taxonomy field option
/v1/taxonomy/option/{uuid}
Deletes the taxonomy field option with the specified uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Taxonomy field option unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit a taxonomy field
/v1/taxonomy/field/{uuid}
Edit the taxonomy field with the uuid sent in the parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the taxonomy field to edit. |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Parent field's uuid |
|
|
Parent field option's uuid |
|
|
Name of the taxonomy field |
|
|
The field is required or not (True / False) |
|
|
The status of the field |
|
|
The position of the field |
|
|
The input type of the field |
|
|
The list of asset types |
POST Edit a taxonomy field option
/v1/taxonomy/option/{uuid}
Edit the taxonomy field option with the uuid sent in the parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The unique identifier of the taxonomy field option to edit. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Name of the taxonomy field |
|
|
The position of the field |
GET Get a taxonomy field details
/v1/taxonomy/field/{uuid}
Get the details of the specified taxonomy field with the requested uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Taxonomy field unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of taxonomy fields
/v1/taxonomy/field
Get taxonomy field list based on the parameters sent.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Name of the taxonomy |
|
|
Offset from where we want to receive results |
|
|
Max allowed limit |
|
|
The response format expected from the API (e.g. application/json). |
User Invite (4)
GET Get list of user invite entries
/v1/users/invites
Get list of user invite entries based on filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Search for keyword |
|
|
List items start date |
|
|
List items end date |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
The response format expected from the API (e.g. application/json). |
POST Invite people
/v1/users/invites
Invite people to platform.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
E-mail address |
|
|
1 - Account Admin, 2 - Team Member |
POST Register invited user with token
/v1/users/register
Register invited user with token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Confirmation token |
|
|
First name |
|
|
Last name |
|
|
Phone number |
|
|
Password |
|
|
Subscribe to newsletter |
POST Validate user invite
/v1/users/register/validate
Validate user invite based on the received token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Confirmation token |
User Password (4)
POST Change current user password
/v1/users/password
Change user password based on the current password and new password sent in the request body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Current user password |
|
|
New user password |
POST Request password change by email
/v1/users/password/request
Request password change by sending account email for what the request is needed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
E-mail address |
POST Reset password with token
/v1/users/password/reset
Reset password based on token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Confirmation token |
|
|
New user password |
POST Validate password change
/v1/users/password/validate
Validate password change based on token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Confirmation token |
Users (12)
DELETE Delete an user
/v1/users/{uuid}
Delete user with the provided uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
User unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete user's avatar
/v1/users/{uuid}/avatar
Delete user's avatar for the user with uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
User unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
POST Edit an user details
/v1/users/{uuid}
Edit an user details based on the provided uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
User unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
E-mail address |
|
|
Password |
|
|
First name |
|
|
Last name |
|
|
Phone number (+{country}{phoneNumber} format) |
|
|
User type (1 = account admin, 2 = team member, 3 = collaborator) |
|
|
User status (1 = enabled, 2 = disabled) |
|
|
User is confirmed status (true or false) |
POST Edit an user permissions
/v1/users/{uuid}/permissions
Edit an user permissions for the user with the requesteduuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
User unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
Uuid of project |
|
|
Can this user view this project assets? |
|
|
Can this user download from this project? |
|
|
Can this user upload to this project? |
|
|
Can this user view metadata in this project? |
|
|
Can this user cut video in this project? |
|
|
Can this user image transform in this project? |
|
|
Can this user manage folders in this project? |
|
|
Can this user manage labels in this project? |
GET Get an user details
/v1/users/{uuid}
Get an user details based on the provided uuid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
User unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
GET Get available projects list
/v1/users/me/projects
Get json response with the available projects for current user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get list of users
/v1/users
Get all the users based on the provided filters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Search for keyword |
|
|
|
|
|
Comma-separated integer list of statuses. (1: enabled, 2: disabled, 3: deleted [only for admins]). If this param is not used, it will list all available statuses. |
|
|
Comma-separated integer list of permissions. (1: account admin, 2: team member, 3: collaborator, 4: viewer, 5: support admin, 6: support member). If this param is not used, it will list all available permissions. |
|
|
Is it the email address confirmed. (true/false) |
|
|
Filter to last login |
|
|
List items start date |
|
|
List items end date |
|
|
Comma separated field names, - (minus) prefix change the list order |
|
|
Start listing from value |
|
|
Items per page |
|
|
Comma-separated list of response fields what you want. If this param is not used, it will list all available fields. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get self details
/v1/users/me/details
Get self account details.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List of users companies
/v1/users/companies
List of users companies.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Name |
|
|
The response format expected from the API (e.g. application/json). |
POST Request upload permission
/v1/users/{uuid}/request-permission
Request upload permission for user on one or more projects.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
User unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Uuid of project/projects with comma separated |
|
|
Name of the user who requests the upload permission |
|
|
Email address of the user who requested the upload permission |
|
|
Name of the organization to which belongs the user who requests the upload permission |
POST Signup request to the platform
/v1/users/signup-request
Signup request to the platform.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Name of the user who wants the right |
|
|
Organisation's name where the requester belongs |
|
|
Email of the requester |
|
|
Custom message |
POST Upload user's avatar
/v1/users/{uuid}/avatar
Upload user's avatar for the user with the uuid from path.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
User unique identifier |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Avatar file |