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 review session has been completed |
| REVIEW_SESSION_HOSTS_CHANGED | Review session users host status has changed |
| REVIEW_SESSION_PLAYLIST_ASSETS_UPDATED | Review session 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 |
| 403 | Access denied |
| 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. |
| 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 |
| 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 |
| 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 |
| 500 | Internal server error |
| 501 | No endpoint response |
| 600 | Required parameter is missing |
| 601 | Not a valid enum value |
| 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 review session |
| 671 | The review session contains no shareable assets |
| 672 | Review session not found |
| 673 | You are not a participant in this review session |
| 674 | The review session has not started |
| 675 | The review session is complete |
| 680 | Unable to add assets. This would exceed the maximum number of assets allowed in a playlist |
| 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 |
| 710 | The company was unable to be created |
| 712 | The team you have specified is not valid for this company |
| 714 | You cannot delete the requested user from this company |
| 720 | No assets can be found to fit the report criteria |
| 750 | This item is already in use |
| 800 | Permission denied |
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 | Id | The ID of the project to get events from | Valid Id |
| 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 | Id | 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 | Id | 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 | Id | 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 |
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 | IdArray | Array of asset IDs | Valid IdArray |
| batch_id | Yes | Id | The destination batch ID | Valid Id |
| from_project_id | Yes | Id | The source project ID | Valid Id |
| 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 | Id | The batch ID | Valid Id |
| batch_name | No | String | The batch name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| 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 |
| project_id | Yes | Id | The project ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| ok | Boolean | True if notifications sent |
Copy a single asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| batch_id | Yes | Id | The batch ID this asset will be copied into | Valid Id |
| id | Yes | Id | The asset ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| copied | Boolean | True if the asset was moved |
Create subclip asset from master asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | Id | The master asset ID | Valid Id |
| batch_id | Yes | Id | The destination batch ID | Valid Id |
| 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 a single asset
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The asset ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the asset was deleted |
Download a single asset video file
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_file_id | Yes | Id | The asset file ID | Valid Id |
| Parameter | Type | Description |
|---|
Download a single asset scrub url
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | Id | The asset file ID | Valid Id |
| Parameter | Type | Description |
|---|
Export an ALE file
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | No | IdArray | Array of asset IDs to include in ALE file | Valid IdArray |
| 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 | Id | The project ID to export from | Valid Id |
| 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_order | No | String | Group ordering | No HTML tags No {{ }} expressions |
| ignore_prefix | No | Boolean | Ignore prefixed letters for Scene | Valid Boolean |
| project_id | Yes | Id | The project ID | Valid Id |
| tags | No | IdArray | Only fetch assets with the given tag IDs | Valid IdArray |
| 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 | IdArray | Array of asset IDs |
| assets_not_playable | IdArray | Array of asset IDs that are not currently playable and should be excluded from offline selection. |
| batch_id | Id | The batch ID (if grouping by batch) |
| 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 | Id | The asset ID | Valid Id |
| 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 |
| trigger_watermarking | No | Boolean | Immediately begin the watermarking process on this asset | Valid Boolean |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| batch_id | Id | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| 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 | Id | The asset ID | |||||||||||||
| 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 | Id | 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 | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | Id | The project ID this asset belongs to | |||||||||||||
| 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] | The asset sub type | |||||||||||||
| tags | IdArray | 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. | |||||||||||||
| transcode_progress | Float | The total transcoding progress percentage | |||||||||||||
| type | Enum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN] | The asset type | |||||||||||||
| user_id | Id | 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 | Id | The asset ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| aspect_ratio | String | The file aspect ratio |
| asset_id | Id | 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 | Id | 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 | Id | 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 | Deprecated: See is_fairplay |
| is_playable | Boolean | True if this file can be played natively in the browser |
| 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 |
| project_id | Id | 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] | The file status |
| url | String | The URL where this file can be accessed |
| used_bytes | Integer | The file size in bytes |
| user_id | Id | 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 |
|---|---|---|---|---|
| id | Yes | Id | The asset ID | Valid Id |
| playable_only | No | Boolean | Only return web playable MP4 files | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| aspect_ratio | String | The file aspect ratio |
| asset_id | Id | 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 | Id | 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 | Id | 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 | Deprecated: See is_fairplay |
| is_playable | Boolean | True if this file can be played natively in the browser |
| 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 |
| project_id | Id | 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] | The file status |
| url | String | The URL where this file can be accessed |
| used_bytes | Integer | The file size in bytes |
| user_id | Id | 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 | Id | The asset ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| * | String | Will return any key->value data |
| tags | IdArray | 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 |
|---|---|---|---|---|
| assets | No | IdArray | Array of asset IDs. Ignored if the batch_id or project_id is specified. | Valid IdArray |
| batch_id | No | Id | The batch ID. | Valid Id |
| 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 |
| project_id | No | Id | The project ID. Ignored if the batch_id is specified. | Valid Id |
| projects | No | IdArray | Only get assets for projects with those ids, Ignored if batch_id, project_id or assets is specified. | Valid IdArray |
| trigger_watermarking | No | Boolean | Immediately begin the watermarking process on these assets. | Valid Boolean |
| updated_since | No | Date | Only return assets created or updated since the supplied date (ISO format). Used only when projects specified. | Valid Date |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| batch_id | Id | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| 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 | Id | The asset ID | |||||||||||||
| 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 | Id | 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 | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | Id | The project ID this asset belongs to | |||||||||||||
| 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] | The asset sub type | |||||||||||||
| tags | IdArray | 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. | |||||||||||||
| transcode_progress | Float | The total transcoding progress percentage | |||||||||||||
| type | Enum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN] | The asset type | |||||||||||||
| user_id | Id | 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
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| batch_id | No | Id | The batch ID, required when uploading to an existing batch | Valid Id |
| batch_name | No | String | The batch name, required when uploading to a new batch | No HTML tags No {{ }} expressions Length must not exceed 45 |
| project_id | Yes | Id | The project ID | Valid Id |
| 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 | Id | The batch ID this asset will be moved into | Valid Id |
| id | Yes | Id | The asset ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| moved | Boolean | True if the asset was moved |
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 |
| id | Yes | IdOrUUID | The asset ID or UUID | Valid IdOrUUID |
| tags | No | IdArray | Set the tags for the asset | Valid IdArray |
| 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 | IdOrUUID | The asset ID | Valid IdOrUUID |
| thumbnail_position | Yes | Float | The new thumbnail position (0-1) | Valid Float |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| batch_id | Id | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| 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 | Id | The asset ID | |||||||||||||
| 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 | Id | 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 | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | Id | The project ID this asset belongs to | |||||||||||||
| 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] | The asset sub type | |||||||||||||
| tags | IdArray | 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. | |||||||||||||
| transcode_progress | Float | The total transcoding progress percentage | |||||||||||||
| type | Enum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN] | The asset type | |||||||||||||
| user_id | Id | 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 | IdArray | Array of asset IDs | Valid IdArray |
| tags | No | IdArray | Set the tags for the asset | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| updated | Boolean | True if the assets have been updated |
Upload a file into a project using HTTP POST (multipart/form-data).
HTTP headers must be set on this API for authentication.
This API will only accept HTTP form post data with the following multipart form entities and headers:
| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| X-Asset-ID | No | HTTP HEADER | The asset ID or UUID. If this asset already exists it will be updated with the new file. If this asset does not exists a new asset will be created with this UUID | Valid HTTP_HEADER |
| X-Batch-ID | No | HTTP HEADER | The batch ID this upload is going to | Valid HTTP_HEADER |
| X-Batch-Name | No | HTTP HEADER | If set, create a new batch with the given name and upload into | Valid HTTP_HEADER |
| X-Project-ID | Yes | HTTP HEADER | The project ID this upload is going to | Valid HTTP_HEADER |
| X-Token | Yes | HTTP HEADER | Your API token | Valid HTTP_HEADER |
| qqfile | Yes | Binary | The actual binary file content (multipart/form-data) | Valid Binary |
| qquuid | Yes | String | A unique ID for this file (multipart/form-data) | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| asset_id | Id | The ID of the newly created or updated asset |
| asset_uuid | String | The UUID of the newly created or updated asset |
| success | Boolean | True if upload has completed |
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 45 |
| 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 |
| project_id | Yes | Id | The project ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| asset_id | Id | 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 | Id | The project ID | Valid Id |
| 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 |
|---|
| 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 |
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 |
| 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 |
| 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_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 |
| 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 |
| 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) |
| 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) |
| 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, CHATTING, VIEWING, UPLOADING, IDLE] | 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 |
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 |
| 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_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 |
| 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 |
| 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) |
| 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) |
| 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, CHATTING, VIEWING, UPLOADING, IDLE] | 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 |
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 |
| onetimetoken | String | A security token that can be exchanged excatly once for a persistent token at `/authenticate/user/onetimetoken`. 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 |
| 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 |
| 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 |
| 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_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 |
| 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 |
| 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) |
| 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) |
| 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, CHATTING, VIEWING, UPLOADING, IDLE] | 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 |
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 45 |
| project_id | Yes | Id | The project ID this batch belongs to | Valid Id |
| 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 | Id | The batch ID |
| name | String | The batch name |
| owner | Id | The owner of this batch (user ID) |
| project_id | Id | 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 | Id | The batch ID | Valid Id |
| 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 | Id | The batch ID | Valid Id |
| 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 | Id | The batch ID |
| name | String | The batch name |
| owner | Id | The owner of this batch (user ID) |
| project_id | Id | 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 | Id | The project ID | Valid Id |
| projects | No | IdArray | Only get batches for projects with those ids | Valid IdArray |
| sort_by | No | Enum [NEWEST, OLDEST, NAME] | Sort by | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| assets | IdArray | 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 | Id | The batch ID |
| name | String | The batch name |
| owner | Id | The owner of this batch (user ID) |
| project_id | Id | 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 | Id | The batch ID | Valid Id |
| name | Yes | String | The batch name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| 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 | Id | The batch ID |
| name | String | The batch name |
| owner | Id | The owner of this batch (user ID) |
| project_id | Id | 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 | IdOrUUID | The asset ID or UUID this comment belongs to | Valid IdOrUUID |
| 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 |
| parent_id | No | Id | The comment ID of the parent comment (only set if this comment is a reply) | 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] | The comment scope: ASSET or REVIEW_SESSION | Valid Enum |
| type | No | Enum [COMMENT, IO_POINT] | 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 | Id | The asset ID this comment belongs to |
| 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 | Id | 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 | Id | 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 | Id | The comment ID of the parent comment (only set if this comment is a reply) |
| project_id | Id | 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] | The comment scope (where this comment is visible) |
| type | Enum [COMMENT, IO_POINT] | The comment type |
| user_first_name | String | First name of comment owner |
| user_id | Id | 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 | IdOrUUID | The comment ID or UUID | Valid IdOrUUID |
| 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 | IdOrUUID | The asset ID | Valid IdOrUUID |
| comment_id | Yes | Id | The comment ID | Valid Id |
| review_session_id | No | Id | The ID of the realtime review session (if any) | Valid Id |
| scope | No | Enum [ASSET, REVIEW_SESSION] | The scope of the comments to retrieve. | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| asset_id | Id | The asset ID this comment belongs to |
| 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 | Id | 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 | Id | 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 | Id | The comment ID of the parent comment (only set if this comment is a reply) |
| project_id | Id | 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] | The comment scope (where this comment is visible) |
| type | Enum [COMMENT, IO_POINT] | The comment type |
| user_first_name | String | First name of comment owner |
| user_id | Id | 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 | IdOrUUID | The asset ID or UUID. | Valid IdOrUUID |
| review_session_id | No | Id | The ID of the realtime review session (if any) | Valid Id |
| scope | No | Enum [ASSET, REVIEW_SESSION] | The scope of the comments to retrieve. | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| asset_id | Id | The asset ID this comment belongs to |
| 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 | Id | 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 | Id | 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 | Id | The comment ID of the parent comment (only set if this comment is a reply) |
| project_id | Id | 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] | The comment scope (where this comment is visible) |
| type | Enum [COMMENT, IO_POINT] | The comment type |
| user_first_name | String | First name of comment owner |
| user_id | Id | 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. |
Update a comment or create a new comment if it does not exist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | No | IdOrUUID | The asset ID or UUID this comment belongs to | Valid IdOrUUID |
| 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 | IdOrUUID | The comment ID or UUID | Valid IdOrUUID |
| 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 |
| parent_id | No | Id | The comment ID of the parent comment (only set if this comment is a reply) | 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] | The comment scope: ASSET or REVIEW_SESSION | Valid Enum |
| type | No | Enum [COMMENT, IO_POINT] | 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 | Id | The asset ID this comment belongs to |
| 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 | Id | 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 | Id | 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 | Id | The comment ID of the parent comment (only set if this comment is a reply) |
| project_id | Id | 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] | The comment scope (where this comment is visible) |
| type | Enum [COMMENT, IO_POINT] | The comment type |
| updated | Boolean | True if comment has been updated |
| user_first_name | String | First name of comment owner |
| user_id | Id | 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 | Id | The comment ID | Valid Id |
| is_complete | Yes | Boolean | True to mark the comment complete, false to unmark it | Valid Boolean |
| Parameter | Type | Description |
|---|---|---|
| asset_id | Id | The asset ID this comment belongs to |
| 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 | Id | 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 | Id | 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 | Id | The comment ID of the parent comment (only set if this comment is a reply) |
| project_id | Id | 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] | The comment scope (where this comment is visible) |
| type | Enum [COMMENT, IO_POINT] | The comment type |
| updated | Boolean | True if comment has been marked completed |
| user_first_name | String | First name of comment owner |
| user_id | Id | 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 | Id | The comment ID this indicator belongs to | Valid Id |
| 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 | Id | 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 | Id | 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 | Id | Remove the user only from this specified group / production | Valid Id |
| id | Yes | Id | The company ID | Valid Id |
| projects | No | IdArray | Remove the user from these projects | Valid IdArray |
| 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 | IdArray | 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 |
|---|
| Parameter | Type | Description |
|---|---|---|
| active | Boolean | Is company active |
| admin_team | Id | The company administration team |
| 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 |
| externally_managed_users | Boolean | True if the users for this company are managed by an external system (eg SCIM) |
| 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 |
| 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 |
| 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 |
| externally_managed_users | Boolean | True if the users for this company are managed by an external system (eg SCIM) |
| 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 |
| 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 |
| Parameter | Type | Description |
|---|---|---|
| color | String | The production folder color |
| company_id | Id | The production folder's company id |
| created | Date | Creation date time |
| id | Id | The production folder id |
| name | String | The production folder name |
Get all users of this company (optionally restricted to a particular group/production)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | No | Id | Restricted by group ID | Valid Id |
| id | Yes | Id | The company ID | 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 |
| 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_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 |
| 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) |
| 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) |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, CHATTING, VIEWING, UPLOADING, IDLE] | 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 |
Update an existing company
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| active | No | Boolean | Is company active | Valid Boolean |
| domain | No | Id | The subdomain this company belongs to | Valid Id |
| 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 |
| 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 |
| 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_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 |
| 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) |
| 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) |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, CHATTING, VIEWING, UPLOADING, IDLE] | 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 |
| updated | Boolean | True if the user has 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 | IdArray | 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 | Id | The project ID to find destinations for | Valid Id |
| 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 | Id | 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 | IdArray | Array of asset IDs contained in this message | Valid IdArray |
| 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 | IdArray | 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 | Id | The project ID this destination is associated with | Valid Id |
| 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 | IdArray | 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 |
| 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: and end with /oauth2/. Mutual 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. |
| 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 |
| 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. |
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 |
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 | Id | The project ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| 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 | Id | The project ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| 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 | Id | The project ID | Valid Id |
| 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 | Id | The project ID | Valid Id |
| 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 | Id | The batch ID, required when creating live assets in an existing batch | Valid Id |
| 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 45 |
| project_id | Yes | Id | The project ID | Valid Id |
| 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 | Id | 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 | Id | The project ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| 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 | Id | The project ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| 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 |
List live registrations for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | Id | List live registrations that are currently setup for streaming into this project | Valid Id |
| 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 | Id | Qtake UUID (in URL) | Valid Id |
| 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 | Id | The asset ID linked to the stream that will be stopped | Valid Id |
| 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 | Id | Qtake UUID (in URL) | Valid Id |
| 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_download | Boolean | True if the message allows asset downloads |
| body | String | The message text |
| created | Date | The date/time this message was created |
| expire_days | Integer | The message expire days |
| expiry | Date | The message expiry time |
| group_id | Id | 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 | Id | 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 | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| batch_id | Id | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| 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 | Id | The asset ID | |||||||||||||
| 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 | Id | 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 | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | Id | The project ID this asset belongs to | |||||||||||||
| 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] | The asset sub type | |||||||||||||
| tags | IdArray | 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. | |||||||||||||
| transcode_progress | Float | The total transcoding progress percentage | |||||||||||||
| type | Enum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN] | The asset type | |||||||||||||
| user_id | Id | 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_download | Boolean | True if the message allows asset downloads |
| body | String | The message text |
| created | Date | The date/time this message was created |
| expire_days | Integer | The message expire days |
| expiry | Date | The message expiry time |
| group_id | Id | 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 | Id | 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) |
| body | String | The message text. Only returned if include_message_content is true. |
| 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 | Id | 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_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 | 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. |
| project_id | Id | 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. |
| 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. |
| type | Enum [PLAYLINK, MESSAGE] | The sent message type. Only returned if include_message_content is true. |
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) |
| body | String | The message text. Only returned if include_message_content is true. |
| 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 | Id | 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_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 | 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. |
| project_id | Id | 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. |
| 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. |
| type | Enum [PLAYLINK, MESSAGE] | The sent message type. Only returned if include_message_content is true. |
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_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) |
| body | String | The message text. Only returned if include_message_content is true. |
| 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 | Id | 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_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 | 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. |
| project_id | Id | 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. |
| 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. |
| type | Enum [PLAYLINK, MESSAGE] | The sent message type. Only returned if include_message_content is true. |
Add an asset to a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_id | Yes | Id | The asset ID | Valid Id |
| id | Yes | Id | The playlink ID | Valid Id |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| added | Boolean | True if the asset has been added | |||||||||||||
| batch_id | Id | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| 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 | Id | The asset ID | |||||||||||||
| 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 | Id | 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 | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | Id | The project ID this asset belongs to | |||||||||||||
| 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] | The asset sub type | |||||||||||||
| tags | IdArray | 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. | |||||||||||||
| transcode_progress | Float | The total transcoding progress percentage | |||||||||||||
| type | Enum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN] | The asset type | |||||||||||||
| user_id | Id | 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 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 | Id | The playlink ID | Valid Id |
| 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 |
| 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_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 |
| 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) |
| phone | String | Users phone number |
| playlink_user_id | Id | |
| 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) |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, CHATTING, VIEWING, UPLOADING, IDLE] | 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 |
Create a new empty playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| name | Yes | String | The playlink name | No HTML tags No {{ }} expressions Length must not exceed 256 |
| project_id | Yes | Id | The project ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allow_comments | Boolean | True if the playlink allows commenting |
| allow_download | Boolean | True if the playlink allows asset downloads |
| auto_play | Boolean | True if the playlink auto pays |
| created | Date | The date/time this playlink was created |
| created_by | Id | The user ID 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) |
| expire_days | Integer | The playlink expire days |
| expiry | Date | The playlink expiry time |
| id | Id | 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 |
| name | String | The playlink name |
| owner | Id | The user ID of the playlink owner |
| password | String | The playlink password |
| project | Id | 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 |
| start_date | Date | The playlink start date |
| timezone | String | Timezone of the expiry date, if any. Only used for display purposes. |
| type | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type |
| zip_url | String | The URL to download the assets from |
Delete a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The playlink ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if the playlink has been deleted |
Get a playlink
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The playlink ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allow_comments | Boolean | True if the playlink allows commenting |
| allow_download | Boolean | True if the playlink allows asset downloads |
| auto_play | Boolean | True if the playlink auto pays |
| created | Date | The date/time this playlink was created |
| created_by | Id | The user ID 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) |
| expire_days | Integer | The playlink expire days |
| expiry | Date | The playlink expiry time |
| id | Id | 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 |
| name | String | The playlink name |
| owner | Id | The user ID of the playlink owner |
| password | String | The playlink password |
| project | Id | 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 |
| start_date | Date | The playlink start date |
| timezone | String | Timezone of the expiry date, if any. Only used for display purposes. |
| type | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type |
| 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 | Id | The playlink ID | Valid Id |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| batch_id | Id | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| 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 | Id | The asset ID | |||||||||||||
| 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 | Id | 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 | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | Id | The project ID this asset belongs to | |||||||||||||
| 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] | The asset sub type | |||||||||||||
| tags | IdArray | 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. | |||||||||||||
| transcode_progress | Float | The total transcoding progress percentage | |||||||||||||
| type | Enum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN] | The asset type | |||||||||||||
| user_id | Id | 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 | Id | The playlink ID | 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 |
| 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_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 |
| 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) |
| opens | Integer | The number of times the playlink has been opened |
| phone | String | Users phone number |
| playlink_user_id | Id | |
| 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) |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, CHATTING, VIEWING, UPLOADING, IDLE] | 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 |
| user_id | Id |
Get all the playlinks for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | Id | The project ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allow_comments | Boolean | True if the playlink allows commenting |
| allow_download | Boolean | True if the playlink allows asset downloads |
| auto_play | Boolean | True if the playlink auto pays |
| created | Date | The date/time this playlink was created |
| created_by | Id | The user ID 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) |
| expire_days | Integer | The playlink expire days |
| expiry | Date | The playlink expiry time |
| id | Id | 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 |
| name | String | The playlink name |
| owner | Id | The user ID of the playlink owner |
| password | String | The playlink password |
| project | Id | 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 |
| start_date | Date | The playlink start date |
| timezone | String | Timezone of the expiry date, if any. Only used for display purposes. |
| type | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type |
| 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 | Id | The asset ID | Valid Id |
| id | Yes | Id | The playlink ID | Valid Id |
| 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 | Id | The playlink ID | Valid Id |
| user_id | Yes | Id | The user ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| removed | Boolean | True if the user has been removed |
Send a playlink to a playlink user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| playlink_id | Yes | Id | The playlink ID | Valid Id |
| 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 | Id | The asset ID | Valid Id |
| id | Yes | Id | The playlink ID | Valid Id |
| 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 |
|---|---|---|---|---|
| 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 |
| 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 |
| expire_days | No | Integer | The number of days when the playlink should expire | Valid Integer |
| expiry | No | Date | Expire date | Valid Date |
| id | Yes | Id | The playlink ID | Valid Id |
| 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 |
| 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 |
| Parameter | Type | Description |
|---|---|---|
| allow_comments | Boolean | True if the playlink allows commenting |
| allow_download | Boolean | True if the playlink allows asset downloads |
| auto_play | Boolean | True if the playlink auto pays |
| created | Date | The date/time this playlink was created |
| created_by | Id | The user ID 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) |
| expire_days | Integer | The playlink expire days |
| expiry | Date | The playlink expiry time |
| id | Id | 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 |
| name | String | The playlink name |
| owner | Id | The user ID of the playlink owner |
| password | String | The playlink password |
| project | Id | 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 |
| start_date | Date | The playlink start date |
| timezone | String | Timezone of the expiry date, if any. Only used for display purposes. |
| type | Enum [PASSWORD, OPEN, SECURE, INBOX] | The playlink type |
| updated | Boolean | True if playlink has been updated |
| zip_url | String | The URL to download the assets from |
Add assets to a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | Yes | IdArray | The asset IDs | Valid IdArray |
| id | Yes | Id | The playlist ID | Valid Id |
| 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 |
|---|---|---|---|---|
| description | No | String | The description of the playlist | No HTML tags No {{ }} expressions Length must not exceed 1024 |
| name | Yes | String | The name of the playlist | No HTML tags No {{ }} expressions Length must not exceed 45 |
| Parameter | Type | Description |
|---|---|---|
| created | Date | The playlist creation date and time |
| description | String | The playlist description |
| id | Id | The playlist ID |
| modified | Date | The playlist modified date and time |
| name | String | The name of the playlist |
| owner_id | Id | The user ID of the playlist owner |
Delete a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The playlist ID | Valid Id |
| 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 | Id | The playlist ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| created | Date | The playlist creation date and time |
| description | String | The playlist description |
| id | Id | The playlist ID |
| modified | Date | The playlist modified date and time |
| name | String | The name of the playlist |
| owner_id | Id | The user ID of the playlist owner |
Get all the assets in a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The playlist ID | Valid Id |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| batch_id | Id | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| 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 | Id | The asset ID | |||||||||||||
| 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 | Id | 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 | |||||||||||||
| playlist_asset_id | Id | The playlist asset ID | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | Id | The project ID this asset belongs to | |||||||||||||
| 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] | The asset sub type | |||||||||||||
| tags | IdArray | 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. | |||||||||||||
| transcode_progress | Float | The total transcoding progress percentage | |||||||||||||
| type | Enum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN] | The asset type | |||||||||||||
| user_id | Id | 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 owned by the current user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|
| Parameter | Type | Description |
|---|---|---|
| created | Date | The playlist creation date and time |
| description | String | The playlist description |
| id | Id | The playlist ID |
| modified | Date | The playlist modified date and time |
| name | String | The name of the playlist |
| owner_id | Id | The user ID of the playlist owner |
Remove assets from a playlist
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The playlist ID | Valid Id |
| 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 |
|---|---|---|---|---|
| description | No | String | The description of the playlist | No HTML tags No {{ }} expressions Length must not exceed 1024 |
| id | Yes | Id | The playlist ID | Valid Id |
| name | No | String | The name of the playlist | No HTML tags No {{ }} expressions Length must not exceed 45 |
| Parameter | Type | Description |
|---|---|---|
| created | Date | The playlist creation date and time |
| description | String | The playlist description |
| id | Id | The playlist ID |
| modified | Date | The playlist modified date and time |
| name | String | The name of the playlist |
| owner_id | Id | The user ID of the playlist owner |
Update the assets in a playlist - asset_ids defines asset order
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The playlist ID | Valid Id |
| 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 | Id | The company id for this production folder | Valid Id |
| 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 | Id | The production folder's company id |
| created | Date | Creation date time |
| id | Id | The production folder id |
| name | String | The production folder name |
Delete a production folder. Only empty production folder can be deleted.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The production folder id | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | True if succeed |
The production folder by id
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The production folder id | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| color | String | The production folder color |
| company_id | Id | The production folder's company id |
| created | Date | Creation date time |
| id | Id | The production folder id |
| name | String | The production folder name |
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 | Id | ID of the production folder to update | Valid Id |
| 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 | Id | The production folder's company id |
| created | Date | Creation date time |
| id | Id | The production folder id |
| name | String | The production folder name |
Add a team to an existing production
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The production ID | Valid Id |
| team_id | Yes | Id | The team ID to be added to this production | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| added | Boolean | True if team has been added to the production |
Associate a group with a list of usecases
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | Yes | Id | The group ID | Valid Id |
| usecase_ids | Yes | IdArray | List of usecases to add | Valid IdArray |
| Parameter | Type | Description |
|---|
Add a team to an existing project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The project ID | Valid Id |
| team_id | Yes | Id | The team ID to be added to this project | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| added | Boolean | True if all team members have been added to the project |
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 |
| id | Yes | Id | The ID of the project to copy | Valid Id |
| 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 | Id | The group ID of the new parent | Valid Id |
| new_parent_project_id | Yes | Id | The project ID of the new parent | Valid Id |
| 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 |
| asset_view_settings | Array | Asset view settings |
| breadcrumbs | Array | Array of breadcrumbs |
| 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_playlinks | Boolean | User can create playlinks |
| 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_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| 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 |
| company | String | The project company |
| company_id | Id | The company associated with the project |
| copied | Boolean | True if project has been copied |
| created | Date | Date/time when the project was created |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| folder_id | Id | The project folder id |
| group | Id | The group associated with the project (if grouped) |
| id | Id | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| is_owner | Boolean | Is the user who requested this project the project owner |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| overlay_custom_text | Boolean | Display custom text on the overlay |
| overlay_custom_text_value | String | Overlay custom text value |
| overlay_email_address | Boolean | Display email address on the overlay |
| overlay_font_size | Float | Overlay text size |
| overlay_opacity | Float | Overlay text opacity |
| overlay_position | Integer | Overlay text alignment |
| overlay_project_name | Boolean | Display project name on the overlay |
| owner | Id | The user id of the project owner |
| owner_name | String | The name of the project owner |
| parent_project_id | Id | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| role | String | The project role this user has on the 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 | Project alternate download format settings |
| watermark_settings | Object | Project watermark settings |
Create a new empty group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| 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 |
| expiry_date | No | Date | Production start date in ISO 8601 format | Valid Date |
| 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 |
| production_folder_id | No | Id | The production folder to create the group under | Valid Id |
| production_type | No | Enum [IN_PRODUCTION, TRIAL_PRODUCTION, MANAGED_FOLDER] | Production type | Valid Enum |
| 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 |
| usecase_ids | No | IdArray | List of usecases for this production | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| allowed_settings | Object | List of allowed settings that be selected for this group |
| can_create_root_folder | Boolean | Can this user create a folder at the root level? |
| can_update_participants | Boolean | If the requesting user can update group participants |
| can_view_participants | Boolean | If the requesting user can view group participants |
| color | Integer | Group color |
| company_id | Id | The company id for this group |
| id | Id | 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_owner | Boolean | If the requesting user is the owner |
| name | String | The group name |
| owner | Id | The user id of the group owner |
| production_folder_id | Id | The production folder id for this group |
| production_type | Enum [IN_PRODUCTION, TRIAL_PRODUCTION, MANAGED_FOLDER] | Production type |
| settings | Object | Group settings |
| sizes | Object | The group sizes |
| 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 |
| 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 |
| folder_id | No | Id | The project folder id | Valid Id |
| group_id | Yes | Id | The production ID | Valid Id |
| name | Yes | String | The project name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| parent_project_id | No | Id | The parent project id | Valid Id |
| 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 |
| asset_view_settings | Array | Asset view settings |
| breadcrumbs | Array | Array of breadcrumbs |
| 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_playlinks | Boolean | User can create playlinks |
| 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_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| 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 |
| company | String | The project company |
| company_id | Id | The company associated with the project |
| created | Date | Date/time when the project was created |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| folder_id | Id | The project folder id |
| group | Id | The group associated with the project (if grouped) |
| id | Id | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| is_owner | Boolean | Is the user who requested this project the project owner |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| overlay_custom_text | Boolean | Display custom text on the overlay |
| overlay_custom_text_value | String | Overlay custom text value |
| overlay_email_address | Boolean | Display email address on the overlay |
| overlay_font_size | Float | Overlay text size |
| overlay_opacity | Float | Overlay text opacity |
| overlay_position | Integer | Overlay text alignment |
| overlay_project_name | Boolean | Display project name on the overlay |
| owner | Id | The user id of the project owner |
| owner_name | String | The name of the project owner |
| parent_project_id | Id | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| role | String | The project role this user has on the 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 | Project alternate download format settings |
| warnings | StringArray | List of configuration warnings for this project |
| watermark_settings | Object | Project watermark settings |
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 team from this production
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The production ID | Valid Id |
| team_id | Yes | Id | The team ID to be deleted from this production | Valid Id |
| 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 | Id | The project ID | Valid Id |
| team_id | Yes | Id | The team ID to be deleted from this project | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| deleted | Boolean | True if team has been deleted from the project |
Get group by ID
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The group ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allowed_settings | Object | List of allowed settings that be selected for this group |
| can_create_root_folder | Boolean | Can this user create a folder at the root level? |
| can_update_participants | Boolean | If the requesting user can update group participants |
| can_view_participants | Boolean | If the requesting user can view group participants |
| color | Integer | Group color |
| company_id | Id | The company id for this group |
| id | Id | 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_owner | Boolean | If the requesting user is the owner |
| name | String | The group name |
| owner | Id | The user id of the group owner |
| production_folder_id | Id | The production folder id for this group |
| production_type | Enum [IN_PRODUCTION, TRIAL_PRODUCTION, MANAGED_FOLDER] | Production type |
| settings | Object | Group settings |
| sizes | Object | The group sizes |
| 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 |
| 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 | Id | The group 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 available projects for a given group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The group ID | Valid Id |
| 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 |
| asset_view_settings | Array | Asset view settings |
| breadcrumbs | Array | Array of breadcrumbs |
| 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_playlinks | Boolean | User can create playlinks |
| 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_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| 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 |
| company | String | The project company |
| company_id | Id | The company associated with the project |
| created | Date | Date/time when the project was created |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| folder_id | Id | The project folder id |
| group | Id | The group associated with the project (if grouped) |
| id | Id | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| is_owner | Boolean | Is the user who requested this project the project owner |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| overlay_custom_text | Boolean | Display custom text on the overlay |
| overlay_custom_text_value | String | Overlay custom text value |
| overlay_email_address | Boolean | Display email address on the overlay |
| overlay_font_size | Float | Overlay text size |
| overlay_opacity | Float | Overlay text opacity |
| overlay_position | Integer | Overlay text alignment |
| overlay_project_name | Boolean | Display project name on the overlay |
| owner | Id | The user id of the project owner |
| owner_name | String | The name of the project owner |
| parent_project_id | Id | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| role | String | The project role this user has on the 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 | Project alternate download format settings |
| watermark_settings | Object | Project watermark settings |
Get teams added to a group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The group 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 | Id | The production ID this team belongs to. 0 means this is a company level team |
| id | Id | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| 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 |
Get all usecases associated with a group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | Yes | Id | The group ID | Valid Id |
| 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 | Id | The group 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 |
| last_name | String | Users last name |
Get available groups
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | No | Id | Include only groups for this company ID | Valid Id |
| include_projects | No | Boolean | Return array of project IDs belonging to the groups | Valid Boolean |
| production_folder_id | No | Id | Include only groups for this production folder ID | Valid Id |
| sort_by | No | String | Sort the groups by: name, company, created, accessed | No HTML tags No {{ }} expressions |
| Parameter | Type | Description |
|---|---|---|
| allowed_settings | Object | List of allowed settings that be selected for this group |
| can_create_root_folder | Boolean | Can this user create a folder at the root level? |
| can_update_participants | Boolean | If the requesting user can update group participants |
| can_view_participants | Boolean | If the requesting user can view group participants |
| color | Integer | Group color |
| company_id | Id | The company id for this group |
| id | Id | 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_owner | Boolean | If the requesting user is the owner |
| name | String | The group name |
| owner | Id | The user id of the group owner |
| production_folder_id | Id | The production folder id for this group |
| production_type | Enum [IN_PRODUCTION, TRIAL_PRODUCTION, MANAGED_FOLDER] | Production type |
| projects | IdArray | Array of project IDs contained in this group |
| settings | Object | Group settings |
| sizes | Object | The group sizes |
| 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 |
| transcode_formats | Object | The transcode formats for assets in the group |
| watermark_settings | Object | The group watermark settings |
Get a single project by project ID
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The project ID | Valid Id |
| include_breadcrumbs | No | Boolean | Include breadcrumbs in the response data | 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 |
| asset_view_settings | Array | Asset view settings |
| breadcrumbs | Array | Array of breadcrumbs |
| 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_playlinks | Boolean | User can create playlinks |
| 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_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| 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 |
| company | String | The project company |
| company_id | Id | The company associated with the project |
| created | Date | Date/time when the project was created |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| folder_id | Id | The project folder id |
| group | Id | The group associated with the project (if grouped) |
| id | Id | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| is_owner | Boolean | Is the user who requested this project the project owner |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| overlay_custom_text | Boolean | Display custom text on the overlay |
| overlay_custom_text_value | String | Overlay custom text value |
| overlay_email_address | Boolean | Display email address on the overlay |
| overlay_font_size | Float | Overlay text size |
| overlay_opacity | Float | Overlay text opacity |
| overlay_position | Integer | Overlay text alignment |
| overlay_project_name | Boolean | Display project name on the overlay |
| owner | Id | The user id of the project owner |
| owner_name | String | The name of the project owner |
| parent_project_id | Id | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| role | String | The project role this user has on the 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 | Project alternate download format settings |
| 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 | Id | The project ID | Valid Id |
| 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 | Id | The project 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 | Id | The production ID this team belongs to. 0 means this is a company level team |
| id | Id | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| 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 |
Get usage information for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The project ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| total_uploaded_usage | Integer | Total uploaded usage in bytes, including sub-folders |
| total_usage | Integer | Total usage in bytes, including sub-folders |
Get a project user
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | Id | The project ID | Valid Id |
| 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 |
| 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 |
Get the user roles and permissions for a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| project_id | Yes | Id | The project ID | Valid Id |
| user_id | Yes | Id | The user ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| production_id | Id | The production this permission derives from |
| role | String | The users new project role |
| security_group | Object | Security details pertaining to this permission |
| team_id | Id | The team this permission derives from |
Get available projects
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| company_id | No | Id | Only get projects in this company | Valid Id |
| group_id | No | Id | Only get projects for this group (production) | Valid Id |
| include_batches | No | Boolean | Return array of batch IDs belonging to this project | 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 |
| include_users | No | Boolean | Return array of user IDs belonging to this project (only active users) | Valid Boolean |
| is_owner | No | Boolean | Only get projects the user is the owner of | Valid Boolean |
| parent_project_id | No | Id | Only get projects with this parent | Valid Id |
| projects | No | IdArray | Only get projects with those ids | Valid IdArray |
| 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 |
| sort_by | No | String | Sort the projects by: name, company, created, accessed | No HTML tags No {{ }} expressions |
| status | No | Enum [ACTIVE, DELETED, ARCHIVED] | Get projects only with the project status | Valid Enum |
| 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 |
| asset_view_settings | Array | Asset view settings |
| batches | IdArray | Array of user IDs |
| breadcrumbs | Array | Array of breadcrumbs |
| 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_playlinks | Boolean | User can create playlinks |
| 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_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| 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 | String | The project company |
| company_id | Id | The company associated with the project |
| created | Date | Date/time when the project was created |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| folder_id | Id | The project folder id |
| group | Id | The group associated with the project (if grouped) |
| id | Id | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| is_owner | Boolean | Is the user who requested this project the project owner |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| overlay_custom_text | Boolean | Display custom text on the overlay |
| overlay_custom_text_value | String | Overlay custom text value |
| overlay_email_address | Boolean | Display email address on the overlay |
| overlay_font_size | Float | Overlay text size |
| overlay_opacity | Float | Overlay text opacity |
| overlay_position | Integer | Overlay text alignment |
| overlay_project_name | Boolean | Display project name on the overlay |
| owner | Id | The user id of the project owner |
| owner_name | String | The name of the project owner |
| parent_project_id | Id | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| role | String | The project role this user has on the 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 | Project alternate download format settings |
| users | IdArray | Array of user IDs |
| watermark_settings | Object | Project watermark settings |
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 |
|---|---|---|---|---|
| project_id | Yes | Id | The project ID | Valid Id |
| teams | No | IdArray | Remove the user from these team relationships | Valid IdArray |
| 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 | IdArray | 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 |
Move a project to a new parent. Moves any subprojects as well.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The ID of the project to move | Valid Id |
| 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 | Id | The group ID of the new parent | Valid Id |
| new_parent_project_id | Yes | Id | The project ID of the new parent | Valid Id |
| 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 |
| asset_view_settings | Array | Asset view settings |
| breadcrumbs | Array | Array of breadcrumbs |
| 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_playlinks | Boolean | User can create playlinks |
| 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_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| 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 |
| company | String | The project company |
| company_id | Id | The company associated with the project |
| created | Date | Date/time when the project was created |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| folder_id | Id | The project folder id |
| group | Id | The group associated with the project (if grouped) |
| id | Id | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| is_owner | Boolean | Is the user who requested this project the project owner |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| overlay_custom_text | Boolean | Display custom text on the overlay |
| overlay_custom_text_value | String | Overlay custom text value |
| overlay_email_address | Boolean | Display email address on the overlay |
| overlay_font_size | Float | Overlay text size |
| overlay_opacity | Float | Overlay text opacity |
| overlay_position | Integer | Overlay text alignment |
| overlay_project_name | Boolean | Display project name on the overlay |
| owner | Id | The user id of the project owner |
| owner_name | String | The name of the project owner |
| parent_project_id | Id | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| role | String | The project role this user has on the 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 | Project alternate download format settings |
| updated | Boolean | True if project has been updated |
| watermark_settings | Object | Project watermark settings |
Remove a list of usecases from a group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | Yes | Id | The group ID | Valid Id |
| 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 | Id | The group ID | Valid Id |
| 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 |
Update a group
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| color | No | Integer | The group color | Valid Integer |
| id | Yes | Id | The group ID | Valid Id |
| name | No | String | The group name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| production_folder_id | No | Id | The production folder to move into | Valid Id |
| production_type | No | Enum [IN_PRODUCTION, TRIAL_PRODUCTION, MANAGED_FOLDER] | Production type | Valid Enum |
| removed | No | Integer | Should the group be marked as deleted | Valid Integer |
| settings | No | Object | The group settings | Valid Object |
| sizes | No | Object | The group sizes | Valid Object |
| 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 |
| 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 |
|---|---|---|
| allowed_settings | Object | List of allowed settings that be selected for this group |
| can_create_root_folder | Boolean | Can this user create a folder at the root level? |
| can_update_participants | Boolean | If the requesting user can update group participants |
| can_view_participants | Boolean | If the requesting user can view group participants |
| color | Integer | Group color |
| company_id | Id | The company id for this group |
| id | Id | 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_owner | Boolean | If the requesting user is the owner |
| name | String | The group name |
| owner | Id | The user id of the group owner |
| production_folder_id | Id | The production folder id for this group |
| production_type | Enum [IN_PRODUCTION, TRIAL_PRODUCTION, MANAGED_FOLDER] | Production type |
| settings | Object | Group settings |
| sizes | Object | The group sizes |
| 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 |
| 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 | Id | The project folder id | Valid Id |
| id | Yes | Id | The project ID | Valid Id |
| 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 |
| asset_view_settings | Array | Asset view settings |
| breadcrumbs | Array | Array of breadcrumbs |
| 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_playlinks | Boolean | User can create playlinks |
| 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_download | Boolean | User can download from this project |
| can_download_nonwatermarked | Boolean | User can download non-watermarked version |
| 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 |
| company | String | The project company |
| company_id | Id | The company associated with the project |
| created | Date | Date/time when the project was created |
| description | String | The project description |
| drm_enabled | Boolean | Is manifest playback is enabled for this project |
| folder_id | Id | The project folder id |
| group | Id | The group associated with the project (if grouped) |
| id | Id | The project id |
| is_admin | Boolean | Is the user who requested this project a project admin |
| is_owner | Boolean | Is the user who requested this project the project owner |
| mfa_enabled | Boolean | Is MFA enabled for this project |
| name | String | The project name |
| overlay_custom_text | Boolean | Display custom text on the overlay |
| overlay_custom_text_value | String | Overlay custom text value |
| overlay_email_address | Boolean | Display email address on the overlay |
| overlay_font_size | Float | Overlay text size |
| overlay_opacity | Float | Overlay text opacity |
| overlay_position | Integer | Overlay text alignment |
| overlay_project_name | Boolean | Display project name on the overlay |
| owner | Id | The user id of the project owner |
| owner_name | String | The name of the project owner |
| parent_project_id | Id | The parent project id |
| playlink_types | StringArray | Playlink types that are allowed to be used with this project |
| role | String | The project role this user has on the 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 | Project alternate download format settings |
| updated | Boolean | True if project has been updated |
| warnings | StringArray | List of configuration warnings for this project |
| watermark_settings | Object | Project watermark settings |
Update project specific settings for a user on a project
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| email_notification_comment | No | Boolean | Get email notifications when someone comments | Valid Boolean |
| email_notification_delete | No | Boolean | Get email notifications when someone deletes assets | Valid Boolean |
| email_notification_download | No | Boolean | Get email notifications when someone downloads | Valid Boolean |
| email_notification_immediates | No | Boolean | Get email notifications when immediate footage is uploaded | Valid Boolean |
| email_notification_immediates_interval | No | Integer | Interval in minutes to receive immediate footage email notifications | Valid Integer |
| email_notification_screencapture | No | Boolean | Get email notifications when someone does screen capture | Valid Boolean |
| email_notification_upload | No | Boolean | Get email notifications when someone uploads | Valid Boolean |
| email_notification_view | No | Boolean | Get email notifications when someone views an asset | Valid Boolean |
| project_id | Yes | Id | The project ID | Valid Id |
| 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 |
Create a new project folder
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| color | No | String | The project folder color | Valid # Hex Color Length must not exceed 10 |
| group_id | Yes | Id | The production id for this project folder | Valid Id |
| name | Yes | String | The project folder name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| Parameter | Type | Description |
|---|---|---|
| color | String | The project folder color |
| created | Date | Creation date time |
| group_id | Id | The project folder production id |
| id | Id | The project folder id |
| name | String | The project folder name |
Delete a project folder. Only empty production folder can be deleted.
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The project folder id | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | True if succeed |
Get project folder by id
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The project folder id | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| color | String | The project folder color |
| created | Date | Creation date time |
| group_id | Id | The project folder production id |
| id | Id | The project folder id |
| name | String | The project folder name |
Get all project folders for a production
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| group_id | Yes | Id | The production id for the project folder | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| color | String | The project folder color |
| created | Date | Creation date time |
| group_id | Id | The project folder production id |
| id | Id | The project folder id |
| name | String | The project folder name |
Update a project folder
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| color | No | String | The new project folder color | Valid # Hex Color Length must not exceed 10 |
| id | Yes | Id | ID of the project folder to update | Valid Id |
| name | No | String | The new project folder name | No HTML tags No {{ }} expressions Length must not exceed 45 |
| Parameter | Type | Description |
|---|---|---|
| color | String | The project folder color |
| created | Date | Creation date time |
| group_id | Id | The project folder production id |
| id | Id | The project folder id |
| name | String | The project folder name |
Generate a report for assets specified (project based)
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| asset_ids | No | IdArray | Array of asset IDs to filter by, if not supplied all assets are returned | Valid IdArray |
| 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_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 | Id | The project ID | Valid Id |
| 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 | IdArray | Array of asset IDs to filter by, if not supplied all assets are returned | Valid IdArray |
| comment_scope | No | Enum [ASSET, REVIEW_SESSION] | 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_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 |
| playlist_ids | Yes | IdArray | List of playlists to report upon. | Valid IdArray |
| report_name | No | String | Specify a custom name for the Report document and Zip file. | 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_state | String | The current asset state JSON data |
| comment_scope | Enum [ASSET, REVIEW_SESSION] | The scope of comments posted in this review session (asset or session-only) |
| 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 |
| end_time | Date | The review session end date and time |
| id | Id | The review session ID |
| 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 |
| 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 |
| 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 |
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] | The scope of the comments posted in this review session (asset or session-only) | Valid Enum |
| company_id | Yes | 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 |
| 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 | IdArray | The review session playlist IDs | Valid IdArray |
| user_ids | No | IdArray | The user IDs of review session participants | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_state | String | The current asset state JSON data |
| comment_scope | Enum [ASSET, REVIEW_SESSION] | The scope of comments posted in this review session (asset or session-only) |
| 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 |
| end_time | Date | The review session end date and time |
| id | Id | The review session ID |
| 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 |
| 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 |
| 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 |
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 | Id | The playlist ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_state | String | The current asset state JSON data |
| comment_scope | Enum [ASSET, REVIEW_SESSION] | The scope of comments posted in this review session (asset or session-only) |
| 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 |
| end_time | Date | The review session end date and time |
| id | Id | The review session ID |
| 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 |
| 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 |
| 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 |
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_state | String | The current asset state JSON data |
| comment_scope | Enum [ASSET, REVIEW_SESSION] | The scope of comments posted in this review session (asset or session-only) |
| 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 |
| end_time | Date | The review session end date and time |
| id | Id | The review session ID |
| 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 |
| 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 |
| 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 |
Get assets for a playlist in a review session
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The review session ID | Valid Id |
| playlist_id | Yes | Id | The playlist ID | Valid Id |
| Parameter | Type | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| batch_id | Id | The batch ID this asset was belongs to | |||||||||||||
| batch_name | String | The batch name | |||||||||||||
| can_comment | Boolean | User can comment on this asset | |||||||||||||
| colorspaces | StringArray | The color spaces available for this asset (SDR/HDR/DOVI) | |||||||||||||
| comment_count | Integer | Number of comments against this asset | |||||||||||||
| created | Date | The date/time this asset was created | |||||||||||||
| 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 | Id | The asset ID | |||||||||||||
| 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 | Id | 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 | |||||||||||||
| playlist_asset_id | Id | The playlist asset ID | |||||||||||||
| processing_estimate | Object | Estimated phase processing times (can be null)
| |||||||||||||
| project_id | Id | The project ID this asset belongs to | |||||||||||||
| 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] | The asset sub type | |||||||||||||
| tags | IdArray | 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. | |||||||||||||
| transcode_progress | Float | The total transcoding progress percentage | |||||||||||||
| type | Enum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN] | The asset type | |||||||||||||
| user_id | Id | 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 |
|---|---|---|
| created | Date | The playlist creation date and time |
| description | String | The playlist description |
| id | Id | The playlist ID |
| modified | Date | The playlist modified date and time |
| name | String | The name of the playlist |
| owner_id | Id | The user ID of the playlist owner |
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 |
| 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 |
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 |
| 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 |
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_state | String | The current asset state JSON data |
| comment_scope | Enum [ASSET, REVIEW_SESSION] | The scope of comments posted in this review session (asset or session-only) |
| 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 |
| end_time | Date | The review session end date and time |
| id | Id | The review session ID |
| 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 |
| 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 |
| 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 |
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_state | String | The current asset state JSON data |
| comment_scope | Enum [ASSET, REVIEW_SESSION] | The scope of comments posted in this review session (asset or session-only) |
| 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 |
| end_time | Date | The review session end date and time |
| id | Id | The review session ID |
| 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 |
| 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 |
| 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 |
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_state | String | The current asset state JSON data |
| comment_scope | Enum [ASSET, REVIEW_SESSION] | The scope of comments posted in this review session (asset or session-only) |
| 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 |
| end_time | Date | The review session end date and time |
| id | Id | The review session ID |
| 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 |
| 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 |
| 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 |
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] | 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 |
| 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 | IdArray | The review session playlist IDs | Valid IdArray |
| user_ids | No | IdArray | The user IDs of review session participants | Valid IdArray |
| Parameter | Type | Description |
|---|---|---|
| allow_participants_to_unmute_self | Boolean | Should participants be allowed to unmute themselves? |
| asset_state | String | The current asset state JSON data |
| comment_scope | Enum [ASSET, REVIEW_SESSION] | The scope of comments posted in this review session (asset or session-only) |
| 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 |
| end_time | Date | The review session end date and time |
| id | Id | The review session ID |
| 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 |
| 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 |
| 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 |
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 | Id | The moxion project ID to load shotgun settings from | Valid Id |
| 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 | Id | The moxion project ID to load shotgun settings from | Valid Id |
| 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 | IdArray | Array of moxion asset IDs to sync metadata from | Valid IdArray |
| project_id | Yes | Id | The moxion project ID to load shotgun settings from | Valid Id |
| 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 | IdArray | 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 | Id | The project ID this tag belongs to | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| color | String | The tag color |
| id | Id | The tag ID |
| name | String | The tag name |
| project_id | Id | 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 | Id | The tag ID | Valid Id |
| 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 | Id | The tag ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| color | String | The tag color |
| id | Id | The tag ID |
| name | String | The tag name |
| project_id | Id | 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 | Yes | Id | The project ID | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| color | String | The tag color |
| id | Id | The tag ID |
| name | String | The tag name |
| project_id | Id | 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 | Id | The tag ID | Valid Id |
| 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 | Id | The tag ID |
| name | String | The tag name |
| project_id | Id | The project ID this tag belongs to |
Add user to an existing team
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The team ID | Valid Id |
| 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 | Id | The production ID this team belongs to | Valid Id |
| 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 | Id | The production ID this team belongs to. 0 means this is a company level team |
| id | Id | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| 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 |
Delete a team by team id
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The team ID | Valid Id |
| productions | No | IdArray | Remove the user from these productions | Valid IdArray |
| projects | No | IdArray | Remove the user from these projects | Valid IdArray |
| 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 | IdArray | Remove the user from these productions |
| projects | IdArray | 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 | Id | The team ID | Valid Id |
| 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 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 | Id | The production ID this team belongs to. 0 means this is a company level team |
| id | Id | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| 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 |
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 |
| 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 | Yes | Id | The company 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 | Id | The production ID this team belongs to. 0 means this is a company level team |
| id | Id | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| 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 |
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 |
| 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 |
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 | Id | The team production ID, pass empty string to change to company level team | Valid Id |
| id | Yes | Id | The team ID | Valid Id |
| 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 | Id | The production ID this team belongs to. 0 means this is a company level team |
| id | Id | The team ID |
| is_admin_team | Boolean | Is this a reserved company-wide admin team? |
| 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 |
Update user details in a team
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| id | Yes | Id | The team ID | Valid Id |
| 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 |
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 the link for an external link ID that has been returned in an email
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| link_id | Yes | Id | The external link from the email message | Valid Id |
| Parameter | Type | Description |
|---|---|---|
| link | String | The external link |
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 |
| city | String | Present user city (based on IP geolocation) |
| company | String | Users company name |
| 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_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 |
| 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 |
| 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) |
| 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 |
| 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, CHATTING, VIEWING, UPLOADING, IDLE] | 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 |
Get all associated users / participants
Token Required: Yes| Parameter | Required | Type | Description | Constraints |
|---|---|---|---|---|
| exclude_project | No | Id | Exclude users who are already connected to this project ID | Valid Id |
| include_inactive | No | Boolean | Include users who no longer have access to this project | Valid Boolean |
| project_id | No | Id | Only get the users related to this project | Valid Id |
| 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 |
| 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 | Id | The company id for this invite | Valid Id |
| 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 | Id | The group id for this invite | Valid Id |
| 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 | Id | The project this user is being invited to | Valid Id |
| 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 |
| 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_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 |
| 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) |
| 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) |
| sequential_playback | Boolean | If the next asset should load automatically after playback completes for the current asset |
| status | Enum [ONLINE, OFFLINE, CHATTING, VIEWING, UPLOADING, IDLE] | 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 |
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 |
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 | IdArray | Only fetch assets with the given tag IDs | Valid IdArray |
| 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 |
| 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 | IdArray | Only fetch assets with the given tag IDs | Valid IdArray |
| 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 | Id | The source project for this workflow | Valid Id |
| type | Yes | Enum [COPY_ACTION, SEND_TO_SHOTGUN] | 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 | IdArray | 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 | Id | 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 | IdArray | 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 | Id | The source project for this workflow |
| type | Enum [COPY_ACTION, SEND_TO_SHOTGUN] | 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 | IdArray | Only fetch assets with the given tag IDs | Valid IdArray |
| 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 | IdArray | Only fetch assets with the given tag IDs | Valid IdArray |
| 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 | Id | The source project for this workflow | Valid Id |
| type | Yes | Enum [COPY_ACTION, SEND_TO_SHOTGUN] | The type of workflow | Valid Enum |
| Parameter | Type | Description |
|---|---|---|
| destination_asset_id | Id | The source asset id |
| identify_value | String | The value obtained from the identify expression that matches the source and destination asset |
| source_asset_id | Id | 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 | Id | The source asset id |
| identify_value | String | The value obtained from the identify expression that matches the source and destination asset |
| source_asset_id | Id | 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 | IdArray | Only fetch assets with the given tag IDs | Valid IdArray |
| 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 | IdArray | Only fetch assets with the given tag IDs | Valid IdArray |
| 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 | IdArray | 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 | Id | 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 | IdArray | 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 | Id | The source project for this workflow |
| type | Enum [COPY_ACTION, SEND_TO_SHOTGUN] | The type of workflow |
| version | Integer | The workflow version number |