Moxion API Docs
Welcome to the Moxion API docs
The Moxion API is a simple RESTful style API which will accept requests via HTTP POST, HTTP GET and
WebSockets!
The API responds with JSON data either as a simple JSON object or as an array of JSON objects for APIs which
return lists.
API Access and Authentication:
The Moxion API uses a token based authentication model, this means every API request must be sent with a secure
token (SHA2).
A token is generated by calling the authenticate endpoint (/authenticate/api).
HTTP Authentication:
When making HTTP calls pass the authentication token using the X-Token header.
X-Token: <token>
WebSocket Authentication:
When using WebSockets their are two ways to pass the authentication token:
Option 1) Establish a new WebSocket connection and provide the X-Token header on the upgrade request.
Option 2) When making WebSocket calls pass the authentication token as parameter on each JSON request frame.
IMPORTANT NOTE: Moxion will not allow an established WebSocket connection to be shared by multiple users.
Endpoint URLs:
HTTPS: https://api.moxion.io
WebSockets: wss://api.moxion.io
| Field | Description |
|---|---|
| data | Request data |
| endpoint | Endpoint to send request to |
| features | Feature flags (optional) |
| request_id | Id of the request (used to match with response) |
| token | Authentication token (WebSockets only) |
| Field | Description |
|---|---|
| data | Payload data |
| event_type | Real-time event type (indicates payload is a real-time event) |
| request_id | Corresponding request id (indicates payload is a response) |
| Event Type | Description |
|---|---|
| ASSET_CREATED | Asset has been created |
| COMMENT_CREATED | A new comment has been created |
| COMMENT_DELETED | An existing comment has been deleted |
| COMMENT_UPDATED | An existing comment has been updated |
| DESTINATION_MESSAGE | A new destination message is available (destination_id) |
| LOGIN | Current user has logged in on another device |
| REVIEW_SESSION_COMPLETE | A room has been completed |
| REVIEW_SESSION_HOSTS_CHANGED | Room users host status has changed |
| REVIEW_SESSION_PLAYLIST_ASSETS_UPDATED | Room playlist assets have been updated |
| TASK_PROGRESS | Background task progress update (task_id) |
| VIEW | Asset has been viewed |
| Numeric Code | Error Message |
|---|---|
| 400 | API endpoint does not exist |
| 401 | No API request data present |
| 402 | Invalid security token permission |
| 403 | Access denied |
| 404 | Not found |
| 405 | Invalid security token |
| 406 | This version of the Moxion app is no longer supported. Please update Moxion via the AppStore. |
| 407 | Invalid request data provided |
| 408 | This feature has been deprecated, please contact Moxion for further details |
| 409 | You have failed to authenticate correctly too many times, please wait for 15 minutes before you attempt to authenticate again. |
| 410 | Not authorized to update this folder |
| 411 | Not authorized to remove this user |
| 412 | You can't remove yourself from your own folder |
| 413 | You no longer have access to this folder. Please contact the folder owner for more information |
| 414 | Could not create this folder |
| 415 | Sorry, you are not authorized to update metadata on this folder |
| 416 | You can't remove the folder owner from this folder |
| 417 | Cannot link the folder to this parent |
| 418 | Cannot move or copy a folder to another production |
| 419 | Only external managed users are allowed in this folder |
| 420 | The folder you are updating is currently being updated by another user |
| 422 | Could not update this folder |
| 423 | Too many requests from this IP address. Please try again shortly. |
| 424 | You are not able to grant yourself viewer permissions |
| 430 | Could not create this comment |
| 432 | Sorry, you cannot delete this comment |
| 433 | Could not create this indicator |
| 440 | You can not use a password that you have used as one of your last folder passwords. |
| 441 | This email address is already registered |
| 442 | Invalid email address, please check the email address you entered is correct |
| 443 | Password not correct |
| 444 | Sorry, the requested user could not be created |
| 445 | Error while generating ALE file |
| 446 | A user was not found |
| 447 | Your application does not support the features required for watermarking this asset. |
| 448 | The asset you are trying to access is missing from the server. Please contact the folder owner for more information. |
| 449 | The asset file you are trying to access has not finished processing. Please check the status of your file and try again at a later time. |
| 450 | The asset file does not have a primary playable asset file. |
| 451 | The asset is missing realtime watermarking files, the system is now generating these. Please try and view this asset again at a later time. |
| 452 | The asset is hidden |
| 453 | The asset cannot be watermarked so you can only download the file without a watermark, you may need additional permission from your folder administator to do this. |
| 454 | SCIM user update cannot be completed. Failed to save user database record. Does a Moxion user already exist with this email address? |
| 455 | Asset metafile cannot be parsed. |
| 456 | The asset you are trying to view is not available in a supported dynamic range. |
| 457 | The asset you are trying to view is not available for playback due to an issue with content security, please contact support for further details. |
| 458 | Could not remove a user |
| 459 | The browser you are using is not supported for playback with DRM enabled |
| 460 | The search you are trying to perform exceeds the maximum number of projects allowed in a search context. Please refine your search criteria. |
| 461 | Cound not create this playlink |
| 462 | This playlink has expired, please contact the playlink sender for a new playlink |
| 463 | Your folder has been configured to only allow secure playlinks, please select a more secure playlink type and try again |
| 464 | The asset(s) you are trying to add already exist on this playlink. |
| 465 | Your folder has been configured to only allow medium secure playlinks, please select a more medium secure playlink type and try again |
| 466 | Could not create new asset. |
| 467 | Could not create asset file. |
| 468 | Could not link your asset(s) |
| 469 | Cannot change shared playlink assets. |
| 470 | Could not create this production |
| 471 | Not authorized to update this production |
| 472 | Could not update this production |
| 473 | Could not update this production user |
| 474 | The production you are updating is currently being updated by another user |
| 481 | A tag with this name already exists |
| 482 | This tag is still being used by existing assets |
| 485 | Shotgun needs to have folders and entity types setup before connecting to Moxion |
| 486 | Moxion to Shotgun integration has not been set up for this folder. |
| 490 | A team with this name already exists |
| 492 | You are not authorized to delete the current company administration team |
| 493 | The team was unable to be created |
| 494 | That permission is not valid for a member of the administration team. |
| 495 | Only external managed users are allowed in this team |
| 496 | You are not able to grant yourself viewer permissions. You will need to contact another Admin team member to make this change |
| 497 | This team is locked down and cannot be modified. Contact support@moxion.io to have it unlocked. |
| 498 | Can not delete License. This is assigned to a production. |
| 499 | Cannot remove this team from a Folder. This team has been assigned at the Production level. To unassign this team, select the Production and try to remove the team from there. |
| 500 | Internal server error |
| 501 | No endpoint response |
| 503 | Could not link user(s) |
| 600 | Required parameter is missing |
| 601 | Not a valid enum value |
| 603 | Received invalid Json Data in the request. |
| 650 | This process is already in progress |
| 655 | This device or stream is already registered, please remove the existing registration before trying to register it again. |
| 670 | Unable to join room |
| 671 | The room contains no shareable assets |
| 672 | Room not found |
| 673 | You are not a participant in this room |
| 674 | The room has not started |
| 675 | The room is complete |
| 676 | You have reached the maximum number of participants for a room |
| 677 | The room user has now been upgraded to a full login user, please login to use this link |
| 680 | Unable to add assets. This would exceed the maximum number of assets allowed in a playlist |
| 681 | Group not assigned to the playlist. Please assign a group to the playlist |
| 682 | Cannot change a hybrid project playlist. |
| 683 | This playlist already has collaborators. For updating, Please use update collaborators api |
| 684 | Can not add collaborators to this playlist. You don't have sharing permissions for one or more assets |
| 685 | Cross production playlist assets are not allowed for this company |
| 700 | Multifactor Authentication Failed |
| 702 | Your account has been suspended |
| 703 | SSO is not configured correctly in Moxion. |
| 704 | Moxion cannot communicate with the authentication server. Please try again shortly. |
| 705 | Access denied |
| 707 | Your account has not been activated yet. Please follow the instructions in the Account Set-up Email sent to you. |
| 708 | You’ve authenticated successfully, but we’re preventing sign-in as you haven’t been added anywhere. If you think this is in error, please contact an administrator from your production or support@moxion.io |
| 709 | No such SSO provider |
| 710 | The company was unable to be created |
| 712 | The team you have specified is not valid for this company |
| 713 | The user you have specified is not valid for this company |
| 714 | You cannot delete the requested user from this company |
| 715 | Access to your account is restricted by your company to certain platforms or locations. |
| 720 | No assets can be found to fit the report criteria |
| 730 | Could not create Consent Document |
| 740 | You have reached the limit on the number of users allowed by your license. |
| 750 | This item is already in use |
| 760 | Deep link format is not understood. Should be in the format https:// |
| 800 | Permission denied |
| 801 | You are unable to view this asset due to a system or production policy. |
| 802 | Your user is not authorized to login. To access your room please use the link that you have been provided, or contact the session administrator or support for further assistance. |
| 803 | You are unable to complete this room setup as you have reached the limit for this production. Please close any existing rooms for this production or contact your sales representative. |
| 804 | Can not update Collaborating Playlist. You don't have sharing permission on one or more assets |
| 900 | Your request rate is too high, please slow down and try again in a few seconds. |
| 901 | Your Shotgun Entity Mappings are not valid JSON |
Get activity and log events
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| limit | No | Integer | Limit number of events returned | Valid Integer |
| offset | No | Integer | Offset for limit if limit used | Valid Integer |
| project_id | Yes | CommonId | The ID of the project to get events from | Valid CommonId |
| type | No | String | The activity type to filter by | No HTML tags No {{ }} expressions |
| types | No | StringArray | The activity types to filter by | Valid StringArray |
| unique_views | No | Boolean | Only show unique views for asset view events | Valid Boolean |
| updated_since | No | Date | Only return activities since the supplied date (ISO format) | Valid Date |
| user_id | No | Id | The user ID to filter by | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| app_type | Enum [BROWSER, DESKTOP, IPHONE, IPAD, TVOS, QTAKE_SERVER, OTHER, UNKNOWN] | Moxion application type |
| asset_id | CommonId | The asset ID the event is related to |
| asset_name | String | The name of the asset related to the event (if any) |
| asset_type | String | The type of the asset related to the event (if any) |
| batch_id | CommonId | The batch ID the event is related to |
| batch_name | String | The name of the batch related to the event (if any) |
| browser_name | String | Browser name |
| browser_version | String | Browser version |
| city | String | Event location city (based on IP geolocation) |
| comment_description | String | The comment description related to the event (if any) |
| comment_id | Id | The comment ID the event is related to |
| country | String | Event location country (based on IP geolocation) |
| country_code | String | Event location country code (based on IP geolocation) |
| day | Integer | Event day of the month |
| destination_type | String | Destination type |
| destination_user_email | String | Destination user email |
| destination_user_name | String | Destination user name |
| destination_user_role | String | Destination user role |
| device_name | String | Device name |
| hour | Integer | Event hour |
| id | Id | The log entry ID |
| ip_address | String | The IP address of the user which created the event |
| latitude | Float | Event location latitude (based on IP geolocation) |
| longitude | Float | Event location longitude (based on IP geolocation) |
| minute | Integer | Event minute |
| month | Integer | Event month of the year |
| platform_name | String | Platform name |
| platform_version | String | Platform version |
| playlink_id | Id | The playlink ID the event is related to |
| playlink_name | String | The name of the playlink related to the event (if any) |
| project_id | CommonId | The project ID the event is related to |
| project_user_id | Id | The user ID of the project user who initiated this event |
| region | String | Event location region (based on IP geolocation) |
| review_session_name | String | The name of the review session associated with the event (if any) |
| review_session_owner_name | String | The name of the review session owner associated with the event (if any) |
| second | Integer | Event second |
| text | String | The event text description (if any) |
| time | Date | The data and time of the event |
| type | Enum [DOWNLOAD, UPLOAD, VIEW, VIEW_PLAYLINK_ASSET, VIEW_REVIEW_SESSION_ASSET, COPY, MOVE, PLAYLINK_SENT, PLAYLINK_CREATED, PLAYLINK_UPDATED, DOWNLOADNONWATERMARKED, USER_REMOVED, DOWNLOADED, INVITE, DEST_CREATED, DELETE, JOIN, WATERMARKING_ENABLED, WATERMARKING_DISABLED, WATERMARKING_CHANGED, DRM_ENABLED, DRM_DISABLED, MFA_ENABLED, MFA_DISABLED, DEME_CREATED, COMMENT, COMMENT_DELETED, USER_LEFT, OFFLINE, APIKEY_CREATED, APIKEY_DELETED, WORKFLOW_CREATED, SCREENSHOT_TAKEN, SCREEN_RECORDED, DELETE_BATCH, DELETE_PROJECT, MOVE_PROJECT, COPY_PROJECT, MOVE_PARENT_PROJECT, COMPANY_ADMIN_ENABLED, COMPANY_ADMIN_DISABLED] | The event type |
| user | Object | User this event is related to |
| user_first_name | String | The first name of the user who created the event |
| user_id | Id | The user ID this event is related to |
| user_initiated | Object | User this event was initiated by |
| user_last_name | String | The last name of the user who created the event |
| workflow_id | Id | The workflow ID the event is related to |
| year | Integer | Event year |
Create a new whitelabel subdomain
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company | Yes | Id | The company who owns this whitelabel domain | Valid Id |
| domain | Yes | String | The domain url to enable for whitelabeling | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| id | Id | Returns the domain ID for the created domain |
Create a zip file of an asset file in a single uncompressed ZIP archive including all associated files stored in the same batch as the original asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The asset file id | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| processing | Boolean | True if ZIP file is being generated |
Publish the required Akamai files to the default S3 bucket. These files are required for CDN checks. Does nothing if the files have already been uploaded.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|
Migrate assets from one cloud storage to another
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | No | CommonIdArray | The identifiers of the assets which are going to be migrated to the destination storage. | Valid CommonIdArray |
| company_ids | No | IdArray | The identifiers of the companies which their asset will be migrated to the destination storage. | Valid IdArray |
| delete_source | Yes | Boolean | If true, files will be removed from the original storage location for the asset, if false, the asset will not be removed. The storage ID of the asset will always be updated to the new location | Valid Boolean |
| destination_storage_id | Yes | Id | The destination storage location. | Valid Id |
| groups_ids | No | IdArray | The identifiers of the groups which their asset will be migrated to the destination storage. | Valid IdArray |
| original_storage_id | No | Id | Migrate all asset that are currently located on this storage location | Valid Id |
| project_ids | No | CommonIdArray | The identifiers of the projects which their asset will be migrated to the destination storage. | Valid CommonIdArray |
| Parameter | Type | Description |
|---|
Migrate asset file to a default cloud storage
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_file_ids | No | CommonIdArray | The identifiers of the assets files which are going to be migrated to the destination storage. | Valid CommonIdArray |
| asset_ids | No | CommonIdArray | The identifiers of the assets which are going to be migrated to the destination storage. | Valid CommonIdArray |
| company_ids | No | IdArray | The identifiers of the companies which their asset files will be migrated to the destination storage. | Valid IdArray |
| delete_source | Yes | Boolean | If true, files will be removed from the original storage location for the asset, if false, the asset files will not be removed. The storage ID of the asset will always be updated to the new location | Valid Boolean |
| destination_storage_id | Yes | Id | The destination storage location. | Valid Id |
| groups_ids | No | IdArray | The identifiers of the groups which their asset files will be migrated to the destination storage. | Valid IdArray |
| original_storage_id | No | Id | Migrate all asset files that are currently located on this storage location | Valid Id |
| project_ids | No | CommonIdArray | The identifiers of the projects which their asset files will be migrated to the destination storage. | Valid CommonIdArray |
| Parameter | Type | Description |
|---|
Trigger production usage verification
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|---|---|
| task_id | String | The processing task ID |
Create Admin endpoint to set support access to integration tests
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| impersonating_user_id | Yes | Id | The ID of the support user | Valid Id |
| token_to_impersonate | Yes | String | The token of a user that is being impersonated | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|
Download a single asset visual watermark file for internal use that may specify an IP address
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_file_id | Yes | CommonId | The asset file ID | Valid CommonId |
| ip_address | Yes | String | The ip address to be used for this watermark | No HTML tags No {{ }} expressions |
| user_token | Yes | String | The token of the user that this is being generated on behalf of | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|
Complete the playout of an asset, this will prevent any further tracking of asset playback progress
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| allow_updates | No | Boolean | True to allow further updates to the resume position for this playout | Valid Boolean |
| id | Yes | CommonId | The asset file ID | Valid CommonId |
| position | Yes | Float | The current player position in seconds | Valid Float |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| available_comment_channels | StringArray | List of available comment channels | |||||||||||||
| batch_id | CommonId | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| blurhash | String | A hashed representation of the asset | |||||||||||||
| can_access_project | Boolean | User can access this asset | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| can_offline | Boolean | User can offline this asset | |||||||||||||
| can_update | Boolean | User can update this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| component_data | Object | The components of the asset | |||||||||||||
| component_links | Array | The component details array List | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| deny_view | Boolean | True if the asset should not be viewable by the user. | |||||||||||||
| desc | String | The asset description | |||||||||||||
| drm_enabled | Boolean | Whether manifest playback is enabled on the project that contains this asset. | |||||||||||||
| duration | Float | The asset duration (in seconds) | |||||||||||||
| ext | String | The original asset file extension | |||||||||||||
| hdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in HDR. | |||||||||||||
| hidden | Boolean | The asset is hidden and not visible to users that don't have permission to view hidden batches | |||||||||||||
| id | CommonId | The asset ID | |||||||||||||
| is_admin | Boolean | True if the user has admin permission for this asset. | |||||||||||||
| is_derived_sdr | Boolean | True if the Asset has generated an SDR from an HDR, False if the user has provided their own SDR | |||||||||||||
| is_derived_sdr_allowed | Boolean | Read Only replication of the is_derived_sdr_allowed Project Setting | |||||||||||||
| is_live | Boolean | Asset is currently live streaming | |||||||||||||
| is_sdr_allowed | Boolean | Read Only replication of the is_sdr_allowed Project Setting | |||||||||||||
| is_unviewed | Boolean | Is this asset not viewed by current user | |||||||||||||
| master_id | CommonId | The master asset Id | |||||||||||||
| metadata | Object | The assets metadata | |||||||||||||
| name | String | The asset file name (without original file extension) | |||||||||||||
| offline_bytes | Integer | Number of bytes of primary files that needed to be downloaded for offline usage | |||||||||||||
| origin_type | Enum [Moxion, Flow, Hybrid] | Asset Origin type | |||||||||||||
| overall_processing_time | String | The overall time in seconds the asset has taken to complete processing | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | CommonId | The project ID this asset belongs to | |||||||||||||
| resume_position | Float | The last playback time in seconds for restarting playback | |||||||||||||
| scrub_jpg_frames | Integer | The number of frames in the scrub JPG | |||||||||||||
| scrub_jpg_url | String | The URL for the scrub JPG | |||||||||||||
| scrub_jpg_url_2x | String | The URL for the scrub JPG (2x resolution) | |||||||||||||
| scrub_jpg_url_3x | String | The URL for the scrub JPG (3x resolution) | |||||||||||||
| scrub_url | String | The URL for the thumbnail scrubber | |||||||||||||
| scrub_url_2x | String | The URL for the thumbnail scrubber (2x resolution) | |||||||||||||
| scrub_url_3x | String | The URL for the thumbnail scrubber (3x resolution) | |||||||||||||
| scrub_url_frames | Integer | The number of frames in the thumbnail scrubber | |||||||||||||
| sdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in SDR. | |||||||||||||
| sort_index | Integer | The sort index to use for display (low value should be display at the first) | |||||||||||||
| status | Enum [ACTIVE, TRANSCODING, PROCESSING, DELETED] | The asset status | |||||||||||||
| subtype | Enum [STREAMING, LIVE, IMMEDIATE, CAMERA_TYPE_ID, SLATE_TYPE_ID, CAPTURE_TYPE_ID, CAMERA_METADATA_TYPE_ID, PRODUCTION_SCENE_TYPE_ID, CAMERA_UNIT_TYPE_ID, SHOT_TYPE_ID, SEQUENCE_TYPE_ID] | The asset subtype | |||||||||||||
| subtypeDisplayName | String | The asset subtype in human readable format | |||||||||||||
| tags | CommonIdArray | The tag IDs for this asset | |||||||||||||
| thumbnail_url | String | The primary thumbnail URL for this asset | |||||||||||||
| thumbnail_url_2x | String | The primary thumbnail URL for this asset (2x resolution) | |||||||||||||
| thumbnail_url_3x | String | The primary thumbnail URL for this asset (3x resolution) | |||||||||||||
| timelines | String | Stringified JSON Array of timelines associated with this asset. Each timeline object contains array with segment objects. | |||||||||||||
| type | Enum [VIDEO, IMAGE, AUDIO, PDF, UNKNOWN, MULTI_PRIMARY, MULTI_SECONDARY, ORIGINAL] | The asset type | |||||||||||||
| uploaded_usage | Integer | Number of bytes of uploaded for this asset | |||||||||||||
| user_id | CommonId | The user ID this asset was created/uploaded by | |||||||||||||
| uuid | String | The asset UUID (if set) | |||||||||||||
| view_link | String | Link to view the asset in the Moxion web application. |
Notify users that a group of assets has been moved/copied into a project batch
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| assets | Yes | CommonIdArray | Array of asset IDs | Valid CommonIdArray |
| batch_id | Yes | CommonId | The destination batch ID | Valid CommonId |
| from_project_id | Yes | CommonId | The source project ID | Valid CommonId |
| notify_users | No | IdArray | Users to notify when transfer is finished | Valid IdArray |
| type | Yes | Enum [COPY, MOVE] | The transfer type | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| ok | Boolean | True if notifications sent |
Notify users that a batch upload has completed and set metadata processing settings
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| batch_id | No | CommonId | The batch ID | Valid CommonId |
| batch_name | No | String | The batch name | No HTML tags No {{ }} expressions Length must not exceed 100 |
| file_names | No | String | The names of the uploaded files | No HTML tags No {{ }} expressions |
| keys | No | StringArray | List of the S3 object keys of the uploaded files | Valid StringArray |
| metadata_auto_slice_ale | No | Boolean | Auto slice compiled clips using an ALE file | Valid Boolean |
| metadata_batch_only | No | Boolean | Only apply metadata to the uploaded batch | Valid Boolean |
| metadata_overwrite | No | Boolean | Overwrite existing metadata | Valid Boolean |
| metadata_process_ale | No | Boolean | Process ALE files | Valid Boolean |
| metadata_process_colorfront_xml | No | Boolean | Process colorfront XML files | Valid Boolean |
| metadata_process_wav | No | Boolean | Process WAV (BWF) files | Valid Boolean |
| notify_users | No | String | Only notify these users. Colon-separated list of email addresses. | No HTML tags No {{ }} expressions |
| priority | No | Enum [PRIORITY, BACKGROUND] | Priority that this process should be run with | Valid Enum |
| project_id | No | CommonId | The project ID | Valid CommonId |
| send_email | No | Boolean | Flag to notify users by email | Valid Boolean |
| sns_topic | No | String | AWS SNS topic to notify about asset processing progress | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| ok | Boolean | True if notifications sent |
Copy a single asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| batch_id | Yes | CommonId | The batch ID this asset will be copied into | Valid CommonId |
| id | Yes | CommonId | The asset ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| copied | Boolean | True if the asset was moved |
Copy a List of assets
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | Yes | CommonIdArray | The List of asset IDs | Valid CommonIdArray |
| batch_id | Yes | CommonId | The batch ID this asset will be copied into | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | Id of the task |
Create subclip asset from master asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | CommonId | The master asset ID | Valid CommonId |
| batch_id | Yes | CommonId | The destination batch ID | Valid CommonId |
| duration | Yes | Float | Subclip duration | Valid Float |
| name | Yes | String | The new asset name | No HTML tags No {{ }} expressions Length must not exceed 256 |
| start_time | Yes | Float | Start time in seconds | Valid Float |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | True if succeeded |
Delete one or more assets
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | No | CommonIdArray | A Collection of assets to delete. Mutually exclusive with id parameter | Valid CommonIdArray |
| id | No | CommonId | The asset ID. Retained for Backwards compatibility | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the asset/s were deleted |
Download a single asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The asset file ID | Valid CommonId |
| playlink_id | No | Id | Playlink ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| download_url | String | CDN Link for downloading the asset file |
| processing | Boolean | True if the file is being watermarked |
| task_id | String | The processing task related to this assets |
Download a single asset video file
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_file_id | Yes | CommonId | The asset file ID | Valid CommonId |
| Parameter | Type | Description |
|---|
Download a single asset scrub url
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | CommonId | The asset file ID | Valid CommonId |
| Parameter | Type | Description |
|---|
Download a single asset video file
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_file_id | Yes | CommonId | The asset file ID | Valid CommonId |
| codec_capabilities | No | Object | Object defining the capabilities of the browser to decode certain codecs with hardware acceleration | Valid Object |
| colorspace | No | String | Lock manifest to specific colorspace only | No HTML tags No {{ }} expressions |
| manifest | No | String | Return the media manifest associated with the asset | No HTML tags No {{ }} expressions |
| resolution | No | String | Lock manifest to specific resolution only | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|
Download a single asset visual watermark file
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_file_id | Yes | CommonId | The asset file ID | Valid CommonId |
| Parameter | Type | Description |
|---|
Export an ALE file
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | No | CommonIdArray | Array of asset IDs to include in ALE file | Valid CommonIdArray |
| filter_on | No | String | The metadata field to filter on | No HTML tags No {{ }} expressions |
| filter_values | No | StringArray | The metadata field values to filter on | Valid StringArray |
| project_id | Yes | CommonId | The project ID to export from | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| ale_url | String | The URL to download the ALE file from |
Fetch all assets within a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_order | No | String | Asset ordering | No HTML tags No {{ }} expressions |
| filter | No | String | The filter text | No HTML tags No {{ }} expressions |
| filter_by | No | String | Filter only by a particular asset field. If not present filters on a range of fields. | No HTML tags No {{ }} expressions |
| filter_match | No | String | Filter matching type. Currently only 'case-insensitive contains' operation supported | No HTML tags No {{ }} expressions |
| group_by | No | String | Group assets by | No HTML tags No {{ }} expressions |
| group_id | No | CommonId | The Group ID | Valid CommonId |
| group_order | No | String | Group ordering | No HTML tags No {{ }} expressions |
| ignore_prefix | No | Boolean | Ignore prefixed letters for Scene | Valid Boolean |
| project_id | No | CommonId | The project ID | Valid CommonId |
| sort_order | No | Enum [asc, desc] | Sort ordering. Ascending or Descending. By Default uses User Setting | Valid Enum |
| tags | No | CommonIdArray | Only fetch assets with the given tag IDs | Valid CommonIdArray |
| tags_match_all | No | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| assets | CommonIdArray | Array of asset IDs |
| assets_not_playable | CommonIdArray | Array of asset IDs that are not currently playable and should be excluded from offline selection. |
| batchDetails | Object | Details of the batch. Returned when grouping assets by batch |
| batch_id | CommonId | The batch ID (if grouping by batch) |
| blurhash | Array | This attribute will contain the blurhash value per asset |
| group | String | The group name |
| hidden | Boolean | The asset is hidden. |
| metadata | Object | Combined metadata for assets in this group with each metadata key containing a object of value and count |
| unviewed_count | Integer | Number of unviewed assets in this group |
Fetch a single asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The asset ID | Valid CommonId |
| include_links | No | Boolean | Whether to include the view_link in the response (default is false). | Valid Boolean |
| include_metadata | No | Boolean | Includes metadata | Valid Boolean |
| include_offline_bytes | No | Boolean | Whether to include the offline_bytes in the response (default is false). | Valid Boolean |
| include_usage | No | Boolean | Whether to include the Asset Usage in the response (default is false). | Valid Boolean |
| trigger_watermarking | No | Boolean | Immediately begin the watermarking process on this asset | Valid Boolean |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| available_comment_channels | StringArray | List of available comment channels | |||||||||||||
| batch_id | CommonId | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| blurhash | String | A hashed representation of the asset | |||||||||||||
| can_access_project | Boolean | User can access this asset | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| can_offline | Boolean | User can offline this asset | |||||||||||||
| can_update | Boolean | User can update this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| component_data | Object | The components of the asset | |||||||||||||
| component_links | Array | The component details array List | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| deny_view | Boolean | True if the asset should not be viewable by the user. | |||||||||||||
| desc | String | The asset description | |||||||||||||
| drm_enabled | Boolean | Whether manifest playback is enabled on the project that contains this asset. | |||||||||||||
| duration | Float | The asset duration (in seconds) | |||||||||||||
| ext | String | The original asset file extension | |||||||||||||
| hdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in HDR. | |||||||||||||
| hidden | Boolean | The asset is hidden and not visible to users that don't have permission to view hidden batches | |||||||||||||
| id | CommonId | The asset ID | |||||||||||||
| is_admin | Boolean | True if the user has admin permission for this asset. | |||||||||||||
| is_derived_sdr | Boolean | True if the Asset has generated an SDR from an HDR, False if the user has provided their own SDR | |||||||||||||
| is_derived_sdr_allowed | Boolean | Read Only replication of the is_derived_sdr_allowed Project Setting | |||||||||||||
| is_live | Boolean | Asset is currently live streaming | |||||||||||||
| is_sdr_allowed | Boolean | Read Only replication of the is_sdr_allowed Project Setting | |||||||||||||
| is_unviewed | Boolean | Is this asset not viewed by current user | |||||||||||||
| master_id | CommonId | The master asset Id | |||||||||||||
| metadata | Object | The assets metadata | |||||||||||||
| name | String | The asset file name (without original file extension) | |||||||||||||
| offline_bytes | Integer | Number of bytes of primary files that needed to be downloaded for offline usage | |||||||||||||
| origin_type | Enum [Moxion, Flow, Hybrid] | Asset Origin type | |||||||||||||
| overall_processing_time | String | The overall time in seconds the asset has taken to complete processing | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | CommonId | The project ID this asset belongs to | |||||||||||||
| resume_position | Float | The last playback time in seconds for restarting playback | |||||||||||||
| scrub_jpg_frames | Integer | The number of frames in the scrub JPG | |||||||||||||
| scrub_jpg_url | String | The URL for the scrub JPG | |||||||||||||
| scrub_jpg_url_2x | String | The URL for the scrub JPG (2x resolution) | |||||||||||||
| scrub_jpg_url_3x | String | The URL for the scrub JPG (3x resolution) | |||||||||||||
| scrub_url | String | The URL for the thumbnail scrubber | |||||||||||||
| scrub_url_2x | String | The URL for the thumbnail scrubber (2x resolution) | |||||||||||||
| scrub_url_3x | String | The URL for the thumbnail scrubber (3x resolution) | |||||||||||||
| scrub_url_frames | Integer | The number of frames in the thumbnail scrubber | |||||||||||||
| sdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in SDR. | |||||||||||||
| sort_index | Integer | The sort index to use for display (low value should be display at the first) | |||||||||||||
| status | Enum [ACTIVE, TRANSCODING, PROCESSING, DELETED] | The asset status | |||||||||||||
| subtype | Enum [STREAMING, LIVE, IMMEDIATE, CAMERA_TYPE_ID, SLATE_TYPE_ID, CAPTURE_TYPE_ID, CAMERA_METADATA_TYPE_ID, PRODUCTION_SCENE_TYPE_ID, CAMERA_UNIT_TYPE_ID, SHOT_TYPE_ID, SEQUENCE_TYPE_ID] | The asset subtype | |||||||||||||
| subtypeDisplayName | String | The asset subtype in human readable format | |||||||||||||
| tags | CommonIdArray | The tag IDs for this asset | |||||||||||||
| thumbnail_url | String | The primary thumbnail URL for this asset | |||||||||||||
| thumbnail_url_2x | String | The primary thumbnail URL for this asset (2x resolution) | |||||||||||||
| thumbnail_url_3x | String | The primary thumbnail URL for this asset (3x resolution) | |||||||||||||
| timelines | String | Stringified JSON Array of timelines associated with this asset. Each timeline object contains array with segment objects. | |||||||||||||
| type | Enum [VIDEO, IMAGE, AUDIO, PDF, UNKNOWN, MULTI_PRIMARY, MULTI_SECONDARY, ORIGINAL] | The asset type | |||||||||||||
| uploaded_usage | Integer | Number of bytes of uploaded for this asset | |||||||||||||
| user_id | CommonId | The user ID this asset was created/uploaded by | |||||||||||||
| uuid | String | The asset UUID (if set) | |||||||||||||
| view_link | String | Link to view the asset in the Moxion web application. |
Get an assets primary playable file
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | No | CommonId | The asset ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| aspect_ratio | String | The file aspect ratio |
| asset_id | CommonId | The asset ID this file belongs to |
| asset_uuid | String | The asset UUID (if set) |
| audio_channels | Integer | The number of audio channels |
| audio_codec | String | The file audio codec |
| audio_rate | Integer | The file audio sample rate |
| batch_id | CommonId | The batch ID this file belongs to |
| bitrate | Float | The file bitrate (expressed in kbps) |
| category | String | The file category |
| certificate_url | String | The Fairplay DRM certificate URL if applicable |
| colorspace | String | The color space of this asset file |
| container | String | The file container format |
| file_extension | String | The file extension |
| file_name | String | The full file name (with file extension) |
| frame_rate | Float | The file framerate (expressed in FPS) |
| height | Integer | The file height |
| hls_resolutions_identifiers | StringArray | Suffix to append to asset file url to enable access to a specific resolution referenced in resolution_labels |
| id | CommonId | The file ID |
| is_dash | Boolean | True if this file points to a manifest for DASH encrypted files |
| is_fairplay | Boolean | True if this file points to an manifest for Fairplay encrypted files |
| is_hls | Boolean | Obsolete. Deprecated: see is_fairplay |
| is_playable | Boolean | True if this file can be played natively in the browser |
| is_playready | Boolean | True if this file points to a manifest for PlayReady encrypted files |
| is_realtime | Boolean | True if this file points to an realtime asset manifest |
| is_webrtc | Boolean | True if this file points to a Moxion live server |
| license_url | String | The license DRM License server URL |
| location | String | The non http location where this file can be accessed from |
| position | Integer | The last playback frame number for restarting playback |
| processing | Boolean | True if file is being generated, progress information provided by task_id |
| project_id | CommonId | The project ID this file belongs to |
| requires_token | Boolean | The license DRM License server requires a token |
| resolution | String | The video resolution |
| resolutions_colorspaces | StringArray | Color spaces for each resolution label (SDR/HDR) (correspond to the resolution labels) |
| resolutions_identifiers | StringArray | Streaming protocol identifier that will allow identification of the currently playing resolution (correspond to the resolution labels) |
| resolutions_labels | StringArray | Resolution display labels |
| resolutions_selectors | StringArray | Suffix to append to asset file url to enable access to a specific resolution and colorspace referenced in resolution_labels (correspond to the resolution labels) |
| resolutions_sizes | StringArray | Video size (width height values delimited by 'x') that correspond to the resolution labels |
| status | Enum [ACTIVE, DELETED, PROCESSING] | The file status |
| task_id | String | The processing task related to this batch of assets |
| tc_end | String | Time Code End |
| tc_start | String | Time Code Start |
| url | String | The URL where this file can be accessed |
| used_bytes | Integer | The file size in bytes |
| user_id | CommonId | The user ID this file was created/uploaded by |
| video_codec | String | The file video codec |
| watermark_url | String | The URL where the visual watermark for this file can be accessed. Note, this is only used for overlay watermarking (not burn-in watermarking). |
| webrtc_server_configuration | Object | WebRTC server configurations to use for STUN and TURN access to live assets |
| width | Integer | The file width |
Get all of the files associated with an asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| codec_capabilities | No | Object | Object defining the capabilities of the browser to decode certain codecs with hardware acceleration | Valid Object |
| id | Yes | CommonId | The asset ID | Valid CommonId |
| playable_only | No | Boolean | Only return web playable MP4 files | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| aspect_ratio | String | The file aspect ratio |
| asset_id | CommonId | The asset ID this file belongs to |
| asset_uuid | String | The asset UUID (if set) |
| audio_channels | Integer | The number of audio channels |
| audio_codec | String | The file audio codec |
| audio_rate | Integer | The file audio sample rate |
| batch_id | CommonId | The batch ID this file belongs to |
| bitrate | Float | The file bitrate (expressed in kbps) |
| category | String | The file category |
| certificate_url | String | The Fairplay DRM certificate URL if applicable |
| colorspace | String | The color space of this asset file |
| container | String | The file container format |
| file_extension | String | The file extension |
| file_name | String | The full file name (with file extension) |
| frame_rate | Float | The file framerate (expressed in FPS) |
| height | Integer | The file height |
| hls_resolutions_identifiers | StringArray | Suffix to append to asset file url to enable access to a specific resolution referenced in resolution_labels |
| id | CommonId | The file ID |
| is_dash | Boolean | True if this file points to a manifest for DASH encrypted files |
| is_fairplay | Boolean | True if this file points to an manifest for Fairplay encrypted files |
| is_hls | Boolean | Obsolete. Deprecated: see is_fairplay |
| is_playable | Boolean | True if this file can be played natively in the browser |
| is_playready | Boolean | True if this file points to a manifest for PlayReady encrypted files |
| is_realtime | Boolean | True if this file points to an realtime asset manifest |
| is_webrtc | Boolean | True if this file points to a Moxion live server |
| license_url | String | The license DRM License server URL |
| location | String | The non http location where this file can be accessed from |
| position | Integer | The last playback frame number for restarting playback |
| project_id | CommonId | The project ID this file belongs to |
| requires_token | Boolean | The license DRM License server requires a token |
| resolution | String | The video resolution |
| resolutions_colorspaces | StringArray | Color spaces for each resolution label (SDR/HDR) (correspond to the resolution labels) |
| resolutions_identifiers | StringArray | Streaming protocol identifier that will allow identification of the currently playing resolution (correspond to the resolution labels) |
| resolutions_labels | StringArray | Resolution display labels |
| resolutions_selectors | StringArray | Suffix to append to asset file url to enable access to a specific resolution and colorspace referenced in resolution_labels (correspond to the resolution labels) |
| resolutions_sizes | StringArray | Video size (width height values delimited by 'x') that correspond to the resolution labels |
| status | Enum [ACTIVE, DELETED, PROCESSING] | The file status |
| tc_end | String | Time Code End |
| tc_start | String | Time Code Start |
| url | String | The URL where this file can be accessed |
| used_bytes | Integer | The file size in bytes |
| user_id | CommonId | The user ID this file was created/uploaded by |
| video_codec | String | The file video codec |
| watermark_url | String | The URL where the visual watermark for this file can be accessed. Note, this is only used for overlay watermarking (not burn-in watermarking). |
| webrtc_server_configuration | Object | WebRTC server configurations to use for STUN and TURN access to live assets |
| width | Integer | The file width |
Get a single asset including all its metadata
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The asset ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| * | String | Will return any key->value data |
| tags | CommonIdArray | Asset tags |
| uploaded | Date | Date of upload |
Get all assets with given ID, or all assets within a batch, single project or list of projects.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_subtype_filter | No | StringArray | Restrict results to Assets of specific subtype(s). . Only used if project_id is specified. | Valid StringArray |
| asset_type_filter | No | StringArray | Restrict results to Assets of specific type(s). Only used if project_id is specified. | Valid StringArray |
| assets | No | CommonIdArray | Array of asset IDs. Ignored if the batch_id or project_id is specified. | Valid CommonIdArray |
| batch_id | No | CommonId | The batch ID. | Valid CommonId |
| include_links | No | Boolean | Whether to include the view_link in the response (default is false). | Valid Boolean |
| include_metadata | No | Boolean | Includes metadata. | Valid Boolean |
| include_offline_bytes | No | Boolean | Includes offline bytes. | Valid Boolean |
| include_usage | No | Boolean | Includes Asset Usage | Valid Boolean |
| project_id | No | CommonId | The project ID. Ignored if the batch_id is specified. | Valid CommonId |
| review_session_id | No | CommonId | Retrieve assets available in the common asset repository for this review session ID. Ignored if the batch_id or project_id is specified. | Valid CommonId |
| trigger_watermarking | No | Boolean | Immediately begin the watermarking process on these assets. | Valid Boolean |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| available_comment_channels | StringArray | List of available comment channels | |||||||||||||
| batch_id | CommonId | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| blurhash | String | A hashed representation of the asset | |||||||||||||
| can_access_project | Boolean | User can access this asset | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| can_offline | Boolean | User can offline this asset | |||||||||||||
| can_update | Boolean | User can update this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| component_data | Object | The components of the asset | |||||||||||||
| component_links | Array | The component details array List | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| deny_view | Boolean | True if the asset should not be viewable by the user. | |||||||||||||
| desc | String | The asset description | |||||||||||||
| drm_enabled | Boolean | Whether manifest playback is enabled on the project that contains this asset. | |||||||||||||
| duration | Float | The asset duration (in seconds) | |||||||||||||
| ext | String | The original asset file extension | |||||||||||||
| hdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in HDR. | |||||||||||||
| hidden | Boolean | The asset is hidden and not visible to users that don't have permission to view hidden batches | |||||||||||||
| id | CommonId | The asset ID | |||||||||||||
| is_admin | Boolean | True if the user has admin permission for this asset. | |||||||||||||
| is_derived_sdr | Boolean | True if the Asset has generated an SDR from an HDR, False if the user has provided their own SDR | |||||||||||||
| is_derived_sdr_allowed | Boolean | Read Only replication of the is_derived_sdr_allowed Project Setting | |||||||||||||
| is_live | Boolean | Asset is currently live streaming | |||||||||||||
| is_sdr_allowed | Boolean | Read Only replication of the is_sdr_allowed Project Setting | |||||||||||||
| is_unviewed | Boolean | Is this asset not viewed by current user | |||||||||||||
| master_id | CommonId | The master asset Id | |||||||||||||
| metadata | Object | The assets metadata | |||||||||||||
| name | String | The asset file name (without original file extension) | |||||||||||||
| offline_bytes | Integer | Number of bytes of primary files that needed to be downloaded for offline usage | |||||||||||||
| origin_type | Enum [Moxion, Flow, Hybrid] | Asset Origin type | |||||||||||||
| overall_processing_time | String | The overall time in seconds the asset has taken to complete processing | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | CommonId | The project ID this asset belongs to | |||||||||||||
| resume_position | Float | The last playback time in seconds for restarting playback | |||||||||||||
| scrub_jpg_frames | Integer | The number of frames in the scrub JPG | |||||||||||||
| scrub_jpg_url | String | The URL for the scrub JPG | |||||||||||||
| scrub_jpg_url_2x | String | The URL for the scrub JPG (2x resolution) | |||||||||||||
| scrub_jpg_url_3x | String | The URL for the scrub JPG (3x resolution) | |||||||||||||
| scrub_url | String | The URL for the thumbnail scrubber | |||||||||||||
| scrub_url_2x | String | The URL for the thumbnail scrubber (2x resolution) | |||||||||||||
| scrub_url_3x | String | The URL for the thumbnail scrubber (3x resolution) | |||||||||||||
| scrub_url_frames | Integer | The number of frames in the thumbnail scrubber | |||||||||||||
| sdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in SDR. | |||||||||||||
| sort_index | Integer | The sort index to use for display (low value should be display at the first) | |||||||||||||
| status | Enum [ACTIVE, TRANSCODING, PROCESSING, DELETED] | The asset status | |||||||||||||
| subtype | Enum [STREAMING, LIVE, IMMEDIATE, CAMERA_TYPE_ID, SLATE_TYPE_ID, CAPTURE_TYPE_ID, CAMERA_METADATA_TYPE_ID, PRODUCTION_SCENE_TYPE_ID, CAMERA_UNIT_TYPE_ID, SHOT_TYPE_ID, SEQUENCE_TYPE_ID] | The asset subtype | |||||||||||||
| subtypeDisplayName | String | The asset subtype in human readable format | |||||||||||||
| tags | CommonIdArray | The tag IDs for this asset | |||||||||||||
| thumbnail_url | String | The primary thumbnail URL for this asset | |||||||||||||
| thumbnail_url_2x | String | The primary thumbnail URL for this asset (2x resolution) | |||||||||||||
| thumbnail_url_3x | String | The primary thumbnail URL for this asset (3x resolution) | |||||||||||||
| timelines | String | Stringified JSON Array of timelines associated with this asset. Each timeline object contains array with segment objects. | |||||||||||||
| type | Enum [VIDEO, IMAGE, AUDIO, PDF, UNKNOWN, MULTI_PRIMARY, MULTI_SECONDARY, ORIGINAL] | The asset type | |||||||||||||
| uploaded_usage | Integer | Number of bytes of uploaded for this asset | |||||||||||||
| user_id | CommonId | The user ID this asset was created/uploaded by | |||||||||||||
| uuid | String | The asset UUID (if set) | |||||||||||||
| view_link | String | Link to view the asset in the Moxion web application. |
Get S3 upload endpoint details for uploaded CSV reports.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| content_type | Yes | String | Mime type of the file to upload | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| method | String | The HTTP method to be used when uploading (PUT or POST) |
| url | String | The signed URL to upload the file to |
Get S3 upload endpoint details
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| batch_id | No | CommonId | The batch ID, required when uploading to an existing batch | Valid CommonId |
| batch_name | No | String | The batch name, required when uploading to a new batch | No HTML tags No {{ }} expressions Length must not exceed 100 |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| accelerated | Boolean | Whether the upload is accelerated |
| access_key_id | String | The AWS access key id |
| endpoint | String | The endpoint base url |
| prefix | String | The prefix to use for files when uploading to S3 |
| region | String | The AWS region to upload to |
Move a single asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| batch_id | Yes | CommonId | The batch ID this asset will be moved into | Valid CommonId |
| id | Yes | CommonId | The asset ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| moved | Boolean | True if the asset was moved |
Move multiple assets
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | Yes | CommonIdArray | The asset IDs | Valid CommonIdArray |
| batch_id | Yes | CommonId | The batch ID this asset will be moved into | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | Id of the task |
Update metadata on a single asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| * | No | String | Will accept any key->value data to be applied to the assets metadata | No HTML tags No {{ }} expressions |
| custom_metadata | No | Object | This field will contain the custom metadata for the asset | Valid Object |
| id | Yes | CommonIdOrUUID | The asset ID or UUID | Valid CommonIdOrUUID |
| tags | No | CommonIdArray | Set the tags for the asset | Valid CommonIdArray |
| uuid | No | String | Set the UUID for the asset | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | True if the asset was updated |
Update the thumbnail position for an asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The asset ID | Valid CommonId |
| thumbnail_position | Yes | Float | The new thumbnail position (0-1) | Valid Float |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| available_comment_channels | StringArray | List of available comment channels | |||||||||||||
| batch_id | CommonId | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| blurhash | String | A hashed representation of the asset | |||||||||||||
| can_access_project | Boolean | User can access this asset | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| can_offline | Boolean | User can offline this asset | |||||||||||||
| can_update | Boolean | User can update this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| component_data | Object | The components of the asset | |||||||||||||
| component_links | Array | The component details array List | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| deny_view | Boolean | True if the asset should not be viewable by the user. | |||||||||||||
| desc | String | The asset description | |||||||||||||
| drm_enabled | Boolean | Whether manifest playback is enabled on the project that contains this asset. | |||||||||||||
| duration | Float | The asset duration (in seconds) | |||||||||||||
| ext | String | The original asset file extension | |||||||||||||
| hdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in HDR. | |||||||||||||
| hidden | Boolean | The asset is hidden and not visible to users that don't have permission to view hidden batches | |||||||||||||
| id | CommonId | The asset ID | |||||||||||||
| is_admin | Boolean | True if the user has admin permission for this asset. | |||||||||||||
| is_derived_sdr | Boolean | True if the Asset has generated an SDR from an HDR, False if the user has provided their own SDR | |||||||||||||
| is_derived_sdr_allowed | Boolean | Read Only replication of the is_derived_sdr_allowed Project Setting | |||||||||||||
| is_live | Boolean | Asset is currently live streaming | |||||||||||||
| is_sdr_allowed | Boolean | Read Only replication of the is_sdr_allowed Project Setting | |||||||||||||
| is_unviewed | Boolean | Is this asset not viewed by current user | |||||||||||||
| master_id | CommonId | The master asset Id | |||||||||||||
| metadata | Object | The assets metadata | |||||||||||||
| name | String | The asset file name (without original file extension) | |||||||||||||
| offline_bytes | Integer | Number of bytes of primary files that needed to be downloaded for offline usage | |||||||||||||
| origin_type | Enum [Moxion, Flow, Hybrid] | Asset Origin type | |||||||||||||
| overall_processing_time | String | The overall time in seconds the asset has taken to complete processing | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | CommonId | The project ID this asset belongs to | |||||||||||||
| resume_position | Float | The last playback time in seconds for restarting playback | |||||||||||||
| scrub_jpg_frames | Integer | The number of frames in the scrub JPG | |||||||||||||
| scrub_jpg_url | String | The URL for the scrub JPG | |||||||||||||
| scrub_jpg_url_2x | String | The URL for the scrub JPG (2x resolution) | |||||||||||||
| scrub_jpg_url_3x | String | The URL for the scrub JPG (3x resolution) | |||||||||||||
| scrub_url | String | The URL for the thumbnail scrubber | |||||||||||||
| scrub_url_2x | String | The URL for the thumbnail scrubber (2x resolution) | |||||||||||||
| scrub_url_3x | String | The URL for the thumbnail scrubber (3x resolution) | |||||||||||||
| scrub_url_frames | Integer | The number of frames in the thumbnail scrubber | |||||||||||||
| sdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in SDR. | |||||||||||||
| sort_index | Integer | The sort index to use for display (low value should be display at the first) | |||||||||||||
| status | Enum [ACTIVE, TRANSCODING, PROCESSING, DELETED] | The asset status | |||||||||||||
| subtype | Enum [STREAMING, LIVE, IMMEDIATE, CAMERA_TYPE_ID, SLATE_TYPE_ID, CAPTURE_TYPE_ID, CAMERA_METADATA_TYPE_ID, PRODUCTION_SCENE_TYPE_ID, CAMERA_UNIT_TYPE_ID, SHOT_TYPE_ID, SEQUENCE_TYPE_ID] | The asset subtype | |||||||||||||
| subtypeDisplayName | String | The asset subtype in human readable format | |||||||||||||
| tags | CommonIdArray | The tag IDs for this asset | |||||||||||||
| thumbnail_updated | Boolean | True if new thumbnail set | |||||||||||||
| thumbnail_url | String | The primary thumbnail URL for this asset | |||||||||||||
| thumbnail_url_2x | String | The primary thumbnail URL for this asset (2x resolution) | |||||||||||||
| thumbnail_url_3x | String | The primary thumbnail URL for this asset (3x resolution) | |||||||||||||
| timelines | String | Stringified JSON Array of timelines associated with this asset. Each timeline object contains array with segment objects. | |||||||||||||
| type | Enum [VIDEO, IMAGE, AUDIO, PDF, UNKNOWN, MULTI_PRIMARY, MULTI_SECONDARY, ORIGINAL] | The asset type | |||||||||||||
| uploaded_usage | Integer | Number of bytes of uploaded for this asset | |||||||||||||
| user_id | CommonId | The user ID this asset was created/uploaded by | |||||||||||||
| uuid | String | The asset UUID (if set) | |||||||||||||
| view_link | String | Link to view the asset in the Moxion web application. |
Bulk update metadata on an array of assets
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| * | No | String | Will accept any key->value data to be applied to the assets metadata | No HTML tags No {{ }} expressions |
| assets | Yes | CommonIdArray | Array of asset IDs | Valid CommonIdArray |
| custom_metadata | No | Object | This field will contain the custom metadata for the asset | Valid Object |
| tags | No | CommonIdArray | Set the tags for the asset | Valid CommonIdArray |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | True if the assets have been updated |
S3 Upload Result. This is a form POST (application/x-www-form-urlencoded)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | No | String | The asset ID, required when uploading a file to an existing asset | No HTML tags No {{ }} expressions |
| asset_uuid | No | String | The asset UUID to assign to a new asset. This asset ID is chosen by the uploading system and can be used to refer to the asset where parameter type is 'IdOrUUID'. | No HTML tags No {{ }} expressions |
| batch_hidden | No | Boolean | Whether the batch is hidden | Valid Boolean |
| batch_id | No | String | The batch ID, required when uploading to an existing batch | No HTML tags No {{ }} expressions |
| batch_name | No | String | The batch name, required when uploading to a new batch | No HTML tags No {{ }} expressions Length must not exceed 100 |
| key | Yes | String | The S3 object key of the uploaded file | No HTML tags No {{ }} expressions |
| name | Yes | String | The original file name | No HTML tags No {{ }} expressions |
| priority | No | Enum [PRIORITY, BACKGROUND] | Priority that this process should be run with | Valid Enum |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| sns_topic | No | String | AWS SNS topic to notify about asset processing progress | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| asset_id | CommonId | The asset ID that is going to be created |
Prepare for S3 upload by getting server-side signature (supports integration with FineUploader)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| headers | No | String | The headers to sign, required for multi-part uploads | No HTML tags No {{ }} expressions |
| policy | No | String | The encoded policy to sign, required for non multi-part uploads | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| policy | String | The base64 encoded signed policy (returned for non multi-part uploads) |
| signature | String | The signature with sha256 applied (returned for multi-part uploads) |
Validate a group of uploads that are going to be uploaded together, returning a list of potential warnings and errors that may affect processing
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| keys | Yes | StringArray | A list of object keys for the files to be uploaded | Valid StringArray |
| metadata | Yes | StringArray | A list of S3 object keys relating to the metadata for this file, if no metadata is available for this file, and empty string should be returned for that position. | Valid StringArray |
| names | Yes | StringArray | A list of original file names that match the keys | Valid StringArray |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| processing | Boolean | True if validation is required and is being processed in the background, progress information provided by task_id |
| task_id | String | The validation task ID related to this batch of assets |
Authenticate a user by their API key pair and return a secure token if successful
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| api_id | Yes | String | API ID | No HTML tags No {{ }} expressions |
| api_key | Yes | String | API Key | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| authenticated | Boolean | True if successful authentication |
| expires | Integer | The time in seconds when the token will expire from now |
| token | String | The security token to use on further API requests |
Begin a device login
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| authentication_scope | No | Enum [DEFAULT, LIVE, IMMEDIATES] | Scope of authentication request. | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| device_code | String | Unique ID of the device |
| expires_in | Integer | Seconds until request expiry |
| interval | Integer | Seconds between polls |
| user_code | String | Short code that verifies that the user is on the correct device |
| verification_uri | String | Page to visit to log in |
Get a QR code image for a given device authentication login
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| No | String | Users email address | Length must not exceed 254 Valid email format | |
| size | No | Integer | The desired size of the QR code image (width or height in pixels) | Valid Integer |
| user_code | Yes | String | Short code that verifies that the user is on the correct device | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|
Poll for a device authentication token.
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| device_code | Yes | String | Device code ex the /authenticate/device flow | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| additional_details | Object | Additional details for an authentication request, varies depending on scope selected |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| authenticated | Boolean | True if successful authentication |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| elevio_hash | String | Elevio authentication hash |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| expires | Integer | The time in seconds when the token will expire from now |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| externally_managed | Boolean | Is this user sourced from outside Moxion (ie SCIM)? |
| first_name | String | Users first name |
| helpscout_user_signature | String | Helpscout user signature |
| helpscout_user_signature_mx6 | String | Helpscout user signature for MX6 |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| phone | String | Users phone number |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| redirect | String | This server is not able to handle this request, resubmit your request on this server |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| session_data | String | Users persistent app session data |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sync_token | String | The CSRF Synchronizer Token to use on further API requests |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| token | String | The security token to use on further API requests |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
Verify a device flow user code and generate a login URL for the frontend
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| user_code | Yes | String | User code ex the /authenticate/device call | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | If the user code is valid and an auth token is ready for pick up by the TV |
Replace the token of authenticated user with a fresh token.
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| onetimetoken | Yes | String | One-time token that was previously provided to a user. | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| authenticated | Boolean | True if successful authentication |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| elevio_hash | String | Elevio authentication hash |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| expires | Integer | The time in seconds when the token will expire from now |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| externally_managed | Boolean | Is this user sourced from outside Moxion (ie SCIM)? |
| first_name | String | Users first name |
| helpscout_user_signature | String | Helpscout user signature |
| helpscout_user_signature_mx6 | String | Helpscout user signature for MX6 |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| phone | String | Users phone number |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| session_data | String | Users persistent app session data |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sync_token | String | The CSRF Synchronizer Token to use on further API requests |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| token | String | The security token to use on further API requests |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
Authenticate a review session user.
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| firstname | Yes | String | the first name of the review user | No HTML tags No {{ }} expressions |
| lastname | Yes | String | the last name of the review user | No HTML tags No {{ }} expressions |
| review_session_user_id | Yes | String | The review user id combined with the review user hash | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| authenticated | Boolean | True if successful authentication |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| elevio_hash | String | Elevio authentication hash |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| expires | Integer | The time in seconds when the token will expire from now |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| externally_managed | Boolean | Is this user sourced from outside Moxion (ie SCIM)? |
| first_name | String | Users first name |
| force_mfa_every_login | Boolean | Require MFA at every login |
| helpscout_user_signature | String | Helpscout user signature |
| helpscout_user_signature_mx6 | String | Helpscout user signature for MX6 |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| md_challenge | String | |
| mfa_required | Boolean | True if this user needs to login with an MFA code |
| mfa_setup_required | Boolean | True if this user has MFA enabled but has not yet setup |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| phone | String | Users phone number |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| server_time | Date | Current server time (ISO format) |
| session_data | String | Users persistent app session data |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sync_token | String | The CSRF Synchronizer Token to use on further API requests |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| token | String | The security token to use on further API requests |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
Authenticate a user via Saml 2.0 using HTTP POST. User-agent will be redirected to `/sso/callback?apiResponse=
| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| relaystate | Yes | String | State of the authorization flow. | No HTML tags No {{ }} expressions |
| samlresponse | Yes | String | Encoded response returned from the identity provider. | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| authenticated | Boolean | True if successful authentication |
| String | The email address of the user. Provided only if authentication was successful. | |
| onetimetoken | String | A security token that can be exchanged exactly once for a persistent token at `/authenticate/user/onetimetoken`. Provided only if authentication was successful. |
| provider | String | The SSO provider ID of this user. Provided only if authentication was successful. |
Authenticate a user via OpenID Connect
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| access_token | Yes | String | Access token provided by frontend OpenID Connect flow | No HTML tags No {{ }} expressions |
| access_token_expiry | No | Integer | Access token expiry (epoch date) | Valid Integer |
| domain | No | String | Domain user is attempting to log into. Must match an entry in the Domain table | No HTML tags No {{ }} expressions |
| provider | Yes | String | OpenID Connect provider (eg okta). Must match an entry in the Domain SSO configuration. | No HTML tags No {{ }} expressions |
| refresh_token | No | String | Refresh token provided by OpenID Connect flow | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| authenticated | Boolean | True if successful authentication |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| elevio_hash | String | Elevio authentication hash |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| expires | Integer | The time in seconds when the token will expire from now |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| externally_managed | Boolean | Is this user sourced from outside Moxion (ie SCIM)? |
| first_name | String | Users first name |
| helpscout_user_signature | String | Helpscout user signature |
| helpscout_user_signature_mx6 | String | Helpscout user signature for MX6 |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| phone | String | Users phone number |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| session_data | String | Users persistent app session data |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sync_token | String | The CSRF Synchronizer Token to use on further API requests |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| token | String | The security token to use on further API requests |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
Invite a user to Autodesk Platform Services, if they do not already exist.
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| Yes | String | Email of user to invite | Length must not exceed 254 Valid email format | |
| provider | Yes | String | Provider that will handle invitation. Must currently be 'aps' | No HTML tags No {{ }} expressions |
| return_url | Yes | String | URL to redirect to after invitation. Must be whitelisted in APS. | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| invitation_url | String | If the user does not already exist, the URL to redirect them to to sign up |
| user_already_exists | Boolean | True if the user already exists (no new invitation issued, user may log in with APS SSO already) |
Create a new empty batch
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| name | Yes | String | The batch name | No HTML tags No {{ }} expressions Length must not exceed 100 |
| project_id | Yes | CommonId | The project ID this batch belongs to | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| created | String | The batch creation time |
| creator | Id | The creator of this batch (user ID) |
| hidden | Boolean | The batch is hidden and not visible to users that don't have permission to view hidden batches |
| id | CommonId | The batch ID |
| name | String | The batch name |
| owner | Id | The owner of this batch (user ID) |
| project_id | CommonId | The project ID this batch belongs to |
| status | Enum [ACTIVE, DELETED] | The batch status |
Delete a batch
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The batch ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the batch (and all containing assets) were deleted |
Get a single batch by the batch ID
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The batch ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| created | String | The batch creation time |
| creator | Id | The creator of this batch (user ID) |
| hidden | Boolean | The batch is hidden and not visible to users that don't have permission to view hidden batches |
| id | CommonId | The batch ID |
| name | String | The batch name |
| owner | Id | The owner of this batch (user ID) |
| project_id | CommonId | The project ID this batch belongs to |
| status | Enum [ACTIVE, DELETED] | The batch status |
Get all batches from a project or if no project ID supplied return all batches the user has access to
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| include_assets | No | Boolean | Return array of asset IDs belonging to the batch | Valid Boolean |
| project_id | No | CommonId | The project ID | Valid CommonId |
| projects | No | CommonIdArray | Only get batches for projects with those ids | Valid CommonIdArray |
| sort_by | No | Enum [NEWEST, OLDEST, NAME] | Sort by | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| assets | CommonIdArray | Array of asset IDs contained in this batch |
| created | String | The batch creation time |
| creator | Id | The creator of this batch (user ID) |
| hidden | Boolean | The batch is hidden and not visible to users that don't have permission to view hidden batches |
| id | CommonId | The batch ID |
| name | String | The batch name |
| owner | Id | The owner of this batch (user ID) |
| project_id | CommonId | The project ID this batch belongs to |
| status | Enum [ACTIVE, DELETED] | The batch status |
Update a batch
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| hidden | No | Boolean | The the batch is hidden | Valid Boolean |
| id | Yes | CommonId | The batch ID | Valid CommonId |
| name | Yes | String | The batch name | No HTML tags No {{ }} expressions Length must not exceed 100 |
| notify_users | No | IdArray | Users to notify when unhide the batch | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| created | String | The batch creation time |
| creator | Id | The creator of this batch (user ID) |
| hidden | Boolean | The batch is hidden and not visible to users that don't have permission to view hidden batches |
| id | CommonId | The batch ID |
| name | String | The batch name |
| owner | Id | The owner of this batch (user ID) |
| project_id | CommonId | The project ID this batch belongs to |
| status | Enum [ACTIVE, DELETED] | The batch status |
Create a comment on an asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | No | CommonIdOrUUID | The asset ID or UUID this comment belongs to | Valid CommonIdOrUUID |
| channel_type | No | Enum [PUBLIC, PRIVATE] | The comment channel type (PUBLIC or PRIVATE) | Valid Enum |
| color | No | String | The color of this comment (in hex format) | No HTML tags No {{ }} expressions |
| colorspace | No | String | The colorspace of the asset the user was viewing at comment time | No HTML tags No {{ }} expressions Length must not exceed 10 |
| created | No | Date | The date/time this comment was created (ISO format UTC) | Valid Date |
| creator_email | No | String | The comment creators email | Length must not exceed 254 Valid email format |
| creator_name | No | String | The comment creators name | No HTML tags No {{ }} expressions Length must not exceed 64 |
| creator_role | No | String | The comment creators role | No HTML tags No {{ }} expressions |
| description | No | String | The actual comment text | No HTML tags No {{ }} expressions Length must not exceed 61440 |
| has_marker | No | Boolean | Is this comment attached to a timeline marker | Valid Boolean |
| height | No | Integer | The height in pixels of the asset this user was viewing at comment time | Valid Integer |
| is_reply | No | Boolean | Is this comment a reply to another comment | Valid Boolean |
| marker_duration | No | Float | The marker duration (only set if the comment has a marker) | Valid Float |
| marker_time | No | Float | The time offset in seconds for the comment marker (only set if the comment has a marker) | Valid Float |
| marker_timecode | No | String | The timecode that corresponds to this marker_time | No HTML tags No {{ }} expressions |
| mentions | No | CommonIdArray | Array of user IDs to mention in the comment | Valid CommonIdArray |
| parent_id | No | CommonId | The comment ID of the parent comment (only set if this comment is a reply) | Valid CommonId |
| playlink_id | No | Id | The playlink ID this comment belongs to (if any) | Valid Id |
| review_session_id | No | Id | The realtime review session ID this comment belongs to (if any) | Valid Id |
| scope | No | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The comment scope: ASSET, REVIEW_SESSION or PLAYLINK | Valid Enum |
| type | No | Enum [COMMENT, IO_POINT, ASSET] | The comment type | Valid Enum |
| uuid | No | String | Assign the new comment this UUID | No HTML tags No {{ }} expressions |
| width | No | Integer | The width in pixels of the asset this user was viewing at comment time | Valid Integer |
| Parameter | Type | Description |
|---|---|---|
| asset_id | CommonId | The asset ID this comment belongs to |
| channel_type | Enum [PUBLIC, PRIVATE] | The comment channel type (PUBLIC or PRIVATE) |
| color | String | The color of this indicator (in hex format) |
| colorspace | String | The colorspace of the asset the user was viewing at comment time. |
| completed_by_user_first_name | String | First name of the user who flagged this comment as completed |
| completed_by_user_id | CommonId | ID of the user who flagged this comment as completed |
| completed_by_user_last_name | String | Last name of the user who flagged this comment as completed |
| created | Date | The date/time this comment was created |
| creator_email | String | The comment creators email |
| creator_name | String | The comment creators name |
| creator_role | String | The comment creators role |
| description | String | The actual comment text |
| has_drawing | Boolean | Does this comment have an associated DRAWING_V2 indicator? |
| has_marker | Boolean | Is this comment attached to a timeline marker |
| has_obsolete_drawing | Boolean | Does this comment have an deprecated DRAWING or BEACON indicator associated with it? |
| has_reply | Boolean | Has this comment been replied to |
| height | Integer | The height of the asset the user was viewing at content time. |
| id | CommonId | The comment ID |
| is_expired | Boolean | Is this comment expired and can no longer be edited or changed |
| is_owner | Boolean | Is the requesting user the owner/creator of this comment |
| is_reply | Boolean | Is this comment a reply to another comment |
| marker_duration | Float | The marker duration (only set if the comment has a marker) |
| marker_time | Float | The time offset in seconds for the comment marker (only set if the comment has a maker) |
| marker_timecode | String | The timecode that corresponds to the marker time |
| parent_id | CommonId | The comment ID of the parent comment (only set if this comment is a reply) |
| project_id | CommonId | The project ID this comment belongs to |
| resolution_label | String | The human-friendly resolution label of the asset the user was viewing at comment time. eg UHD, 1080p, 4K |
| scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The comment scope (where this comment is visible) |
| type | Enum [COMMENT, IO_POINT, ASSET] | The comment type |
| user_first_name | String | First name of comment owner |
| user_id | CommonId | The user ID of the person who created this comment |
| user_last_name | String | Last name of comment owner |
| user_project_role | String | Project role of comment owner |
| uuid | String | The comment UUID (if set) |
| width | Integer | The width of the asset the user was viewing at content time. |
Delete a comment
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonIdOrUUID | The comment ID or UUID | Valid CommonIdOrUUID |
| include_replies | No | Boolean | True if the comment's replies are to be recursively deleted | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the comment (and all associated markers) were deleted |
Get a single comments associated with an asset.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | CommonIdOrUUID | The asset ID | Valid CommonIdOrUUID |
| channel_type | No | Enum [ALL, PUBLIC, PRIVATE] | The comment channel type (PUBLIC, PRIVATE, or ALL) | Valid Enum |
| comment_id | Yes | CommonId | The comment ID | Valid CommonId |
| include_asset_level_comments | No | Boolean | Flag to include asset level comments in the response, by default is true | Valid Boolean |
| playlink_id | No | Id | The ID of the playlink (if any). Only the user's comments will be retrieved for this playlink. | Valid Id |
| read_scopes | No | StringArray | List of scopes of the comments to retrieve. | Valid StringArray |
| review_session_id | No | Id | The ID of the realtime review session (if any) | Valid Id |
| scope | No | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of the comments to retrieve. Deprecated: Prefer read_scopes. | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| asset_id | CommonId | The asset ID this comment belongs to |
| channel_type | Enum [PUBLIC, PRIVATE] | The comment channel type (PUBLIC or PRIVATE) |
| color | String | The color of this indicator (in hex format) |
| colorspace | String | The colorspace of the asset the user was viewing at comment time. |
| completed_by_user_first_name | String | First name of the user who flagged this comment as completed |
| completed_by_user_id | CommonId | ID of the user who flagged this comment as completed |
| completed_by_user_last_name | String | Last name of the user who flagged this comment as completed |
| created | Date | The date/time this comment was created |
| creator_email | String | The comment creators email |
| creator_name | String | The comment creators name |
| creator_role | String | The comment creators role |
| description | String | The actual comment text |
| has_drawing | Boolean | Does this comment have an associated DRAWING_V2 indicator? |
| has_marker | Boolean | Is this comment attached to a timeline marker |
| has_obsolete_drawing | Boolean | Does this comment have an deprecated DRAWING or BEACON indicator associated with it? |
| has_reply | Boolean | Has this comment been replied to |
| height | Integer | The height of the asset the user was viewing at content time. |
| id | CommonId | The comment ID |
| is_expired | Boolean | Is this comment expired and can no longer be edited or changed |
| is_owner | Boolean | Is the requesting user the owner/creator of this comment |
| is_reply | Boolean | Is this comment a reply to another comment |
| marker_duration | Float | The marker duration (only set if the comment has a marker) |
| marker_time | Float | The time offset in seconds for the comment marker (only set if the comment has a maker) |
| marker_timecode | String | The timecode that corresponds to the marker time |
| parent_id | CommonId | The comment ID of the parent comment (only set if this comment is a reply) |
| project_id | CommonId | The project ID this comment belongs to |
| resolution_label | String | The human-friendly resolution label of the asset the user was viewing at comment time. eg UHD, 1080p, 4K |
| scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The comment scope (where this comment is visible) |
| type | Enum [COMMENT, IO_POINT, ASSET] | The comment type |
| user_first_name | String | First name of comment owner |
| user_id | CommonId | The user ID of the person who created this comment |
| user_last_name | String | Last name of comment owner |
| user_project_role | String | Project role of comment owner |
| uuid | String | The comment UUID (if set) |
| width | Integer | The width of the asset the user was viewing at content time. |
Get all of the comments associated with an asset.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | CommonIdOrUUID | The asset ID or UUID. | Valid CommonIdOrUUID |
| channel_type | No | Enum [ALL, PUBLIC, PRIVATE] | The comment channel type (PUBLIC, PRIVATE, or ALL) | Valid Enum |
| include_asset_level_comments | No | Boolean | Flag to include asset level comments in the response, by default is true | Valid Boolean |
| playlink_id | No | Id | The ID of the playlink (if any). Only the user's comments will be retrieved for this playlink. | Valid Id |
| read_scopes | No | StringArray | List of scopes of comments to retrieve. | Valid StringArray |
| review_session_id | No | Id | The ID of the realtime review session (if any) | Valid Id |
| scope | No | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of the comments to retrieve. Deprecated: Prefer read_scopes. | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| asset_id | CommonId | The asset ID this comment belongs to |
| channel_type | Enum [PUBLIC, PRIVATE] | The comment channel type (PUBLIC or PRIVATE) |
| color | String | The color of this indicator (in hex format) |
| colorspace | String | The colorspace of the asset the user was viewing at comment time. |
| completed_by_user_first_name | String | First name of the user who flagged this comment as completed |
| completed_by_user_id | CommonId | ID of the user who flagged this comment as completed |
| completed_by_user_last_name | String | Last name of the user who flagged this comment as completed |
| created | Date | The date/time this comment was created |
| creator_email | String | The comment creators email |
| creator_name | String | The comment creators name |
| creator_role | String | The comment creators role |
| description | String | The actual comment text |
| has_drawing | Boolean | Does this comment have an associated DRAWING_V2 indicator? |
| has_marker | Boolean | Is this comment attached to a timeline marker |
| has_obsolete_drawing | Boolean | Does this comment have an deprecated DRAWING or BEACON indicator associated with it? |
| has_reply | Boolean | Has this comment been replied to |
| height | Integer | The height of the asset the user was viewing at content time. |
| id | CommonId | The comment ID |
| is_expired | Boolean | Is this comment expired and can no longer be edited or changed |
| is_owner | Boolean | Is the requesting user the owner/creator of this comment |
| is_reply | Boolean | Is this comment a reply to another comment |
| marker_duration | Float | The marker duration (only set if the comment has a marker) |
| marker_time | Float | The time offset in seconds for the comment marker (only set if the comment has a maker) |
| marker_timecode | String | The timecode that corresponds to the marker time |
| parent_id | CommonId | The comment ID of the parent comment (only set if this comment is a reply) |
| project_id | CommonId | The project ID this comment belongs to |
| resolution_label | String | The human-friendly resolution label of the asset the user was viewing at comment time. eg UHD, 1080p, 4K |
| scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The comment scope (where this comment is visible) |
| type | Enum [COMMENT, IO_POINT, ASSET] | The comment type |
| user_first_name | String | First name of comment owner |
| user_id | CommonId | The user ID of the person who created this comment |
| user_last_name | String | Last name of comment owner |
| user_project_role | String | Project role of comment owner |
| uuid | String | The comment UUID (if set) |
| width | Integer | The width of the asset the user was viewing at content time. |
Get comments count associated with an asset group by channel.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | CommonIdOrUUID | The asset ID or UUID. | Valid CommonIdOrUUID |
| playlink_id | No | Id | The ID of the playlink (if any). Only the user's comments will be retrieved for this playlink. | Valid Id |
| read_scopes | No | StringArray | List of scopes of comments to retrieve. | Valid StringArray |
| review_session_id | No | Id | The ID of the realtime review session (if any) | Valid Id |
| scope | No | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of the comments to retrieve. Deprecated: Prefer read_scopes. | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| asset_id | CommonId | The asset ID or UUID. |
| private_comments_count | Integer | The count of private comment |
| public_comments_count | Integer | The count of public comment |
Get an SVG version of the indicator (drawing) associated with a comment.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| comment_id | Yes | CommonId | The comment ID to get indicators from | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| has_drawing | Boolean | Does this comment have an indicator? |
| svg | String | SVG representation of the comment indicator, if it exists. |
Update a comment or create a new comment if it does not exist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | No | CommonIdOrUUID | The asset ID or UUID this comment belongs to | Valid CommonIdOrUUID |
| channel_type | No | Enum [PUBLIC, PRIVATE] | The comment channel type (PUBLIC or PRIVATE) | Valid Enum |
| color | No | String | The color of this comment (in hex format) | No HTML tags No {{ }} expressions |
| colorspace | No | String | The colorspace of the asset the user was viewing at comment time | No HTML tags No {{ }} expressions Length must not exceed 10 |
| created | No | Date | The date/time this comment was created (ISO format UTC) | Valid Date |
| creator_email | No | String | The comment creators email | Length must not exceed 254 Valid email format |
| creator_name | No | String | The comment creators name | No HTML tags No {{ }} expressions Length must not exceed 64 |
| creator_role | No | String | The comment creators role | No HTML tags No {{ }} expressions |
| description | No | String | The actual comment text | No HTML tags No {{ }} expressions Length must not exceed 61440 |
| has_marker | No | Boolean | Is this comment attached to a timeline marker | Valid Boolean |
| height | No | Integer | The height in pixels of the asset this user was viewing at comment time | Valid Integer |
| id | Yes | CommonIdOrUUID | The comment ID or UUID | Valid CommonIdOrUUID |
| is_reply | No | Boolean | Is this comment a reply to another comment | Valid Boolean |
| marker_duration | No | Float | The marker duration (only set if the comment has a marker) | Valid Float |
| marker_time | No | Float | The time offset in seconds for the comment marker (only set if the comment has a marker) | Valid Float |
| marker_timecode | No | String | The timecode that corresponds to this marker_time | No HTML tags No {{ }} expressions |
| mentions | No | CommonIdArray | Array of user IDs to mention in the comment | Valid CommonIdArray |
| parent_id | No | CommonId | The comment ID of the parent comment (only set if this comment is a reply) | Valid CommonId |
| playlink_id | No | Id | The playlink ID this comment belongs to (if any) | Valid Id |
| review_session_id | No | Id | The realtime review session ID this comment belongs to (if any) | Valid Id |
| scope | No | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The comment scope: ASSET, REVIEW_SESSION or PLAYLINK | Valid Enum |
| type | No | Enum [COMMENT, IO_POINT, ASSET] | The comment type | Valid Enum |
| uuid | No | String | Assign the new comment this UUID | No HTML tags No {{ }} expressions |
| width | No | Integer | The width in pixels of the asset this user was viewing at comment time | Valid Integer |
| Parameter | Type | Description |
|---|---|---|
| asset_id | CommonId | The asset ID this comment belongs to |
| channel_type | Enum [PUBLIC, PRIVATE] | The comment channel type (PUBLIC or PRIVATE) |
| color | String | The color of this indicator (in hex format) |
| colorspace | String | The colorspace of the asset the user was viewing at comment time. |
| completed_by_user_first_name | String | First name of the user who flagged this comment as completed |
| completed_by_user_id | CommonId | ID of the user who flagged this comment as completed |
| completed_by_user_last_name | String | Last name of the user who flagged this comment as completed |
| created | Date | The date/time this comment was created |
| creator_email | String | The comment creators email |
| creator_name | String | The comment creators name |
| creator_role | String | The comment creators role |
| description | String | The actual comment text |
| has_drawing | Boolean | Does this comment have an associated DRAWING_V2 indicator? |
| has_marker | Boolean | Is this comment attached to a timeline marker |
| has_obsolete_drawing | Boolean | Does this comment have an deprecated DRAWING or BEACON indicator associated with it? |
| has_reply | Boolean | Has this comment been replied to |
| height | Integer | The height of the asset the user was viewing at content time. |
| id | CommonId | The comment ID |
| is_expired | Boolean | Is this comment expired and can no longer be edited or changed |
| is_owner | Boolean | Is the requesting user the owner/creator of this comment |
| is_reply | Boolean | Is this comment a reply to another comment |
| marker_duration | Float | The marker duration (only set if the comment has a marker) |
| marker_time | Float | The time offset in seconds for the comment marker (only set if the comment has a maker) |
| marker_timecode | String | The timecode that corresponds to the marker time |
| parent_id | CommonId | The comment ID of the parent comment (only set if this comment is a reply) |
| project_id | CommonId | The project ID this comment belongs to |
| resolution_label | String | The human-friendly resolution label of the asset the user was viewing at comment time. eg UHD, 1080p, 4K |
| scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The comment scope (where this comment is visible) |
| type | Enum [COMMENT, IO_POINT, ASSET] | The comment type |
| updated | Boolean | True if comment has been updated |
| user_first_name | String | First name of comment owner |
| user_id | CommonId | The user ID of the person who created this comment |
| user_last_name | String | Last name of comment owner |
| user_project_role | String | Project role of comment owner |
| uuid | String | The comment UUID (if set) |
| width | Integer | The width of the asset the user was viewing at content time. |
Mark a comment as completed or not completed
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The comment ID | Valid CommonId |
| is_complete | Yes | Boolean | True to mark the comment complete, false to unmark it | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| asset_id | CommonId | The asset ID this comment belongs to |
| channel_type | Enum [PUBLIC, PRIVATE] | The comment channel type (PUBLIC or PRIVATE) |
| color | String | The color of this indicator (in hex format) |
| colorspace | String | The colorspace of the asset the user was viewing at comment time. |
| completed_by_user_first_name | String | First name of the user who flagged this comment as completed |
| completed_by_user_id | CommonId | ID of the user who flagged this comment as completed |
| completed_by_user_last_name | String | Last name of the user who flagged this comment as completed |
| created | Date | The date/time this comment was created |
| creator_email | String | The comment creators email |
| creator_name | String | The comment creators name |
| creator_role | String | The comment creators role |
| description | String | The actual comment text |
| has_drawing | Boolean | Does this comment have an associated DRAWING_V2 indicator? |
| has_marker | Boolean | Is this comment attached to a timeline marker |
| has_obsolete_drawing | Boolean | Does this comment have an deprecated DRAWING or BEACON indicator associated with it? |
| has_reply | Boolean | Has this comment been replied to |
| height | Integer | The height of the asset the user was viewing at content time. |
| id | CommonId | The comment ID |
| is_expired | Boolean | Is this comment expired and can no longer be edited or changed |
| is_owner | Boolean | Is the requesting user the owner/creator of this comment |
| is_reply | Boolean | Is this comment a reply to another comment |
| marker_duration | Float | The marker duration (only set if the comment has a marker) |
| marker_time | Float | The time offset in seconds for the comment marker (only set if the comment has a maker) |
| marker_timecode | String | The timecode that corresponds to the marker time |
| parent_id | CommonId | The comment ID of the parent comment (only set if this comment is a reply) |
| project_id | CommonId | The project ID this comment belongs to |
| resolution_label | String | The human-friendly resolution label of the asset the user was viewing at comment time. eg UHD, 1080p, 4K |
| scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The comment scope (where this comment is visible) |
| type | Enum [COMMENT, IO_POINT, ASSET] | The comment type |
| updated | Boolean | True if comment has been marked completed |
| user_first_name | String | First name of comment owner |
| user_id | CommonId | The user ID of the person who created this comment |
| user_last_name | String | Last name of comment owner |
| user_project_role | String | Project role of comment owner |
| uuid | String | The comment UUID (if set) |
| width | Integer | The width of the asset the user was viewing at content time. |
Create or update drawing data for an comment marker
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| comment_id | Yes | CommonId | The comment ID this indicator belongs to | Valid CommonId |
| drawing_data | Yes | String | The drawing data JSON | No HTML tags No {{ }} expressions |
| type | No | Enum [DRAWING_V2, DRAWING, BEACON] | The type of Drawing data: DRAWING_V2 (default) or DRAWING | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| beacon_x | Float | The indicator beacons X position relative to the frame |
| beacon_y | Float | The indicator beacons Y position relative to the frame |
| color | String | The color of this indicator (in hex format) |
| comment_id | CommonId | The comment ID this indicator belongs to |
| created | Date | The date/time this indicator was created |
| drawing_data | String | The raw drawing/path data JSON |
| has_reply | Boolean | Has this indicator been replied to |
| id | CommonId | The indicator ID |
| is_expired | Boolean | Is this indicator expired and can no longer be edited or changed |
| is_owner | Boolean | Is the requesting user the owner/creator of this indicator |
| type | Enum [DRAWING_V2, DRAWING, BEACON] | The indicator type will be DRAWING_V2 (with BEACON and DRAWING being older, obsolete types) |
| user_id | Id | The user ID of the person who created this comment |
Create company control settings/limits
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| expiry_date | No | Date | The last date the company will be active | Valid Date |
| id | Yes | Id | The company ID | Valid Id |
| max_usage | No | Integer | The maximum disk usage allowed on assets for the company | Valid Integer |
| notes | No | String | Notes on the control record | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| control_id | Id | The control record id |
| expiry_date | Date | Expiry date of the corresponding record |
| max_usage | Integer | Maximum allowed usage |
| notes | String | Notes on the restrictions |
| record_id | Id | ID of the matching company/group |
| record_type | String | Type of record control attached to |
| start_date | Date | Start date of the corresponding record |
| updated | Boolean | True if the company control has been created |
Delete control limits from the company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| all_groups | No | Boolean | Flag indicating the group control records are also to be deleted | Valid Boolean |
| id | Yes | Id | The company ID | Valid Id |
| notes | No | String | String note to be added to the control record. | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the control record was deleted from the company |
| groups | IdArray | The control record was also removed from these groups |
Delete a user from the company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | No | CommonId | Remove the user only from this specified group / production | Valid CommonId |
| id | Yes | Id | The company ID | Valid Id |
| projects | No | CommonIdArray | Remove the user from these projects | Valid CommonIdArray |
| teams | No | IdArray | Remove the user from these teams | Valid IdArray |
| user_id | Yes | Id | The user ID to delete from the company | Valid Id |
| validate | No | Boolean | Check if this delete will work without actually deleting | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the user was deleted from the company |
| projects | CommonIdArray | The user was removed from these projects |
| teams | IdArray | The user was removed from these teams |
| validated | Boolean | True if the dry_run is true and the user can be deleted removed with these parameters |
Get all of the companies associated with the current user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| with_usage | No | Boolean | Return usage and production count for each company. | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| active | Boolean | Is company active |
| admin_team | Id | The company administration team |
| allow_impersonation_control | Boolean | User may see the controls that allow enable/disable Support User Access |
| allow_inbox_only_option | Boolean | This parameter will be used to control the access to modify the 'inbox only' option on 'Manage Teams' feature |
| can_create_group | Boolean | True if this user can create groups for this company |
| can_create_playlinks | Boolean | True if the user can send create playlinks |
| can_create_screenshots | Boolean | True if the user can create screenshots from assets |
| can_csv_transfer | Boolean | True if the user can Import/Export CSV files |
| can_display_activity_stream | Boolean | True if the user can see the 'Activity Stream' feature |
| can_display_personal_settings | Boolean | True if the user can see the 'Personal Settings' panel |
| can_display_playlists | Boolean | This parameter will be used to control access to the playlinks panel in the bottom of the UI |
| can_display_production_template | Boolean | True if the user can see the 'Production Template' feature |
| can_display_shares | Boolean | This parameter this will be used to control access to the sharing panel |
| can_display_tags | Boolean | True if the user can see the 'Tags' panel |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_manage_asset | Boolean | True if the user can manage assets |
| can_search_query | Boolean | True if the user can search query |
| can_send_to_qtake | Boolean | True if the user can send assets to shotgrid |
| can_send_to_shotgrid | Boolean | True if the user can send assets to shotgrid |
| can_share | Boolean | Does this company allow shares? |
| can_update_participants | Boolean | True if this user can update participants for this company |
| can_view_participants | Boolean | True if this user can view participants for this company |
| disallow_impersonation | Boolean | This parameter will indicate if the company disallows user impersonation |
| externally_managed_users | Boolean | True if the users for this company are managed by an external system (eg SCIM) |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| id | Id | The company ID |
| is_admin | Boolean | True if this user is an administrator of this company |
| is_owner | Boolean | True if this company is the default company for this user |
| mfa_enabled | Boolean | Is company MFA enabled |
| name | String | The company name |
| named_licenses_available | Integer | Number of named licenses available for the company |
| named_licenses_used | Integer | Number of named licenses used for the company |
| production_count | Integer | Total number of productions that are from this company |
| production_counts_by_license | Array | Active Productions counts under the company for each license type |
| settings | Object | Company settings |
| total_uploaded_usage | Integer | Total uploaded usage in bytes |
| total_usage | Integer | Total usage in bytes |
| watermark_settings | Object | Company watermark settings |
Get this companies details
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The company ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| active | Boolean | Is company active |
| admin_team | Id | The company administration team |
| allow_impersonation_control | Boolean | User may see the controls that allow enable/disable Support User Access |
| allow_inbox_only_option | Boolean | This parameter will be used to control the access to modify the 'inbox only' option on 'Manage Teams' feature |
| can_create_group | Boolean | True if this user can create groups for this company |
| can_create_playlinks | Boolean | True if the user can send create playlinks |
| can_create_screenshots | Boolean | True if the user can create screenshots from assets |
| can_csv_transfer | Boolean | True if the user can Import/Export CSV files |
| can_display_activity_stream | Boolean | True if the user can see the 'Activity Stream' feature |
| can_display_personal_settings | Boolean | True if the user can see the 'Personal Settings' panel |
| can_display_playlists | Boolean | This parameter will be used to control access to the playlinks panel in the bottom of the UI |
| can_display_production_template | Boolean | True if the user can see the 'Production Template' feature |
| can_display_shares | Boolean | This parameter this will be used to control access to the sharing panel |
| can_display_tags | Boolean | True if the user can see the 'Tags' panel |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_manage_asset | Boolean | True if the user can manage assets |
| can_search_query | Boolean | True if the user can search query |
| can_send_to_qtake | Boolean | True if the user can send assets to shotgrid |
| can_send_to_shotgrid | Boolean | True if the user can send assets to shotgrid |
| can_share | Boolean | Does this company allow shares? |
| can_update_participants | Boolean | True if this user can update participants for this company |
| can_view_participants | Boolean | True if this user can view participants for this company |
| disallow_impersonation | Boolean | This parameter will indicate if the company disallows user impersonation |
| externally_managed_users | Boolean | True if the users for this company are managed by an external system (eg SCIM) |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| id | Id | The company ID |
| is_admin | Boolean | True if this user is an administrator of this company |
| is_owner | Boolean | True if this company is the default company for this user |
| mfa_enabled | Boolean | Is company MFA enabled |
| name | String | The company name |
| named_licenses_available | Integer | Number of named licenses available for the company |
| named_licenses_used | Integer | Number of named licenses used for the company |
| production_count | Integer | Total number of productions that are from this company |
| production_counts_by_license | Array | Active Productions counts under the company for each license type |
| settings | Object | Company settings |
| total_uploaded_usage | Integer | Total uploaded usage in bytes |
| total_usage | Integer | Total usage in bytes |
| watermark_settings | Object | Company watermark settings |
Get the control/limit record for this company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The company ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| control_id | Id | The control record id |
| expiry_date | Date | Expiry date of the corresponding record |
| max_usage | Integer | Maximum allowed usage |
| notes | String | Notes on the restrictions |
| record_id | Id | ID of the matching company/group |
| record_type | String | Type of record control attached to |
| start_date | Date | Start date of the corresponding record |
Get all production folders of this company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The company ID | Valid Id |
| include_child_count | No | Boolean | Compute and return the number of accessible child groups for each production folder. Returns direct children only, not recursive. | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| child_count | Integer | Number of immediate child groups |
| color | String | The production folder color |
| company_id | CommonId | The production folder's company id |
| created | Date | Creation date time |
| id | CommonId | The production folder id |
| name | String | The production folder name |
| total_uploaded_usage | Integer | Total Uploaded Usage in Bytes |
| total_usage | Integer | Total Usage in Bytes |
Searches users of this company and returns paginated results
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The company ID | Valid CommonId |
| limit | No | Integer | Maximum number of users to return, 20 if not specified | Valid Integer |
| search | No | String | Find users with user name matching this string | No HTML tags No {{ }} expressions |
| sort_by | No | Enum [NAME, DATE] | Sort by filed for the api | Valid Enum |
| sort_direction | No | Enum [ASC, DESC] | Sort direction filed for the api | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| externally_managed | Boolean | Is this user sourced from outside Moxion (ie SCIM)? |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| phone | String | Users phone number |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
Get all users of this company (optionally restricted to a particular group/production)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | No | CommonId | Restricted by group ID | Valid CommonId |
| id | Yes | Id | The company ID | Valid Id |
| include_review_only_users | No | Boolean | Whether to include one-off review room users in the response | Valid Boolean |
| review_session_id | No | Id | Users should be returned to be added to this review session | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| externally_managed | Boolean | Is this user sourced from outside Moxion (ie SCIM)? |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| phone | String | Users phone number |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
Get watermark details and thumbnail file for a company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | CommonId | The company ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| company_id | CommonId | The company which owns this watermark |
| description | String | The company which owns this watermark |
| watermark | Object | The watermark definition |
| watermark_thumbnail_file | String | Base 64 string of thumbnail file generated from watermarksettings |
Update an existing company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| active | No | Boolean | Is company active | Valid Boolean |
| disallow_impersonation | No | Boolean | This parameter will indicate if the company disallow user impersonation | Valid Boolean |
| domain | No | Id | The subdomain this company belongs to | Valid Id |
| hub_id | No | CommonId | Flow Hub ID | Valid CommonId |
| id | Yes | Id | The company ID | Valid Id |
| mfa_enabled | No | Boolean | MFA enabled | Valid Boolean |
| name | No | String | The company name | No HTML tags No {{ }} expressions Length must not exceed 100 |
| settings | No | Object | Company settings | Valid Object |
| watermark_settings | No | Object | Company watermark settings | Valid Object |
| Parameter | Type | Description |
|---|---|---|
| active | Boolean | Is company active |
| admin_team | Id | The company administration team |
| allow_inbox_only_option | Boolean | This parameter will be used to control the access to modify the 'inbox only' option on 'Manage Teams' feature |
| can_display_playlists | Boolean | This parameter will be used to control access to the playlinks panel in the bottom of the UI |
| can_display_shares | Boolean | This parameter this will be used to control access to the sharing panel |
| can_share | Boolean | Does this company allow shares? |
| disallow_impersonation | Boolean | This parameter will indicate if the company disallows user impersonation |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| id | Id | The company ID |
| mfa_enabled | Boolean | Is company MFA enabled |
| name | String | The company name |
| settings | Object | Company settings |
| updated | Boolean | True if the company has been updated |
| watermark_settings | Object | Company watermark settings |
Update company control/limit settings
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| expiry_date | No | Date | The last date the company will be active | Valid Date |
| id | Yes | Id | The company ID | Valid Id |
| max_usage | No | Integer | The maximum disk usage allowed on assets for the company | Valid Integer |
| notes | No | String | Notes on the control record | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| control_id | Id | The control record id |
| expiry_date | Date | Expiry date of the corresponding record |
| max_usage | Integer | Maximum allowed usage |
| notes | String | Notes on the restrictions |
| record_id | Id | ID of the matching company/group |
| record_type | String | Type of record control attached to |
| start_date | Date | Start date of the corresponding record |
| updated | Boolean | True if the company control has been updated |
Update company specific settings for a user on a company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The company ID | Valid Id |
| inbox_only | No | Boolean | Users inbox only setting | Valid Boolean |
| reset_mfa | No | Boolean | Reset the users MFA credentials so they can run MFA setup again | Valid Boolean |
| user_id | Yes | Id | The user ID to delete from the company | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| phone | String | Users phone number |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
| updated | Boolean | True if the user has been updated |
Create a new consent document, or if one with of this type already exists, create a new version
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| type | Yes | Enum [PRIVACY_POLICY, TERMS_OF_SERVICE] | The type of consent document | Valid Enum |
| url | Yes | String | The URL of the consent document | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | True if successful |
Get the latest consent document URLs
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|---|---|
| type | Enum [PRIVACY_POLICY, TERMS_OF_SERVICE] | The type of this doc |
| url | String | The URL |
This method will delete a custom metadata
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The id of soon to be deleted custom metadata | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the custom metadata has been deleted successfully |
Update an existing custom metadata
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | No | String | The description of the custom metadata | No HTML tags No {{ }} expressions |
| id | Yes | CommonId | The custom metadata ID | Valid CommonId |
| name | No | String | The name of the custom metadata | No HTML tags No {{ }} expressions |
| options | No | Array | The options available for the custom metadata | Valid Array |
| sortable | No | Boolean | Indicates if the custom metadata options should be sorted | Valid Boolean |
| status | No | Enum [NEW, ACTIVE, DELETED, DISABLED] | Indicates the status for the custom metadata | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| assignment | Object | Provides assignment information for the custom metadata |
| company_id | CommonId | The company id where this custom metadata belongs |
| description | String | The description of the custom metadata |
| id | CommonId | The custom metadata ID |
| name | String | The name of the custom metadata |
| options | Array | The options available for the custom metadata |
| sortable | Boolean | Indicates if the custom metadata options should be sorted |
| status | String | Indicates the status for the custom metadata |
| updated | Boolean | True if the custom metadata has been updated |
Create a new customization
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | Id | The company this asset available for use in | Valid Id |
| data_base64 | Yes | String | Base64 encoded asset data | No HTML tags No {{ }} expressions |
| description | No | String | Description of customization | No HTML tags No {{ }} expressions |
| email_domain_id | No | Id | For email templates, the domain ID for any links generated by the template. | Valid Id |
| group_id | No | CommonId | The production this asset should be restricted for use in | Valid CommonId |
| name | Yes | String | Customization short name, shown in the UI | No HTML tags No {{ }} expressions |
| project_id | No | CommonId | The project this asset should be restrictred for use in | Valid CommonId |
| type | Yes | String | Type of customization asset | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| id | Id | Returns the customization ID |
Delete an existing customization
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | No | Id | The customization to delete | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | Has the customization been deleted? |
Update an existing customization
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| data_base64 | Yes | String | Base64 encoded asset data | No HTML tags No {{ }} expressions |
| description | No | String | Description of customization | No HTML tags No {{ }} expressions |
| email_domain_id | No | Id | For email templates, the domain ID for any links generated by the template. | Valid Id |
| id | No | Id | The customization to update | Valid Id |
| name | No | String | Customization short name, shown in the UI | No HTML tags No {{ }} expressions |
| type | No | String | Type of customization asset | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | Has the customization been updated? |
Get messages for a destination. The oldest message is returned first. To retrieve only new messages, provide a start_after_message_id value.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| destination_id | Yes | Id | The destination to get messages for | Valid Id |
| limit | No | Integer | Max number of messages to receive (defaults to 10) | Valid Integer |
| sort | No | Enum [NEWEST, OLDEST] | Sort order (defaults to OLDEST) | Valid Enum |
| start_after_message_id | No | Id | The message to start after, if no message is specified, will list objects from the beginning | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| assets | CommonIdArray | Array of asset IDs contained in this message |
| created | Date | The message creation time |
| destination_id | Id | The destination this message is associated with |
| id | Id | The message id |
| sender_email | String | The email of the user that sent the message |
| sender_first_name | String | The first name of user that sent the message |
| sender_id | Id | The user that sent the message |
| sender_last_name | String | The last name of the user that sent the message |
| status | Enum [PENDING, DELIVERED, RECEIVED, ERROR] | Message status |
| text | String | The message text to display with the delivery |
Get information about a destination subscription
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| subscription_id | Yes | Id | The subscription ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| created | Date | The date/time this subscription was created |
| created_by | Id | The user id the subscription was created by |
| destination_id | Id | The subscription destination id |
| device_name | String | The subscription device name |
| id | Id | The subscription id |
List all destinations for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | CommonId | The project ID to find destinations for | Valid CommonId |
| type | Yes | Enum [QTAKE] | The display type of the destination | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| active_subscriptions | IdArray | Array of active subscription ids |
| created | Date | The date/time this destination was created |
| id | Id | The destination ID |
| project_id | CommonId | The project ID this destination is associated with |
| type | Enum [QTAKE] | The display type of the destination. |
| user_email | String | The email address of the destination user |
| user_name | String | The name of the destination user |
| user_role | String | The role of the destination user |
Send a message to a destination
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| assets | Yes | CommonIdArray | Array of asset IDs contained in this message | Valid CommonIdArray |
| destination_id | Yes | Id | The destination this message is associated with | Valid Id |
| text | No | String | Message text | No HTML tags No {{ }} expressions Length must not exceed 10000 |
| Parameter | Type | Description |
|---|---|---|
| assets | CommonIdArray | Array of asset IDs contained in this message |
| created | Date | The message creation time |
| destination_id | Id | The destination this message is associated with |
| id | Id | The message id |
| sender_email | String | The email of the user that sent the message |
| sender_first_name | String | The first name of user that sent the message |
| sender_id | Id | The user that sent the message |
| sender_last_name | String | The last name of the user that sent the message |
| status | Enum [PENDING, DELIVERED, RECEIVED, ERROR] | Message status |
| text | String | The message text to display with the delivery |
Subscribe to a destination to receive destination messages (destination will be created if it doesn't exist). When a new message is available a DESTINATION_MESSAGE event will be sent via WebSockets. To get destination messages use /get/destination/messages.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| device_name | No | String | The name of the subscription device (eg machine name) | No HTML tags No {{ }} expressions Length must not exceed 256 |
| project_id | Yes | CommonId | The project ID this destination is associated with | Valid CommonId |
| type | Yes | Enum [QTAKE] | The display type of the destination | Valid Enum |
| user_email | Yes | String | The email address of the destination user | Length must not exceed 254 Valid email format |
| user_name | Yes | String | The name of the destination user | No HTML tags No {{ }} expressions Length must not exceed 256 |
| user_role | No | String | The role name of the destination user | No HTML tags No {{ }} expressions Length must not exceed 256 |
| Parameter | Type | Description |
|---|---|---|
| created | Date | The date/time this subscription was created |
| created_by | Id | The user id the subscription was created by |
| destination_id | Id | The subscription destination id |
| device_name | String | The subscription device name |
| id | Id | The subscription id |
Unsubscribe from a destination to stop receiving destination messages
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| subscription_id | Yes | Id | The ID for the subscription to unsubscribe from | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | Unsubscribe success |
Update destination message status
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| error_message | No | String | The associated error message (if applicable) | No HTML tags No {{ }} expressions |
| message_id | Yes | Id | The destination message to update | Valid Id |
| status | Yes | Enum [PENDING, DELIVERED, RECEIVED, ERROR] | The status of the message | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| assets | CommonIdArray | Array of asset IDs contained in this message |
| created | Date | The message creation time |
| destination_id | Id | The destination this message is associated with |
| id | Id | The message id |
| sender_email | String | The email of the user that sent the message |
| sender_first_name | String | The first name of user that sent the message |
| sender_id | Id | The user that sent the message |
| sender_last_name | String | The last name of the user that sent the message |
| status | Enum [PENDING, DELIVERED, RECEIVED, ERROR] | Message status |
| text | String | The message text to display with the delivery |
Create a new domain asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| content_type | Yes | String | Content type for this asset | No HTML tags No {{ }} expressions |
| data | Yes | String | base64 encoded asset data | No HTML tags No {{ }} expressions |
| domain | Yes | Id | The domain this asset belongs to | Valid Id |
| type | Yes | String | The asset type, e.g. login_page_logo | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| id | Id | Returns the domain asset ID for the created domain asset |
Delete an existing domain asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | No | Id | The domain asset to update | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | has the domain asset been deleted |
Retrieve a list of identity providers to be used for login.
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| domain | Yes | String | The domain to retrieve the providers for | No HTML tags No {{ }} expressions |
| is_ios_app | No | Boolean | The request is coming from an iOS native application (default false) | Valid Boolean |
| issuer | No | String | A unique identifier used to identify the SSO provider or identity provider (IdP) that issued the token, This identifier is typically a URL or a URN | No HTML tags No {{ }} expressions |
| provider | No | String | A unique name of the identity provider (eg internal, okta, google) | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| base_url | String | The base URL of the Open ID Connect server. Used with openid-connect provider types. Must start with https:. Mutually exclusive with saml2_* parameters. |
| claims | StringArray | The Open ID Claims a client should request from the provider. Mutually exclusive with saml2_* parameters. |
| client_id | String | The public client ID of the Open ID Connect application. Used with openid-connect provider types. Mutual exclusive with saml2_* parameters. |
| discovery_url | String | The discovery URL of the Open ID Connect server. Used with openid-connect provider types to detect various endpoints. Must start with https:. Mutually exclusive with saml2_* parameters. |
| hide_branding | Boolean | Hide the provider's branding (no name or logo image in front end) |
| logo_image | String | The provider's logo image, if any. To be retrieved by /get/domain/asset |
| okta_compatible | Boolean | Is this an Okta Open ID Connect Provider? If so, it is safe to use the okta-auth-js frontend library. |
| provider | String | A unique name of the identity provider (eg internal, okta, google) |
| provider_type | String | Protocol used to authenticate with the provider (eg internal, openid-connect, saml2.0) |
| saml2_auth_post_params | Object | The parameters to include with POST requests to saml2_auth_post_url. Used with saml2.0 provider types. Mutual exclusive with client_id and base_url. |
| saml2_auth_post_url | String | The URL used to authenticate at SAML 2.0 server, using POST method (HTTP-Post binding). Used with saml2.0 provider types. Mutual exclusive with client_id and base_url. |
| saml2_auth_url | String | The URL used to authenticate at SAML 2.0 server, using GET method (HTTP-Redirect binding). Used with saml2.0 provider types. Mutual exclusive with client_id and base_url. |
| user_profile_page_url | String | The Identity Provider's Profile page for the user, where they may turn on MFA. |
Retrieve a default provider for given a domain.
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| domain | Yes | String | The domain to retrieve the providers for | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| has_default_provider | Boolean | Has only one SSO provider. |
| has_internal_provider | Boolean | Has an internal provider. |
| provider | String | The provider code of a default SSO provider. Null if there is no default.. |
Retrieve a list of identity providers to be used for login.
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| domain | Yes | String | The domain to retrieve the providers for | No HTML tags No {{ }} expressions |
| is_ios_app | No | Boolean | The request is coming from an iOS native application (default false) | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| base_url | String | The base URL of the Open ID Connect server. Used with openid-connect provider types. Must start with https:. Mutually exclusive with saml2_* parameters. |
| claims | StringArray | The Open ID Claims a client should request from the provider. Mutually exclusive with saml2_* parameters. |
| client_id | String | The public client ID of the Open ID Connect application. Used with openid-connect provider types. Mutual exclusive with saml2_* parameters. |
| discovery_url | String | The discovery URL of the Open ID Connect server. Used with openid-connect provider types to detect various endpoints. Must start with https:. Mutually exclusive with saml2_* parameters. |
| hide_branding | Boolean | Hide the provider's branding (no name or logo image in front end) |
| logo_image | String | The provider's logo image, if any. To be retrieved by /get/domain/asset |
| okta_compatible | Boolean | Is this an Okta Open ID Connect Provider? If so, it is safe to use the okta-auth-js frontend library. |
| provider | String | A unique name of the identity provider (eg internal, okta, google) |
| provider_type | String | Protocol used to authenticate with the provider (eg internal, openid-connect, saml2.0) |
| saml2_auth_post_params | Object | The parameters to include with POST requests to saml2_auth_post_url. Used with saml2.0 provider types. Mutual exclusive with client_id and base_url. |
| saml2_auth_post_url | String | The URL used to authenticate at SAML 2.0 server, using POST method (HTTP-Post binding). Used with saml2.0 provider types. Mutual exclusive with client_id and base_url. |
| saml2_auth_url | String | The URL used to authenticate at SAML 2.0 server, using GET method (HTTP-Redirect binding). Used with saml2.0 provider types. Mutual exclusive with client_id and base_url. |
| user_profile_page_url | String | The Identity Provider's Profile page for the user, where they may turn on MFA. |
Update an existing domain asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| content_type | Yes | String | Content type for this asset | No HTML tags No {{ }} expressions |
| data | Yes | String | base64 encoded asset data | No HTML tags No {{ }} expressions |
| domain | Yes | Id | The domain this asset belongs to | Valid Id |
| id | No | Id | The domain asset to update | Valid Id |
| type | Yes | String | The asset type, e.g. login_page_logo | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | has the domain asset been updated |
Download assets as a single file or an uncompressed ZIP archive where there are multiple files to download
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| assets | No | CommonIdArray | Array of asset IDs | Valid CommonIdArray |
| file_categories | No | StringArray | Array of categories to download | Valid StringArray |
| file_name | No | String | The filename prefix to use on the ZIP file | No HTML tags No {{ }} expressions |
| file_type | No | String | Only include asset files of the specific file type | No HTML tags No {{ }} expressions |
| non_watermarked | No | Boolean | Download a non watermarked version of these files (requires appropriate permission) | Valid Boolean |
| playlink_id | No | Id | Playlink ID of the files to download | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| access_token | String | The JWT access token that grants access to download |
| file_name | String | File name fo the file |
| path | String | The file path |
| processing | Boolean | True if file is being generated, progress information provided by task_id |
| task_id | String | The processing task related to this batch of assets |
Download assets directly without ZIP when there are multiple files to download
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| assets | No | CommonIdArray | Array of asset IDs | Valid CommonIdArray |
| file_categories | No | StringArray | Array of categories to download | Valid StringArray |
| non_watermarked | No | Boolean | Download a non watermarked version of these files (requires appropriate permission) | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| errors | Array | The Array for failed process |
| successful_processes | Array | The Array for success process information |
Download a single asset visual watermark file for internal use that may specify an IP address
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_file_id | Yes | CommonId | The asset file ID | Valid CommonId |
| ip_address | Yes | String | The ip address to be used for this watermark | No HTML tags No {{ }} expressions |
| user_token | Yes | String | The token of the user that this is being generated on behalf of | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|
Download a single asset video file
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_file_id | Yes | CommonId | The asset file ID | Valid CommonId |
| Parameter | Type | Description |
|---|
Flow Download a single asset scrub url
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | CommonId | The asset ID | Valid CommonId |
| Parameter | Type | Description |
|---|
Download a single asset video file
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_file_id | Yes | CommonId | The asset file ID | Valid CommonId |
| colorspace | No | String | Lock manifest to specific colorspace only | No HTML tags No {{ }} expressions |
| manifest | No | String | Return the media manifest associated with the asset | No HTML tags No {{ }} expressions |
| resolution | No | String | Lock manifest to specific resolution only | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|
Download a single asset visual watermark file
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_file_id | Yes | CommonId | The asset file ID | Valid CommonId |
| Parameter | Type | Description |
|---|
Search for a message to display in the home page.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| include_thumbnails | No | Boolean | Whether to include message thumbnail URLs | Valid Boolean |
| search | Yes | String | Find messages matching this string | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| allow_download | Boolean | True if the message allows asset downloads. Only returned if include_message_content is true. |
| allow_edit | Boolean | Whether the message is editable by the current user (in the case of playlinks this is whether the current user can edit the playlink) |
| allow_offline | Boolean | True if the message allows asset offlining on mobile devices. Only returned if include_message_content is true. |
| asset_count | Integer | The number of assets in this message |
| blurhash | String | A hashed representation of the asset |
| body | String | The message text. Only returned if include_message_content is true. |
| can_be_restricted | Boolean | True if the message assets could be restricted because they have an IP address or view count restriction |
| company_id | Id | The company id |
| company_name | String | The company name |
| created | Date | The date/time this message was created. Only returned if include_message_content is true. |
| expire_days | Integer | The message expire days. Only returned if include_message_content is true. |
| expiry | Date | The message expiry time. Only returned if include_message_content is true. |
| folder | Enum [INBOX, ARCHIVE, SENT] | The folder that this sent message belongs to |
| group_color | Integer | The group color |
| group_id | CommonId | The production ID this sent message belongs to |
| group_name | String | The production display name this sent message belongs to |
| id | Id | The sent message ID |
| is_deferred | Boolean | True if the message is deferred from viewing. Only returned if include_message_content is true. |
| is_expired | Boolean | True if the message has now expired. Only returned if include_message_content is true. |
| is_live | Boolean | True if the message is a live steam related message. |
| is_share | Boolean | True if the message is of type notification but not live stream related |
| is_starred | Boolean | Whether the sent message is marked with a star |
| is_unread | Boolean | Whether the message is currently marked as unread |
| is_unviewed | Boolean | No longer used Deprecated: Always returns false. |
| last_modified | Date | The date/time this message was last modified (to display to user) |
| message_id | Id | The message id |
| modified_since | Date | The date/time this sent message was modified (for caching inbox data) |
| playlink_id | Id | The playlink ID (playlink messages only). Only returned if include_message_content is true. |
| playlist_id | CommonId | Id of the playlist |
| playlist_name | String | Name of the playlist |
| playlist_thumbnail_url | String | The primary thumbnail URL for shared playlist |
| playlist_thumbnail_url_2x | String | The primary thumbnail URL for for shared playlist (2x resolution) |
| playlist_thumbnail_url_3x | String | The primary thumbnail URL for for shared playlist (3x resolution) |
| project_id | CommonId | The message project id. Only returned if include_message_content is true. |
| project_name | String | The message project name. Only returned if include_message_content is true. |
| read_timestamp | Date | Time when the message was read |
| search_context | String | Text to apply client-side full text search against |
| sender_first_name | String | The first name of user that sent the message. Only returned if include_message_content is true. |
| sender_last_name | String | The last name of the user that sent the message. Only returned if include_message_content is true. |
| sender_role | String | The role of the user that sent the message. Only returned if include_message_content is true. |
| sender_user_id | Id | The user ID of the message sender. Only returned if include_message_content is true. |
| share_id | Id | Id of the share/playlink |
| share_name | String | Share Name |
| share_sent_date | Date | Share Sent Date |
| start | Date | The message time this message is available to be used from. Only returned if include_message_content is true. |
| subject | String | The message subject. Only returned if include_message_content is true. |
| thumbnail_url | String | The primary thumbnail URL for this message |
| thumbnail_url_2x | String | The primary thumbnail URL for this message (2x resolution) |
| thumbnail_url_3x | String | The primary thumbnail URL for this message (3x resolution) |
| type | Enum [PLAYLINK, MESSAGE] | The sent message type. Only returned if include_message_content is true. |
| unviewed_count | Integer | Number of unread assets in the share/playlink |
Update pinned user production, true or false
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| pinned | Yes | Boolean | True or false for pinned column user production | Valid Boolean |
| production_id | Yes | CommonId | Update pinned column to this user production | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | True if user production has been updated |
Create a new widget for the home page
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| widget_definition | Yes | Object | The widget definition | Valid Object |
| widget_name | Yes | String | The widget name | No HTML tags No {{ }} expressions |
| widget_order | No | Integer | The widget order | Valid Integer |
| widget_settings | Yes | Object | The widget settings | Valid Object |
| widget_type | Yes | Enum [SHARED_PLAYLISTS, PRODUCTIONS] | The widget type | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| order | Integer | The order |
| widget_definition | Object | The widget definition |
| widget_id | Id | The widget ID |
| widget_name | String | The widget name |
| widget_settings | Object | The widget settings |
| widget_type | Enum [SHARED_PLAYLISTS, PRODUCTIONS] | The widget type |
Delete a widget from the home page
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| widget_id | Yes | Id | The widget ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the widget has been deleted |
Gets widget details based on wiget type, widget data and filters
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| limit | No | Integer | Maximum number of items per page | Valid Integer |
| message_types | No | StringArray | Restrict messages to these types | Valid StringArray |
| production_id | No | CommonId | The id of the production to filter messages | Valid CommonId |
| search_term | No | String | Find messages matching this string | No HTML tags No {{ }} expressions |
| sort_by | No | Enum [UNREAD, DATE, MESSAGE_ID, NAME] | Sort by field | Valid Enum |
| sort_direction | No | Enum [ASC, DESC] | Sort direction filed for the api | Valid Enum |
| unplayed_only | No | Boolean | return unread messages or messages with unplayed assets | Valid Boolean |
| unread_only | No | Boolean | Unread only flag | Valid Boolean |
| view_by_production | No | Boolean | View by production flag | Valid Boolean |
| widget_id | Yes | Id | The widget ID | Valid Id |
| with_pagination | No | Boolean | Whether to paginate the widget details or not | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| assets | Array | Widget response of type assets |
| messages | Array | Widget response of type messages |
| productions | Array | Widget response of type productions |
| widget_data_types | StringArray | Widget response data types |
Get widgets for the home page
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|---|---|
| order | Integer | The order |
| widget_definition | Object | The widget definition |
| widget_id | Id | The widget ID |
| widget_name | String | The widget name |
| widget_settings | Object | The widget settings |
| widget_type | Enum [SHARED_PLAYLISTS, PRODUCTIONS] | The widget type |
Update a widget for the home page
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| widget_definition | No | Object | The widget definition | Valid Object |
| widget_id | Yes | Id | The widget ID | Valid Id |
| widget_name | No | String | The widget name | No HTML tags No {{ }} expressions |
| widget_settings | No | Object | The widget settings | Valid Object |
| widget_type | No | Enum [SHARED_PLAYLISTS, PRODUCTIONS] | The widget type | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| order | Integer | The order |
| widget_definition | Object | The widget definition |
| widget_id | Id | The widget ID |
| widget_name | String | The widget name |
| widget_settings | Object | The widget settings |
| widget_type | Enum [SHARED_PLAYLISTS, PRODUCTIONS] | The widget type |
Update widgets for the home page
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| widget_details | Yes | Array | The Array of Widget details with action. | Valid Array |
| Parameter | Type | Description |
|---|---|---|
| order | Integer | The order |
| widget_definition | Object | The widget definition |
| widget_id | Id | The widget ID |
| widget_name | String | The widget name |
| widget_settings | Object | The widget settings |
| widget_type | Enum [SHARED_PLAYLISTS, PRODUCTIONS] | The widget type |
Update widgets order for the home page
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| widget_order | Yes | Array | The Array of Widgets and it's order | Valid Array |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | The widget order update status |
Creates a new license and assigns it to a company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | CommonId | The company id | Valid CommonId |
| count | No | Integer | License Count for Named user License | Valid Integer |
| description | No | String | License Description | No HTML tags No {{ }} expressions |
| end_date | No | Date | License end date | Valid Date |
| transaction_reference | No | String | License Transaction Reference | No HTML tags No {{ }} expressions |
| type | Yes | Enum [CONTRACTED, ENTERPRISE, NAMED_USER, TOKEN_USER, ROOMS_ONLY, TRIAL, PARTNER, INTERNAL] | License Type | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| company_id | CommonId | The company ID |
| count | Integer | License Count for Named user License |
| description | String | License Description |
| end_date | Date | License end date |
| id | CommonId | The License ID |
| status | String | License Status |
| transaction_reference | String | License Transaction Reference |
| type | String | License Type |
Delete a license for a company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | CommonId | The company id | Valid CommonId |
| id | Yes | CommonId | The company id | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if a license is removed from a company |
Gets licenses for a company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | CommonId | The company id | Valid CommonId |
| include_expired | No | Boolean | Allow to retrieve expired license for the company | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| company_id | CommonId | The company ID |
| count | Integer | License Count for Named user License |
| description | String | License Description |
| end_date | Date | License end date |
| id | CommonId | The License ID |
| status | String | License Status |
| transaction_reference | String | License Transaction Reference |
| type | String | License Type |
Updates a license for a company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | CommonId | The company id | Valid CommonId |
| count | No | Integer | License Count for Named user License | Valid Integer |
| description | No | String | License Description | No HTML tags No {{ }} expressions |
| end_date | No | Date | License end date | Valid Date |
| id | Yes | CommonId | The company id | Valid CommonId |
| transaction_reference | No | String | License Transaction Reference | No HTML tags No {{ }} expressions |
| type | Yes | Enum [CONTRACTED, ENTERPRISE, NAMED_USER, TOKEN_USER, ROOMS_ONLY, TRIAL, PARTNER, INTERNAL] | License Type | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| company_id | CommonId | The company ID |
| count | Integer | License Count for Named user License |
| description | String | License Description |
| end_date | Date | License end date |
| id | CommonId | The License ID |
| status | String | License Status |
| transaction_reference | String | License Transaction Reference |
| type | String | License Type |
Get live stream information for a source identifier
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| stream_identifier | No | String | The stream iIdentifier or do not speficy to return all stream details | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| details | Object | JSON structure with details about a stream setup and configuration |
Register a new Composite Stream with a Moxion Project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | Yes | String | The Stream Description | No HTML tags No {{ }} expressions |
| layout | No | Object | The composite layout | Valid Object |
| name | Yes | String | The Stream name | No HTML tags No {{ }} expressions |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| id | Id | ID for this stream registration |
| stream_uri | String | Streaming URI used to reference this registration |
| success | Boolean | Successfully registered |
Register a new Moxion desktop sharing stream
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | Yes | String | The Stream Description | No HTML tags No {{ }} expressions |
| name | Yes | String | The stream name | No HTML tags No {{ }} expressions |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| id | Id | ID for this stream registration |
| success | Boolean | Successfully registered |
Register a new Elemental Live Stream with a Moxion Project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| account_id | No | String | The Elemental Link account ID (where it is not hosted by Moxion) | No HTML tags No {{ }} expressions |
| description | Yes | String | The Stream Description | No HTML tags No {{ }} expressions |
| device_id | Yes | String | The Elemental Link Device ID | No HTML tags No {{ }} expressions |
| name | Yes | String | The Stream name | No HTML tags No {{ }} expressions |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| stream_uri | String | Streaming URI used to reference this registration |
| success | Boolean | Successfully registered |
Register a new Qtake Cloud project with a Moxion Project, the JWT claim userEmail must match the current user email address
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | Yes | String | The Stream Description | No HTML tags No {{ }} expressions |
| name | Yes | String | The stream name | No HTML tags No {{ }} expressions |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| registration | Yes | String | A JWT token containing the registration data for the Qtake Cloud | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | Successfully registered with Qtake Cloud |
Register a new RTP stream registration
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | No | String | The asset ID or UUID if we are to use an existing asset | No HTML tags No {{ }} expressions |
| asset_name | No | String | The asset name for this stream if we are creating a new asset | No HTML tags No {{ }} expressions |
| audio_port | Yes | Integer | The source audio port | Valid Integer |
| batch_hidden | No | Boolean | Whether the batch is hidden | Valid Boolean |
| batch_id | No | CommonId | The batch ID, required when creating live assets in an existing batch | Valid CommonId |
| batch_name | No | String | The batch name, required when creating a new live batch for this project | No HTML tags No {{ }} expressions Length must not exceed 100 |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| source_ip | Yes | String | The source ip address | No HTML tags No {{ }} expressions |
| video_port | Yes | Integer | The source video port | Valid Integer |
| Parameter | Type | Description |
|---|---|---|
| asset_id | CommonId | The asset ID for this asset |
| success | Boolean | Successfully registered |
Register a new SRT client
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | Yes | String | The Stream Description | No HTML tags No {{ }} expressions |
| name | Yes | String | The Stream Name | No HTML tags No {{ }} expressions |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| id | Id | ID for this stream registration |
| stream_id | String | Stream ID for this stream |
| success | Boolean | Successfully registered |
| token | String | Token to use for this stream |
| url | String | Connection details for this Stream |
Register a new WHIP client e.g. OBS
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | Yes | String | The Stream Description | No HTML tags No {{ }} expressions |
| name | Yes | String | The stream name | No HTML tags No {{ }} expressions |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| id | Id | ID for this stream registration |
| success | Boolean | Successfully registered |
| token | String | Auth Bearer Token |
| url | String | URL to use for this Stream |
Delete a live registration for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The live registration to delete | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | If the live registration was successfully deleted |
Get live stream detail
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | No | Id | The stream registration ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| additional_details | Object | Additional details that can be displayed about this connection |
| breadcrumbs | Array | The breadcrumbs for the project where this stream is configured |
| description | String | The stream description |
| group | Id | The group ID where this stream is configured |
| group_name | String | The group name where this stream is configured |
| id | Id | The live registration id |
| last_connected | Date | When the stream was last connected |
| name | String | The stream name |
| project | CommonId | The project ID where this stream is configured |
| project_name | String | The project name where this stream is configured |
| registration_data | String | Specific registration data that may be returned for some stream types |
| status | String | The live stream status |
| stream_uri | String | The URI that can be used to connect to this stream |
| type | Enum | The live stream source type |
List live registrations for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | CommonId | List live registrations that are currently setup for streaming into this project | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| additional_details | Object | Additional details that can be displayed about this connection |
| description | String | The stream description |
| id | Id | The live registration id |
| last_connected | Date | When the stream was last connected |
| name | String | The stream name |
| registration_data | String | Specific registration data that may be returned for some stream types |
| status | String | The live stream status |
| type | Enum | The live stream source type |
List live registrations for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | CommonId | List live registrations that are currently setup for streaming into this project | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| additional_details | Object | Additional details that can be displayed about this connection |
| description | String | The stream description |
| id | Id | The live registration id |
| last_connected | Date | When the stream was last connected |
| name | String | The stream name |
| registration_data | String | Specific registration data that may be returned for some stream types |
| status | String | The live stream status |
| type | Enum | The live stream source type |
List live ice servers for a streaming URL (Available for WHIP tokens only)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| stream_uri | Yes | String | The stream that the ICE server configuration is required for | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| webrtc_server_configuration | Object | WebRTC server configurations to use for STUN and TURN access to live the live server |
Start the underlying stream, configuring as required. Valid for Elemental, SRT stream types
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| password | No | String | Password required for authentication, required for SRT | No HTML tags No {{ }} expressions |
| stream_uri | No | String | The URI of the stream that we are starting | No HTML tags No {{ }} expressions |
| user_id | No | Id | User ID, required for SRT | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| connect_uri | String | The URI of the location the stream should be forwarded to |
| success | Boolean | If the live streaming association was started successfully |
Create a new live streaming asset using the WHIP protocol (https://tools.ietf.org/html/draft-murillo-whip-00). Request body contains SDP Offer, parameters indicated in the URL are described below.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| RequestBody | No | String | The request body contains the SDP Offer | No HTML tags No {{ }} expressions |
| deviceUUID | Yes | Id | Qtake UUID (in URL) | Valid Id |
| projectUUID | Yes | CommonIdOrUUID | Qtake UUID (in URL) | Valid CommonIdOrUUID |
| streamNumber | Yes | Id | Qtake Stream ID (in URL), if exists already it will reuse the existing asset | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| RequestBody | String | The response body contains the SDP Answer |
Disable a live stream from being shown in Moxion, for Elemental streams this will disable the underlying channel
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | No | CommonId | The asset ID linked to the stream that will be stopped | Valid CommonId |
| stream_uri | No | String | The URI of the stream that we are stopping | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | If the live streaming association was stopped successfully |
Stop receiving a live streaming asset that was created with the WHIP protocol. Parameters indicated in the URL are described below.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| deviceUUID | Yes | Id | Qtake UUID (in URL) | Valid Id |
| projectUUID | Yes | CommonIdOrUUID | Qtake UUID (in URL) | Valid CommonIdOrUUID |
| streamNumber | Yes | Id | Qtake Stream ID (in URL), if exists already it will reuse the existing asset | Valid Id |
| Parameter | Type | Description |
|---|
Update a Composite Stream
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | Yes | String | The new Stream Description | No HTML tags No {{ }} expressions |
| id | Yes | Id | The composite stream ID that we are updating | Valid Id |
| layout | Yes | Object | The new composite layout | Valid Object |
| name | Yes | String | The new Stream name | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | Successfully updated |
Get a message
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The message ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allow_comments | Boolean | Can comments be made. for Playlink messages, this value comes from the Playlink setting. For non-playlink messages, it comes from the user's can_comment permission in the project. |
| allow_download | Boolean | True if the message allows asset downloads |
| allow_offline | Boolean | True if the message allows asset offlining on mobile devices |
| body | String | The message text |
| can_be_restricted | Boolean | True if the message assets could be restricted because they have an IP address or view count restriction . |
| created | Date | The date/time this message was created |
| expire_days | Integer | The message expire days |
| expiry | Date | The message expiry time |
| group_id | CommonId | The production ID this message belongs to |
| id | Id | The message ID |
| is_deferred | Boolean | True if the message is deferred from viewing. Only returned if include_message_content is true. |
| is_expired | Boolean | True if the message has now expired |
| last_modified | Date | The date/time this message was last modified |
| playlink_id | Id | The playlink ID (playlink messages only) |
| project_id | CommonId | The message project id |
| project_name | String | The message project name |
| sender_first_name | String | The first name of user that sent the message |
| sender_last_name | String | The last name of the user that sent the message |
| sender_role | String | The role of the user that sent the message |
| sender_user_id | Id | The user ID of the message sender |
| start | Date | The message time this message is available to be used from. Only returned if include_message_content is true. |
| subject | String | The message subject |
| type | Enum [PLAYLINK, MESSAGE] | The sent message type |
Get all the assets attached to a message
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The message ID | Valid Id |
| trigger_watermarking | No | Boolean | Immediately begin the watermarking process on these assets | Valid Boolean |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| available_comment_channels | StringArray | List of available comment channels | |||||||||||||
| batch_id | CommonId | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| blurhash | String | A hashed representation of the asset | |||||||||||||
| can_access_project | Boolean | User can access this asset | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| can_navigate_to_folder | Boolean | User can show in folder for this asset | |||||||||||||
| can_offline | Boolean | User can offline this asset | |||||||||||||
| can_update | Boolean | User can update this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| component_data | Object | The components of the asset | |||||||||||||
| component_links | Array | The component details array List | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| deny_view | Boolean | True if the asset should not be viewable by the user. | |||||||||||||
| desc | String | The asset description | |||||||||||||
| drm_enabled | Boolean | Whether manifest playback is enabled on the project that contains this asset. | |||||||||||||
| duration | Float | The asset duration (in seconds) | |||||||||||||
| ext | String | The original asset file extension | |||||||||||||
| hdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in HDR. | |||||||||||||
| hidden | Boolean | The asset is hidden and not visible to users that don't have permission to view hidden batches | |||||||||||||
| id | CommonId | The asset ID | |||||||||||||
| is_admin | Boolean | True if the user has admin permission for this asset. | |||||||||||||
| is_derived_sdr | Boolean | True if the Asset has generated an SDR from an HDR, False if the user has provided their own SDR | |||||||||||||
| is_derived_sdr_allowed | Boolean | Read Only replication of the is_derived_sdr_allowed Project Setting | |||||||||||||
| is_live | Boolean | Asset is currently live streaming | |||||||||||||
| is_sdr_allowed | Boolean | Read Only replication of the is_sdr_allowed Project Setting | |||||||||||||
| is_unviewed | Boolean | Is this asset not viewed by current user | |||||||||||||
| master_id | CommonId | The master asset Id | |||||||||||||
| metadata | Object | The assets metadata | |||||||||||||
| name | String | The asset file name (without original file extension) | |||||||||||||
| offline_bytes | Integer | Number of bytes of primary files that needed to be downloaded for offline usage | |||||||||||||
| origin_type | Enum [Moxion, Flow, Hybrid] | Asset Origin type | |||||||||||||
| overall_processing_time | String | The overall time in seconds the asset has taken to complete processing | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | CommonId | The project ID this asset belongs to | |||||||||||||
| resume_position | Float | The last playback time in seconds for restarting playback | |||||||||||||
| scrub_jpg_frames | Integer | The number of frames in the scrub JPG | |||||||||||||
| scrub_jpg_url | String | The URL for the scrub JPG | |||||||||||||
| scrub_jpg_url_2x | String | The URL for the scrub JPG (2x resolution) | |||||||||||||
| scrub_jpg_url_3x | String | The URL for the scrub JPG (3x resolution) | |||||||||||||
| scrub_url | String | The URL for the thumbnail scrubber | |||||||||||||
| scrub_url_2x | String | The URL for the thumbnail scrubber (2x resolution) | |||||||||||||
| scrub_url_3x | String | The URL for the thumbnail scrubber (3x resolution) | |||||||||||||
| scrub_url_frames | Integer | The number of frames in the thumbnail scrubber | |||||||||||||
| sdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in SDR. | |||||||||||||
| sort_index | Integer | The sort index to use for display (low value should be display at the first) | |||||||||||||
| status | Enum [ACTIVE, TRANSCODING, PROCESSING, DELETED] | The asset status | |||||||||||||
| subtype | Enum [STREAMING, LIVE, IMMEDIATE, CAMERA_TYPE_ID, SLATE_TYPE_ID, CAPTURE_TYPE_ID, CAMERA_METADATA_TYPE_ID, PRODUCTION_SCENE_TYPE_ID, CAMERA_UNIT_TYPE_ID, SHOT_TYPE_ID, SEQUENCE_TYPE_ID] | The asset subtype | |||||||||||||
| subtypeDisplayName | String | The asset subtype in human readable format | |||||||||||||
| tags | CommonIdArray | The tag IDs for this asset | |||||||||||||
| thumbnail_url | String | The primary thumbnail URL for this asset | |||||||||||||
| thumbnail_url_2x | String | The primary thumbnail URL for this asset (2x resolution) | |||||||||||||
| thumbnail_url_3x | String | The primary thumbnail URL for this asset (3x resolution) | |||||||||||||
| timelines | String | Stringified JSON Array of timelines associated with this asset. Each timeline object contains array with segment objects. | |||||||||||||
| type | Enum [VIDEO, IMAGE, AUDIO, PDF, UNKNOWN, MULTI_PRIMARY, MULTI_SECONDARY, ORIGINAL] | The asset type | |||||||||||||
| uploaded_usage | Integer | Number of bytes of uploaded for this asset | |||||||||||||
| user_id | CommonId | The user ID this asset was created/uploaded by | |||||||||||||
| uuid | String | The asset UUID (if set) | |||||||||||||
| view_count_remaining | Integer | How many times remaining this asset can be viewed | |||||||||||||
| view_link | String | Link to view the asset in the Moxion web application. | |||||||||||||
| viewing_restricted | StringArray | Reason why this asset is restricted from viewing, an attempt to view will be blocked |
Get all the users who where sent a message
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The message ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| company | String | Users company name |
| first_name | String | Users first name |
| id | Id | The user ID |
| last_name | String | Users last name |
Get a list of messages
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| ids | Yes | IdArray | The message IDs | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| allow_comments | Boolean | Can comments be made. for Playlink messages, this value comes from the Playlink setting. For non-playlink messages, it comes from the user's can_comment permission in the project. |
| allow_download | Boolean | True if the message allows asset downloads |
| allow_offline | Boolean | True if the message allows asset offlining on mobile devices |
| body | String | The message text |
| can_be_restricted | Boolean | True if the message assets could be restricted because they have an IP address or view count restriction . |
| created | Date | The date/time this message was created |
| expire_days | Integer | The message expire days |
| expiry | Date | The message expiry time |
| group_id | CommonId | The production ID this message belongs to |
| id | Id | The message ID |
| is_deferred | Boolean | True if the message is deferred from viewing. Only returned if include_message_content is true. |
| is_expired | Boolean | True if the message has now expired |
| last_modified | Date | The date/time this message was last modified |
| playlink_id | Id | The playlink ID (playlink messages only) |
| project_id | CommonId | The message project id |
| project_name | String | The message project name |
| sender_first_name | String | The first name of user that sent the message |
| sender_last_name | String | The last name of the user that sent the message |
| sender_role | String | The role of the user that sent the message |
| sender_user_id | Id | The user ID of the message sender |
| start | Date | The message time this message is available to be used from. Only returned if include_message_content is true. |
| subject | String | The message subject |
| type | Enum [PLAYLINK, MESSAGE] | The sent message type |
Get a sent message
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The sent message ID | Valid Id |
| include_message_content | No | Boolean | Includes the message content fields in the response (defaults to false for backwards compatibility) | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| allow_download | Boolean | True if the message allows asset downloads. Only returned if include_message_content is true. |
| allow_edit | Boolean | Whether the message is editable by the current user (in the case of playlinks this is whether the current user can edit the playlink) |
| allow_offline | Boolean | True if the message allows asset offlining on mobile devices. Only returned if include_message_content is true. |
| asset_count | Integer | The number of assets in this message |
| blurhash | String | A hashed representation of the asset |
| body | String | The message text. Only returned if include_message_content is true. |
| can_be_restricted | Boolean | True if the message assets could be restricted because they have an IP address or view count restriction |
| company_id | Id | The company id |
| company_name | String | The company name |
| created | Date | The date/time this message was created. Only returned if include_message_content is true. |
| expire_days | Integer | The message expire days. Only returned if include_message_content is true. |
| expiry | Date | The message expiry time. Only returned if include_message_content is true. |
| folder | Enum [INBOX, ARCHIVE, SENT] | The folder that this sent message belongs to |
| group_color | Integer | The group color |
| group_id | CommonId | The production ID this sent message belongs to |
| group_name | String | The production display name this sent message belongs to |
| id | Id | The sent message ID |
| is_deferred | Boolean | True if the message is deferred from viewing. Only returned if include_message_content is true. |
| is_expired | Boolean | True if the message has now expired. Only returned if include_message_content is true. |
| is_live | Boolean | True if the message is a live steam related message. |
| is_share | Boolean | True if the message is of type notification but not live stream related |
| is_starred | Boolean | Whether the sent message is marked with a star |
| is_unread | Boolean | Whether the message is currently marked as unread |
| is_unviewed | Boolean | No longer used Deprecated: Always returns false. |
| last_modified | Date | The date/time this message was last modified (to display to user) |
| message_id | Id | The message id |
| modified_since | Date | The date/time this sent message was modified (for caching inbox data) |
| playlink_id | Id | The playlink ID (playlink messages only). Only returned if include_message_content is true. |
| playlist_id | CommonId | Id of the playlist |
| playlist_name | String | Name of the playlist |
| playlist_thumbnail_url | String | The primary thumbnail URL for shared playlist |
| playlist_thumbnail_url_2x | String | The primary thumbnail URL for for shared playlist (2x resolution) |
| playlist_thumbnail_url_3x | String | The primary thumbnail URL for for shared playlist (3x resolution) |
| project_id | CommonId | The message project id. Only returned if include_message_content is true. |
| project_name | String | The message project name. Only returned if include_message_content is true. |
| read_timestamp | Date | Time when the message was read |
| search_context | String | Text to apply client-side full text search against |
| sender_first_name | String | The first name of user that sent the message. Only returned if include_message_content is true. |
| sender_last_name | String | The last name of the user that sent the message. Only returned if include_message_content is true. |
| sender_role | String | The role of the user that sent the message. Only returned if include_message_content is true. |
| sender_user_id | Id | The user ID of the message sender. Only returned if include_message_content is true. |
| share_id | Id | Id of the share/playlink |
| share_name | String | Share Name |
| share_sent_date | Date | Share Sent Date |
| start | Date | The message time this message is available to be used from. Only returned if include_message_content is true. |
| subject | String | The message subject. Only returned if include_message_content is true. |
| thumbnail_url | String | The primary thumbnail URL for this message |
| thumbnail_url_2x | String | The primary thumbnail URL for this message (2x resolution) |
| thumbnail_url_3x | String | The primary thumbnail URL for this message (3x resolution) |
| type | Enum [PLAYLINK, MESSAGE] | The sent message type. Only returned if include_message_content is true. |
| unviewed_count | Integer | Number of unread assets in the share/playlink |
Get available sent messages for the current user. Note must specify either ids or folder.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| folder | No | Enum [INBOX, ARCHIVE, SENT] | The folder to get sent messages for. | Valid Enum |
| ids | No | IdArray | The the sent messages ids to get data. | Valid IdArray |
| ids_only | No | Boolean | Only return message ids in the response (defaults to false) | Valid Boolean |
| include_message_content | No | Boolean | Includes the message content fields in the response (defaults to false for backwards compatibility) | Valid Boolean |
| modified_since | No | Date | Only return messages that have been modified since this date | Valid Date |
| Parameter | Type | Description |
|---|---|---|
| allow_download | Boolean | True if the message allows asset downloads. Only returned if include_message_content is true. |
| allow_edit | Boolean | Whether the message is editable by the current user (in the case of playlinks this is whether the current user can edit the playlink) |
| allow_offline | Boolean | True if the message allows asset offlining on mobile devices. Only returned if include_message_content is true. |
| asset_count | Integer | The number of assets in this message |
| blurhash | String | A hashed representation of the asset |
| body | String | The message text. Only returned if include_message_content is true. |
| can_be_restricted | Boolean | True if the message assets could be restricted because they have an IP address or view count restriction |
| company_id | Id | The company id |
| company_name | String | The company name |
| created | Date | The date/time this message was created. Only returned if include_message_content is true. |
| expire_days | Integer | The message expire days. Only returned if include_message_content is true. |
| expiry | Date | The message expiry time. Only returned if include_message_content is true. |
| folder | Enum [INBOX, ARCHIVE, SENT] | The folder that this sent message belongs to |
| group_color | Integer | The group color |
| group_id | CommonId | The production ID this sent message belongs to |
| group_name | String | The production display name this sent message belongs to |
| id | Id | The sent message ID |
| is_deferred | Boolean | True if the message is deferred from viewing. Only returned if include_message_content is true. |
| is_expired | Boolean | True if the message has now expired. Only returned if include_message_content is true. |
| is_live | Boolean | True if the message is a live steam related message. |
| is_share | Boolean | True if the message is of type notification but not live stream related |
| is_starred | Boolean | Whether the sent message is marked with a star |
| is_unread | Boolean | Whether the message is currently marked as unread |
| is_unviewed | Boolean | No longer used Deprecated: Always returns false. |
| last_modified | Date | The date/time this message was last modified (to display to user) |
| message_id | Id | The message id |
| modified_since | Date | The date/time this sent message was modified (for caching inbox data) |
| playlink_id | Id | The playlink ID (playlink messages only). Only returned if include_message_content is true. |
| playlist_id | CommonId | Id of the playlist |
| playlist_name | String | Name of the playlist |
| playlist_thumbnail_url | String | The primary thumbnail URL for shared playlist |
| playlist_thumbnail_url_2x | String | The primary thumbnail URL for for shared playlist (2x resolution) |
| playlist_thumbnail_url_3x | String | The primary thumbnail URL for for shared playlist (3x resolution) |
| project_id | CommonId | The message project id. Only returned if include_message_content is true. |
| project_name | String | The message project name. Only returned if include_message_content is true. |
| read_timestamp | Date | Time when the message was read |
| search_context | String | Text to apply client-side full text search against |
| sender_first_name | String | The first name of user that sent the message. Only returned if include_message_content is true. |
| sender_last_name | String | The last name of the user that sent the message. Only returned if include_message_content is true. |
| sender_role | String | The role of the user that sent the message. Only returned if include_message_content is true. |
| sender_user_id | Id | The user ID of the message sender. Only returned if include_message_content is true. |
| share_id | Id | Id of the share/playlink |
| share_name | String | Share Name |
| share_sent_date | Date | Share Sent Date |
| start | Date | The message time this message is available to be used from. Only returned if include_message_content is true. |
| subject | String | The message subject. Only returned if include_message_content is true. |
| thumbnail_url | String | The primary thumbnail URL for this message |
| thumbnail_url_2x | String | The primary thumbnail URL for this message (2x resolution) |
| thumbnail_url_3x | String | The primary thumbnail URL for this message (3x resolution) |
| type | Enum [PLAYLINK, MESSAGE] | The sent message type. Only returned if include_message_content is true. |
| unviewed_count | Integer | Number of unread assets in the share/playlink |
Get count of available sent messages for the current user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| folder | Yes | Enum [INBOX, ARCHIVE, SENT] | The folder to get sent messages for. | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| count | Integer | The count of messages in the folder |
| last_modified | Date | The most recent last modified time of any message in the folder |
| unread | Integer | The count of unread messages in the folder |
Updates a sent message (only valid for messages sent to the current user)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The sent message ID | Valid Id |
| include_message_content | No | Boolean | Includes the message content fields in the response (defaults to false for backwards compatibility) | Valid Boolean |
| is_archived | No | Boolean | Whether to move message to ARCHIVE Folder | Valid Boolean |
| is_starred | No | Boolean | Flagging/unflagging message | Valid Boolean |
| is_unread | No | Boolean | Whether the sent message is unread | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| allow_download | Boolean | True if the message allows asset downloads. Only returned if include_message_content is true. |
| allow_edit | Boolean | Whether the message is editable by the current user (in the case of playlinks this is whether the current user can edit the playlink) |
| allow_offline | Boolean | True if the message allows asset offlining on mobile devices. Only returned if include_message_content is true. |
| asset_count | Integer | The number of assets in this message |
| blurhash | String | A hashed representation of the asset |
| body | String | The message text. Only returned if include_message_content is true. |
| can_be_restricted | Boolean | True if the message assets could be restricted because they have an IP address or view count restriction |
| company_id | Id | The company id |
| company_name | String | The company name |
| created | Date | The date/time this message was created. Only returned if include_message_content is true. |
| expire_days | Integer | The message expire days. Only returned if include_message_content is true. |
| expiry | Date | The message expiry time. Only returned if include_message_content is true. |
| folder | Enum [INBOX, ARCHIVE, SENT] | The folder that this sent message belongs to |
| group_color | Integer | The group color |
| group_id | CommonId | The production ID this sent message belongs to |
| group_name | String | The production display name this sent message belongs to |
| id | Id | The sent message ID |
| is_deferred | Boolean | True if the message is deferred from viewing. Only returned if include_message_content is true. |
| is_expired | Boolean | True if the message has now expired. Only returned if include_message_content is true. |
| is_live | Boolean | True if the message is a live steam related message. |
| is_share | Boolean | True if the message is of type notification but not live stream related |
| is_starred | Boolean | Whether the sent message is marked with a star |
| is_unread | Boolean | Whether the message is currently marked as unread |
| is_unviewed | Boolean | No longer used Deprecated: Always returns false. |
| last_modified | Date | The date/time this message was last modified (to display to user) |
| message_id | Id | The message id |
| modified_since | Date | The date/time this sent message was modified (for caching inbox data) |
| playlink_id | Id | The playlink ID (playlink messages only). Only returned if include_message_content is true. |
| playlist_id | CommonId | Id of the playlist |
| playlist_name | String | Name of the playlist |
| playlist_thumbnail_url | String | The primary thumbnail URL for shared playlist |
| playlist_thumbnail_url_2x | String | The primary thumbnail URL for for shared playlist (2x resolution) |
| playlist_thumbnail_url_3x | String | The primary thumbnail URL for for shared playlist (3x resolution) |
| project_id | CommonId | The message project id. Only returned if include_message_content is true. |
| project_name | String | The message project name. Only returned if include_message_content is true. |
| read_timestamp | Date | Time when the message was read |
| search_context | String | Text to apply client-side full text search against |
| sender_first_name | String | The first name of user that sent the message. Only returned if include_message_content is true. |
| sender_last_name | String | The last name of the user that sent the message. Only returned if include_message_content is true. |
| sender_role | String | The role of the user that sent the message. Only returned if include_message_content is true. |
| sender_user_id | Id | The user ID of the message sender. Only returned if include_message_content is true. |
| share_id | Id | Id of the share/playlink |
| share_name | String | Share Name |
| share_sent_date | Date | Share Sent Date |
| start | Date | The message time this message is available to be used from. Only returned if include_message_content is true. |
| subject | String | The message subject. Only returned if include_message_content is true. |
| thumbnail_url | String | The primary thumbnail URL for this message |
| thumbnail_url_2x | String | The primary thumbnail URL for this message (2x resolution) |
| thumbnail_url_3x | String | The primary thumbnail URL for this message (3x resolution) |
| type | Enum [PLAYLINK, MESSAGE] | The sent message type. Only returned if include_message_content is true. |
| unviewed_count | Integer | Number of unread assets in the share/playlink |
Updates all sent message as read or unread
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | No | CommonId | Restrict messages to this production | Valid CommonId |
| is_unread | Yes | Boolean | Whether the sent message is unread | Valid Boolean |
| message_type | Yes | Enum [SHARE, ACTIVITY, LIVE, FLAGGED, INBOX, SENT, ARCHIVE] | Restrict messages to this type | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| updated | Integer | Number of updated messages |
Add a team to an existing production
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The production ID | Valid CommonId |
| team_id | Yes | CommonId | The team ID to be added to this production | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| added | Boolean | True if team has been added to the production |
Add a team to an existing project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The project ID | Valid CommonId |
| team_id | Yes | CommonId | The team ID to be added to this project | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| added | Boolean | True if all team members have been added to the project |
Add user to an existing team
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The team ID | Valid CommonId |
| role_id | No | Id | The role to add this user to the team as | Valid Id |
| role_id_list | No | IdArray | A list of role ids to add this user to the team as, must have the same number of items as user_id_list | Valid IdArray |
| security_group_id | No | Integer | The security group to add these users to the team with | Valid Integer |
| user_id | No | Id | The user to add to the team | Valid Id |
| user_id_list | No | IdArray | A list of user ids to add to the team, must have the same number of items as role_id_list | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| added | Boolean | True if the users were added to the team |
Create a team within a company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | Id | The company ID this team belongs to | Valid Id |
| default_security_group | No | Integer | The security group that new members of this team will be assigned to by default | Valid Integer |
| group_id | No | CommonId | The production ID this team belongs to | Valid CommonId |
| name | Yes | String | The team name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| settings | Yes | Object | Team settings | Valid Object |
| Parameter | Type | Description |
|---|---|---|
| can_edit_team_details | Boolean | Is the user authorized to edit the company name/color etc (not the participants)? |
| can_update_participants | Boolean | User can update participants on this team |
| company_id | Id | The company ID this team belongs to |
| default_security_group | Integer | The security group that new members of this team will be assigned to by default. |
| group_id | CommonId | The production ID this team belongs to. 0 means this is a company level team |
| id | CommonId | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| is_collaborating | Boolean | Is this team collaborating in a playlist |
| is_externally_managed | Boolean | Does this team have externally managed users (ie is it a SCIM team)? |
| name | String | The team name |
| settings | Object | Team settings |
| user_count | Integer | Number of users present in a team |
Delete a team from this production
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The production ID | Valid CommonId |
| team_id | Yes | CommonId | The team ID to be deleted from this production | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if team has been deleted from the production |
Remove a team from an existing project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The project ID | Valid CommonId |
| team_id | Yes | CommonId | The team ID to be deleted from this project | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if team has been deleted from the project |
Delete a team by team id
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The team ID | Valid CommonId |
| productions | No | CommonIdArray | Remove the user from these productions | Valid CommonIdArray |
| projects | No | CommonIdArray | Remove the user from these projects | Valid CommonIdArray |
| validate | No | Boolean | Check if this delete will work without actually deleting | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the team (and all containing team relationships) were deleted |
| productions | CommonIdArray | Remove the user from these productions |
| projects | CommonIdArray | Remove the user from these projects |
| validated | Boolean | True if the team and the parameters provided are valid |
Delete user from a team
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The team ID | Valid CommonId |
| user_id | Yes | Id | The user to remove from the team | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the user was deleted from the team |
Get a project user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| user_id | Yes | Id | The user ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| account_status | Enum [INVITED, ACTIVE, DELETED] | User's account status (Invited, Active, Deleted) |
| can_delete_assets | Boolean | User can delete assets from this project |
| can_download | Boolean | User can download from this project |
| can_invite_users | Boolean | User can invite new users to this project |
| can_offline | Boolean | User can store assets for offline viewing |
| can_send_to_qtake | Boolean | User can send assets to QTAKE |
| can_update_batch_visibility | Boolean | User can update batch visibility |
| can_update_participants | Boolean | User can update participants on project |
| can_upload | Boolean | User can upload into this project |
| can_view | Boolean | User can view assets in this project |
| can_view_hidden_batches | Boolean | User can view hidden batches |
| can_view_participants | Boolean | User can view participants on project |
| company | String | Users company name |
| String | Users email | |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_only | Boolean | User can only view inbox |
| last_name | String | Users last name |
| project_permissions | Array | Array of group and team permissions for this user |
| project_role | String | The users new project role |
| security_group | Integer | The users new security group ID |
Remove a user from a project and remove a users production/team relationship with a project where required
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| keep_playlink_associations | No | Boolean | If true, retain the playlink-user associations, if any. This may mean the user does not leave the project if they have a playlink association that is kept. | Valid Boolean |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| teams | No | CommonIdArray | Remove the user from these team relationships | Valid CommonIdArray |
| user_id | No | Id | Remove a specific user (defaults to the current user). Only project admins can specify users other than themselves. | Valid Id |
| validate | No | Boolean | Check if this delete will remove the user from the project | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| removed | Boolean | True if user has been removed from the specified project |
| teams | CommonIdArray | Remove the user from these team relationships |
| validated | Boolean | True if the parameters provided will remove the user and all its production/team relationships from the project |
Update project specific settings for a user on a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| project_role | No | String | The users new project role | No HTML tags No {{ }} expressions |
| reset_mfa | No | Boolean | Reset the users MFA credentials so they can run MFA setup again | Valid Boolean |
| security_group | No | Integer | The users new security group ID | Valid Integer |
| user_id | Yes | Id | The user ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | True if the user has been updated |
Update a team by team id
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| default_security_group | No | Integer | The security group that new members of this team will be assigned to by default | Valid Integer |
| group_id | No | CommonId | The team production ID, pass empty string to change to company level team | Valid CommonId |
| id | Yes | CommonId | The team ID | Valid CommonId |
| name | No | String | The team name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| settings | No | Object | Team settings | Valid Object |
| Parameter | Type | Description |
|---|---|---|
| can_edit_team_details | Boolean | Is the user authorized to edit the company name/color etc (not the participants)? |
| can_update_participants | Boolean | User can update participants on this team |
| company_id | Id | The company ID this team belongs to |
| default_security_group | Integer | The security group that new members of this team will be assigned to by default. |
| group_id | CommonId | The production ID this team belongs to. 0 means this is a company level team |
| id | CommonId | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| is_collaborating | Boolean | Is this team collaborating in a playlist |
| is_externally_managed | Boolean | Does this team have externally managed users (ie is it a SCIM team)? |
| name | String | The team name |
| settings | Object | Team settings |
| updated | Boolean | True if the team has been updated |
| user_count | Integer | Number of users present in a team |
Update user details in a team
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The team ID | Valid CommonId |
| role_id | No | Id | The new role ID | Valid Id |
| security_group_id | No | Integer | The new security group ID | Valid Integer |
| user_id | Yes | Id | The user to update in the | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | True if update succeeded |
Add a list of collaborators to a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| collaborators | No | Array | The collaborator's list | Valid Array |
| playlist_id | Yes | CommonId | The playlist ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| collaborators | Array | The collaborator's that were added |
| playlist_id | CommonId | The playlist ID |
Get a list of collaborators from a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| playlist_id | Yes | CommonId | The playlist ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| collaborators | Array | The collaborator's that were added |
| playlist_id | CommonId | The playlist ID |
Remove a list of collaborators from a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| playlist_id | Yes | CommonId | The playlist ID | Valid CommonId |
| team_id | No | IdArray | The team ID's to remove from the playlist | Valid IdArray |
| user_id | No | IdArray | The user ID's to remove from the playlist | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| collaborators_deleted | Boolean | flag to indicate if collaborators were deleted |
Updates a list of collaborators of a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| collaborators | No | Array | The collaborator's list | Valid Array |
| playlist_id | Yes | CommonId | The playlist ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| collaborators | Array | The collaborator's that were updated |
| playlist_id | CommonId | The playlist ID |
Add an asset to a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | CommonId | The asset ID | Valid CommonId |
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| added | Boolean | True if the asset has been added | |||||||||||||
| available_comment_channels | StringArray | List of available comment channels | |||||||||||||
| batch_id | CommonId | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| blurhash | String | A hashed representation of the asset | |||||||||||||
| can_access_project | Boolean | User can access this asset | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| can_offline | Boolean | User can offline this asset | |||||||||||||
| can_update | Boolean | User can update this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| component_data | Object | The components of the asset | |||||||||||||
| component_links | Array | The component details array List | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| deny_view | Boolean | True if the asset should not be viewable by the user. | |||||||||||||
| desc | String | The asset description | |||||||||||||
| drm_enabled | Boolean | Whether manifest playback is enabled on the project that contains this asset. | |||||||||||||
| duration | Float | The asset duration (in seconds) | |||||||||||||
| ext | String | The original asset file extension | |||||||||||||
| hdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in HDR. | |||||||||||||
| hidden | Boolean | The asset is hidden and not visible to users that don't have permission to view hidden batches | |||||||||||||
| id | CommonId | The asset ID | |||||||||||||
| is_admin | Boolean | True if the user has admin permission for this asset. | |||||||||||||
| is_derived_sdr | Boolean | True if the Asset has generated an SDR from an HDR, False if the user has provided their own SDR | |||||||||||||
| is_derived_sdr_allowed | Boolean | Read Only replication of the is_derived_sdr_allowed Project Setting | |||||||||||||
| is_live | Boolean | Asset is currently live streaming | |||||||||||||
| is_sdr_allowed | Boolean | Read Only replication of the is_sdr_allowed Project Setting | |||||||||||||
| is_unviewed | Boolean | Is this asset not viewed by current user | |||||||||||||
| master_id | CommonId | The master asset Id | |||||||||||||
| metadata | Object | The assets metadata | |||||||||||||
| name | String | The asset file name (without original file extension) | |||||||||||||
| offline_bytes | Integer | Number of bytes of primary files that needed to be downloaded for offline usage | |||||||||||||
| origin_type | Enum [Moxion, Flow, Hybrid] | Asset Origin type | |||||||||||||
| overall_processing_time | String | The overall time in seconds the asset has taken to complete processing | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | CommonId | The project ID this asset belongs to | |||||||||||||
| resume_position | Float | The last playback time in seconds for restarting playback | |||||||||||||
| scrub_jpg_frames | Integer | The number of frames in the scrub JPG | |||||||||||||
| scrub_jpg_url | String | The URL for the scrub JPG | |||||||||||||
| scrub_jpg_url_2x | String | The URL for the scrub JPG (2x resolution) | |||||||||||||
| scrub_jpg_url_3x | String | The URL for the scrub JPG (3x resolution) | |||||||||||||
| scrub_url | String | The URL for the thumbnail scrubber | |||||||||||||
| scrub_url_2x | String | The URL for the thumbnail scrubber (2x resolution) | |||||||||||||
| scrub_url_3x | String | The URL for the thumbnail scrubber (3x resolution) | |||||||||||||
| scrub_url_frames | Integer | The number of frames in the thumbnail scrubber | |||||||||||||
| sdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in SDR. | |||||||||||||
| sort_index | Integer | The sort index to use for display (low value should be display at the first) | |||||||||||||
| status | Enum [ACTIVE, TRANSCODING, PROCESSING, DELETED] | The asset status | |||||||||||||
| subtype | Enum [STREAMING, LIVE, IMMEDIATE, CAMERA_TYPE_ID, SLATE_TYPE_ID, CAPTURE_TYPE_ID, CAMERA_METADATA_TYPE_ID, PRODUCTION_SCENE_TYPE_ID, CAMERA_UNIT_TYPE_ID, SHOT_TYPE_ID, SEQUENCE_TYPE_ID] | The asset subtype | |||||||||||||
| subtypeDisplayName | String | The asset subtype in human readable format | |||||||||||||
| tags | CommonIdArray | The tag IDs for this asset | |||||||||||||
| thumbnail_url | String | The primary thumbnail URL for this asset | |||||||||||||
| thumbnail_url_2x | String | The primary thumbnail URL for this asset (2x resolution) | |||||||||||||
| thumbnail_url_3x | String | The primary thumbnail URL for this asset (3x resolution) | |||||||||||||
| timelines | String | Stringified JSON Array of timelines associated with this asset. Each timeline object contains array with segment objects. | |||||||||||||
| type | Enum [VIDEO, IMAGE, AUDIO, PDF, UNKNOWN, MULTI_PRIMARY, MULTI_SECONDARY, ORIGINAL] | The asset type | |||||||||||||
| uploaded_usage | Integer | Number of bytes of uploaded for this asset | |||||||||||||
| user_id | CommonId | The user ID this asset was created/uploaded by | |||||||||||||
| uuid | String | The asset UUID (if set) | |||||||||||||
| view_link | String | Link to view the asset in the Moxion web application. |
Add assets to a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | Yes | CommonIdArray | The asset ID | Valid CommonIdArray |
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| added | Boolean | True if the assets have been added |
Add a user to playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| Yes | String | The users email address | Length must not exceed 254 Valid email format | |
| first_name | Yes | String | The users first name | No HTML tags No {{ }} expressions Length must not exceed 100 |
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| last_name | Yes | String | The users last name | No HTML tags No {{ }} expressions Length must not exceed 100 |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| added | Boolean | True if the user has been added |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| phone | String | Users phone number |
| playlink_user_id | CommonId | |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
Add a list of users to playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| users | No | Array | The Array of Users to be added | Valid Array |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| added | Boolean | True if the user has been added |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| phone | String | Users phone number |
| playlink_user_id | CommonId | |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
Create a new empty playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| admin_only_access_to_share_status | No | Boolean | This will only allow Admin permissions to see the participant viewed status of the playlink | Valid Boolean |
| allow_comments | No | Boolean | True if the playlink allows commenting | Valid Boolean |
| allow_download | No | Boolean | True if the playlink allows asset downloads | Valid Boolean |
| allow_offline | No | Boolean | True if the playlink allows asset offlining on mobile devices | Valid Boolean |
| allow_participants_to_see_others | No | Boolean | Whether participants can see other participants | Valid Boolean |
| auto_play | No | Boolean | True if the playlink auto plays | Valid Boolean |
| company_id | No | CommonId | The company id this playlink belongs to | Valid CommonId |
| defer_notification | No | Boolean | Defer notification until the start date has passed | Valid Boolean |
| description | No | String | The playlink description | No HTML tags No {{ }} expressions Length must not exceed 10000 |
| download_only | No | Boolean | True if the playlink only allows downloading (no playback) | Valid Boolean |
| email_cust_id | No | Id | Customization ID for the email template, if any. | Valid Id |
| email_notification | No | Boolean | Whether to send an email notification in the case of an inbox-only playlink | Valid Boolean |
| expire_days | No | Integer | The number of days when the playlink should expire | Valid Integer |
| expiry | No | Date | Expire date | Valid Date |
| expiry_timezone | No | String | Timezone of the expiry date/time if any. Only used for display purposes | No HTML tags No {{ }} expressions |
| is_scheduled | No | Boolean | True if the playlink is scheduled | Valid Boolean |
| name | Yes | String | The playlink name | No HTML tags No {{ }} expressions Length must not exceed 256 |
| password | No | String | The playlink password | No HTML tags No {{ }} expressions |
| playlist_ids | No | CommonIdArray | The playlist IDs | Valid CommonIdArray |
| project_id | No | CommonId | The project ID | Valid CommonId |
| restrict_lock_ip_address | No | Boolean | Viewers are limited to viewing at the first location (IP address) they view an asset from this playlink | Valid Boolean |
| restrict_view_count | No | Integer | Viewers are limited to viewing individual assets from this playlink this number of times | Valid Integer |
| send_password | No | Boolean | Should send playlink in email | Valid Boolean |
| should_expire | No | Boolean | True if the playlink has an expiration | Valid Boolean |
| start_date | No | Date | Start date | Valid Date |
| timezone | No | String | Timezone of the expiry start date/time if any. Only used for display purposes | No HTML tags No {{ }} expressions |
| type | No | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type | Valid Enum |
| watermark_id | No | Id | Watermark id of the playlink. | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| admin_only_access_to_share_status | Boolean | This will only allow Admin permissions to see the participant viewed status of the playlink |
| allow_comments | Boolean | True if the playlink allows commenting |
| allow_download | Boolean | True if the playlink allows asset downloads |
| allow_offline | Boolean | True if the playlink allows asset offlining on mobile devices |
| allow_participants_to_see_others | Boolean | Whether the participants can see other participants |
| auto_play | Boolean | True if the playlink auto pays |
| can_edit | Boolean | True if the user can edit the playlink |
| created | Date | The date/time this playlink was created |
| created_by | Id | The user ID of the playlink creator |
| created_by_name | String | The name of the playlink creator |
| defer_notification | Boolean | The playlink will defer notification until the start date has passed |
| description | String | The playlink description |
| download_only | Boolean | True if the playlink only allows downloading (no playback) |
| email_cust_id | Id | Id of this Playlink's custom email template, if any. |
| email_notification | Boolean | Whether to send an email notification in the case of an inbox-only playlink |
| expire_days | Integer | The playlink expire days |
| expiry | Date | The playlink expiry time |
| expiry_timezone | String | Timezone of the expiry date, if any. Only used for display purposes. |
| id | CommonId | The playlink ID |
| is_deferred | Boolean | True if the playlink is not available for use yet |
| is_expired | Boolean | True if the playlink has now expired, and has been sent |
| is_scheduled | Boolean | True if the playlink is scheduled |
| name | String | The playlink name |
| owner | CommonId | The user ID of the playlink owner |
| owner_name | String | The name of the playlink owner |
| participants_count | Integer | Number of users present in a playlink |
| password | String | The playlink password |
| project | CommonId | The project ID this playlink belongs to |
| restrict_lock_ip_address | Boolean | Viewers are limited to viewing at the first location (IP address) they view an asset from this playlink |
| restrict_view_count | Integer | Viewers are limited to viewing individual assets from this playlink this number of times |
| send_password | Boolean | Should send password with playlink email |
| sent | Boolean | True if the playlink has been sent |
| sent_by | Id | The user ID of the user who sent this playlink |
| sent_by_name | String | The name of the user who sent this playlink |
| sent_date | Date | The date/time this playlink was sent |
| should_expire | Boolean | Whether the playlink should expire |
| start_date | Date | The playlink start date |
| status | Enum [ACTIVE, DELETED] | The playlink status |
| timezone | String | Timezone of the expiry start date, if any. Only used for display purposes. |
| type | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type |
| updated | Date | The date/time this playlink was updated |
| updated_by | Id | The user ID of the user who updated this playlink |
| updated_by_name | String | The name of the user who updated this playlink |
| watermark_id | Id | Watermark Id of the Playlink. |
| watermark_name | String | Watermark Name |
| zip_url | String | The URL to download the assets from |
Delete a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| purge | No | Boolean | Flag to delete play link permanently | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the playlink has been deleted |
Duplicate the existing playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| playlink_id | Yes | CommonId | ID of the existing playlink. | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| admin_only_access_to_share_status | Boolean | This will only allow Admin permissions to see the participant viewed status of the playlink |
| allow_comments | Boolean | True if the playlink allows commenting |
| allow_download | Boolean | True if the playlink allows asset downloads |
| allow_offline | Boolean | True if the playlink allows asset offlining on mobile devices |
| allow_participants_to_see_others | Boolean | Whether the participants can see other participants |
| assets_count | Integer | Number of assets for the playlink |
| auto_play | Boolean | True if the playlink auto pays |
| can_edit | Boolean | True if the user can edit the playlink |
| created | Date | The date/time this playlink was created |
| created_by | Id | The user ID of the playlink creator |
| created_by_name | String | The name of the playlink creator |
| defer_notification | Boolean | The playlink will defer notification until the start date has passed |
| description | String | The playlink description |
| download_only | Boolean | True if the playlink only allows downloading (no playback) |
| email_cust_id | Id | Id of this Playlink's custom email template, if any. |
| email_notification | Boolean | Whether to send an email notification in the case of an inbox-only playlink |
| expire_days | Integer | The playlink expire days |
| expiry | Date | The playlink expiry time |
| expiry_timezone | String | Timezone of the expiry date, if any. Only used for display purposes. |
| group_id | CommonId | ID of the group |
| id | CommonId | The playlink ID |
| is_deferred | Boolean | True if the playlink is not available for use yet |
| is_expired | Boolean | True if the playlink has now expired, and has been sent |
| is_scheduled | Boolean | True if the playlink is scheduled |
| name | String | The playlink name |
| owner | CommonId | The user ID of the playlink owner |
| owner_name | String | The name of the playlink owner |
| participants_count | Integer | Number of users present in a playlink |
| password | String | The playlink password |
| project | CommonId | The project ID this playlink belongs to |
| restrict_lock_ip_address | Boolean | Viewers are limited to viewing at the first location (IP address) they view an asset from this playlink |
| restrict_view_count | Integer | Viewers are limited to viewing individual assets from this playlink this number of times |
| send_password | Boolean | Should send password with playlink email |
| sent | Boolean | True if the playlink has been sent |
| sent_by | Id | The user ID of the user who sent this playlink |
| sent_by_name | String | The name of the user who sent this playlink |
| sent_date | Date | The date/time this playlink was sent |
| should_expire | Boolean | Whether the playlink should expire |
| start_date | Date | The playlink start date |
| status | Enum [ACTIVE, DELETED] | The playlink status |
| timezone | String | Timezone of the expiry start date, if any. Only used for display purposes. |
| type | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type |
| updated | Date | The date/time this playlink was updated |
| updated_by | Id | The user ID of the user who updated this playlink |
| updated_by_name | String | The name of the user who updated this playlink |
| watermark_id | Id | Watermark Id of the Playlink. |
| watermark_name | String | Watermark Name |
| zip_url | String | The URL to download the assets from |
Get a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| admin_only_access_to_share_status | No | Boolean | This will only allow Admin permissions to see the participant viewed status of the playlink | Valid Boolean |
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| include_assets_count | No | Boolean | Include the number of asset for the playlink | Valid Boolean |
| include_participants_count | No | Boolean | Include the number of participants for the playlink | Valid Boolean |
| include_shared_playlists | No | Boolean | Include shared playlists in the response | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| admin_only_access_to_share_status | Boolean | This will only allow Admin permissions to see the participant viewed status of the playlink |
| allow_comments | Boolean | True if the playlink allows commenting |
| allow_download | Boolean | True if the playlink allows asset downloads |
| allow_offline | Boolean | True if the playlink allows asset offlining on mobile devices |
| allow_participants_to_see_others | Boolean | Whether the participants can see other participants |
| assets_count | Integer | Number of assets for the playlink |
| auto_play | Boolean | True if the playlink auto pays |
| can_edit | Boolean | True if the user can edit the playlink |
| created | Date | The date/time this playlink was created |
| created_by | Id | The user ID of the playlink creator |
| created_by_name | String | The name of the playlink creator |
| defer_notification | Boolean | The playlink will defer notification until the start date has passed |
| description | String | The playlink description |
| download_only | Boolean | True if the playlink only allows downloading (no playback) |
| email_cust_id | Id | Id of this Playlink's custom email template, if any. |
| email_notification | Boolean | Whether to send an email notification in the case of an inbox-only playlink |
| expire_days | Integer | The playlink expire days |
| expiry | Date | The playlink expiry time |
| expiry_timezone | String | Timezone of the expiry date, if any. Only used for display purposes. |
| group_id | CommonId | ID of the group |
| id | CommonId | The playlink ID |
| is_deferred | Boolean | True if the playlink is not available for use yet |
| is_expired | Boolean | True if the playlink has now expired, and has been sent |
| is_scheduled | Boolean | True if the playlink is scheduled |
| name | String | The playlink name |
| owner | CommonId | The user ID of the playlink owner |
| owner_name | String | The name of the playlink owner |
| participants_count | Integer | Number of users present in a playlink |
| password | String | The playlink password |
| playlists | Array | Array of shared playlists |
| project | CommonId | The project ID this playlink belongs to |
| restrict_lock_ip_address | Boolean | Viewers are limited to viewing at the first location (IP address) they view an asset from this playlink |
| restrict_view_count | Integer | Viewers are limited to viewing individual assets from this playlink this number of times |
| send_password | Boolean | Should send password with playlink email |
| sent | Boolean | True if the playlink has been sent |
| sent_by | Id | The user ID of the user who sent this playlink |
| sent_by_name | String | The name of the user who sent this playlink |
| sent_date | Date | The date/time this playlink was sent |
| should_expire | Boolean | Whether the playlink should expire |
| start_date | Date | The playlink start date |
| status | Enum [ACTIVE, DELETED] | The playlink status |
| timezone | String | Timezone of the expiry start date, if any. Only used for display purposes. |
| type | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type |
| updated | Date | The date/time this playlink was updated |
| updated_by | Id | The user ID of the user who updated this playlink |
| updated_by_name | String | The name of the user who updated this playlink |
| watermark_id | Id | Watermark Id of the Playlink. |
| watermark_name | String | Watermark Name |
| zip_url | String | The URL to download the assets from |
Get all the assets within a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| available_comment_channels | StringArray | List of available comment channels | |||||||||||||
| batch_id | CommonId | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| blurhash | String | A hashed representation of the asset | |||||||||||||
| can_access_project | Boolean | User can access this asset | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| can_navigate_to_folder | Boolean | User can show in folder for this asset | |||||||||||||
| can_offline | Boolean | User can offline this asset | |||||||||||||
| can_update | Boolean | User can update this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| component_data | Object | The components of the asset | |||||||||||||
| component_links | Array | The component details array List | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| deny_view | Boolean | True if the asset should not be viewable by the user. | |||||||||||||
| desc | String | The asset description | |||||||||||||
| drm_enabled | Boolean | Whether manifest playback is enabled on the project that contains this asset. | |||||||||||||
| duration | Float | The asset duration (in seconds) | |||||||||||||
| ext | String | The original asset file extension | |||||||||||||
| hdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in HDR. | |||||||||||||
| hidden | Boolean | The asset is hidden and not visible to users that don't have permission to view hidden batches | |||||||||||||
| id | CommonId | The asset ID | |||||||||||||
| is_admin | Boolean | True if the user has admin permission for this asset. | |||||||||||||
| is_derived_sdr | Boolean | True if the Asset has generated an SDR from an HDR, False if the user has provided their own SDR | |||||||||||||
| is_derived_sdr_allowed | Boolean | Read Only replication of the is_derived_sdr_allowed Project Setting | |||||||||||||
| is_live | Boolean | Asset is currently live streaming | |||||||||||||
| is_sdr_allowed | Boolean | Read Only replication of the is_sdr_allowed Project Setting | |||||||||||||
| is_unviewed | Boolean | Is this asset not viewed by current user | |||||||||||||
| master_id | CommonId | The master asset Id | |||||||||||||
| metadata | Object | The assets metadata | |||||||||||||
| name | String | The asset file name (without original file extension) | |||||||||||||
| offline_bytes | Integer | Number of bytes of primary files that needed to be downloaded for offline usage | |||||||||||||
| origin_type | Enum [Moxion, Flow, Hybrid] | Asset Origin type | |||||||||||||
| overall_processing_time | String | The overall time in seconds the asset has taken to complete processing | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | CommonId | The project ID this asset belongs to | |||||||||||||
| resume_position | Float | The last playback time in seconds for restarting playback | |||||||||||||
| scrub_jpg_frames | Integer | The number of frames in the scrub JPG | |||||||||||||
| scrub_jpg_url | String | The URL for the scrub JPG | |||||||||||||
| scrub_jpg_url_2x | String | The URL for the scrub JPG (2x resolution) | |||||||||||||
| scrub_jpg_url_3x | String | The URL for the scrub JPG (3x resolution) | |||||||||||||
| scrub_url | String | The URL for the thumbnail scrubber | |||||||||||||
| scrub_url_2x | String | The URL for the thumbnail scrubber (2x resolution) | |||||||||||||
| scrub_url_3x | String | The URL for the thumbnail scrubber (3x resolution) | |||||||||||||
| scrub_url_frames | Integer | The number of frames in the thumbnail scrubber | |||||||||||||
| sdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in SDR. | |||||||||||||
| sort_index | Integer | The sort index to use for display (low value should be display at the first) | |||||||||||||
| status | Enum [ACTIVE, TRANSCODING, PROCESSING, DELETED] | The asset status | |||||||||||||
| subtype | Enum [STREAMING, LIVE, IMMEDIATE, CAMERA_TYPE_ID, SLATE_TYPE_ID, CAPTURE_TYPE_ID, CAMERA_METADATA_TYPE_ID, PRODUCTION_SCENE_TYPE_ID, CAMERA_UNIT_TYPE_ID, SHOT_TYPE_ID, SEQUENCE_TYPE_ID] | The asset subtype | |||||||||||||
| subtypeDisplayName | String | The asset subtype in human readable format | |||||||||||||
| tags | CommonIdArray | The tag IDs for this asset | |||||||||||||
| thumbnail_url | String | The primary thumbnail URL for this asset | |||||||||||||
| thumbnail_url_2x | String | The primary thumbnail URL for this asset (2x resolution) | |||||||||||||
| thumbnail_url_3x | String | The primary thumbnail URL for this asset (3x resolution) | |||||||||||||
| timelines | String | Stringified JSON Array of timelines associated with this asset. Each timeline object contains array with segment objects. | |||||||||||||
| type | Enum [VIDEO, IMAGE, AUDIO, PDF, UNKNOWN, MULTI_PRIMARY, MULTI_SECONDARY, ORIGINAL] | The asset type | |||||||||||||
| uploaded_usage | Integer | Number of bytes of uploaded for this asset | |||||||||||||
| user_id | CommonId | The user ID this asset was created/uploaded by | |||||||||||||
| uuid | String | The asset UUID (if set) | |||||||||||||
| view_count_remaining | Integer | How many times remaining this asset can be viewed | |||||||||||||
| view_link | String | Link to view the asset in the Moxion web application. | |||||||||||||
| viewing_restricted | StringArray | Reason why this asset is restricted from viewing, an attempt to view will be blocked |
Get all the users on a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| first_name | String | Users first name |
| hash | String | The playlink hash for this user |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| opens | Integer | The number of times the playlink has been opened |
| phone | String | Users phone number |
| playlink_user_id | CommonId | |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sysop | Boolean | User is a SysOp |
| team_id | CommonId | The team ID of a playlink user, if they were added via a team |
| timezone | String | Users current timezone |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
| user_id | Id |
Get all the playlinks for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| admin_only_access_to_share_status | No | Boolean | This will only allow Admin permissions to see the participant viewed status of the playlink | Valid Boolean |
| company_id | No | CommonId | The company id to filter the playlinks by | Valid CommonId |
| from_date | No | Date | Filter playlinks by the date they were created | Valid Date |
| include_assets_count | No | Boolean | Include the number of asset for the playlinks | Valid Boolean |
| include_participants_count | No | Boolean | Include the number of participants for each playlink | Valid Boolean |
| include_shared_playlists | No | Boolean | Include shared playlists in the response | Valid Boolean |
| is_expired | No | Boolean | Filter playlinks by expired status | Valid Boolean |
| limit | No | Integer | Maximum number of playlists to return, 20 if not specified | Valid Integer |
| my_invites_only | No | Boolean | Include only playlinks where user is invited | Valid Boolean |
| playlist_id | No | CommonId | The playlist ID | Valid CommonId |
| project_id | No | CommonId | The project ID | Valid CommonId |
| search | No | String | Find playlinks matching this string | No HTML tags No {{ }} expressions |
| sent_by | No | CommonId | Filter playlinks by the user who sent them | Valid CommonId |
| sort_by | No | Enum [NAME, DATE] | Sort by filed for the api | Valid Enum |
| sort_direction | No | Enum [ASC, DESC] | Sort direction filed for the api | Valid Enum |
| status | No | Enum [ACTIVE, DELETED] | Filter playlinks by status | Valid Enum |
| to_date | No | Date | Filter playlinks by the date they were created | Valid Date |
| with_pagination | No | Boolean | Whether to paginate or return all playlinks | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| admin_only_access_to_share_status | Boolean | This will only allow Admin permissions to see the participant viewed status of the playlink |
| allow_comments | Boolean | True if the playlink allows commenting |
| allow_download | Boolean | True if the playlink allows asset downloads |
| allow_offline | Boolean | True if the playlink allows asset offlining on mobile devices |
| allow_participants_to_see_others | Boolean | Whether the participants can see other participants |
| assets_count | Integer | Number of assets for the playlink |
| auto_play | Boolean | True if the playlink auto pays |
| can_edit | Boolean | True if the user can edit the playlink |
| created | Date | The date/time this playlink was created |
| created_by | Id | The user ID of the playlink creator |
| created_by_name | String | The name of the playlink creator |
| defer_notification | Boolean | The playlink will defer notification until the start date has passed |
| description | String | The playlink description |
| download_only | Boolean | True if the playlink only allows downloading (no playback) |
| email_cust_id | Id | Id of this Playlink's custom email template, if any. |
| email_notification | Boolean | Whether to send an email notification in the case of an inbox-only playlink |
| expire_days | Integer | The playlink expire days |
| expiry | Date | The playlink expiry time |
| expiry_timezone | String | Timezone of the expiry date, if any. Only used for display purposes. |
| group_id | CommonId | ID of the group |
| id | CommonId | The playlink ID |
| is_deferred | Boolean | True if the playlink is not available for use yet |
| is_expired | Boolean | True if the playlink has now expired, and has been sent |
| is_scheduled | Boolean | True if the playlink is scheduled |
| name | String | The playlink name |
| owner | CommonId | The user ID of the playlink owner |
| owner_name | String | The name of the playlink owner |
| participants_count | Integer | Number of users present in a playlink |
| password | String | The playlink password |
| playlists | Array | Array of shared playlists |
| project | CommonId | The project ID this playlink belongs to |
| restrict_lock_ip_address | Boolean | Viewers are limited to viewing at the first location (IP address) they view an asset from this playlink |
| restrict_view_count | Integer | Viewers are limited to viewing individual assets from this playlink this number of times |
| send_password | Boolean | Should send password with playlink email |
| sent | Boolean | True if the playlink has been sent |
| sent_by | Id | The user ID of the user who sent this playlink |
| sent_by_name | String | The name of the user who sent this playlink |
| sent_date | Date | The date/time this playlink was sent |
| should_expire | Boolean | Whether the playlink should expire |
| start_date | Date | The playlink start date |
| status | Enum [ACTIVE, DELETED] | The playlink status |
| timezone | String | Timezone of the expiry start date, if any. Only used for display purposes. |
| type | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type |
| updated | Date | The date/time this playlink was updated |
| updated_by | Id | The user ID of the user who updated this playlink |
| updated_by_name | String | The name of the user who updated this playlink |
| watermark_id | Id | Watermark Id of the Playlink. |
| watermark_name | String | Watermark Name |
| zip_url | String | The URL to download the assets from |
Remove an asset from a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | CommonId | The asset ID | Valid CommonId |
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| removed | Boolean | True if the asset has been removed |
Remove a user from a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| user_id | Yes | Id | The user ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| removed | Boolean | True if the user has been removed |
Remove users from a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| user_ids | Yes | IdArray | The user IDs | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| removed | Boolean | True if the users have been removed |
Search for users in playlinks
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | CommonId | Filter playlinks by company | Valid CommonId |
| is_expired | No | Boolean | Filter playlinks by expiry | Valid Boolean |
| search_term | Yes | String | The search term to match against user names. Minimum 3 characters | No HTML tags No {{ }} expressions Length must not be less than 3 characters Length must not exceed 100 |
| status | No | Enum [ACTIVE, DELETED] | Filter playlinks by status | Valid Enum |
| user_type | No | Enum [OWNER, SENDER] | Filter playlinks by user type | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| first_name | String | The user's first name |
| last_name | String | The user's last name |
| user_id | Id | The user ID |
Send a playlink to a playlink user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| playlink_id | Yes | CommonId | The playlink ID | Valid CommonId |
| playlink_users | Yes | IdArray | List of playlink user IDs | Valid IdArray |
| timezone | No | String | The sender timezone | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| sent | Boolean | True if the playlink has been sent |
Set the order of an asset in a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | CommonId | The asset ID | Valid CommonId |
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| order | Yes | Integer | The order value | Valid Integer |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | True if the asset has been updated |
Update the playlink settings
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| admin_only_access_to_share_status | No | Boolean | This will only allow Admin permissions to see the participant viewed status of the playlink | Valid Boolean |
| allow_comments | No | Boolean | True if the playlink allows commenting | Valid Boolean |
| allow_download | No | Boolean | True if the playlink allows asset downloads | Valid Boolean |
| allow_offline | No | Boolean | True if the playlink allows asset offlining on mobile devices | Valid Boolean |
| allow_participants_to_see_others | No | Boolean | Whether participants can see other participants | Valid Boolean |
| auto_play | No | Boolean | True if the playlink auto plays | Valid Boolean |
| defer_notification | No | Boolean | Defer notification until the start date has passed | Valid Boolean |
| description | No | String | The playlink description | No HTML tags No {{ }} expressions Length must not exceed 10000 |
| download_only | No | Boolean | True if the playlink only allows downloading (no playback) | Valid Boolean |
| email_cust_id | No | Id | Customization ID for the email template, if any. | Valid Id |
| email_notification | No | Boolean | Whether to send an email notification in the case of an inbox-only playlink | Valid Boolean |
| expire_days | No | Integer | The number of days when the playlink should expire | Valid Integer |
| expiry | No | Date | Expire date | Valid Date |
| expiry_timezone | No | String | Timezone of the expiry date/time if any. Only used for display purposes | No HTML tags No {{ }} expressions |
| id | Yes | CommonId | The playlink ID | Valid CommonId |
| is_scheduled | No | Boolean | True if the playlink is scheduled | Valid Boolean |
| name | No | String | The playlink name | No HTML tags No {{ }} expressions Length must not exceed 256 |
| password | No | String | The playlink password | No HTML tags No {{ }} expressions |
| restrict_lock_ip_address | No | Boolean | Viewers are limited to viewing at the first location (IP address) they view an asset from this playlink | Valid Boolean |
| restrict_view_count | No | Integer | Viewers are limited to viewing individual assets from this playlink this number of times | Valid Integer |
| send_password | No | Boolean | Should send playlink in email | Valid Boolean |
| should_expire | No | Boolean | True if the playlink has an expiration | Valid Boolean |
| start_date | No | Date | Start date | Valid Date |
| timezone | No | String | Timezone of the expiry date/time if any. Only used for display purposes | No HTML tags No {{ }} expressions |
| type | No | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type | Valid Enum |
| watermark_id | No | Id | Watermark id of the playlink. | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| admin_only_access_to_share_status | Boolean | This will only allow Admin permissions to see the participant viewed status of the playlink |
| allow_comments | Boolean | True if the playlink allows commenting |
| allow_download | Boolean | True if the playlink allows asset downloads |
| allow_offline | Boolean | True if the playlink allows asset offlining on mobile devices |
| allow_participants_to_see_others | Boolean | Whether the participants can see other participants |
| assets_count | Integer | Number of assets for the playlink |
| auto_play | Boolean | True if the playlink auto pays |
| can_edit | Boolean | True if the user can edit the playlink |
| created | Date | The date/time this playlink was created |
| created_by | Id | The user ID of the playlink creator |
| created_by_name | String | The name of the playlink creator |
| defer_notification | Boolean | The playlink will defer notification until the start date has passed |
| description | String | The playlink description |
| download_only | Boolean | True if the playlink only allows downloading (no playback) |
| email_cust_id | Id | Id of this Playlink's custom email template, if any. |
| email_notification | Boolean | Whether to send an email notification in the case of an inbox-only playlink |
| expire_days | Integer | The playlink expire days |
| expiry | Date | The playlink expiry time |
| expiry_timezone | String | Timezone of the expiry date, if any. Only used for display purposes. |
| id | CommonId | The playlink ID |
| is_deferred | Boolean | True if the playlink is not available for use yet |
| is_expired | Boolean | True if the playlink has now expired, and has been sent |
| is_scheduled | Boolean | True if the playlink is scheduled |
| is_updated | Boolean | True if playlink has been updated |
| name | String | The playlink name |
| owner | CommonId | The user ID of the playlink owner |
| owner_name | String | The name of the playlink owner |
| participants_count | Integer | Number of users present in a playlink |
| password | String | The playlink password |
| playlists | Array | Array of shared playlists |
| project | CommonId | The project ID this playlink belongs to |
| restrict_lock_ip_address | Boolean | Viewers are limited to viewing at the first location (IP address) they view an asset from this playlink |
| restrict_view_count | Integer | Viewers are limited to viewing individual assets from this playlink this number of times |
| send_password | Boolean | Should send password with playlink email |
| sent | Boolean | True if the playlink has been sent |
| sent_by | Id | The user ID of the user who sent this playlink |
| sent_by_name | String | The name of the user who sent this playlink |
| sent_date | Date | The date/time this playlink was sent |
| should_expire | Boolean | Whether the playlink should expire |
| start_date | Date | The playlink start date |
| status | Enum [ACTIVE, DELETED] | The playlink status |
| timezone | String | Timezone of the expiry start date, if any. Only used for display purposes. |
| type | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type |
| updated | Date | The date/time this playlink was updated |
| updated_by | Id | The user ID of the user who updated this playlink |
| updated_by_name | String | The name of the user who updated this playlink |
| watermark_id | Id | Watermark Id of the Playlink. |
| watermark_name | String | Watermark Name |
| zip_url | String | The URL to download the assets from |
Add playlink default settings
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| allow_comments | No | Boolean | True if the playlink allows commenting | Valid Boolean |
| allow_download | No | Boolean | True if the playlink allows asset downloads | Valid Boolean |
| allow_offline | No | Boolean | True if the playlink allows asset offlining on mobile devices | Valid Boolean |
| auto_play | No | Boolean | True if the playlink auto plays | Valid Boolean |
| company_id | Yes | CommonId | The company ID | Valid CommonId |
| expiry_timezone | No | String | Timezone of the expiry date/time if any. Only used for display purposes | No HTML tags No {{ }} expressions |
| playlink_type | No | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type | Valid Enum |
| restrict_lock_ip_address | No | Boolean | Viewers are limited to viewing at the first location (IP address) they view an asset from this playlink | Valid Boolean |
| timezone | No | String | Timezone of the expiry start date/time if any. Only used for display purposes | No HTML tags No {{ }} expressions |
| user_id | Yes | Id | The user ID | Valid Id |
| watermark_id | No | Id | Watermark id of the playlink default settings | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| added | Boolean | True if the playlink default settings have been added |
| id | Id | ID of the playlink default settings |
Get Playlink default settings
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | CommonId | The company ID | Valid CommonId |
| playlist_id | No | CommonId | The playlist ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| access_code | String | The playlink password |
| allow_comments | Boolean | Allow Comments |
| allow_download | Boolean | Allow Download |
| allow_offline | Boolean | Allow Offline |
| auto_play | Boolean | Allow Play |
| can_add_external_users | Boolean | If adding externally managed users allowed or not |
| company_id | CommonId | The company ID |
| download_assets | Enum [ALL, SOME, NONE] | Whether user can share all, some or none of the assets |
| expiry_timezone | String | Expiry Timezone |
| id | CommonId | The playlink Default Settings ID |
| offline_assets | Enum [ALL, SOME, NONE] | Whether user can offline all, some or none of the assets |
| playlink_access_types | StringArray | List if playlink types supported for a playlist id |
| playlink_type | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type |
| restrict_lock_ip_address | Boolean | Restrict Lock Ip Address |
| share_assets | Enum [ALL, SOME, NONE] | Whether user can share all, some or none of the assets |
| timezone | String | Time zone |
| user_id | Id | The playlink Default Settings user ID |
| watermark_id | Id | Watermark Id |
| watermark_name | String | Watermark Name |
DEPRECATED : Use /update/playlist.
Add assets to a playlist.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | Yes | CommonIdArray | The asset IDs | Valid CommonIdArray |
| id | Yes | CommonId | The playlist ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| added | Boolean | True if the assets were added |
Create a new empty playlist owned by the current user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | No | CommonId | The Company Id | Valid CommonId |
| description | No | String | The description of the playlist | No HTML tags No {{ }} expressions Length must not exceed 1024 |
| group_id | No | CommonId | The Group ID | Valid CommonId |
| name | Yes | String | The name of the playlist | No HTML tags No {{ }} expressions Length must not exceed 45 |
| playlist_source | No | Enum [SNAPSHOT, FOLDER] | Source of Playlist | Valid Enum |
| source_project_id | No | CommonId | Project ID this playlist associates to | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| blurhash | String | A hashed representation of the asset |
| can_add_collaborators | Boolean | True if the user can add collaborators to the playlist. |
| can_collaborate | Boolean | Suggests if a playlist is eligible for collaboration. |
| can_edit | Boolean | True if the user can edit the playlist. |
| can_share | Boolean | True if the user can share the playlist. |
| company_id | CommonId | The Company ID this playlist belongs to |
| created | Date | The playlist creation date and time |
| description | String | The playlist description |
| flow_id | String | The native Flow ID of this playlist, without encryption. Only provided if this is a Flow Playlist. |
| group_id | CommonId | The production ID this playlist belongs to |
| has_collaborators | Boolean | True if the playlist has collaborators. |
| id | CommonId | The playlist ID |
| is_dynamic | Boolean | Is this a dynamic playlist? Dynamic playlists cannot be modified through the UI. |
| is_shared_with_me | Boolean | True if the playlist is shared with the requesting user by another user |
| modified | Date | The playlist modified date and time |
| name | String | The name of the playlist |
| origin_type | Enum [Moxion, Flow, Hybrid] | Playlist Origin type |
| owner_id | Id | The user ID of the playlist owner |
| owner_name | String | The name of the playlist owner |
| playlinks | Array | Array of playlinks |
| source_project_id | CommonId | If this is a dynamic playlist, the ID of the source folder |
| source_type | Enum [USER, REVIEW_SESSION] | If this is a dynamic playlist, the source type (SNAPSHOT, FOLDER) |
| thumbnail_asset_id | CommonId | The ID of the asset that is being used as the thumbnail ID. If not provided, a default thumbnail will be generated and used. |
| thumbnail_type | Enum [NONE, GENERATED, UPLOADED, SELECTED_ASSET] | The type of the Playlist thumbnail: NONE, GENERATED, SELECTED_ASSET or UPLOADED |
| thumbnail_url | String | The primary thumbnail URL for this playlist |
| thumbnail_url_2x | String | The primary thumbnail URL for this playlist (2x resolution) |
| thumbnail_url_3x | String | The primary thumbnail URL for this playlist (3x resolution) |
| type | Enum [USER, REVIEW_SESSION] | Playlist type |
Delete a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlist ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the playlist has been deleted |
Get a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlist ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| asset_ids | CommonIdArray | The playlist asset IDs |
| blurhash | String | A hashed representation of the asset |
| can_add_collaborators | Boolean | True if the user can add collaborators to the playlist. |
| can_collaborate | Boolean | Suggests if a playlist is eligible for collaboration. |
| can_edit | Boolean | True if the user can edit the playlist. |
| can_share | Boolean | True if the user can share the playlist. |
| can_view_collaborators | Boolean | Can View Collaborators |
| company_id | CommonId | The Company ID this playlist belongs to |
| created | Date | The playlist creation date and time |
| description | String | The playlist description |
| flow_id | String | The native Flow ID of this playlist, without encryption. Only provided if this is a Flow Playlist. |
| group_id | CommonId | The production ID this playlist belongs to |
| has_collaborators | Boolean | True if the playlist has collaborators. |
| id | CommonId | The playlist ID |
| is_dynamic | Boolean | Is this a dynamic playlist? Dynamic playlists cannot be modified through the UI. |
| is_shared_with_me | Boolean | True if the playlist is shared with the requesting user by another user |
| modified | Date | The playlist modified date and time |
| name | String | The name of the playlist |
| origin_type | Enum [Moxion, Flow, Hybrid] | Playlist Origin type |
| owner_id | Id | The user ID of the playlist owner |
| owner_name | String | The name of the playlist owner |
| playlinks | Array | Array of playlinks |
| source_project_id | CommonId | If this is a dynamic playlist, the ID of the source folder |
| source_type | Enum [USER, REVIEW_SESSION] | If this is a dynamic playlist, the source type (SNAPSHOT, FOLDER) |
| thumbnail_asset_id | CommonId | The ID of the asset that is being used as the thumbnail ID. If not provided, a default thumbnail will be generated and used. |
| thumbnail_type | Enum [NONE, GENERATED, UPLOADED, SELECTED_ASSET] | The type of the Playlist thumbnail: NONE, GENERATED, SELECTED_ASSET or UPLOADED |
| thumbnail_url | String | The primary thumbnail URL for this playlist |
| thumbnail_url_2x | String | The primary thumbnail URL for this playlist (2x resolution) |
| thumbnail_url_3x | String | The primary thumbnail URL for this playlist (3x resolution) |
| type | Enum [USER, REVIEW_SESSION] | Playlist type |
Get all the assets in a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlist ID | Valid CommonId |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| available_comment_channels | StringArray | List of available comment channels | |||||||||||||
| batch_id | CommonId | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| blurhash | String | A hashed representation of the asset | |||||||||||||
| can_access_project | Boolean | User can access this asset | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| can_offline | Boolean | User can offline this asset | |||||||||||||
| can_update | Boolean | User can update this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| component_data | Object | The components of the asset | |||||||||||||
| component_links | Array | The component details array List | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| deny_view | Boolean | True if the asset should not be viewable by the user. | |||||||||||||
| desc | String | The asset description | |||||||||||||
| drm_enabled | Boolean | Whether manifest playback is enabled on the project that contains this asset. | |||||||||||||
| duration | Float | The asset duration (in seconds) | |||||||||||||
| ext | String | The original asset file extension | |||||||||||||
| hdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in HDR. | |||||||||||||
| hidden | Boolean | The asset is hidden and not visible to users that don't have permission to view hidden batches | |||||||||||||
| id | CommonId | The asset ID | |||||||||||||
| is_admin | Boolean | True if the user has admin permission for this asset. | |||||||||||||
| is_derived_sdr | Boolean | True if the Asset has generated an SDR from an HDR, False if the user has provided their own SDR | |||||||||||||
| is_derived_sdr_allowed | Boolean | Read Only replication of the is_derived_sdr_allowed Project Setting | |||||||||||||
| is_live | Boolean | Asset is currently live streaming | |||||||||||||
| is_sdr_allowed | Boolean | Read Only replication of the is_sdr_allowed Project Setting | |||||||||||||
| is_unviewed | Boolean | Is this asset not viewed by current user | |||||||||||||
| master_id | CommonId | The master asset Id | |||||||||||||
| metadata | Object | The assets metadata | |||||||||||||
| name | String | The asset file name (without original file extension) | |||||||||||||
| offline_bytes | Integer | Number of bytes of primary files that needed to be downloaded for offline usage | |||||||||||||
| origin_type | Enum [Moxion, Flow, Hybrid] | Asset Origin type | |||||||||||||
| overall_processing_time | String | The overall time in seconds the asset has taken to complete processing | |||||||||||||
| playlist_asset_id | CommonId | The playlist asset ID | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | CommonId | The project ID this asset belongs to | |||||||||||||
| resume_position | Float | The last playback time in seconds for restarting playback | |||||||||||||
| scrub_jpg_frames | Integer | The number of frames in the scrub JPG | |||||||||||||
| scrub_jpg_url | String | The URL for the scrub JPG | |||||||||||||
| scrub_jpg_url_2x | String | The URL for the scrub JPG (2x resolution) | |||||||||||||
| scrub_jpg_url_3x | String | The URL for the scrub JPG (3x resolution) | |||||||||||||
| scrub_url | String | The URL for the thumbnail scrubber | |||||||||||||
| scrub_url_2x | String | The URL for the thumbnail scrubber (2x resolution) | |||||||||||||
| scrub_url_3x | String | The URL for the thumbnail scrubber (3x resolution) | |||||||||||||
| scrub_url_frames | Integer | The number of frames in the thumbnail scrubber | |||||||||||||
| sdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in SDR. | |||||||||||||
| sort_index | Integer | The sort index to use for display (low value should be display at the first) | |||||||||||||
| status | Enum [ACTIVE, TRANSCODING, PROCESSING, DELETED] | The asset status | |||||||||||||
| subtype | Enum [STREAMING, LIVE, IMMEDIATE, CAMERA_TYPE_ID, SLATE_TYPE_ID, CAPTURE_TYPE_ID, CAMERA_METADATA_TYPE_ID, PRODUCTION_SCENE_TYPE_ID, CAMERA_UNIT_TYPE_ID, SHOT_TYPE_ID, SEQUENCE_TYPE_ID] | The asset subtype | |||||||||||||
| subtypeDisplayName | String | The asset subtype in human readable format | |||||||||||||
| tags | CommonIdArray | The tag IDs for this asset | |||||||||||||
| thumbnail_url | String | The primary thumbnail URL for this asset | |||||||||||||
| thumbnail_url_2x | String | The primary thumbnail URL for this asset (2x resolution) | |||||||||||||
| thumbnail_url_3x | String | The primary thumbnail URL for this asset (3x resolution) | |||||||||||||
| timelines | String | Stringified JSON Array of timelines associated with this asset. Each timeline object contains array with segment objects. | |||||||||||||
| type | Enum [VIDEO, IMAGE, AUDIO, PDF, UNKNOWN, MULTI_PRIMARY, MULTI_SECONDARY, ORIGINAL] | The asset type | |||||||||||||
| uploaded_usage | Integer | Number of bytes of uploaded for this asset | |||||||||||||
| user_id | CommonId | The user ID this asset was created/uploaded by | |||||||||||||
| uuid | String | The asset UUID (if set) | |||||||||||||
| view_link | String | Link to view the asset in the Moxion web application. |
Return playlist asset counts group by Production Name and Project Name
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| playlist_id | Yes | CommonId | The playlist ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| asset_counts | Array | Asset Counts |
| playlist_id | CommonId | The playlist ID |
Get all the playlists owned by the current user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | No | CommonId | The Company Id | Valid CommonId |
| group_id | No | CommonId | The group (production) ID | Valid CommonId |
| include_collaborating_playlists | No | Boolean | Include collaborator details. | Valid Boolean |
| include_shared | No | Boolean | Include shared playlists | Valid Boolean |
| playlist_collaboration_type_filter | No | Enum [mine, collaborating, shared] | Filter playlists by collaboration type | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| asset_ids | CommonIdArray | The playlist asset IDs |
| blurhash | String | A hashed representation of the asset |
| can_add_collaborators | Boolean | True if the user can add collaborators to the playlist. |
| can_collaborate | Boolean | Suggests if a playlist is eligible for collaboration. |
| can_edit | Boolean | True if the user can edit the playlist. |
| can_share | Boolean | True if the user can share the playlist. |
| can_view_collaborators | Boolean | Can View Collaborators |
| company_id | CommonId | The Company ID this playlist belongs to |
| created | Date | The playlist creation date and time |
| description | String | The playlist description |
| flow_id | String | The native Flow ID of this playlist, without encryption. Only provided if this is a Flow Playlist. |
| group_id | CommonId | The production ID this playlist belongs to |
| has_collaborators | Boolean | True if the playlist has collaborators. |
| id | CommonId | The playlist ID |
| is_dynamic | Boolean | Is this a dynamic playlist? Dynamic playlists cannot be modified through the UI. |
| is_shared_with_me | Boolean | True if the playlist is shared with the requesting user by another user |
| modified | Date | The playlist modified date and time |
| name | String | The name of the playlist |
| origin_type | Enum [Moxion, Flow, Hybrid] | Playlist Origin type |
| owner_id | Id | The user ID of the playlist owner |
| owner_name | String | The name of the playlist owner |
| playlinks | Array | Array of playlinks |
| source_project_id | CommonId | If this is a dynamic playlist, the ID of the source folder |
| source_type | Enum [USER, REVIEW_SESSION] | If this is a dynamic playlist, the source type (SNAPSHOT, FOLDER) |
| thumbnail_asset_id | CommonId | The ID of the asset that is being used as the thumbnail ID. If not provided, a default thumbnail will be generated and used. |
| thumbnail_type | Enum [NONE, GENERATED, UPLOADED, SELECTED_ASSET] | The type of the Playlist thumbnail: NONE, GENERATED, SELECTED_ASSET or UPLOADED |
| thumbnail_url | String | The primary thumbnail URL for this playlist |
| thumbnail_url_2x | String | The primary thumbnail URL for this playlist (2x resolution) |
| thumbnail_url_3x | String | The primary thumbnail URL for this playlist (3x resolution) |
| type | Enum [USER, REVIEW_SESSION] | Playlist type |
DEPRECATED : Use /update/playlist
Remove assets from a playlist.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlist ID | Valid CommonId |
| playlist_asset_ids | Yes | IdArray | The playlist asset IDs | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| removed | Boolean | True if the assets were removed |
Update an existing playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | No | CommonIdArray | The asset ids to associate with the playlist, in their correct order | Valid CommonIdArray |
| description | No | String | The description of the playlist | No HTML tags No {{ }} expressions Length must not exceed 1024 |
| group_id | No | CommonId | The Group ID | Valid CommonId |
| id | Yes | CommonId | The playlist ID | Valid CommonId |
| name | No | String | The name of the playlist | No HTML tags No {{ }} expressions Length must not exceed 45 |
| thumbnail_asset_id | No | CommonId | The asset to use as this playlist's thumbnail | Valid CommonId |
| thumbnail_type | No | Enum [NONE, GENERATED, UPLOADED, SELECTED_ASSET] | Type of the asset thumbnail | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| asset_ids | CommonIdArray | The playlist asset IDs |
| blurhash | String | A hashed representation of the asset |
| can_add_collaborators | Boolean | True if the user can add collaborators to the playlist. |
| can_collaborate | Boolean | Suggests if a playlist is eligible for collaboration. |
| can_edit | Boolean | True if the user can edit the playlist. |
| can_share | Boolean | True if the user can share the playlist. |
| company_id | CommonId | The Company ID this playlist belongs to |
| created | Date | The playlist creation date and time |
| description | String | The playlist description |
| flow_id | String | The native Flow ID of this playlist, without encryption. Only provided if this is a Flow Playlist. |
| group_id | CommonId | The production ID this playlist belongs to |
| has_collaborators | Boolean | True if the playlist has collaborators. |
| id | CommonId | The playlist ID |
| is_dynamic | Boolean | Is this a dynamic playlist? Dynamic playlists cannot be modified through the UI. |
| is_shared_with_me | Boolean | True if the playlist is shared with the requesting user by another user |
| modified | Date | The playlist modified date and time |
| name | String | The name of the playlist |
| origin_type | Enum [Moxion, Flow, Hybrid] | Playlist Origin type |
| owner_id | Id | The user ID of the playlist owner |
| owner_name | String | The name of the playlist owner |
| playlinks | Array | Array of playlinks |
| source_project_id | CommonId | If this is a dynamic playlist, the ID of the source folder |
| source_type | Enum [USER, REVIEW_SESSION] | If this is a dynamic playlist, the source type (SNAPSHOT, FOLDER) |
| thumbnail_asset_id | CommonId | The ID of the asset that is being used as the thumbnail ID. If not provided, a default thumbnail will be generated and used. |
| thumbnail_type | Enum [NONE, GENERATED, UPLOADED, SELECTED_ASSET] | The type of the Playlist thumbnail: NONE, GENERATED, SELECTED_ASSET or UPLOADED |
| thumbnail_url | String | The primary thumbnail URL for this playlist |
| thumbnail_url_2x | String | The primary thumbnail URL for this playlist (2x resolution) |
| thumbnail_url_3x | String | The primary thumbnail URL for this playlist (3x resolution) |
| type | Enum [USER, REVIEW_SESSION] | Playlist type |
DEPRECATED : Use /update/playlist
Update the assets in a playlist.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The playlist ID | Valid CommonId |
| playlist_asset_ids | Yes | IdArray | The playlist asset IDs | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | True if the assets were updated |
Create a new production folder
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| color | No | String | The production folder color | Valid # Hex Color Length must not exceed 10 |
| company_id | Yes | CommonId | The company id for this production folder | Valid CommonId |
| name | Yes | String | The production folder name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| Parameter | Type | Description |
|---|---|---|
| color | String | The production folder color |
| company_id | CommonId | The production folder's company id |
| created | Date | Creation date time |
| id | CommonId | The production folder id |
| name | String | The production folder name |
| total_uploaded_usage | Integer | Total Uploaded Usage in Bytes |
| total_usage | Integer | Total Usage in Bytes |
Delete a production folder. Only empty production folder can be deleted.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The production folder id | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | True if succeed |
The production folder by id
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The production folder id | Valid CommonId |
| include_child_count | No | Boolean | Compute and return the number of accessible child groups. Returns direct children only, not recursive. | Valid Boolean |
| include_usage | No | Boolean | Whether to include Usage stats in the response | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| child_count | Integer | Number of immediate child groups |
| color | String | The production folder color |
| company_id | CommonId | The production folder's company id |
| created | Date | Creation date time |
| id | CommonId | The production folder id |
| name | String | The production folder name |
| total_uploaded_usage | Integer | Total Uploaded Usage in Bytes |
| total_usage | Integer | Total Usage in Bytes |
Update a production folder
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| color | No | String | The new production folder color | Valid # Hex Color Length must not exceed 10 |
| id | Yes | CommonId | ID of the production folder to update | Valid CommonId |
| name | No | String | The new production folder name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| Parameter | Type | Description |
|---|---|---|
| color | String | The production folder color |
| company_id | CommonId | The production folder's company id |
| created | Date | Creation date time |
| id | CommonId | The production folder id |
| name | String | The production folder name |
| total_uploaded_usage | Integer | Total Uploaded Usage in Bytes |
| total_usage | Integer | Total Usage in Bytes |
Associate a group with a list of usecases
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | Yes | CommonId | The group ID | Valid CommonId |
| usecase_ids | Yes | IdArray | List of usecases to add | Valid IdArray |
| Parameter | Type | Description |
|---|
Copy a project to a new parent. Copies any subprojects as well.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| copy_batches_and_assets | No | Boolean | Copy batches and assets too. If true, batches and assets are copied for subprojects as well. Default false. | Valid Boolean |
| copy_in_background | No | Boolean | Run the copy operation asynchronously in a background task | Valid Boolean |
| id | Yes | CommonId | The ID of the project to copy | Valid CommonId |
| keep_existing_project_settings | Yes | Boolean | Retain the existing project settings. If false, clone down settings from parent. | Valid Boolean |
| keep_existing_users_and_teams | Yes | Boolean | Maintain the existing users and teams on the project (merging users and teams with those on the parent). If false, clone down users and teams from parent without keeping any from the project before it was moved. | Valid Boolean |
| new_parent_group_id | Yes | CommonId | The group ID of the new parent | Valid CommonId |
| new_parent_project_id | No | CommonId | The project ID of the new parent | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Date/time when the project was last accessed/updated |
| allowed_settings | Object | List of project settings that be selected for this project |
| asset_count | Integer | Number of assets in this project |
| breadcrumbs | Array | Array of breadcrumbs |
| can_add_dynamic_folder_playlist | Boolean | |
| can_asset_search | Boolean | User can search for assets in this project |
| can_assign_job_to_others | Boolean | User can assign jobs to others |
| can_comment | Boolean | User can view, create, edit or delete comments in this project |
| can_create_live_stream | Boolean | User can create a live stream |
| can_create_playlinks | Boolean | User can create playlinks |
| can_create_playlists | Boolean | User can create playlists |
| can_create_subclip | Boolean | User can create subclip |
| can_create_subproject | Boolean | User can create a child project |
| can_create_workflow | Boolean | User can create workflow |
| can_delete_assets | Boolean | User can delete assets from this project |
| can_delete_project | Boolean | User can delete project |
| can_delete_users | Boolean | User can delete users |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| can_invite_playlink_users | Boolean | User can invite playlink users to this project |
| can_invite_users | Boolean | User can invite new users to this project |
| can_offline | Boolean | User can store assets for offline viewing |
| can_send_to_qtake | Boolean | User can send assets to QTAKE |
| can_share_assets_in_review_session | Boolean | User can share assets in the project in a review session |
| can_take_screenshot | Boolean | User can take a screenshot in this project |
| can_toggle_drm | Boolean | User can toggle DRM |
| can_toggle_mfa | Boolean | User can toggle MFA |
| can_update_assets | Boolean | User can update assets |
| can_update_batch_visibility | Boolean | User can update batch visibility |
| can_update_batches | Boolean | User can update batches |
| can_update_participants | Boolean | User can update participants on this project |
| can_update_watermark | Boolean | User can update watermarks |
| can_upload | Boolean | User can upload into this project |
| can_view | Boolean | User can view assets in this project |
| can_view_activity | Boolean | User can view activity on this project |
| can_view_hidden_batches | Boolean | User can view hidden batches. |
| can_view_participants | Boolean | User can view participants on this project |
| child_count | Integer | Number of immediate children |
| company_id | Id | The company associated with the project |
| component_links | Array | The component details array List |
| copied | Boolean | True if project has been copied |
| created | Date | Date/time when the project was created |
| deny_download | Boolean | User is prohibited from any downloads in this project |
| deny_view | Boolean | User is prohibited from viewing any assets in this project |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| group | CommonId | The group associated with the project (if grouped) |
| id | CommonId | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| parent_project_id | CommonId | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| settings | Object | Project settings |
| sizes | String | The transcode sizes for this project |
| status | Enum [ACTIVE, DELETED, ARCHIVED] | The project status |
| task_id | String | ID of the spawned task if copy_in_background is true |
| thumbnail_position | Float | Default thumbnail position (0-1) |
| transcode_formats | Object | Transcode formats for this project |
| watermark_settings | Object | Project watermark settings |
Copy a batch of projects to a new parent. Copies any subprojects as well.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| copy_batches_and_assets | No | Boolean | Copy batches and assets too. If true, batches and assets are copied for subprojects as well. Default false. | Valid Boolean |
| keep_existing_project_settings | Yes | Boolean | Retain the existing project settings. If false, clone down settings from parent. | Valid Boolean |
| keep_existing_users_and_teams | Yes | Boolean | Maintain the existing users and teams on the project (merging users and teams with those on the parent). If false, clone down users and teams from parent without keeping any from the project before it was moved. | Valid Boolean |
| new_parent_group_id | Yes | CommonId | The group ID of the new parent | Valid CommonId |
| new_parent_project_id | No | CommonId | The project ID of the new parent | Valid CommonId |
| project_ids | Yes | CommonIdArray | The List of project IDs to copy | Valid CommonIdArray |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | Id of the task |
Register an Immediates device
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| name | Yes | String | The device description | No HTML tags No {{ }} expressions |
| project_id | Yes | CommonId | The project ID to connect immediates to | Valid CommonId |
| user_code | Yes | String | The user code displayed on the device | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| id | Id | ID for this stream registration |
| success | Boolean | Successfully registered |
Create a new empty group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| additional_rooms | No | Integer | Additional rooms for this group | Valid Integer |
| background_image_asset_id | No | Id | The asset id for the production background image | Valid Id |
| color | No | Integer | The group color | Valid Integer |
| company_id | Yes | Id | The company to create the group under | Valid Id |
| control_notes | No | String | Free notes to associate with the control record | No HTML tags No {{ }} expressions |
| description | No | String | The group description | No HTML tags No {{ }} expressions |
| expiry_date | No | Date | Production expiry date in ISO 8601 format | Valid Date |
| flow_project_id | No | String | The Flow project ID to link this group to. This enables shared playlists between Flow and Flow Capture | No HTML tags No {{ }} expressions |
| license_id | No | Id | The license assigned to the group | Valid Id |
| max_usage | No | Integer | Maximum allowed usage for this production, in bytes | Valid Integer |
| name | Yes | String | The group name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| poster_asset_id | No | Id | The asset id for the Production poster | Valid Id |
| production_folder_id | No | Id | The production folder to create the group under | Valid Id |
| settings | No | Object | Settings for this production (only these props are used, the rest are ignored: hdr, dolby_vision, 4k, live_streaming, realtime_review) | Valid Object |
| start_date | No | Date | Production start date in ISO 8601 format | Valid Date |
| status | No | Enum [ACTIVE, PENDING, DELETED] | The status of the group | Valid Enum |
| template_id | No | Id | The template ID to base this group off | Valid Id |
| transaction_reference | No | String | Property used to map ECA number | No HTML tags No {{ }} expressions |
| usecase_ids | No | IdArray | List of usecases for this production | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| additional_rooms | Integer | Additional rooms purchased for this production |
| allowed_settings | Object | List of allowed settings that be selected for this group |
| asset_project_id | CommonId | The Project ID to upload Group Assets, e.g. Production Posters |
| available_rooms | Integer | Available Rooms |
| background_image_url | String | The production background image url |
| blurhash | String | A hashed representation of the asset |
| can_create_rooms | Boolean | If the requesting user can create rooms in this group |
| can_create_root_folder | Boolean | Can this user create a folder at the root level? |
| can_create_template | Boolean | Can this user create a template from this group? |
| can_display_production_settings | Boolean | True if the user can see the 'Production Setting' for this group? |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_link_to_flow_project | Boolean | Can this group be linked to a Flow Project. User must have permission and the feature must be enabled. |
| can_move_group | Boolean | Can this user move production from this group? |
| can_update_participants | Boolean | If the requesting user can update group participants |
| can_view_participants | Boolean | If the requesting user can view group participants |
| child_count | Integer | Number of immediate child projects |
| color | Integer | Group color |
| company_id | Id | The company id for this group |
| company_name | String | The company name for this group (only populated for the home API) |
| created | Date | The group creation time |
| description | String | The group description |
| flow_id | String | The native Flow ID of this group, without encryption. Only provided if this is a Flow Group. |
| flow_project_id | String | If a Flow Production is linked, the Flow ID of said production. |
| flow_project_name | String | If a Flow Production is linked, the Name of linked production. |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| id | CommonId | The group ID |
| is_admin | Boolean | If the requesting user is the production admin |
| is_company_admin | Boolean | If the requesting user is a company admin |
| is_linked_to_flow_project | Boolean | Do we have a link to a Flow Project established? |
| is_owner | Boolean | If the requesting user is the owner |
| is_pinned | Boolean | If the requesting user pinned this production |
| license_id | Id | The license assigned to the group |
| license_type | String | The type of license assigned to the group |
| licensed_rooms | Integer | Licensed Rooms |
| name | String | The group name |
| named_licenses_available | Integer | Total Number of named licenses available for the company |
| named_licenses_used | Integer | Number of named licenses used by the production |
| origin_type | Enum [MOXION, FLOW] | The group origin type |
| owner | Id | The user id of the group owner |
| production_folder_id | CommonId | The production folder id for this group |
| production_poster_asset | Object | The Asset Id of the Production Poster (if present) |
| production_poster_url | String | The Path to the Production Poster |
| projects | CommonIdArray | Array of project IDs contained in this group |
| settings | Object | Group settings |
| sizes | Object | The group sizes |
| status | Enum [ACTIVE, PENDING, DELETED] | The group status |
| suspended | Date | Time when the group was suspended (Epoch when not suspended) |
| task_id | String | The processing task that will handle the copy of this group |
| thumbnail_position | Float | The thumbnail position for assets in the group |
| total_uploaded_usage | Integer | Total uploaded usage in bytes |
| total_usage | Integer | Total usage in bytes |
| transaction_reference | String | Property used to map ECA number |
| transcode_formats | Object | The transcode formats for assets in the group |
| warnings | StringArray | List of configuration warnings for this group |
| watermark_settings | Object | The group watermark settings |
Create a new empty project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | No | String | The project description | No HTML tags No {{ }} expressions Length must not exceed 1024 |
| group_id | Yes | CommonId | The production ID | Valid CommonId |
| name | Yes | String | The project name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| parent_project_id | No | CommonId | The parent project id | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Date/time when the project was last accessed/updated |
| allowed_settings | Object | List of project settings that be selected for this project |
| asset_count | Integer | Number of assets in this project |
| breadcrumbs | Array | Array of breadcrumbs |
| can_add_dynamic_folder_playlist | Boolean | |
| can_asset_search | Boolean | User can search for assets in this project |
| can_assign_job_to_others | Boolean | User can assign jobs to others |
| can_comment | Boolean | User can view, create, edit or delete comments in this project |
| can_create_live_stream | Boolean | User can create a live stream |
| can_create_playlinks | Boolean | User can create playlinks |
| can_create_playlists | Boolean | User can create playlists |
| can_create_subclip | Boolean | User can create subclip |
| can_create_subproject | Boolean | User can create a child project |
| can_create_workflow | Boolean | User can create workflow |
| can_delete_assets | Boolean | User can delete assets from this project |
| can_delete_project | Boolean | User can delete project |
| can_delete_users | Boolean | User can delete users |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| can_invite_playlink_users | Boolean | User can invite playlink users to this project |
| can_invite_users | Boolean | User can invite new users to this project |
| can_offline | Boolean | User can store assets for offline viewing |
| can_send_to_qtake | Boolean | User can send assets to QTAKE |
| can_share_assets_in_review_session | Boolean | User can share assets in the project in a review session |
| can_take_screenshot | Boolean | User can take a screenshot in this project |
| can_toggle_drm | Boolean | User can toggle DRM |
| can_toggle_mfa | Boolean | User can toggle MFA |
| can_update_assets | Boolean | User can update assets |
| can_update_batch_visibility | Boolean | User can update batch visibility |
| can_update_batches | Boolean | User can update batches |
| can_update_participants | Boolean | User can update participants on this project |
| can_update_watermark | Boolean | User can update watermarks |
| can_upload | Boolean | User can upload into this project |
| can_view | Boolean | User can view assets in this project |
| can_view_activity | Boolean | User can view activity on this project |
| can_view_hidden_batches | Boolean | User can view hidden batches. |
| can_view_participants | Boolean | User can view participants on this project |
| child_count | Integer | Number of immediate children |
| company_id | Id | The company associated with the project |
| component_links | Array | The component details array List |
| created | Date | Date/time when the project was created |
| deny_download | Boolean | User is prohibited from any downloads in this project |
| deny_view | Boolean | User is prohibited from viewing any assets in this project |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| group | CommonId | The group associated with the project (if grouped) |
| id | CommonId | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| parent_project_id | CommonId | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| settings | Object | Project settings |
| sizes | String | The transcode sizes for this project |
| status | Enum [ACTIVE, DELETED, ARCHIVED] | The project status |
| thumbnail_position | Float | Default thumbnail position (0-1) |
| transcode_formats | Object | Transcode formats for this project |
| warnings | StringArray | List of configuration warnings for this project |
| watermark_settings | Object | Project watermark settings |
Delete a group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The group ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if this group has been deleted |
Delete control limits from the group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The group ID | Valid Id |
| notes | No | String | The group control notes to use if exists | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the control record was deleted from the group |
Delete a project. Sets the project status to DELETED.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if project has been flagged as deleted. |
Get group by ID
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | No | String | The group description | No HTML tags No {{ }} expressions |
| id | Yes | CommonId | The group ID | Valid CommonId |
| include_child_count | No | Boolean | Compute and return the number of accessible child projects. Returns direct children only, not recursive. | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| additional_rooms | Integer | Additional rooms purchased for this production |
| allowed_settings | Object | List of allowed settings that be selected for this group |
| asset_project_id | CommonId | The Project ID to upload Group Assets, e.g. Production Posters |
| available_rooms | Integer | Available Rooms |
| background_image_url | String | The production background image url |
| blurhash | String | A hashed representation of the asset |
| can_create_rooms | Boolean | If the requesting user can create rooms in this group |
| can_create_root_folder | Boolean | Can this user create a folder at the root level? |
| can_create_template | Boolean | Can this user create a template from this group? |
| can_display_production_settings | Boolean | True if the user can see the 'Production Setting' for this group? |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_link_to_flow_project | Boolean | Can this group be linked to a Flow Project. User must have permission and the feature must be enabled. |
| can_move_group | Boolean | Can this user move production from this group? |
| can_update_participants | Boolean | If the requesting user can update group participants |
| can_view_participants | Boolean | If the requesting user can view group participants |
| child_count | Integer | Number of immediate child projects |
| color | Integer | Group color |
| company_id | Id | The company id for this group |
| company_name | String | The company name for this group (only populated for the home API) |
| created | Date | The group creation time |
| description | String | The group description |
| flow_id | String | The native Flow ID of this group, without encryption. Only provided if this is a Flow Group. |
| flow_project_id | String | If a Flow Production is linked, the Flow ID of said production. |
| flow_project_name | String | If a Flow Production is linked, the Name of linked production. |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| id | CommonId | The group ID |
| is_admin | Boolean | If the requesting user is the production admin |
| is_company_admin | Boolean | If the requesting user is a company admin |
| is_linked_to_flow_project | Boolean | Do we have a link to a Flow Project established? |
| is_owner | Boolean | If the requesting user is the owner |
| is_pinned | Boolean | If the requesting user pinned this production |
| license_id | Id | The license assigned to the group |
| license_type | String | The type of license assigned to the group |
| licensed_rooms | Integer | Licensed Rooms |
| name | String | The group name |
| named_licenses_available | Integer | Total Number of named licenses available for the company |
| named_licenses_used | Integer | Number of named licenses used by the production |
| origin_type | Enum [MOXION, FLOW] | The group origin type |
| owner | Id | The user id of the group owner |
| production_folder_id | CommonId | The production folder id for this group |
| production_poster_asset | Object | The Asset Id of the Production Poster (if present) |
| production_poster_url | String | The Path to the Production Poster |
| projects | CommonIdArray | Array of project IDs contained in this group |
| settings | Object | Group settings |
| sizes | Object | The group sizes |
| status | Enum [ACTIVE, PENDING, DELETED] | The group status |
| suspended | Date | Time when the group was suspended (Epoch when not suspended) |
| thumbnail_position | Float | The thumbnail position for assets in the group |
| total_uploaded_usage | Integer | Total uploaded usage in bytes |
| total_usage | Integer | Total usage in bytes |
| transaction_reference | String | Property used to map ECA number |
| transcode_formats | Object | The transcode formats for assets in the group |
| watermark_settings | Object | The group watermark settings |
Get the control/limit record for this group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The group ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| control_id | Id | The control record id |
| expiry_date | Date | Expiry date of the corresponding record |
| max_usage | Integer | Maximum allowed usage |
| notes | String | Notes on the restrictions |
| record_id | Id | ID of the matching company/group |
| record_type | String | Type of record control attached to |
| start_date | Date | Start date of the corresponding record |
Get available projects for a given group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The group ID | Valid CommonId |
| sort_by | No | String | Sort the groups by: name, company, created, accessed | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Date/time when the project was last accessed/updated |
| allowed_settings | Object | List of project settings that be selected for this project |
| asset_count | Integer | Number of assets in this project |
| breadcrumbs | Array | Array of breadcrumbs |
| can_add_dynamic_folder_playlist | Boolean | |
| can_asset_search | Boolean | User can search for assets in this project |
| can_assign_job_to_others | Boolean | User can assign jobs to others |
| can_comment | Boolean | User can view, create, edit or delete comments in this project |
| can_create_live_stream | Boolean | User can create a live stream |
| can_create_playlinks | Boolean | User can create playlinks |
| can_create_playlists | Boolean | User can create playlists |
| can_create_subclip | Boolean | User can create subclip |
| can_create_subproject | Boolean | User can create a child project |
| can_create_workflow | Boolean | User can create workflow |
| can_delete_assets | Boolean | User can delete assets from this project |
| can_delete_project | Boolean | User can delete project |
| can_delete_users | Boolean | User can delete users |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| can_invite_playlink_users | Boolean | User can invite playlink users to this project |
| can_invite_users | Boolean | User can invite new users to this project |
| can_offline | Boolean | User can store assets for offline viewing |
| can_send_to_qtake | Boolean | User can send assets to QTAKE |
| can_share_assets_in_review_session | Boolean | User can share assets in the project in a review session |
| can_take_screenshot | Boolean | User can take a screenshot in this project |
| can_toggle_drm | Boolean | User can toggle DRM |
| can_toggle_mfa | Boolean | User can toggle MFA |
| can_update_assets | Boolean | User can update assets |
| can_update_batch_visibility | Boolean | User can update batch visibility |
| can_update_batches | Boolean | User can update batches |
| can_update_participants | Boolean | User can update participants on this project |
| can_update_watermark | Boolean | User can update watermarks |
| can_upload | Boolean | User can upload into this project |
| can_view | Boolean | User can view assets in this project |
| can_view_activity | Boolean | User can view activity on this project |
| can_view_hidden_batches | Boolean | User can view hidden batches. |
| can_view_participants | Boolean | User can view participants on this project |
| child_count | Integer | Number of immediate children |
| company_id | Id | The company associated with the project |
| component_links | Array | The component details array List |
| created | Date | Date/time when the project was created |
| deny_download | Boolean | User is prohibited from any downloads in this project |
| deny_view | Boolean | User is prohibited from viewing any assets in this project |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| group | CommonId | The group associated with the project (if grouped) |
| id | CommonId | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| parent_project_id | CommonId | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| settings | Object | Project settings |
| sizes | String | The transcode sizes for this project |
| status | Enum [ACTIVE, DELETED, ARCHIVED] | The project status |
| thumbnail_position | Float | Default thumbnail position (0-1) |
| transcode_formats | Object | Transcode formats for this project |
| watermark_settings | Object | Project watermark settings |
Get teams added to a group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The group ID | Valid CommonId |
| include_project_teams | No | Boolean | Whether to include Project Teams in the response | Valid Boolean |
| review_session_id | No | Id | Review session ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| can_edit_team_details | Boolean | Is the user authorized to edit the company name/color etc (not the participants)? |
| can_update_participants | Boolean | User can update participants on this team |
| company_id | Id | The company ID this team belongs to |
| default_security_group | Integer | The security group that new members of this team will be assigned to by default. |
| group_id | CommonId | The production ID this team belongs to. 0 means this is a company level team |
| id | CommonId | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| is_collaborating | Boolean | Is this team collaborating in a playlist |
| is_externally_managed | Boolean | Does this team have externally managed users (ie is it a SCIM team)? |
| name | String | The team name |
| settings | Object | Team settings |
| user_count | Integer | Number of users present in a team |
Get all usecases associated with a group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | Yes | CommonId | The group ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| display_name | String | Name to display in UI |
| id | Id | Unique Id for this usecase |
Get users for this group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The group ID | Valid CommonId |
| review_session_id | No | Id | Review session ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| account_status | Enum [INVITED, ACTIVE, DELETED] | User's account status (Invited, Active, Deleted) |
| company | String | Users company name |
| String | Users email | |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_only | Boolean | User can only view inbox |
| last_name | String | Users last name |
Get watermark details and thumbnail file for a group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | Yes | CommonId | The group ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| company_id | CommonId | The company which owns this watermark |
| description | String | The group which owns this watermark |
| group_id | CommonId | The group which owns this watermark |
| watermark | Object | The watermark definition |
| watermark_thumbnail_file | String | Base 64 string of thumbnail file generated from watermarksettings |
Get available groups
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | No | Id | Include only groups for this company ID | Valid Id |
| description | No | String | The group description | No HTML tags No {{ }} expressions |
| include_child_count | No | Boolean | Compute and return the number of accessible child projects. Returns direct children only, not recursive. | Valid Boolean |
| include_projects | No | Boolean | Return array of project IDs belonging to the groups | Valid Boolean |
| include_rooms | No | Boolean | Include hidden room group type in response | Valid Boolean |
| include_templates | No | Boolean | Include templates in the list of groups | Valid Boolean |
| production_folder_id | No | CommonId | Include only groups for this production folder ID | Valid CommonId |
| sort_by | No | Enum [name, created] | Sort the groups by: name, created. Default is name | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| additional_rooms | Integer | Additional rooms purchased for this production |
| allowed_settings | Object | List of allowed settings that be selected for this group |
| asset_project_id | CommonId | The Project ID to upload Group Assets, e.g. Production Posters |
| available_rooms | Integer | Available Rooms |
| background_image_url | String | The production background image url |
| blurhash | String | A hashed representation of the asset |
| can_create_rooms | Boolean | If the requesting user can create rooms in this group |
| can_create_root_folder | Boolean | Can this user create a folder at the root level? |
| can_create_template | Boolean | Can this user create a template from this group? |
| can_display_production_settings | Boolean | True if the user can see the 'Production Setting' for this group? |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_link_to_flow_project | Boolean | Can this group be linked to a Flow Project. User must have permission and the feature must be enabled. |
| can_move_group | Boolean | Can this user move production from this group? |
| can_update_participants | Boolean | If the requesting user can update group participants |
| can_view_participants | Boolean | If the requesting user can view group participants |
| child_count | Integer | Number of immediate child projects |
| color | Integer | Group color |
| company_id | Id | The company id for this group |
| company_name | String | The company name for this group (only populated for the home API) |
| created | Date | The group creation time |
| description | String | The group description |
| flow_id | String | The native Flow ID of this group, without encryption. Only provided if this is a Flow Group. |
| flow_project_id | String | If a Flow Production is linked, the Flow ID of said production. |
| flow_project_name | String | If a Flow Production is linked, the Name of linked production. |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| id | CommonId | The group ID |
| is_admin | Boolean | If the requesting user is the production admin |
| is_company_admin | Boolean | If the requesting user is a company admin |
| is_linked_to_flow_project | Boolean | Do we have a link to a Flow Project established? |
| is_owner | Boolean | If the requesting user is the owner |
| is_pinned | Boolean | If the requesting user pinned this production |
| license_id | Id | The license assigned to the group |
| license_type | String | The type of license assigned to the group |
| licensed_rooms | Integer | Licensed Rooms |
| name | String | The group name |
| named_licenses_available | Integer | Total Number of named licenses available for the company |
| named_licenses_used | Integer | Number of named licenses used by the production |
| origin_type | Enum [MOXION, FLOW] | The group origin type |
| owner | Id | The user id of the group owner |
| production_folder_id | CommonId | The production folder id for this group |
| production_poster_asset | Object | The Asset Id of the Production Poster (if present) |
| production_poster_url | String | The Path to the Production Poster |
| projects | CommonIdArray | Array of project IDs contained in this group |
| settings | Object | Group settings |
| sizes | Object | The group sizes |
| status | Enum [ACTIVE, PENDING, DELETED] | The group status |
| suspended | Date | Time when the group was suspended (Epoch when not suspended) |
| thumbnail_position | Float | The thumbnail position for assets in the group |
| total_uploaded_usage | Integer | Total uploaded usage in bytes |
| total_usage | Integer | Total usage in bytes |
| transaction_reference | String | Property used to map ECA number |
| transcode_formats | Object | The transcode formats for assets in the group |
| watermark_settings | Object | The group watermark settings |
| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The project ID | Valid CommonId |
| include_breadcrumbs | No | Boolean | Include breadcrumbs in the response data | Valid Boolean |
| include_child_count | No | Boolean | Compute and return the number of accessible child projects. Returns direct children only, not recursive. | Valid Boolean |
| include_offline_data | No | Boolean | Include additional data for offline usage | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Date/time when the project was last accessed/updated |
| allowed_settings | Object | List of project settings that be selected for this project |
| asset_count | Integer | Number of assets in this project |
| breadcrumbs | Array | Array of breadcrumbs |
| can_add_dynamic_folder_playlist | Boolean | |
| can_asset_search | Boolean | User can search for assets in this project |
| can_assign_job_to_others | Boolean | User can assign jobs to others |
| can_comment | Boolean | User can view, create, edit or delete comments in this project |
| can_create_live_stream | Boolean | User can create a live stream |
| can_create_playlinks | Boolean | User can create playlinks |
| can_create_playlists | Boolean | User can create playlists |
| can_create_subclip | Boolean | User can create subclip |
| can_create_subproject | Boolean | User can create a child project |
| can_create_workflow | Boolean | User can create workflow |
| can_delete_assets | Boolean | User can delete assets from this project |
| can_delete_project | Boolean | User can delete project |
| can_delete_users | Boolean | User can delete users |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| can_invite_playlink_users | Boolean | User can invite playlink users to this project |
| can_invite_users | Boolean | User can invite new users to this project |
| can_offline | Boolean | User can store assets for offline viewing |
| can_send_to_qtake | Boolean | User can send assets to QTAKE |
| can_share_assets_in_review_session | Boolean | User can share assets in the project in a review session |
| can_take_screenshot | Boolean | User can take a screenshot in this project |
| can_toggle_drm | Boolean | User can toggle DRM |
| can_toggle_mfa | Boolean | User can toggle MFA |
| can_update_assets | Boolean | User can update assets |
| can_update_batch_visibility | Boolean | User can update batch visibility |
| can_update_batches | Boolean | User can update batches |
| can_update_participants | Boolean | User can update participants on this project |
| can_update_watermark | Boolean | User can update watermarks |
| can_upload | Boolean | User can upload into this project |
| can_view | Boolean | User can view assets in this project |
| can_view_activity | Boolean | User can view activity on this project |
| can_view_hidden_batches | Boolean | User can view hidden batches. |
| can_view_participants | Boolean | User can view participants on this project |
| child_count | Integer | Number of immediate children |
| company_id | Id | The company associated with the project |
| component_links | Array | The component details array List |
| created | Date | Date/time when the project was created |
| deny_download | Boolean | User is prohibited from any downloads in this project |
| deny_view | Boolean | User is prohibited from viewing any assets in this project |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| group | CommonId | The group associated with the project (if grouped) |
| id | CommonId | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| parent_project_id | CommonId | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| settings | Object | Project settings |
| sizes | String | The transcode sizes for this project |
| status | Enum [ACTIVE, DELETED, ARCHIVED] | The project status |
| thumbnail_position | Float | Default thumbnail position (0-1) |
| transcode_formats | Object | Transcode formats for this project |
| watermark_settings | Object | Project watermark settings |
Get list of unique metadata filters for this project (based on existing assets and their metadata)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| batch | StringArray | List of unique batch names |
| reel | StringArray | List of unique reel names |
| scene | StringArray | List of unique scene names |
Get a projects teams
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| can_edit_team_details | Boolean | Is the user authorized to edit the company name/color etc (not the participants)? |
| can_update_participants | Boolean | User can update participants on this team |
| company_id | Id | The company ID this team belongs to |
| default_security_group | Integer | The security group that new members of this team will be assigned to by default. |
| group_id | CommonId | The production ID this team belongs to. 0 means this is a company level team |
| id | CommonId | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| is_collaborating | Boolean | Is this team collaborating in a playlist |
| is_externally_managed | Boolean | Does this team have externally managed users (ie is it a SCIM team)? |
| name | String | The team name |
| settings | Object | Team settings |
| user_count | Integer | Number of users present in a team |
Get usage information for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The project ID | Valid CommonId |
| include_live_assets | No | Boolean | Include count of live assets in the response data | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| project_count | Integer | Total number of projects included in the stats, including sub-folders |
| total_asset_count | Integer | Total number of assets included in the stats, including sub-folders |
| total_uploaded_usage | Integer | Total uploaded usage in bytes, including sub-folders |
| total_usage | Integer | Total usage in bytes, including sub-folders |
Get watermark details and thumbnail file for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| company_id | CommonId | The company which owns this watermark |
| description | String | The project which owns this watermark |
| group_id | CommonId | The group which owns this watermark |
| watermark | Object | The watermark definition |
| watermark_thumbnail_file | String | Base 64 string of thumbnail file generated from watermarksettings |
Get available projects
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | No | CommonId | Only get projects in this company | Valid CommonId |
| group_id | No | CommonId | Only get projects for this group (production) | Valid CommonId |
| include_child_count | No | Boolean | Compute and return the number of accessible child projects. Returns direct children only, not recursive. | Valid Boolean |
| is_owner | No | Boolean | Only get projects the user is the owner of | Valid Boolean |
| limit | No | Integer | Only return X projects | Valid Integer |
| parent_project_id | No | CommonId | Only get projects with this parent | Valid CommonId |
| projects | No | CommonIdArray | Only get projects with those ids | Valid CommonIdArray |
| roots_only | No | Boolean | Only get projects at the root level. Root projects either have no parent, or no parent accessible to this user. | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Date/time when the project was last accessed/updated |
| allowed_settings | Object | List of project settings that be selected for this project |
| asset_count | Integer | Number of assets in this project |
| breadcrumbs | Array | Array of breadcrumbs |
| can_add_dynamic_folder_playlist | Boolean | |
| can_asset_search | Boolean | User can search for assets in this project |
| can_assign_job_to_others | Boolean | User can assign jobs to others |
| can_comment | Boolean | User can view, create, edit or delete comments in this project |
| can_create_live_stream | Boolean | User can create a live stream |
| can_create_playlinks | Boolean | User can create playlinks |
| can_create_playlists | Boolean | User can create playlists |
| can_create_subclip | Boolean | User can create subclip |
| can_create_subproject | Boolean | User can create a child project |
| can_create_workflow | Boolean | User can create workflow |
| can_delete_assets | Boolean | User can delete assets from this project |
| can_delete_project | Boolean | User can delete project |
| can_delete_users | Boolean | User can delete users |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| can_invite_playlink_users | Boolean | User can invite playlink users to this project |
| can_invite_users | Boolean | User can invite new users to this project |
| can_offline | Boolean | User can store assets for offline viewing |
| can_send_to_qtake | Boolean | User can send assets to QTAKE |
| can_share_assets_in_review_session | Boolean | User can share assets in the project in a review session |
| can_take_screenshot | Boolean | User can take a screenshot in this project |
| can_toggle_drm | Boolean | User can toggle DRM |
| can_toggle_mfa | Boolean | User can toggle MFA |
| can_update_assets | Boolean | User can update assets |
| can_update_batch_visibility | Boolean | User can update batch visibility |
| can_update_batches | Boolean | User can update batches |
| can_update_participants | Boolean | User can update participants on this project |
| can_update_watermark | Boolean | User can update watermarks |
| can_upload | Boolean | User can upload into this project |
| can_view | Boolean | User can view assets in this project |
| can_view_activity | Boolean | User can view activity on this project |
| can_view_hidden_batches | Boolean | User can view hidden batches. |
| can_view_participants | Boolean | User can view participants on this project |
| child_count | Integer | Number of immediate children |
| company_id | Id | The company associated with the project |
| component_links | Array | The component details array List |
| created | Date | Date/time when the project was created |
| deny_download | Boolean | User is prohibited from any downloads in this project |
| deny_view | Boolean | User is prohibited from viewing any assets in this project |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| group | CommonId | The group associated with the project (if grouped) |
| id | CommonId | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| parent_project_id | CommonId | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| settings | Object | Project settings |
| sizes | String | The transcode sizes for this project |
| status | Enum [ACTIVE, DELETED, ARCHIVED] | The project status |
| thumbnail_position | Float | Default thumbnail position (0-1) |
| transcode_formats | Object | Transcode formats for this project |
| watermark_settings | Object | Project watermark settings |
Move a project to a new parent. Moves any subprojects as well.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The ID of the project to move | Valid CommonId |
| keep_existing_project_settings | Yes | Boolean | Retain the existing project settings. If false, clone down settings from parent. | Valid Boolean |
| keep_existing_users_and_teams | Yes | Boolean | Maintain the existing users and teams on the project (merging users and teams with those on the parent). If false, clone down users and teams from parent without keeping any from the project before it was moved. | Valid Boolean |
| new_parent_group_id | Yes | CommonId | The group ID of the new parent | Valid CommonId |
| new_parent_project_id | No | CommonId | The project ID of the new parent | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Date/time when the project was last accessed/updated |
| allowed_settings | Object | List of project settings that be selected for this project |
| asset_count | Integer | Number of assets in this project |
| breadcrumbs | Array | Array of breadcrumbs |
| can_add_dynamic_folder_playlist | Boolean | |
| can_asset_search | Boolean | User can search for assets in this project |
| can_assign_job_to_others | Boolean | User can assign jobs to others |
| can_comment | Boolean | User can view, create, edit or delete comments in this project |
| can_create_live_stream | Boolean | User can create a live stream |
| can_create_playlinks | Boolean | User can create playlinks |
| can_create_playlists | Boolean | User can create playlists |
| can_create_subclip | Boolean | User can create subclip |
| can_create_subproject | Boolean | User can create a child project |
| can_create_workflow | Boolean | User can create workflow |
| can_delete_assets | Boolean | User can delete assets from this project |
| can_delete_project | Boolean | User can delete project |
| can_delete_users | Boolean | User can delete users |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| can_invite_playlink_users | Boolean | User can invite playlink users to this project |
| can_invite_users | Boolean | User can invite new users to this project |
| can_offline | Boolean | User can store assets for offline viewing |
| can_send_to_qtake | Boolean | User can send assets to QTAKE |
| can_share_assets_in_review_session | Boolean | User can share assets in the project in a review session |
| can_take_screenshot | Boolean | User can take a screenshot in this project |
| can_toggle_drm | Boolean | User can toggle DRM |
| can_toggle_mfa | Boolean | User can toggle MFA |
| can_update_assets | Boolean | User can update assets |
| can_update_batch_visibility | Boolean | User can update batch visibility |
| can_update_batches | Boolean | User can update batches |
| can_update_participants | Boolean | User can update participants on this project |
| can_update_watermark | Boolean | User can update watermarks |
| can_upload | Boolean | User can upload into this project |
| can_view | Boolean | User can view assets in this project |
| can_view_activity | Boolean | User can view activity on this project |
| can_view_hidden_batches | Boolean | User can view hidden batches. |
| can_view_participants | Boolean | User can view participants on this project |
| child_count | Integer | Number of immediate children |
| company_id | Id | The company associated with the project |
| component_links | Array | The component details array List |
| created | Date | Date/time when the project was created |
| deny_download | Boolean | User is prohibited from any downloads in this project |
| deny_view | Boolean | User is prohibited from viewing any assets in this project |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| group | CommonId | The group associated with the project (if grouped) |
| id | CommonId | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| parent_project_id | CommonId | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| settings | Object | Project settings |
| sizes | String | The transcode sizes for this project |
| status | Enum [ACTIVE, DELETED, ARCHIVED] | The project status |
| thumbnail_position | Float | Default thumbnail position (0-1) |
| transcode_formats | Object | Transcode formats for this project |
| updated | Boolean | True if project has been updated |
| watermark_settings | Object | Project watermark settings |
Move projects to a new parent. Moves any subprojects as well.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| keep_existing_project_settings | Yes | Boolean | Retain the existing project settings. If false, clone down settings from parent. | Valid Boolean |
| keep_existing_users_and_teams | Yes | Boolean | Maintain the existing users and teams on the project (merging users and teams with those on the parent). If false, clone down users and teams from parent without keeping any from the project before it was moved. | Valid Boolean |
| new_parent_group_id | Yes | CommonId | The group ID of the new parent | Valid CommonId |
| new_parent_project_id | No | CommonId | The project ID of the new parent | Valid CommonId |
| project_ids | Yes | CommonIdArray | The List of project IDs | Valid CommonIdArray |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | Id of the task |
Remove a list of usecases from a group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | Yes | CommonId | The group ID | Valid CommonId |
| usecase_ids | Yes | IdArray | List of usecases to remove | Valid IdArray |
| Parameter | Type | Description |
|---|
Find a project by its name. Partial name search, case insensitive. Intended for typeahead searches.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | Id | Company ID to search within. | Valid Id |
| limit | No | Integer | Max number of results to return (default 100) | Valid Integer |
| search_term | Yes | String | Project name to find. Partial string, case insensitive. Minimum 3 characters. | No HTML tags No {{ }} expressions Length must not be less than 3 characters |
| Parameter | Type | Description |
|---|---|---|
| project_breadcrumbs | Array | List of breadcrumbs for projects hit by the search. |
Create/update group control settings/limits
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| expiry_date | No | Date | The last day the group will be active | Valid Date |
| id | Yes | CommonId | The group ID | Valid CommonId |
| max_usage | No | Integer | The maximum disk usage allowed on assets for the group | Valid Integer |
| notes | No | String | Notes on the control record | No HTML tags No {{ }} expressions |
| start_date | No | Date | The first day the group will be active | Valid Date |
| Parameter | Type | Description |
|---|---|---|
| control_id | Id | The control record id |
| expiry_date | Date | Expiry date of the corresponding record |
| max_usage | Integer | Maximum allowed usage |
| notes | String | Notes on the restrictions |
| record_id | Id | ID of the matching company/group |
| record_type | String | Type of record control attached to |
| start_date | Date | Start date of the corresponding record |
Create a Group Asset Folder where it does not exist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | Yes | CommonId | The group ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| project_id | CommonId | The project id (if created) |
| success | Boolean | If the operation was successful |
Update a group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| additional_rooms | No | Integer | Additional rooms for this group | Valid Integer |
| background_image_asset_id | No | Id | The asset id for the production background image | Valid Id |
| color | No | Integer | The group color | Valid Integer |
| description | No | String | The group description | No HTML tags No {{ }} expressions |
| flow_project_id | No | String | The Flow Project ID linked with this group. | No HTML tags No {{ }} expressions |
| flow_project_name | No | String | The Flow Project name linked with this group. | No HTML tags No {{ }} expressions |
| id | Yes | CommonId | The group ID | Valid CommonId |
| is_linked_to_flow | No | Boolean | Is this group linked to a Flow project? | Valid Boolean |
| license_id | No | Id | The license assigned to the group | Valid Id |
| name | No | String | The group name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| poster_asset_id | No | Id | The asset id for the Production poster | Valid Id |
| production_folder_id | No | Id | The production folder to move into | Valid Id |
| settings | No | Object | The group settings | Valid Object |
| sizes | No | Object | The group sizes | Valid Object |
| status | No | Enum [ACTIVE, PENDING, DELETED] | The status of the group | Valid Enum |
| suspended | No | Date | Time when the group was suspended (Epoch when not suspended) | Valid Date |
| thumbnail_position | No | Integer | The thumbnail position for assets in the group | Valid Integer |
| transaction_reference | No | String | Property used to map ECA number | No HTML tags No {{ }} expressions |
| transcode_formats | No | Object | The transcode formats for assets in the group | Valid Object |
| watermark_settings | No | Object | The group watermark settings | Valid Object |
| Parameter | Type | Description |
|---|---|---|
| additional_rooms | Integer | Additional rooms purchased for this production |
| allowed_settings | Object | List of allowed settings that be selected for this group |
| asset_project_id | CommonId | The Project ID to upload Group Assets, e.g. Production Posters |
| available_rooms | Integer | Available Rooms |
| background_image_url | String | The production background image url |
| blurhash | String | A hashed representation of the asset |
| can_create_rooms | Boolean | If the requesting user can create rooms in this group |
| can_create_root_folder | Boolean | Can this user create a folder at the root level? |
| can_create_template | Boolean | Can this user create a template from this group? |
| can_display_production_settings | Boolean | True if the user can see the 'Production Setting' for this group? |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_link_to_flow_project | Boolean | Can this group be linked to a Flow Project. User must have permission and the feature must be enabled. |
| can_move_group | Boolean | Can this user move production from this group? |
| can_update_participants | Boolean | If the requesting user can update group participants |
| can_view_participants | Boolean | If the requesting user can view group participants |
| child_count | Integer | Number of immediate child projects |
| color | Integer | Group color |
| company_id | Id | The company id for this group |
| company_name | String | The company name for this group (only populated for the home API) |
| created | Date | The group creation time |
| description | String | The group description |
| flow_id | String | The native Flow ID of this group, without encryption. Only provided if this is a Flow Group. |
| flow_project_id | String | If a Flow Production is linked, the Flow ID of said production. |
| flow_project_name | String | If a Flow Production is linked, the Name of linked production. |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| id | CommonId | The group ID |
| is_admin | Boolean | If the requesting user is the production admin |
| is_company_admin | Boolean | If the requesting user is a company admin |
| is_linked_to_flow_project | Boolean | Do we have a link to a Flow Project established? |
| is_owner | Boolean | If the requesting user is the owner |
| is_pinned | Boolean | If the requesting user pinned this production |
| license_id | Id | The license assigned to the group |
| license_type | String | The type of license assigned to the group |
| licensed_rooms | Integer | Licensed Rooms |
| name | String | The group name |
| named_licenses_available | Integer | Total Number of named licenses available for the company |
| named_licenses_used | Integer | Number of named licenses used by the production |
| origin_type | Enum [MOXION, FLOW] | The group origin type |
| owner | Id | The user id of the group owner |
| production_folder_id | CommonId | The production folder id for this group |
| production_poster_asset | Object | The Asset Id of the Production Poster (if present) |
| production_poster_url | String | The Path to the Production Poster |
| projects | CommonIdArray | Array of project IDs contained in this group |
| settings | Object | Group settings |
| sizes | Object | The group sizes |
| status | Enum [ACTIVE, PENDING, DELETED] | The group status |
| suspended | Date | Time when the group was suspended (Epoch when not suspended) |
| thumbnail_position | Float | The thumbnail position for assets in the group |
| total_uploaded_usage | Integer | Total uploaded usage in bytes |
| total_usage | Integer | Total usage in bytes |
| transaction_reference | String | Property used to map ECA number |
| transcode_formats | Object | The transcode formats for assets in the group |
| updated | Boolean | True if this production has been updated |
| warnings | StringArray | List of configuration warnings for this group |
| watermark_settings | Object | The group watermark settings |
Update a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_view_settings | No | Array | Asset view settings | Valid Array |
| company | No | String | The company this project belongs to | No HTML tags No {{ }} expressions Length must not exceed 100 |
| description | No | String | The project description | No HTML tags No {{ }} expressions Length must not exceed 1024 |
| folder_id | No | CommonId | The project folder id | Valid CommonId |
| id | Yes | CommonId | The project ID | Valid CommonId |
| mfa_enabled | No | Boolean | MFA enabled | Valid Boolean |
| name | No | String | The project name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| overlay_custom_text | No | Boolean | Display custom text on the overlay | Valid Boolean |
| overlay_custom_text_value | No | String | Overlay custom text value | No HTML tags No {{ }} expressions |
| overlay_email_address | No | Boolean | Display email address on the overlay | Valid Boolean |
| overlay_font_size | No | Float | Overlay text size | Valid Float |
| overlay_opacity | No | Float | Overlay text opacity | Valid Float |
| overlay_position | No | Integer | Overlay text alignment | Valid Integer |
| overlay_project_name | No | Boolean | Display project name on the overlay | Valid Boolean |
| settings | No | Object | Project settings | Valid Object |
| sizes | No | String | The transcode sizes for this project | No HTML tags No {{ }} expressions |
| status | No | Enum [ACTIVE, DELETED, ARCHIVED] | The project status | Valid Enum |
| thumbnail_position | No | Float | Default thumbnail position (0-1) | Valid Float |
| transcode_formats | No | Object | Project alternate download format settings | Valid Object |
| watermark_settings | No | Object | Project watermark settings | Valid Object |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Date/time when the project was last accessed/updated |
| allowed_settings | Object | List of project settings that be selected for this project |
| asset_count | Integer | Number of assets in this project |
| breadcrumbs | Array | Array of breadcrumbs |
| can_add_dynamic_folder_playlist | Boolean | |
| can_asset_search | Boolean | User can search for assets in this project |
| can_assign_job_to_others | Boolean | User can assign jobs to others |
| can_comment | Boolean | User can view, create, edit or delete comments in this project |
| can_create_live_stream | Boolean | User can create a live stream |
| can_create_playlinks | Boolean | User can create playlinks |
| can_create_playlists | Boolean | User can create playlists |
| can_create_subclip | Boolean | User can create subclip |
| can_create_subproject | Boolean | User can create a child project |
| can_create_workflow | Boolean | User can create workflow |
| can_delete_assets | Boolean | User can delete assets from this project |
| can_delete_project | Boolean | User can delete project |
| can_delete_users | Boolean | User can delete users |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| can_invite_playlink_users | Boolean | User can invite playlink users to this project |
| can_invite_users | Boolean | User can invite new users to this project |
| can_offline | Boolean | User can store assets for offline viewing |
| can_send_to_qtake | Boolean | User can send assets to QTAKE |
| can_share_assets_in_review_session | Boolean | User can share assets in the project in a review session |
| can_take_screenshot | Boolean | User can take a screenshot in this project |
| can_toggle_drm | Boolean | User can toggle DRM |
| can_toggle_mfa | Boolean | User can toggle MFA |
| can_update_assets | Boolean | User can update assets |
| can_update_batch_visibility | Boolean | User can update batch visibility |
| can_update_batches | Boolean | User can update batches |
| can_update_participants | Boolean | User can update participants on this project |
| can_update_watermark | Boolean | User can update watermarks |
| can_upload | Boolean | User can upload into this project |
| can_view | Boolean | User can view assets in this project |
| can_view_activity | Boolean | User can view activity on this project |
| can_view_hidden_batches | Boolean | User can view hidden batches. |
| can_view_participants | Boolean | User can view participants on this project |
| child_count | Integer | Number of immediate children |
| company_id | Id | The company associated with the project |
| component_links | Array | The component details array List |
| created | Date | Date/time when the project was created |
| deny_download | Boolean | User is prohibited from any downloads in this project |
| deny_view | Boolean | User is prohibited from viewing any assets in this project |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| group | CommonId | The group associated with the project (if grouped) |
| id | CommonId | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| parent_project_id | CommonId | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| settings | Object | Project settings |
| sizes | String | The transcode sizes for this project |
| status | Enum [ACTIVE, DELETED, ARCHIVED] | The project status |
| thumbnail_position | Float | Default thumbnail position (0-1) |
| transcode_formats | Object | Transcode formats for this project |
| updated | Boolean | True if project has been updated |
| warnings | StringArray | List of configuration warnings for this project |
| watermark_settings | Object | Project watermark settings |
Generate a report for assets specified (project based)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | No | CommonIdArray | Array of asset IDs to filter by, if not supplied all assets are returned | Valid CommonIdArray |
| asset_order | Yes | String | Asset ordering | No HTML tags No {{ }} expressions |
| comments_report | No | Boolean | Switch report style to comments mode and include all asset comments | Valid Boolean |
| exclude_null | No | Boolean | Only return metadata which is not null | Valid Boolean |
| format | No | String | Output file format (default is `pdf`). | No HTML tags No {{ }} expressions |
| group_by | No | String | Group assets by | No HTML tags No {{ }} expressions |
| include_asset_level_comments | No | Boolean | Boolean indicator to include asset level comments in the response. (Default is true.) | Valid Boolean |
| include_images | No | Boolean | Include source images in the report ZIP | Valid Boolean |
| metadata | Yes | Boolean | Flag indicating if metadata files (LUT, CDL, ALE etc) should be included with the report | Valid Boolean |
| only_comments | No | Boolean | If comments report mode, only include assets that actually have comments | Valid Boolean |
| project_id | Yes | CommonId | The project ID | Valid CommonId |
| report_name | No | String | Specify a custom name for the Report document and Zip file. | No HTML tags No {{ }} expressions |
| save_report | No | Boolean | Save this report into the project under a batch called 'Reports' | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | The ID of the processing task generating the report |
Generate a report for the assets in the specified playlists
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | No | CommonIdArray | Array of asset IDs to filter by, if not supplied all assets are returned | Valid CommonIdArray |
| comment_scope | No | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of the comments to show | Valid Enum |
| comments_report | No | Boolean | Switch report style to comments mode and include all asset comments | Valid Boolean |
| exclude_null | No | Boolean | Only return metadata which is not null | Valid Boolean |
| format | No | String | Output file format (default is `pdf`). | No HTML tags No {{ }} expressions |
| include_asset_level_comments | No | Boolean | Boolean indicator to include asset level comments in the response. (Default is true.) | Valid Boolean |
| include_images | No | Boolean | Include source images in the report ZIP | Valid Boolean |
| metadata | Yes | Boolean | Flag indicating if metadata files (LUT, CDL, ALE etc) should be included with the report | Valid Boolean |
| only_comments | No | Boolean | If comments report mode, only include assets that actually have comments | Valid Boolean |
| playlink_id | No | Id | The playlink ID of the comments to export (if scope is PLAYLINK) | Valid Id |
| playlist_ids | Yes | CommonIdArray | List of playlists to report upon. | Valid CommonIdArray |
| report_name | No | String | The name of the report that will be generated, if the user does not specify a name the default of 'comments_report' will be used | No HTML tags No {{ }} expressions |
| review_session_id | No | Id | The realtime review session ID of the comments to export (if scope is REVIEW_SESSION) | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | The ID of the processing task generating the report |
Complete a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_count | Integer | The number of assets in this room |
| asset_state | String | The current asset state JSON data |
| can_browse_assets | Boolean | The authenticated user can add browse assets to add in the add assets wizard |
| can_display_watermarks | Boolean | The authenticated user can display watermarks in the room lobby |
| can_edit | Boolean | The authenticated user can edit this room |
| can_reopen | Boolean | The room can be re-opened |
| can_show_playlists | Boolean | The authenticated user can show playlists in the assets wizard |
| can_show_teams | Boolean | The authenticated user can show teams on the manage participants panel |
| can_upload_assets | Boolean | The authenticated user can upload assets in the add assets wizard |
| comment_scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of comments posted in this review session (asset or session-only) |
| common_asset_repository_id | CommonId | The project ID for retrieving assets from the common production asset repository |
| company_id | Id | The ID of the company displayed in the review session |
| company_name | String | The name of the company displayed in the review session |
| created | Date | The review session creation date and time |
| description | String | The name of the review session |
| echo_cancellation_enabled | Boolean | Is Amazon Chime Echo Cancellation available for this room? |
| end_time | Date | The review session end date and time |
| group_id | CommonId | The ID of the group (production) associated with this review session |
| group_name | String | The name of the group (production) associated with this review session |
| id | Id | The review session ID |
| is_guest_user_allowed | Boolean | Review session guest user is allowed to be created |
| is_host | Boolean | True if the current user is a host of the review session |
| is_owner | Boolean | True if the current user owns the review session |
| is_session_live_enabled | Boolean | Can this review session have use in-room live streaming |
| is_standalone_room | Boolean | True if the review session belongs to rooms only production |
| last_joined | Date | The most recent time any user joined the review session |
| modified | Date | The review session modified date and time |
| mute_participants_on_entry | Boolean | Should all participants be muted initially? |
| name | String | The name of the review session |
| owner_id | Id | The user ID of the review session owner |
| owner_name | String | The name of the review session owner |
| playlist_count | Integer | The number of playlists in this room |
| session_playlist_id | CommonId | ID of the review session managed playlist |
| session_project_id | CommonId | ID of the review session managed project |
| start_time | Date | The review session start date and time |
| status | Enum [DRAFT, SCHEDULED, STARTED, COMPLETE] | The review session status |
| sync_mode | Enum [HOST, EVERYONE, UNSYNCED] | The current sync mode |
| watermark_id | Id | The watermark ID associated with this review session |
Create a new empty review session owned by the current user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| allow_participants_to_unmute_self | No | Boolean | Should participants be allowed to unmute themselves? | Valid Boolean |
| comment_scope | No | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of the comments posted in this review session (asset or session-only) | Valid Enum |
| description | No | String | The description of the review session | No HTML tags No {{ }} expressions Length must not exceed 1024 |
| group_id | Yes | CommonId | The ID of the production this review session is related to | Valid CommonId |
| host_user_ids | No | IdArray | The user IDs of review session hosts | Valid IdArray |
| mute_participants_on_entry | No | Boolean | Should all participants be muted initially? | Valid Boolean |
| name | Yes | String | The name of the review session | No HTML tags No {{ }} expressions Length must not exceed 45 |
| playlist_ids | No | CommonIdArray | The review session playlist IDs | Valid CommonIdArray |
| team_ids | No | IdArray | The team IDs of review session participants | Valid IdArray |
| user_ids | No | IdArray | The user IDs of review session participants | Valid IdArray |
| watermark_id | No | Id | The watermark associated with this session. | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_count | Integer | The number of assets in this room |
| asset_state | String | The current asset state JSON data |
| can_browse_assets | Boolean | The authenticated user can add browse assets to add in the add assets wizard |
| can_display_watermarks | Boolean | The authenticated user can display watermarks in the room lobby |
| can_edit | Boolean | The authenticated user can edit this room |
| can_reopen | Boolean | The room can be re-opened |
| can_show_playlists | Boolean | The authenticated user can show playlists in the assets wizard |
| can_show_teams | Boolean | The authenticated user can show teams on the manage participants panel |
| can_upload_assets | Boolean | The authenticated user can upload assets in the add assets wizard |
| comment_scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of comments posted in this review session (asset or session-only) |
| common_asset_repository_id | CommonId | The project ID for retrieving assets from the common production asset repository |
| company_id | Id | The ID of the company displayed in the review session |
| company_name | String | The name of the company displayed in the review session |
| created | Date | The review session creation date and time |
| description | String | The name of the review session |
| echo_cancellation_enabled | Boolean | Is Amazon Chime Echo Cancellation available for this room? |
| end_time | Date | The review session end date and time |
| group_id | CommonId | The ID of the group (production) associated with this review session |
| group_name | String | The name of the group (production) associated with this review session |
| id | Id | The review session ID |
| is_guest_user_allowed | Boolean | Review session guest user is allowed to be created |
| is_host | Boolean | True if the current user is a host of the review session |
| is_owner | Boolean | True if the current user owns the review session |
| is_session_live_enabled | Boolean | Can this review session have use in-room live streaming |
| is_standalone_room | Boolean | True if the review session belongs to rooms only production |
| last_joined | Date | The most recent time any user joined the review session |
| modified | Date | The review session modified date and time |
| mute_participants_on_entry | Boolean | Should all participants be muted initially? |
| name | String | The name of the review session |
| owner_id | Id | The user ID of the review session owner |
| owner_name | String | The name of the review session owner |
| playlist_count | Integer | The number of playlists in this room |
| session_playlist_id | CommonId | ID of the review session managed playlist |
| session_project_id | CommonId | ID of the review session managed project |
| start_time | Date | The review session start date and time |
| status | Enum [DRAFT, SCHEDULED, STARTED, COMPLETE] | The review session status |
| sync_mode | Enum [HOST, EVERYONE, UNSYNCED] | The current sync mode |
| watermark_id | Id | The watermark ID associated with this review session |
Create users for review sessions
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| emails | Yes | StringArray | Users emails | Valid StringArray |
| review_session_id | Yes | Id | The review session ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| user_id | Id | The created user Id |
Delete a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the review session has been deleted |
Get all the review sessions that reference a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| playlist_id | Yes | CommonId | The playlist ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_count | Integer | The number of assets in this room |
| asset_state | String | The current asset state JSON data |
| can_browse_assets | Boolean | The authenticated user can add browse assets to add in the add assets wizard |
| can_display_watermarks | Boolean | The authenticated user can display watermarks in the room lobby |
| can_edit | Boolean | The authenticated user can edit this room |
| can_reopen | Boolean | The room can be re-opened |
| can_show_playlists | Boolean | The authenticated user can show playlists in the assets wizard |
| can_show_teams | Boolean | The authenticated user can show teams on the manage participants panel |
| can_upload_assets | Boolean | The authenticated user can upload assets in the add assets wizard |
| comment_scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of comments posted in this review session (asset or session-only) |
| common_asset_repository_id | CommonId | The project ID for retrieving assets from the common production asset repository |
| company_id | Id | The ID of the company displayed in the review session |
| company_name | String | The name of the company displayed in the review session |
| created | Date | The review session creation date and time |
| description | String | The name of the review session |
| echo_cancellation_enabled | Boolean | Is Amazon Chime Echo Cancellation available for this room? |
| end_time | Date | The review session end date and time |
| group_id | CommonId | The ID of the group (production) associated with this review session |
| group_name | String | The name of the group (production) associated with this review session |
| id | Id | The review session ID |
| is_guest_user_allowed | Boolean | Review session guest user is allowed to be created |
| is_host | Boolean | True if the current user is a host of the review session |
| is_owner | Boolean | True if the current user owns the review session |
| is_session_live_enabled | Boolean | Can this review session have use in-room live streaming |
| is_standalone_room | Boolean | True if the review session belongs to rooms only production |
| last_joined | Date | The most recent time any user joined the review session |
| modified | Date | The review session modified date and time |
| mute_participants_on_entry | Boolean | Should all participants be muted initially? |
| name | String | The name of the review session |
| owner_id | Id | The user ID of the review session owner |
| owner_name | String | The name of the review session owner |
| playlist_count | Integer | The number of playlists in this room |
| session_playlist_id | CommonId | ID of the review session managed playlist |
| session_project_id | CommonId | ID of the review session managed project |
| start_time | Date | The review session start date and time |
| status | Enum [DRAFT, SCHEDULED, STARTED, COMPLETE] | The review session status |
| sync_mode | Enum [HOST, EVERYONE, UNSYNCED] | The current sync mode |
| watermark_id | Id | The watermark ID associated with this review session |
Get a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_count | Integer | The number of assets in this room |
| asset_state | String | The current asset state JSON data |
| can_browse_assets | Boolean | The authenticated user can add browse assets to add in the add assets wizard |
| can_display_watermarks | Boolean | The authenticated user can display watermarks in the room lobby |
| can_edit | Boolean | The authenticated user can edit this room |
| can_reopen | Boolean | The room can be re-opened |
| can_show_playlists | Boolean | The authenticated user can show playlists in the assets wizard |
| can_show_teams | Boolean | The authenticated user can show teams on the manage participants panel |
| can_upload_assets | Boolean | The authenticated user can upload assets in the add assets wizard |
| comment_scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of comments posted in this review session (asset or session-only) |
| common_asset_repository_id | CommonId | The project ID for retrieving assets from the common production asset repository |
| company_id | Id | The ID of the company displayed in the review session |
| company_name | String | The name of the company displayed in the review session |
| created | Date | The review session creation date and time |
| description | String | The name of the review session |
| echo_cancellation_enabled | Boolean | Is Amazon Chime Echo Cancellation available for this room? |
| end_time | Date | The review session end date and time |
| group_id | CommonId | The ID of the group (production) associated with this review session |
| group_name | String | The name of the group (production) associated with this review session |
| id | Id | The review session ID |
| is_guest_user_allowed | Boolean | Review session guest user is allowed to be created |
| is_host | Boolean | True if the current user is a host of the review session |
| is_owner | Boolean | True if the current user owns the review session |
| is_session_live_enabled | Boolean | Can this review session have use in-room live streaming |
| is_standalone_room | Boolean | True if the review session belongs to rooms only production |
| last_joined | Date | The most recent time any user joined the review session |
| modified | Date | The review session modified date and time |
| mute_participants_on_entry | Boolean | Should all participants be muted initially? |
| name | String | The name of the review session |
| owner_id | Id | The user ID of the review session owner |
| owner_name | String | The name of the review session owner |
| playlist_count | Integer | The number of playlists in this room |
| session_playlist_id | CommonId | ID of the review session managed playlist |
| session_project_id | CommonId | ID of the review session managed project |
| start_time | Date | The review session start date and time |
| status | Enum [DRAFT, SCHEDULED, STARTED, COMPLETE] | The review session status |
| sync_mode | Enum [HOST, EVERYONE, UNSYNCED] | The current sync mode |
| watermark_id | Id | The watermark ID associated with this review session |
Get assets for playlists in a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The review session ID | Valid CommonId |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| available_comment_channels | StringArray | List of available comment channels | |||||||||||||
| batch_id | CommonId | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| blurhash | String | A hashed representation of the asset | |||||||||||||
| can_access_project | Boolean | User can access this asset | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| can_offline | Boolean | User can offline this asset | |||||||||||||
| can_remove | Boolean | Is this user able to remove this asset | |||||||||||||
| can_update | Boolean | User can update this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| component_data | Object | The components of the asset | |||||||||||||
| component_links | Array | The component details array List | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| deny_view | Boolean | True if the asset should not be viewable by the user. | |||||||||||||
| desc | String | The asset description | |||||||||||||
| drm_enabled | Boolean | Whether manifest playback is enabled on the project that contains this asset. | |||||||||||||
| duration | Float | The asset duration (in seconds) | |||||||||||||
| ext | String | The original asset file extension | |||||||||||||
| hdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in HDR. | |||||||||||||
| hidden | Boolean | The asset is hidden and not visible to users that don't have permission to view hidden batches | |||||||||||||
| id | CommonId | The asset ID | |||||||||||||
| is_admin | Boolean | True if the user has admin permission for this asset. | |||||||||||||
| is_derived_sdr | Boolean | True if the Asset has generated an SDR from an HDR, False if the user has provided their own SDR | |||||||||||||
| is_derived_sdr_allowed | Boolean | Read Only replication of the is_derived_sdr_allowed Project Setting | |||||||||||||
| is_live | Boolean | Asset is currently live streaming | |||||||||||||
| is_sdr_allowed | Boolean | Read Only replication of the is_sdr_allowed Project Setting | |||||||||||||
| is_unviewed | Boolean | Is this asset not viewed by current user | |||||||||||||
| master_id | CommonId | The master asset Id | |||||||||||||
| metadata | Object | The assets metadata | |||||||||||||
| name | String | The asset file name (without original file extension) | |||||||||||||
| offline_bytes | Integer | Number of bytes of primary files that needed to be downloaded for offline usage | |||||||||||||
| origin_type | Enum [Moxion, Flow, Hybrid] | Asset Origin type | |||||||||||||
| overall_processing_time | String | The overall time in seconds the asset has taken to complete processing | |||||||||||||
| playlist_asset_id | CommonId | The playlist asset ID | |||||||||||||
| playlist_id | CommonId | The source playlist for this asset | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | CommonId | The project ID this asset belongs to | |||||||||||||
| resume_position | Float | The last playback time in seconds for restarting playback | |||||||||||||
| review_session_asset_id | CommonId | The review session asset ID | |||||||||||||
| review_session_id | CommonId | The review session asset ID | |||||||||||||
| scrub_jpg_frames | Integer | The number of frames in the scrub JPG | |||||||||||||
| scrub_jpg_url | String | The URL for the scrub JPG | |||||||||||||
| scrub_jpg_url_2x | String | The URL for the scrub JPG (2x resolution) | |||||||||||||
| scrub_jpg_url_3x | String | The URL for the scrub JPG (3x resolution) | |||||||||||||
| scrub_url | String | The URL for the thumbnail scrubber | |||||||||||||
| scrub_url_2x | String | The URL for the thumbnail scrubber (2x resolution) | |||||||||||||
| scrub_url_3x | String | The URL for the thumbnail scrubber (3x resolution) | |||||||||||||
| scrub_url_frames | Integer | The number of frames in the thumbnail scrubber | |||||||||||||
| sdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in SDR. | |||||||||||||
| session_order | Integer | The position this asset should be in the review session | |||||||||||||
| sort_index | Integer | The sort index to use for display (low value should be display at the first) | |||||||||||||
| status | Enum [ACTIVE, TRANSCODING, PROCESSING, DELETED] | The asset status | |||||||||||||
| subtype | Enum [STREAMING, LIVE, IMMEDIATE, CAMERA_TYPE_ID, SLATE_TYPE_ID, CAPTURE_TYPE_ID, CAMERA_METADATA_TYPE_ID, PRODUCTION_SCENE_TYPE_ID, CAMERA_UNIT_TYPE_ID, SHOT_TYPE_ID, SEQUENCE_TYPE_ID] | The asset subtype | |||||||||||||
| subtypeDisplayName | String | The asset subtype in human readable format | |||||||||||||
| tags | CommonIdArray | The tag IDs for this asset | |||||||||||||
| thumbnail_url | String | The primary thumbnail URL for this asset | |||||||||||||
| thumbnail_url_2x | String | The primary thumbnail URL for this asset (2x resolution) | |||||||||||||
| thumbnail_url_3x | String | The primary thumbnail URL for this asset (3x resolution) | |||||||||||||
| timelines | String | Stringified JSON Array of timelines associated with this asset. Each timeline object contains array with segment objects. | |||||||||||||
| type | Enum [VIDEO, IMAGE, AUDIO, PDF, UNKNOWN, MULTI_PRIMARY, MULTI_SECONDARY, ORIGINAL] | The asset type | |||||||||||||
| uploaded_usage | Integer | Number of bytes of uploaded for this asset | |||||||||||||
| user_id | CommonId | The user ID this asset was created/uploaded by | |||||||||||||
| uuid | String | The asset UUID (if set) | |||||||||||||
| view_link | String | Link to view the asset in the Moxion web application. |
Get assets for one or many playlists in a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| playlist_id | No | CommonId | The playlist ID Deprecated: Use playlist_ids | Valid CommonId |
| playlist_ids | No | CommonIdArray | Playlist IDs to fetch | Valid CommonIdArray |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| available_comment_channels | StringArray | List of available comment channels | |||||||||||||
| batch_id | CommonId | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| blurhash | String | A hashed representation of the asset | |||||||||||||
| can_access_project | Boolean | User can access this asset | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| can_offline | Boolean | User can offline this asset | |||||||||||||
| can_update | Boolean | User can update this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| component_data | Object | The components of the asset | |||||||||||||
| component_links | Array | The component details array List | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| deny_view | Boolean | True if the asset should not be viewable by the user. | |||||||||||||
| desc | String | The asset description | |||||||||||||
| drm_enabled | Boolean | Whether manifest playback is enabled on the project that contains this asset. | |||||||||||||
| duration | Float | The asset duration (in seconds) | |||||||||||||
| ext | String | The original asset file extension | |||||||||||||
| hdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in HDR. | |||||||||||||
| hidden | Boolean | The asset is hidden and not visible to users that don't have permission to view hidden batches | |||||||||||||
| id | CommonId | The asset ID | |||||||||||||
| is_admin | Boolean | True if the user has admin permission for this asset. | |||||||||||||
| is_derived_sdr | Boolean | True if the Asset has generated an SDR from an HDR, False if the user has provided their own SDR | |||||||||||||
| is_derived_sdr_allowed | Boolean | Read Only replication of the is_derived_sdr_allowed Project Setting | |||||||||||||
| is_live | Boolean | Asset is currently live streaming | |||||||||||||
| is_sdr_allowed | Boolean | Read Only replication of the is_sdr_allowed Project Setting | |||||||||||||
| is_unviewed | Boolean | Is this asset not viewed by current user | |||||||||||||
| master_id | CommonId | The master asset Id | |||||||||||||
| metadata | Object | The assets metadata | |||||||||||||
| name | String | The asset file name (without original file extension) | |||||||||||||
| offline_bytes | Integer | Number of bytes of primary files that needed to be downloaded for offline usage | |||||||||||||
| origin_type | Enum [Moxion, Flow, Hybrid] | Asset Origin type | |||||||||||||
| overall_processing_time | String | The overall time in seconds the asset has taken to complete processing | |||||||||||||
| playlist_asset_id | CommonId | The playlist asset ID | |||||||||||||
| playlist_id | CommonId | The playlist ID | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | CommonId | The project ID this asset belongs to | |||||||||||||
| resume_position | Float | The last playback time in seconds for restarting playback | |||||||||||||
| scrub_jpg_frames | Integer | The number of frames in the scrub JPG | |||||||||||||
| scrub_jpg_url | String | The URL for the scrub JPG | |||||||||||||
| scrub_jpg_url_2x | String | The URL for the scrub JPG (2x resolution) | |||||||||||||
| scrub_jpg_url_3x | String | The URL for the scrub JPG (3x resolution) | |||||||||||||
| scrub_url | String | The URL for the thumbnail scrubber | |||||||||||||
| scrub_url_2x | String | The URL for the thumbnail scrubber (2x resolution) | |||||||||||||
| scrub_url_3x | String | The URL for the thumbnail scrubber (3x resolution) | |||||||||||||
| scrub_url_frames | Integer | The number of frames in the thumbnail scrubber | |||||||||||||
| sdr_screen_brightness | Float | The screen brightness value (between 0.0 and 1.0) to be applied on iPhone and iPad devices when playing in SDR. | |||||||||||||
| sort_index | Integer | The sort index to use for display (low value should be display at the first) | |||||||||||||
| status | Enum [ACTIVE, TRANSCODING, PROCESSING, DELETED] | The asset status | |||||||||||||
| subtype | Enum [STREAMING, LIVE, IMMEDIATE, CAMERA_TYPE_ID, SLATE_TYPE_ID, CAPTURE_TYPE_ID, CAMERA_METADATA_TYPE_ID, PRODUCTION_SCENE_TYPE_ID, CAMERA_UNIT_TYPE_ID, SHOT_TYPE_ID, SEQUENCE_TYPE_ID] | The asset subtype | |||||||||||||
| subtypeDisplayName | String | The asset subtype in human readable format | |||||||||||||
| tags | CommonIdArray | The tag IDs for this asset | |||||||||||||
| thumbnail_url | String | The primary thumbnail URL for this asset | |||||||||||||
| thumbnail_url_2x | String | The primary thumbnail URL for this asset (2x resolution) | |||||||||||||
| thumbnail_url_3x | String | The primary thumbnail URL for this asset (3x resolution) | |||||||||||||
| timelines | String | Stringified JSON Array of timelines associated with this asset. Each timeline object contains array with segment objects. | |||||||||||||
| type | Enum [VIDEO, IMAGE, AUDIO, PDF, UNKNOWN, MULTI_PRIMARY, MULTI_SECONDARY, ORIGINAL] | The asset type | |||||||||||||
| uploaded_usage | Integer | Number of bytes of uploaded for this asset | |||||||||||||
| user_id | CommonId | The user ID this asset was created/uploaded by | |||||||||||||
| uuid | String | The asset UUID (if set) | |||||||||||||
| view_link | String | Link to view the asset in the Moxion web application. |
Get all the playlists in a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| blurhash | String | A hashed representation of the asset |
| can_add_collaborators | Boolean | True if the user can add collaborators to the playlist. |
| can_collaborate | Boolean | Suggests if a playlist is eligible for collaboration. |
| can_edit | Boolean | True if the user can edit the playlist. |
| can_share | Boolean | True if the user can share the playlist. |
| company_id | CommonId | The Company ID this playlist belongs to |
| created | Date | The playlist creation date and time |
| description | String | The playlist description |
| flow_id | String | The native Flow ID of this playlist, without encryption. Only provided if this is a Flow Playlist. |
| group_id | CommonId | The production ID this playlist belongs to |
| has_collaborators | Boolean | True if the playlist has collaborators. |
| id | CommonId | The playlist ID |
| is_dynamic | Boolean | Is this a dynamic playlist? Dynamic playlists cannot be modified through the UI. |
| is_shared_with_me | Boolean | True if the playlist is shared with the requesting user by another user |
| modified | Date | The playlist modified date and time |
| name | String | The name of the playlist |
| origin_type | Enum [Moxion, Flow, Hybrid] | Playlist Origin type |
| owner_id | Id | The user ID of the playlist owner |
| owner_name | String | The name of the playlist owner |
| playlinks | Array | Array of playlinks |
| playlist_id | CommonId | The playlist ID |
| source_project_id | CommonId | If this is a dynamic playlist, the ID of the source folder |
| source_type | Enum [USER, REVIEW_SESSION] | If this is a dynamic playlist, the source type (SNAPSHOT, FOLDER) |
| thumbnail_asset_id | CommonId | The ID of the asset that is being used as the thumbnail ID. If not provided, a default thumbnail will be generated and used. |
| thumbnail_type | Enum [NONE, GENERATED, UPLOADED, SELECTED_ASSET] | The type of the Playlist thumbnail: NONE, GENERATED, SELECTED_ASSET or UPLOADED |
| thumbnail_url | String | The primary thumbnail URL for this playlist |
| thumbnail_url_2x | String | The primary thumbnail URL for this playlist (2x resolution) |
| thumbnail_url_3x | String | The primary thumbnail URL for this playlist (3x resolution) |
| type | Enum [USER, REVIEW_SESSION] | Playlist type |
Get all the teams in a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| review_session_id | Id | The review session ID |
| team_id | Id | Team Id of the team in as review session |
Get a user in a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| user_id | Yes | Id | The user ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| company | String | Users company name |
| String | The user's email address | |
| first_name | String | Users first name |
| host_status_adjustable | Boolean | Is it valid for the host status to be adjusted |
| id | Id | The user ID |
| is_host | Boolean | True if the user is a host of the review session |
| last_name | String | Users last name |
| role | String | The user's role as it appears in the review session |
| user_type | String | The type of user |
Get all the users in a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| include_owner | No | Boolean | Whether to include the review session owner | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| company | String | Users company name |
| String | The user's email address | |
| first_name | String | Users first name |
| host_status_adjustable | Boolean | Is it valid for the host status to be adjusted |
| id | Id | The user ID |
| is_host | Boolean | True if the user is a host of the review session |
| last_name | String | Users last name |
| role | String | The user's role as it appears in the review session |
| user_type | String | The type of user |
Get all the review sessions visible to the current user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_count | Integer | The number of assets in this room |
| asset_state | String | The current asset state JSON data |
| can_browse_assets | Boolean | The authenticated user can add browse assets to add in the add assets wizard |
| can_display_watermarks | Boolean | The authenticated user can display watermarks in the room lobby |
| can_edit | Boolean | The authenticated user can edit this room |
| can_reopen | Boolean | The room can be re-opened |
| can_show_playlists | Boolean | The authenticated user can show playlists in the assets wizard |
| can_show_teams | Boolean | The authenticated user can show teams on the manage participants panel |
| can_upload_assets | Boolean | The authenticated user can upload assets in the add assets wizard |
| comment_scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of comments posted in this review session (asset or session-only) |
| common_asset_repository_id | CommonId | The project ID for retrieving assets from the common production asset repository |
| company_id | Id | The ID of the company displayed in the review session |
| company_name | String | The name of the company displayed in the review session |
| created | Date | The review session creation date and time |
| description | String | The name of the review session |
| echo_cancellation_enabled | Boolean | Is Amazon Chime Echo Cancellation available for this room? |
| end_time | Date | The review session end date and time |
| group_id | CommonId | The ID of the group (production) associated with this review session |
| group_name | String | The name of the group (production) associated with this review session |
| id | Id | The review session ID |
| is_guest_user_allowed | Boolean | Review session guest user is allowed to be created |
| is_host | Boolean | True if the current user is a host of the review session |
| is_owner | Boolean | True if the current user owns the review session |
| is_session_live_enabled | Boolean | Can this review session have use in-room live streaming |
| is_standalone_room | Boolean | True if the review session belongs to rooms only production |
| last_joined | Date | The most recent time any user joined the review session |
| modified | Date | The review session modified date and time |
| mute_participants_on_entry | Boolean | Should all participants be muted initially? |
| name | String | The name of the review session |
| owner_id | Id | The user ID of the review session owner |
| owner_name | String | The name of the review session owner |
| playlist_count | Integer | The number of playlists in this room |
| session_playlist_id | CommonId | ID of the review session managed playlist |
| session_project_id | CommonId | ID of the review session managed project |
| start_time | Date | The review session start date and time |
| status | Enum [DRAFT, SCHEDULED, STARTED, COMPLETE] | The review session status |
| sync_mode | Enum [HOST, EVERYONE, UNSYNCED] | The current sync mode |
| watermark_id | Id | The watermark ID associated with this review session |
Join a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| media_region | Yes | String | The user's preferred Chime media region | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| attendee | String | Chime meeting attendee JSON data |
| meeting | String | Chime meeting JSON data |
Set the current review session state
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_state | No | String | The current asset state JSON data | No HTML tags No {{ }} expressions |
| id | Yes | Id | The review session ID | Valid Id |
| sync_mode | Yes | Enum [HOST, EVERYONE, UNSYNCED] | The current sync mode | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_count | Integer | The number of assets in this room |
| asset_state | String | The current asset state JSON data |
| can_browse_assets | Boolean | The authenticated user can add browse assets to add in the add assets wizard |
| can_display_watermarks | Boolean | The authenticated user can display watermarks in the room lobby |
| can_edit | Boolean | The authenticated user can edit this room |
| can_reopen | Boolean | The room can be re-opened |
| can_show_playlists | Boolean | The authenticated user can show playlists in the assets wizard |
| can_show_teams | Boolean | The authenticated user can show teams on the manage participants panel |
| can_upload_assets | Boolean | The authenticated user can upload assets in the add assets wizard |
| comment_scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of comments posted in this review session (asset or session-only) |
| common_asset_repository_id | CommonId | The project ID for retrieving assets from the common production asset repository |
| company_id | Id | The ID of the company displayed in the review session |
| company_name | String | The name of the company displayed in the review session |
| created | Date | The review session creation date and time |
| description | String | The name of the review session |
| echo_cancellation_enabled | Boolean | Is Amazon Chime Echo Cancellation available for this room? |
| end_time | Date | The review session end date and time |
| group_id | CommonId | The ID of the group (production) associated with this review session |
| group_name | String | The name of the group (production) associated with this review session |
| id | Id | The review session ID |
| is_guest_user_allowed | Boolean | Review session guest user is allowed to be created |
| is_host | Boolean | True if the current user is a host of the review session |
| is_owner | Boolean | True if the current user owns the review session |
| is_session_live_enabled | Boolean | Can this review session have use in-room live streaming |
| is_standalone_room | Boolean | True if the review session belongs to rooms only production |
| last_joined | Date | The most recent time any user joined the review session |
| modified | Date | The review session modified date and time |
| mute_participants_on_entry | Boolean | Should all participants be muted initially? |
| name | String | The name of the review session |
| owner_id | Id | The user ID of the review session owner |
| owner_name | String | The name of the review session owner |
| playlist_count | Integer | The number of playlists in this room |
| session_playlist_id | CommonId | ID of the review session managed playlist |
| session_project_id | CommonId | ID of the review session managed project |
| start_time | Date | The review session start date and time |
| status | Enum [DRAFT, SCHEDULED, STARTED, COMPLETE] | The review session status |
| sync_mode | Enum [HOST, EVERYONE, UNSYNCED] | The current sync mode |
| watermark_id | Id | The watermark ID associated with this review session |
Set whether a user is a review session host
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| is_host | Yes | Boolean | Whether the user is a host of the review session | Valid Boolean |
| user_id | Yes | Id | The user ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | True if the user's host status was updated successfully |
Set the current user's role on a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| role | No | String | The user's role as it appears in the review session | No HTML tags No {{ }} expressions Length must not exceed 45 |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | True if the user's role was set successfully |
Start a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_count | Integer | The number of assets in this room |
| asset_state | String | The current asset state JSON data |
| can_browse_assets | Boolean | The authenticated user can add browse assets to add in the add assets wizard |
| can_display_watermarks | Boolean | The authenticated user can display watermarks in the room lobby |
| can_edit | Boolean | The authenticated user can edit this room |
| can_reopen | Boolean | The room can be re-opened |
| can_show_playlists | Boolean | The authenticated user can show playlists in the assets wizard |
| can_show_teams | Boolean | The authenticated user can show teams on the manage participants panel |
| can_upload_assets | Boolean | The authenticated user can upload assets in the add assets wizard |
| comment_scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of comments posted in this review session (asset or session-only) |
| common_asset_repository_id | CommonId | The project ID for retrieving assets from the common production asset repository |
| company_id | Id | The ID of the company displayed in the review session |
| company_name | String | The name of the company displayed in the review session |
| created | Date | The review session creation date and time |
| description | String | The name of the review session |
| echo_cancellation_enabled | Boolean | Is Amazon Chime Echo Cancellation available for this room? |
| end_time | Date | The review session end date and time |
| group_id | CommonId | The ID of the group (production) associated with this review session |
| group_name | String | The name of the group (production) associated with this review session |
| id | Id | The review session ID |
| is_guest_user_allowed | Boolean | Review session guest user is allowed to be created |
| is_host | Boolean | True if the current user is a host of the review session |
| is_owner | Boolean | True if the current user owns the review session |
| is_session_live_enabled | Boolean | Can this review session have use in-room live streaming |
| is_standalone_room | Boolean | True if the review session belongs to rooms only production |
| last_joined | Date | The most recent time any user joined the review session |
| modified | Date | The review session modified date and time |
| mute_participants_on_entry | Boolean | Should all participants be muted initially? |
| name | String | The name of the review session |
| owner_id | Id | The user ID of the review session owner |
| owner_name | String | The name of the review session owner |
| playlist_count | Integer | The number of playlists in this room |
| session_playlist_id | CommonId | ID of the review session managed playlist |
| session_project_id | CommonId | ID of the review session managed project |
| start_time | Date | The review session start date and time |
| status | Enum [DRAFT, SCHEDULED, STARTED, COMPLETE] | The review session status |
| sync_mode | Enum [HOST, EVERYONE, UNSYNCED] | The current sync mode |
| watermark_id | Id | The watermark ID associated with this review session |
Update an existing review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| allow_participants_to_unmute_self | No | Boolean | Should participants be allowed to unmute themselves? | Valid Boolean |
| comment_scope | No | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of the comments posted in this review session (asset or session-only) | Valid Enum |
| company_id | No | Id | The ID of the company displayed in the review session | Valid Id |
| description | No | String | The description of the review session | No HTML tags No {{ }} expressions Length must not exceed 1024 |
| group_id | No | CommonId | The ID of the group (production) displayed in the review session | Valid CommonId |
| host_user_ids | No | IdArray | The user IDs of review session hosts | Valid IdArray |
| id | Yes | Id | The review session ID | Valid Id |
| mute_participants_on_entry | No | Boolean | Should all participants be muted initially? | Valid Boolean |
| name | No | String | The name of the review session | No HTML tags No {{ }} expressions Length must not exceed 45 |
| playlist_ids | No | CommonIdArray | The review session playlist IDs | Valid CommonIdArray |
| team_ids | No | IdArray | The team IDs of review session participants | Valid IdArray |
| user_ids | No | IdArray | The user IDs of review session participants | Valid IdArray |
| watermark_id | No | Id | Watermark associated with this review session | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_count | Integer | The number of assets in this room |
| asset_state | String | The current asset state JSON data |
| can_browse_assets | Boolean | The authenticated user can add browse assets to add in the add assets wizard |
| can_display_watermarks | Boolean | The authenticated user can display watermarks in the room lobby |
| can_edit | Boolean | The authenticated user can edit this room |
| can_reopen | Boolean | The room can be re-opened |
| can_show_playlists | Boolean | The authenticated user can show playlists in the assets wizard |
| can_show_teams | Boolean | The authenticated user can show teams on the manage participants panel |
| can_upload_assets | Boolean | The authenticated user can upload assets in the add assets wizard |
| comment_scope | Enum [ASSET, REVIEW_SESSION, PLAYLINK] | The scope of comments posted in this review session (asset or session-only) |
| common_asset_repository_id | CommonId | The project ID for retrieving assets from the common production asset repository |
| company_id | Id | The ID of the company displayed in the review session |
| company_name | String | The name of the company displayed in the review session |
| created | Date | The review session creation date and time |
| description | String | The name of the review session |
| echo_cancellation_enabled | Boolean | Is Amazon Chime Echo Cancellation available for this room? |
| end_time | Date | The review session end date and time |
| group_id | CommonId | The ID of the group (production) associated with this review session |
| group_name | String | The name of the group (production) associated with this review session |
| id | Id | The review session ID |
| is_guest_user_allowed | Boolean | Review session guest user is allowed to be created |
| is_host | Boolean | True if the current user is a host of the review session |
| is_owner | Boolean | True if the current user owns the review session |
| is_session_live_enabled | Boolean | Can this review session have use in-room live streaming |
| is_standalone_room | Boolean | True if the review session belongs to rooms only production |
| last_joined | Date | The most recent time any user joined the review session |
| modified | Date | The review session modified date and time |
| mute_participants_on_entry | Boolean | Should all participants be muted initially? |
| name | String | The name of the review session |
| owner_id | Id | The user ID of the review session owner |
| owner_name | String | The name of the review session owner |
| playlist_count | Integer | The number of playlists in this room |
| session_playlist_id | CommonId | ID of the review session managed playlist |
| session_project_id | CommonId | ID of the review session managed project |
| start_time | Date | The review session start date and time |
| status | Enum [DRAFT, SCHEDULED, STARTED, COMPLETE] | The review session status |
| sync_mode | Enum [HOST, EVERYONE, UNSYNCED] | The current sync mode |
| watermark_id | Id | The watermark ID associated with this review session |
Update the review session asset order - asset_ids defines asset order
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| review_session_asset_ids | Yes | IdArray | The review session asset IDs | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| review_session_asset_ids | IdArray | The ordered list of review session asset IDs |
| updated | Boolean | True if the assets were updated |
Check the server status
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|---|---|
| ok | Boolean | Should be true unless theres a problem... |
| status_error | String | Any error messages |
Check that new DRM assets can be created, returns XML
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|
Check existing DRM assets can be accessed, returns XML
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|
Fetch all entity types from shotgun
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | CommonId | The moxion project ID to load shotgun settings from | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| default | Boolean | This is the default entity |
| sg_entity_name | String | The shotgun entity name |
| sg_entity_type | String | The shotgun entity type |
Fetch all projects from shotgun
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | CommonId | The moxion project ID to load shotgun settings from | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| default | Boolean | This is the default project |
| sg_project_id | String | The shotgun project ID |
| sg_project_name | String | The shotgun project name |
Sync metadata from moxion assets into shotgun entities. Creates shotgun entities if they don't exist, updates otherwise
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| assets | Yes | CommonIdArray | Array of moxion asset IDs to sync metadata from | Valid CommonIdArray |
| project_id | Yes | CommonId | The moxion project ID to load shotgun settings from | Valid CommonId |
| sg_entity_type | Yes | String | The shotgun entity type to create or update | No HTML tags No {{ }} expressions |
| sg_project_id | Yes | String | The shotgun project ID to update | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| assets | CommonIdArray | Array of moxion asset IDs that were able to be updated |
| entities | StringArray | Array of shotgun entity codes that were able to be updated |
| updated | Integer | The number of entities updated/created in shotgun |
Create
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| color | Yes | String | The tag color | Valid # Hex Color Length must not exceed 10 |
| name | Yes | String | The tag name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| project_id | Yes | CommonId | The project ID this tag belongs to | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| color | String | The tag color |
| id | CommonId | The tag ID |
| name | String | The tag name |
| project_id | CommonId | The project ID this tag belongs to |
Delete a tag
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| force | No | Boolean | Remove this tag from its associated assets then delete this tag | Valid Boolean |
| id | Yes | CommonId | The tag ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if this tag has been deleted |
Fetch a single tag
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | CommonId | The tag ID | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| color | String | The tag color |
| id | CommonId | The tag ID |
| name | String | The tag name |
| project_id | CommonId | The project ID this tag belongs to |
Fetch all tags that belong to a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | No | CommonId | The project ID | Valid CommonId |
| project_ids | No | CommonIdArray | The project IDs | Valid CommonIdArray |
| Parameter | Type | Description |
|---|---|---|
| color | String | The tag color |
| id | CommonId | The tag ID |
| name | String | The tag name |
| project_id | CommonId | The project ID this tag belongs to |
Update a tag
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| color | No | String | The tag color | Valid # Hex Color Length must not exceed 10 |
| id | Yes | CommonId | The tag ID | Valid CommonId |
| name | No | String | The tag name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| Parameter | Type | Description |
|---|---|---|
| color | String | The tag color |
| id | CommonId | The tag ID |
| name | String | The tag name |
| project_id | CommonId | The project ID this tag belongs to |
Get the most recent status message for a task
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| task_id | No | String | Get the message for this task | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| message | Object | Last status message for task |
Get the most recent status message for tasks
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| task_ids | No | StringArray | Get the message for this tasks | Valid StringArray |
| Parameter | Type | Description |
|---|---|---|
| message | Object | Last status message for task |
| task_id | String | Task |
Get this teams details (the currently connected user)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The team ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| can_edit_team_details | Boolean | Is the user authorized to edit the company name/color etc (not the participants)? |
| can_update_participants | Boolean | User can update participants on this team |
| company_id | Id | The company ID this team belongs to |
| default_security_group | Integer | The security group that new members of this team will be assigned to by default. |
| group_id | CommonId | The production ID this team belongs to. 0 means this is a company level team |
| id | CommonId | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| is_collaborating | Boolean | Is this team collaborating in a playlist |
| is_externally_managed | Boolean | Does this team have externally managed users (ie is it a SCIM team)? |
| name | String | The team name |
| settings | Object | Team settings |
| user_count | Integer | Number of users present in a team |
Get users for this team
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The team ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| account_status | Enum [INVITED, ACTIVE, DELETED] | User's account status (Invited, Active, Deleted) |
| company | String | Users company name |
| String | Users email | |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| externally_managed | Boolean | Is this user sourced from outside Moxion (ie SCIM)? |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_only | Boolean | User can only view inbox |
| last_name | String | Users last name |
| project_role_id | Id | The users project role ID |
| project_role_name | String | The users project role name |
| security_group_id | Integer | The users security group ID |
Get all of the teams associated with this company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | No | Id | The company ID (also returns all production-level teams for all company productions) | Valid Id |
| group_id | No | CommonId | The production ID this team belongs to (also returns all company-level teams) | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| can_edit_team_details | Boolean | Is the user authorized to edit the company name/color etc (not the participants)? |
| can_update_participants | Boolean | User can update participants on this team |
| company_id | Id | The company ID this team belongs to |
| default_security_group | Integer | The security group that new members of this team will be assigned to by default. |
| group_id | CommonId | The production ID this team belongs to. 0 means this is a company level team |
| id | CommonId | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| is_collaborating | Boolean | Is this team collaborating in a playlist |
| is_externally_managed | Boolean | Does this team have externally managed users (ie is it a SCIM team)? |
| name | String | The team name |
| settings | Object | Team settings |
| user_count | Integer | Number of users present in a team |
Searches and returns the teams and users
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | CommonId | The company ID | Valid CommonId |
| group_ids | No | CommonIdArray | The production IDs | Valid CommonIdArray |
| limit | No | Integer | Maximum number of users to return, 200 if not specified | Valid Integer |
| search | No | String | Find users and Teams with user name or Team Name matching this string | No HTML tags No {{ }} expressions |
| sort_by | No | Enum [NAME] | Sort by filed for the api | Valid Enum |
| sort_direction | No | Enum [ASC, DESC] | Sort direction filed for the api | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| account_status | Enum [INVITED, ACTIVE, DELETED] | User's account status (Invited, Active, Deleted) |
| company_id | Id | The company ID this team or user belongs to |
| company_name | String | company name of user or team |
| String | Users email | |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| externally_managed | Boolean | Is this user sourced from outside Moxion (ie SCIM)? |
| first_name | String | Users first name |
| group_id | CommonId | The production ID this team belongs to. 0 means this is a company level team |
| id | CommonId | The team ID or User Id |
| inbox_only | Boolean | User can only view inbox |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| is_team | Boolean | Is this a Team |
| is_user | Boolean | Is this a user |
| last_name | String | Users last name |
| security_group_id | Integer | The users security group ID |
| team_id | Id | Team associated with this user |
| team_name | String | The team name |
| team_security_group | Integer | The security group that new members of this team will be assigned to by default. |
| user_count | Integer | Number of users present in a team |
Get users for multiple teams. May return a user multiple times if they are in several teams.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| team_ids | Yes | IdArray | The team ID | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| account_status | Enum [INVITED, ACTIVE, DELETED] | User's account status (Invited, Active, Deleted) |
| company | String | Users company name |
| String | Users email | |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| externally_managed | Boolean | Is this user sourced from outside Moxion (ie SCIM)? |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_only | Boolean | User can only view inbox |
| last_name | String | Users last name |
| project_role_id | Id | The users project role ID |
| project_role_name | String | The users project role name |
| security_group_id | Integer | The users security group ID |
| team_id | Id | Team associated with this user |
This endpoint will import a structure parsed from a CSV file. It will assign users to teams, if user does not exists, this process will create those users as well
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | Id | The id of the company in which these teams will be imported | Valid Id |
| filename | Yes | String | The rout of the file which is going to be imported | No HTML tags No {{ }} expressions |
| group_id | No | CommonId | The id of the group in which these teams will be imported | Valid CommonId |
| original_filename | Yes | String | The name of the file which is going to be imported | No HTML tags No {{ }} expressions |
| validate_only | Yes | Boolean | If this parameter is set to true the process will run the entire process without committing the changes | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | The id of running task |
Create template from an existing group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | Yes | CommonId | The ID of the group to copy | Valid CommonId |
| include_projects | Yes | Boolean | Include the project structure and settings with this template | Valid Boolean |
| include_teams | Yes | Boolean | Include teams from the source group in this template, if you require the users within the teams you must specify include_users | Valid Boolean |
| include_users | Yes | Boolean | Include users from the source group in this template | Valid Boolean |
| name | Yes | String | The name of the new template | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| task_id | String | The processing task that will handle the copy of this group |
| template_id | Id | The template ID that has been created |
Delete template
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| template_id | Yes | Id | The ID of the template to delete | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | Was the template deleted |
Get available templates
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | No | Id | Include only groups for this company ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| additional_rooms | Integer | Additional rooms purchased for this production |
| allowed_settings | Object | List of allowed settings that be selected for this group |
| asset_project_id | CommonId | The Project ID to upload Group Assets, e.g. Production Posters |
| available_rooms | Integer | Available Rooms |
| background_image_url | String | The production background image url |
| blurhash | String | A hashed representation of the asset |
| can_create_rooms | Boolean | If the requesting user can create rooms in this group |
| can_create_root_folder | Boolean | Can this user create a folder at the root level? |
| can_create_template | Boolean | Can this user create a template from this group? |
| can_delete_template | Boolean | Does the user have permission to delete this template? |
| can_display_production_settings | Boolean | True if the user can see the 'Production Setting' for this group? |
| can_display_watermarking | Boolean | True if the user can see the 'Watermarking' feature |
| can_link_to_flow_project | Boolean | Can this group be linked to a Flow Project. User must have permission and the feature must be enabled. |
| can_move_group | Boolean | Can this user move production from this group? |
| can_update_participants | Boolean | If the requesting user can update group participants |
| can_update_template | Boolean | Does the user have permission to edit/update this template? |
| can_view_participants | Boolean | If the requesting user can view group participants |
| child_count | Integer | Number of immediate child projects |
| color | Integer | Group color |
| company_id | Id | The company id for this group |
| company_name | String | The company name for this group (only populated for the home API) |
| copied_from_group_id | CommonId | The group ID that this template was originally copied from |
| copied_from_group_name | String | Name of the group (production) that this template was originally copied from |
| created | Date | The group creation time |
| description | String | The group description |
| flow_id | String | The native Flow ID of this group, without encryption. Only provided if this is a Flow Group. |
| flow_project_id | String | If a Flow Production is linked, the Flow ID of said production. |
| flow_project_name | String | If a Flow Production is linked, the Name of linked production. |
| forensic_watermarking | Boolean | is forensic watermarking enabled |
| forensic_watermarking_definition_level | String | at what point is the forensic watermarking flag turned on (Company, Group etc) |
| forensic_watermarking_minimum_length_seconds | Integer | The minimum length in seconds for videos to set a forensic watermark. |
| id | CommonId | The group ID |
| is_admin | Boolean | If the requesting user is the production admin |
| is_company_admin | Boolean | If the requesting user is a company admin |
| is_linked_to_flow_project | Boolean | Do we have a link to a Flow Project established? |
| is_owner | Boolean | If the requesting user is the owner |
| is_pinned | Boolean | If the requesting user pinned this production |
| license_id | Id | The license assigned to the group |
| license_type | String | The type of license assigned to the group |
| licensed_rooms | Integer | Licensed Rooms |
| name | String | The group name |
| named_licenses_available | Integer | Total Number of named licenses available for the company |
| named_licenses_used | Integer | Number of named licenses used by the production |
| origin_type | Enum [MOXION, FLOW] | The group origin type |
| owner | Id | The user id of the group owner |
| owner_first_name | String | First name of the template owner/creator |
| owner_last_name | String | Last name of the template owner/creator |
| production_folder_id | CommonId | The production folder id for this group |
| production_poster_asset | Object | The Asset Id of the Production Poster (if present) |
| production_poster_url | String | The Path to the Production Poster |
| project_count | Integer | Count of active projects for a template |
| projects | CommonIdArray | Array of project IDs contained in this group |
| settings | Object | Group settings |
| sizes | Object | The group sizes |
| status | Enum [ACTIVE, PENDING, DELETED] | The group status |
| suspended | Date | Time when the group was suspended (Epoch when not suspended) |
| team_count | Integer | Count of active teams for a template |
| thumbnail_position | Float | The thumbnail position for assets in the group |
| total_uploaded_usage | Integer | Total uploaded usage in bytes |
| total_usage | Integer | Total usage in bytes |
| transaction_reference | String | Property used to map ECA number |
| transcode_formats | Object | The transcode formats for assets in the group |
| user_count | Integer | Count of active users for a template |
| watermark_settings | Object | The group watermark settings |
Aborts a multipart asset upload
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| key | Yes | String | Key of the upload (ex AWS) | No HTML tags No {{ }} expressions |
| upload_id | Yes | String | ID of the upload (ex AWS) | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|
Completes an asset multipart upload
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| batch_hidden | No | Boolean | Whether the batch is hidden | Valid Boolean |
| batch_id | No | CommonId | The batch ID, required when uploading to an existing batch | Valid CommonId |
| batch_name | No | String | The batch name, required when uploading to a new batch | No HTML tags No {{ }} expressions Length must not exceed 100 |
| etags | Yes | StringArray | Part number | Valid StringArray |
| filename | Yes | String | Filename | No HTML tags No {{ }} expressions |
| key | Yes | String | Key of the upload (ex AWS) | No HTML tags No {{ }} expressions |
| priority | No | Enum [PRIORITY, BACKGROUND] | Priority that this process should be run with | Valid Enum |
| project_id | No | CommonId | The project ID | Valid CommonId |
| sns_topic | No | String | AWS SNS topic to notify about asset processing progress | No HTML tags No {{ }} expressions |
| upload_id | Yes | String | ID of the upload (ex AWS) | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| asset_id | CommonId | The asset ID that is going to be created |
Begin uploading an asset to the upload bucket. Uses the AWS multipart upload API.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| filename | Yes | String | Name of the file to upload | No HTML tags No {{ }} expressions |
| project_id | No | CommonId | The project ID, required unless using device authentication | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| key | String | key of the file to upload, as provided by AWS |
| upload_id | String | upload_id of the upload, as provided by AWS |
Returns the presigned URL for an UploadPart. URL is valid for 5 minutes from issue.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| content_md5 | No | String | Base64 encoded MD5 hash of the part's data | No HTML tags No {{ }} expressions |
| key | Yes | String | Key of the upload (ex AWS) | No HTML tags No {{ }} expressions |
| part_number | Yes | Integer | Part number | Valid Integer |
| upload_id | Yes | String | ID of the upload (ex AWS) | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| presigned_url | String | URL to upload the part to. |
Upload an asset from an S3 bucket. Optionally from a presigned url or specified bucket details.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| access_key_id | No | String | AWS Access Key ID | No HTML tags No {{ }} expressions |
| batch_hidden | No | Boolean | Whether the batch is hidden | Valid Boolean |
| batch_id | No | CommonId | The batch ID, required when uploading to an existing batch | Valid CommonId |
| batch_name | No | String | The batch name, required when uploading to a new batch | No HTML tags No {{ }} expressions Length must not exceed 100 |
| bucket | No | String | S3 Bucket | No HTML tags No {{ }} expressions |
| filename | Yes | String | Name of the file to upload | No HTML tags No {{ }} expressions |
| key | Yes | String | The S3 object key of the uploaded file | No HTML tags No {{ }} expressions |
| path_prefix | No | String | Folder prefix to use for all S3 operations | No HTML tags No {{ }} expressions |
| presigned_url | No | String | Presigned URL of file to upload from S3 bucket | No HTML tags No {{ }} expressions |
| priority | No | Enum [PRIORITY, BACKGROUND] | Priority that this process should be run with | Valid Enum |
| project_id | No | CommonId | The project ID, required unless using device authentication | Valid CommonId |
| region | No | String | The S3 Region | No HTML tags No {{ }} expressions |
| secret_access_key | No | String | AWS Secret Access Key | No HTML tags No {{ }} expressions |
| session_token | No | String | AWS Session Token (if using STS) | No HTML tags No {{ }} expressions |
| sns_topic | No | String | AWS SNS topic to notify about asset processing progress | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| asset_id | CommonId | The asset ID that for the asset that was created |
| task_id | String | The ID of the upload Task, can be used to track success or failure |
Get list of all usecases in the system
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|---|---|
| display_name | String | Name to display in UI |
| id | Id | Unique Id for this usecase |
Get public user information for the given email address
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| Yes | String | The user's email address | Length must not exceed 254 Valid email format |
| Parameter | Type | Description |
|---|---|---|
| company | String | Users company name |
| String | The user's email address | |
| first_name | String | Users first name |
| id | Id | The user ID |
| last_name | String | Users last name |
Get a list of all default user security groups
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | No | Id | The company ID of the security group | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| can_assign_job_to_others | Boolean | Can the user assign jobs to other users |
| can_create_playlinks | Boolean | Can the user create new playlinks |
| can_delete_assets | Boolean | Can the user delete assets |
| can_delete_users | Boolean | Can the user remove other users from the project |
| can_download | Boolean | Can the user download assets |
| can_invite_users | Boolean | Can the user invite new or existing users to the project |
| can_upload | Boolean | Can the user upload assets |
| can_view | Boolean | Can the user view/playback assets |
| id | Integer | The security group ID |
| is_admin | Boolean | This security group is for a project administrator |
| lang_key | String | Language key |
| name | String | The name of the security group |
Get this users details (the currently connected user)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| autoplay_video | Boolean | If video should automatically begin playback |
| can_link_to_flow | Boolean | Is the option 'Link to Flow user' available in the UI? |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| elevio_hash | String | Elevio authentication hash |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| email_share_cc_users | Array | A list of users which should be notify as well on summary emails for inbox-only shares |
| email_share_frequency | Enum [INSTANT, DAILY, WEEKLY] | If true the user will receive summary emails for inbox-only shares |
| email_share_notification | Boolean | If true the user will receive summary emails for inbox-only shares |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| externally_managed | Boolean | Is this user sourced from outside Moxion (ie SCIM)? |
| first_name | String | Users first name |
| helpscout_user_signature | String | Helpscout user signature |
| helpscout_user_signature_mx6 | String | Helpscout user signature for MX6 |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| linked_to_flow_user | Boolean | Is this user currently linked to a Flow user? |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| phone | String | Users phone number |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| server_time | Date | Current server time (ISO format) |
| session_data | String | Users persistent app session data |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
Get all associated users / participants
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| exclude_project | No | CommonId | Exclude users who are already connected to this project ID | Valid CommonId |
| include_inactive | No | Boolean | Include users who no longer have access to this project | Valid Boolean |
| project_id | Yes | CommonId | Only get the users related to this project | Valid CommonId |
| required_permission | No | String | Only include users who have the specified permission | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| account_status | Enum [INVITED, ACTIVE, DELETED] | User's account status (Invited, Active, Deleted) |
| company | String | Users company name |
| String | Users email | |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_only | Boolean | User can only view inbox |
| last_name | String | Users last name |
| project_permissions | Array | Array of group and team permissions for this user |
Invite a new (or existing) user to an existing project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company | No | String | Users company name | No HTML tags No {{ }} expressions Length must not exceed 100 |
| company_id | No | CommonId | The company id for this invite | Valid CommonId |
| Yes | String | Users email | Length must not exceed 254 Valid email format | |
| first_name | Yes | String | Users first name | No HTML tags No {{ }} expressions Length must not exceed 100 |
| group_id | No | CommonId | The group id for this invite | Valid CommonId |
| inbox_only | No | Boolean | Users inbox only setting | Valid Boolean |
| last_name | Yes | String | Users last name | No HTML tags No {{ }} expressions Length must not exceed 100 |
| project_id | No | CommonId | The project this user is being invited to | Valid CommonId |
| project_role | No | String | The role for this user on this project | No HTML tags No {{ }} expressions |
| security_group | Yes | Integer | The security group this user will have on the project | Valid Integer |
| Parameter | Type | Description |
|---|---|---|
| accessed | Date | Last time the user accessed the system |
| account_status | Enum [INVITED, ACTIVE, DELETED] | The user account status |
| allow_support_access | Boolean | Whether Moxion support is allowed access to your account |
| api_key_created | Date | Last time the API key was created |
| api_key_last_used | Date | Last time the API key was used |
| api_key_prefix | String | Current API key prefix |
| autoplay_video | Boolean | If video should automatically begin playback |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| consent_check_required | Boolean | True if a Consent Check is required for this user. Default is False. |
| country | String | Present user country (based on IP geolocation) |
| country_code | String | Present user country code (based on IP geolocation) |
| dateformat | String | Users current date and time format |
| String | Users email | |
| email_notification_comment | Boolean | Get email notifications when someone comments |
| email_notification_delete | Boolean | Get email notifications when someone deletes assets |
| email_notification_download | Boolean | Get email notifications when someone downloads |
| email_notification_folder_add | Boolean | Get Email Notifications when a user is added to a folder |
| email_notification_immediates | Boolean | Get email notifications when immediate footage is uploaded |
| email_notification_immediates_interval | Integer | Interval in minutes to receive immediate footage email notifications |
| email_notification_screencapture | Boolean | Get email notifications when someone does screen capture |
| email_notification_upload | Boolean | Get email notifications when someone uploads |
| email_notification_view | Boolean | Get email notifications when someone views an asset |
| email_notification_view_audio | Boolean | Get email notifications when someone views an audio asset |
| email_notification_view_image | Boolean | Get email notifications when someone views an image asset |
| external_idp_id | String | The user's unique ID as provided by the external Identity Provider (eg Okta) |
| first_name | String | Users first name |
| id | Id | The user ID |
| inbox_days_until_archive | Integer | The number of days an inbox message stays in the inbox before being auto-archived |
| inbox_only | Boolean | User can only view inbox |
| invited | Boolean | True if successful project invitation has been created |
| ip_address | String | Present users IP address |
| last_name | String | Users last name |
| latitude | Float | Present user latitude (based on IP geolocation) |
| longitude | Float | Present longitude (based on IP geolocation) |
| mx6_autoplay | Boolean | Enable Autoplay for MX6 Player |
| mx6_player | Boolean | Use the experimental MX6 Player |
| new_user | Boolean | True if a new user has been created, false if they already existed |
| phone | String | Users phone number |
| playout_percent | Float | Percentage of playout used relative to the plan limits |
| playout_total | Integer | Total amount of playout available |
| playout_used | Integer | Amount of playout used in bytes |
| project_role | String | Users role on the current project (only set for project related requests) |
| project_security_group | Integer | Users security group on the current project (only set for project related requests) |
| region | String | Present user region (based on IP geolocation) |
| remember_playback_position | Boolean | Remember the playback position for video |
| rooms_only | Boolean | This user should only see the rooms tab |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, ANONYMIZED] | Users current activity status |
| storage_percent | Float | Percentage of storage used relative to the plan limits |
| storage_total | Integer | Total amount of storage available |
| storage_used | Integer | Amount of storage used in bytes |
| sysop | Boolean | User is a SysOp |
| timezone | String | Users current timezone |
| trans_mins_percent | Float | Percentage of transcode minutes used relative to the plan limits |
| trans_mins_total | Integer | Total amount of transcode minutes available |
| trans_mins_used | Integer | Amount of transcode minutes used |
| type | String | The type of user |
Send a server ping (with user credentials)
Token Required: No| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|---|---|
| buildId | String | Server build ID |
| buildTime | String | Server build time |
| ip | String | User IP address |
| maintenance_mode | Boolean | If true server has gone into maintenance mode, client should reconnect to next available server |
| pong | Boolean | Always true |
| sourceVersion | String | Server Source Version |
| time | String | Current server time in ISO format |
Update the User's consent for Privacy, ToS, Marketing, etc
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| consented | No | Boolean | User has Consented to Required Documents | Valid Boolean |
| marketing_subscription | No | Boolean | Subscribe the User to Marketing Communications | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | True if Successful |
This method will create a watermark with the specified parameters
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | Id | The company this watermark relates to | Valid Id |
| description | Yes | String | The watermark description | No HTML tags No {{ }} expressions |
| group_id | Yes | CommonId | The group this watermark relates to | Valid CommonId |
| playlink_id | No | Id | Playlink id associated with the watermark | Valid Id |
| watermark | Yes | Object | The JSON watermark layout | Valid Object |
| Parameter | Type | Description |
|---|---|---|
| company_id | Id | The company who owns this watermark |
| description | String | The description of this watermark |
| group_id | CommonId | The group who owns this watermark |
| owner_id | Id | The Owner of the Watermark |
| playlink_id | Id | Returns playlink id associated with the watermark |
| url | String | A thumbnail rendition of this watermark |
| usage_count | Integer | Number of times the watermark is used |
| watermark | Object | The watermark definition |
| watermark_id | Id | The Watermark ID |
This endpoint will delete the specified watermark
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| watermark_id | Yes | Id | The id of the watermark that will be deleted | Valid Id |
| Parameter | Type | Description |
|---|
This endpoint will obtain the specified watermark
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| watermark_id | Yes | Id | The id of the watermark that will be obtained | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| company_id | Id | The company who owns this watermark |
| description | String | The description of this watermark |
| group_id | CommonId | The group who owns this watermark |
| owner_id | Id | The Owner of the Watermark |
| playlink_id | Id | Returns playlink id associated with the watermark |
| url | String | A thumbnail rendition of this watermark |
| usage_count | Integer | Number of times the watermark is used |
| watermark | Object | The watermark definition |
| watermark_id | Id | The Watermark ID |
This endpoint will obtain all the watermarks for the specified company and group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | Yes | CommonId | The company to list watermark templates for | Valid CommonId |
| group_id | No | CommonId | The group to list watermark templates for | Valid CommonId |
| Parameter | Type | Description |
|---|---|---|
| company_id | Id | The company who owns this watermark |
| description | String | The description of this watermark |
| group_id | CommonId | The group who owns this watermark |
| owner_id | Id | The Owner of the Watermark |
| playlink_id | Id | Returns playlink id associated with the watermark |
| url | String | A thumbnail rendition of this watermark |
| usage_count | Integer | Number of times the watermark is used |
| watermark | Object | The watermark definition |
| watermark_id | Id | The Watermark ID |
This method will update a watermark with the specified data
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | No | String | The watermark description | No HTML tags No {{ }} expressions |
| playlink_id | No | Id | Playlink id associated with the watermark | Valid Id |
| watermark | No | Object | The JSON watermark layout | Valid Object |
| watermark_id | Yes | Id | The id of the watermark that will be updated | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| company_id | Id | The company who owns this watermark |
| description | String | The description of this watermark |
| group_id | CommonId | The group who owns this watermark |
| owner_id | Id | The Owner of the Watermark |
| playlink_id | Id | Returns playlink id associated with the watermark |
| url | String | A thumbnail rendition of this watermark |
| usage_count | Integer | Number of times the watermark is used |
| watermark | Object | The watermark definition |
| watermark_id | Id | The Watermark ID |
Create a new workflow
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | No | String | The description of this workflow | No HTML tags No {{ }} expressions Length must not exceed 1024 |
| destination_asset_filter | No | String | The filter text | No HTML tags No {{ }} expressions |
| destination_asset_filter_by | No | String | Filter only by a particular asset field. If not present filters on a range of fields. | No HTML tags No {{ }} expressions |
| destination_asset_filter_match | No | String | Filter matching type. Currently only 'case-insensitive contains' operation supported | No HTML tags No {{ }} expressions |
| destination_asset_identify_expression | No | String | The expression to used to identify an asset in the source project the resulting value will be used to find a matching asset in the destination | No HTML tags No {{ }} expressions |
| destination_asset_tags | No | CommonIdArray | Only fetch assets with the given tag IDs | Valid CommonIdArray |
| destination_asset_tags_match_all | No | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs | Valid Boolean |
| destination_project_id | No | CommonId | The destination project for this workflow | Valid CommonId |
| name | Yes | String | The name of this workflow | No HTML tags No {{ }} expressions Length must not exceed 45 |
| schedule_type | Yes | Enum [NONE, REALTIME] | The schedule for the workflow | Valid Enum |
| source_asset_filter | No | String | The filter text | No HTML tags No {{ }} expressions |
| source_asset_filter_by | No | String | Filter only by a particular asset field. If not present filters on a range of fields. | No HTML tags No {{ }} expressions |
| source_asset_filter_match | No | String | Filter matching type. Currently only 'case-insensitive contains' operation supported | No HTML tags No {{ }} expressions |
| source_asset_identify_expression | No | String | The expression to used to identify an asset in the source project the resulting value will be used to find a matching asset in the destination | No HTML tags No {{ }} expressions |
| source_asset_tags | No | CommonIdArray | Only fetch assets with the given tag IDs | Valid CommonIdArray |
| source_asset_tags_match_all | No | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs | Valid Boolean |
| source_project_id | No | CommonId | The source project for this workflow | Valid CommonId |
| type | Yes | Enum [COPY_ACTION, SEND_TO_SHOTGUN, COMPOSITE_VIDEO] | The type of workflow | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| created | Date | When the workflow was initially created |
| created_by_user_id | Id | The user that created the workflow |
| description | String | The description of this workflow |
| destination_asset_filter | String | The filter text |
| destination_asset_filter_by | String | Filter only by a particular asset field. If not present filters on a range of fields. |
| destination_asset_filter_match | String | Filter matching type. Currently only 'case-insensitive contains' operation supported |
| destination_asset_identify_expression | String | The expression to used to identify an asset in the source project the resulting value will be used to find a matching asset in the destination |
| destination_asset_tags | CommonIdArray | Only fetch assets with the given tag IDs |
| destination_asset_tags_match_all | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs |
| destination_project_id | CommonId | The destination project for this workflow |
| id | Id | The workflow id |
| last_edited_by_user_id | Id | The user that last edited the workflow |
| last_executed | Date | When the workflow was last executed |
| last_updated | Date | When the workflow was last updated |
| name | String | The name of this workflow |
| owner_user_id | Id | The user that the workflow will execute as |
| schedule_type | Enum [NONE, REALTIME] | The schedule for the workflow |
| source_asset_filter | String | The filter text |
| source_asset_filter_by | String | Filter only by a particular asset field. If not present filters on a range of fields. |
| source_asset_filter_match | String | Filter matching type. Currently only 'case-insensitive contains' operation supported |
| source_asset_identify_expression | String | The expression to used to identify an asset in the source project the resulting value will be used to find a matching asset in the destination |
| source_asset_tags | CommonIdArray | Only fetch assets with the given tag IDs |
| source_asset_tags_match_all | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs |
| source_project_id | CommonId | The source project for this workflow |
| type | Enum [COPY_ACTION, SEND_TO_SHOTGUN, COMPOSITE_VIDEO] | The type of workflow |
| version | Integer | The workflow version number |
Execute a workflow
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The workflow id | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | True if succeeded |
Preview destination assets a new workflow will affect before the workflow is created
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| destination_asset_filter | No | String | The filter text | No HTML tags No {{ }} expressions |
| destination_asset_filter_by | No | String | Filter only by a particular asset field. If not present filters on a range of fields. | No HTML tags No {{ }} expressions |
| destination_asset_filter_match | No | String | Filter matching type. Currently only 'case-insensitive contains' operation supported | No HTML tags No {{ }} expressions |
| destination_asset_identify_expression | No | String | The expression to used to identify an asset in the source project the resulting value will be used to find a matching asset in the destination | No HTML tags No {{ }} expressions |
| destination_asset_tags | No | CommonIdArray | Only fetch assets with the given tag IDs | Valid CommonIdArray |
| destination_asset_tags_match_all | No | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs | Valid Boolean |
| destination_project_id | No | Id | The destination project for this workflow | Valid Id |
| source_asset_filter | No | String | The filter text | No HTML tags No {{ }} expressions |
| source_asset_filter_by | No | String | Filter only by a particular asset field. If not present filters on a range of fields. | No HTML tags No {{ }} expressions |
| source_asset_filter_match | No | String | Filter matching type. Currently only 'case-insensitive contains' operation supported | No HTML tags No {{ }} expressions |
| source_asset_identify_expression | No | String | The expression to used to identify an asset in the source project the resulting value will be used to find a matching asset in the destination | No HTML tags No {{ }} expressions |
| source_asset_tags | No | CommonIdArray | Only fetch assets with the given tag IDs | Valid CommonIdArray |
| source_asset_tags_match_all | No | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs | Valid Boolean |
| source_project_id | No | CommonId | The source project for this workflow | Valid CommonId |
| type | Yes | Enum [COPY_ACTION, SEND_TO_SHOTGUN, COMPOSITE_VIDEO] | The type of workflow | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| destination_asset_id | CommonId | The source asset id |
| identify_value | String | The value obtained from the identify expression that matches the source and destination asset |
| source_asset_id | CommonId | The source asset id |
Preview destination assets a workflow will affect when next executed
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The workflow id | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| destination_asset_id | CommonId | The source asset id |
| identify_value | String | The value obtained from the identify expression that matches the source and destination asset |
| source_asset_id | CommonId | The source asset id |
Update an existing workflow
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| description | No | String | The description of this workflow | No HTML tags No {{ }} expressions Length must not exceed 1024 |
| destination_asset_filter | No | String | The filter text | No HTML tags No {{ }} expressions |
| destination_asset_filter_by | No | String | Filter only by a particular asset field. If not present filters on a range of fields. | No HTML tags No {{ }} expressions |
| destination_asset_filter_match | No | String | Filter matching type. Currently only 'case-insensitive contains' operation supported | No HTML tags No {{ }} expressions |
| destination_asset_identify_expression | No | String | The expression to used to identify an asset in the source project the resulting value will be used to find a matching asset in the destination | No HTML tags No {{ }} expressions |
| destination_asset_tags | No | CommonIdArray | Only fetch assets with the given tag IDs | Valid CommonIdArray |
| destination_asset_tags_match_all | No | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs | Valid Boolean |
| id | Yes | Id | The workflow id | Valid Id |
| name | No | String | The name of this workflow | No HTML tags No {{ }} expressions Length must not exceed 45 |
| schedule_type | No | Enum [NONE, REALTIME] | The schedule for the workflow | Valid Enum |
| source_asset_filter | No | String | The filter text | No HTML tags No {{ }} expressions |
| source_asset_filter_by | No | String | Filter only by a particular asset field. If not present filters on a range of fields. | No HTML tags No {{ }} expressions |
| source_asset_filter_match | No | String | Filter matching type. Currently only 'case-insensitive contains' operation supported | No HTML tags No {{ }} expressions |
| source_asset_identify_expression | No | String | The expression to used to identify an asset in the source project the resulting value will be used to find a matching asset in the destination | No HTML tags No {{ }} expressions |
| source_asset_tags | No | CommonIdArray | Only fetch assets with the given tag IDs | Valid CommonIdArray |
| source_asset_tags_match_all | No | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs | Valid Boolean |
| take_ownership | No | Boolean | Whether to take ownership of the workflow | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| created | Date | When the workflow was initially created |
| created_by_user_id | Id | The user that created the workflow |
| description | String | The description of this workflow |
| destination_asset_filter | String | The filter text |
| destination_asset_filter_by | String | Filter only by a particular asset field. If not present filters on a range of fields. |
| destination_asset_filter_match | String | Filter matching type. Currently only 'case-insensitive contains' operation supported |
| destination_asset_identify_expression | String | The expression to used to identify an asset in the source project the resulting value will be used to find a matching asset in the destination |
| destination_asset_tags | CommonIdArray | Only fetch assets with the given tag IDs |
| destination_asset_tags_match_all | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs |
| destination_project_id | CommonId | The destination project for this workflow |
| id | Id | The workflow id |
| last_edited_by_user_id | Id | The user that last edited the workflow |
| last_executed | Date | When the workflow was last executed |
| last_updated | Date | When the workflow was last updated |
| name | String | The name of this workflow |
| owner_user_id | Id | The user that the workflow will execute as |
| schedule_type | Enum [NONE, REALTIME] | The schedule for the workflow |
| source_asset_filter | String | The filter text |
| source_asset_filter_by | String | Filter only by a particular asset field. If not present filters on a range of fields. |
| source_asset_filter_match | String | Filter matching type. Currently only 'case-insensitive contains' operation supported |
| source_asset_identify_expression | String | The expression to used to identify an asset in the source project the resulting value will be used to find a matching asset in the destination |
| source_asset_tags | CommonIdArray | Only fetch assets with the given tag IDs |
| source_asset_tags_match_all | Boolean | If fetching by tag, only fetch assets with have ALL of the given tag IDs |
| source_project_id | CommonId | The source project for this workflow |
| type | Enum [COPY_ACTION, SEND_TO_SHOTGUN, COMPOSITE_VIDEO] | The type of workflow |
| version | Integer | The workflow version number |