API Docs

Moxion.io API Docs (2.2.5e)

Welcome to the Moxion.io API docs, for technical support or any questions related to these APIs please contact us via: hello@moxion.io

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).
Each API request must include the token in a parameter called "token".
A token is generated by calling the authenticate endpoint (/authenticate/api).
To obtain an API key pair for authentication you must contact us directly to request access.


Endpoint URLs:

HTTPS:       https://api.moxion.io
WebSockets:  wss://api.moxion.io


Simple curl example:

Authenticate and get a token:

curl 'https://api.moxion.io/authenticate/api' --data-urlencode 'api_id=YOUR_API_ID' --data-urlencode 'api_key=YOUR_API_KEY'

Fetch all projects:

curl 'https://api.moxion.io/get/projects' --data-urlencode 'token=YOUR_API_TOKEN'

Upload a file:

curl -F 'qqfile=@/path/to/file' -F 'qquuid=FILE_ID' 'https://api.moxion.io/upload' -H 'X-Token: YOUR_API_TOKEN' -H 'X-Project-ID: PROJECT_ID' -H 'X-Batch-Name: TEST_BATCH'


ERROR CODES
Numeric CodeError Message
400API endpoint does not exist
401No API request data present
403Access denied
405Invalid security token
407Invalid request data provided
410Not authorized to update this project
411Not authorized to remove this user
412You cant remove your self from your own project
413You no longer have access to this project. Please contact the project owner for more information
414Could not create this project
415Sorry, you are not authorized to update metadata on this project
420Not authorized to access this batch
430Could not create this comment
431Not authorized to access this comment
432Sorry, you cannot delete this comment
433Could not create this indicator
434Not authorized to access this asset
440Not authorized to access this asset
441This email address is already registered
442Error while generating ALE file
443Password not correct
450Invalid plan ID
461Cound not create this playlink
462Not authorized to access this playlink
470Could not create this group
481A tag with this name already exists
482This tag is still being used by existing assets
500Internal server error
501No endpoint response
600Required parameter is missing
601Not a valid enum value
700Multifactor Authentication Failed


Endpoint: /authenticate/api

Authenicate a user by their API key pair and return a secure token if successful

Token Required: No
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
api_idYesStringAPI ID
api_keyYesStringAPI Key

Response Paramaters
ParameterTypeDescription
authenticatedBooleanTrue if successful authenication
expiresIntegerThe time in seconds when the token will expire from now
tokenStringThe security token to use on further API requests


Endpoint: /copy/asset

Copy a single asset

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
batch_idYesIntegerThe batch ID this asset will be copied into
idYesIntegerThe asset ID

Response Paramaters
ParameterTypeDescription
copiedBooleanTrue if the asset was moved


Endpoint: /create/batch

Create a new empty batch

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
nameYesStringThe batch name
project_idYesIntegerThe project ID this batch belongs to

Response Paramaters
ParameterTypeDescription
createdStringThe batch creation time
creatorIntegerThe creator of this batch (user ID)
idIntegerThe batch ID
nameStringThe batch name
ownerIntegerThe owner of this batch (user ID)
project_idIntegerThe project ID this batch belongs to
statusEnum [ACTIVE, DELETED]The batch status


Endpoint: /create/beacon

Create a beacon for an asset comment marker

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
beacon_xYesFloatThe indicator beacons X position relative to the frame
beacon_yYesFloatThe indicator beacons Y position relative to the frame
comment_idYesStringThe comment ID or UUID this indicator belongs to

Response Paramaters
ParameterTypeDescription
beacon_xFloatThe indicator beacons X position relative to the frame
beacon_yFloatThe indicator beacons Y position relative to the frame
colorStringThe color of this indicator (in hex format)
comment_idIntegerThe comment ID this indicator belongs to
createdDateThe date/time this indicator was created
drawing_dataStringThe raw drawing/path data JSON
has_replyBooleanHas this indicator been replied to
idIntegerThe indicator ID
is_expiredBooleanIs this indicator expired and can no longer be edited or changed
is_ownerBooleanIs the requesting user the owner/creator of this indicator
typeStringThe indicator type will be either BEACON or DRAWING
user_idIntegerThe user ID of the person who created this comment


Endpoint: /create/comment

Create a comment on an asset

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
asset_idYesStringThe asset ID or UUID this comment belongs to
colorNoStringThe color of this comment (in hex format)
createdNoDateThe date/time this comment was created (ISO format UTC)
creator_emailNoStringThe comment creators email
creator_nameNoStringThe comment creators name
creator_roleNoStringThe comment creators role
descriptionNoStringThe actual comment text
has_markerNoBooleanIs this comment attached to a timeline marker
is_replyNoBooleanIs this comment a reply to another comment
marker_durationNoFloatThe marker duration (only set if the comment has a marker)
marker_timeNoFloatThe time offset in seconds for the comment marker (only set if the comment has a marker)
parent_idNoIntegerThe comment ID of the parent comment (only set if this comment is a reply)
uuidNoStringAssign the new comment this UUID

Response Paramaters
ParameterTypeDescription
asset_idIntegerThe asset ID this comment belongs to
colorStringThe color of this indicator (in hex format)
createdDateThe date/time this comment was created
creator_emailStringThe comment creators email
creator_nameStringThe comment creators name
creator_roleStringThe comment creators role
descriptionStringThe actual comment text
has_markerBooleanIs this comment attached to a timeline marker
has_replyBooleanHas this comment been replied to
idIntegerThe comment ID
is_expiredBooleanIs this comment expired and can no longer be edited or changed
is_ownerBooleanIs the requesting user the owner/creator of this comment
is_replyBooleanIs this comment a reply to another comment
marker_durationFloatThe marker duration (only set if the comment has a marker)
marker_timeFloatThe time offset in seconds for the comment marker (only set if the comment has a maker)
parent_idIntegerThe comment ID of the parent comment (only set if this comment is a reply)
project_idIntegerThe project ID this comment belongs to
user_first_nameStringFirst name of comment owner
user_idIntegerThe user ID of the person who created this comment
user_last_nameStringLast name of comment owner
user_project_roleStringProject role of comment owner
uuidStringThe comment UUID (if set)


Endpoint: /create/group

Create a new empty group

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
colorNoIntegerThe group color
nameYesStringThe group name
ownerNoIntegerThe user account to create the group under, if not their own account

Response Paramaters
ParameterTypeDescription
colorIntegerGroup color
idIntegerThe group ID
is_nomineeBooleanIf the requesting user a nominee on the group
is_ownerBooleanIf the requesting user is the owner
nameStringThe group name
ownerIntegerThe user id of the group owner
sharedBooleanIf the group has been shared with the requesting user


Endpoint: /create/project

Create a new empty project

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
companyNoStringThe company this project belongs to
descriptionNoStringThe project description
nameYesStringThe project name
ownerNoIntegerThe user ID of the owner of this project (the requesting user must be on the owners account delegate list)

Response Paramaters
ParameterTypeDescription
accessedDateDate/time when the project was last accessed/updated
can_delete_assetsBooleanUser can delete assets from this project
can_downloadBooleanUser can download from this project
can_invite_usersBooleanUser can invite new users to this project
can_offlineBooleanUser can store assets for offline viewing
can_uploadBooleanUser can upload into this project
can_viewBooleanUser can view assets in this project
companyStringThe project company
createdDateDate/time when the project was created
descriptionStringThe project description
drm_enabledBooleanIs DRM enabled for this project
idIntegerThe project id
is_adminBooleanIs the user who requested this project a project admin
is_nomineeBooleanIf the requesting user a nominee on the group
is_ownerBooleanIs the user who requested this project the project owner
mfa_enabledBooleanIs MFA enabled for this project
nameStringThe project name
overlay_custom_textBooleanDisplay custom text on the overlay
overlay_custom_text_valueStringOverlay custom text value
overlay_email_addressBooleanDisplay email address on the overlay
overlay_font_sizeFloatOverlay text size
overlay_opacityFloatOverlay text opacity
overlay_positionIntegerOverlay text alignment
overlay_project_nameBooleanDisplay project name on the overlay
ownerIntegerThe user id of the project owner
owner_nameStringThe name of the project owner
playout_percentFloatPercentage of playout this project has used relative to its plan limits
playout_totalIntegerTotal amount of playout this project has available
playout_usedIntegerAmount of playout this project has used in bytes
roleStringThe project role this user has on the project
sizesStringThe trancode sizes for this project
statusEnum [ACTIVE, DELETED, ARCHIVED]The project status
storage_percentFloatPercentage of storage this project has used relative to its plan limits
storage_totalIntegerTotal amount of storage this project has available
storage_usedIntegerAmount of storage this project is using in bytes
sync_metadata_fromIntegerSync metadata from project
sync_metadata_from_nameBooleanExtract metadata from the actual asset name
sync_metadata_overrideBooleanSync metadata overrride existing data
sync_metadata_patternStringSync metadata name matching pattern
thumbnail_positionFloatDefault thumbnail position (0-1)
trans_mins_percentFloatPercentage of transcode minutes this project has used relative to its plan limits
trans_mins_totalIntegerTotal amount of transcode minutes this project has available
trans_mins_usedIntegerAmount of transcode minutes this project has used


Endpoint: /create/tag

Create

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
colorYesStringThe tag color
nameYesStringThe tag name
project_idYesIntegerThe project ID this tag belongs to

Response Paramaters
ParameterTypeDescription
colorStringThe tag color
idIntegerThe tag ID
nameStringThe tag name
project_idIntegerThe proejct ID this tag belongs to


Endpoint: /delete/asset

Delete a single asset

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesIntegerThe asset ID

Response Paramaters
ParameterTypeDescription
deletedBooleanTrue if the asset was deleted


Endpoint: /delete/batch

Delete a batch

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesIntegerThe batch ID

Response Paramaters
ParameterTypeDescription
deletedBooleanTrue if the batch (and all containing assets) were deleted


Endpoint: /delete/comment

Delete a comment

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesStringThe comment ID or UUID

Response Paramaters
ParameterTypeDescription
deletedBooleanTrue if the comment (and all assoicated markers) were deleted


Endpoint: /delete/indicator

Delete an indicator

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesIntegerThe indicator ID

Response Paramaters
ParameterTypeDescription
deletedBooleanTrue if the indicator was deleted


Endpoint: /delete/tag

Delete a tag

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesIntegerThe tag ID

Response Paramaters
ParameterTypeDescription
deletedBooleanTrue if this tag has been deleted


Endpoint: /export/ale

Export an ALE file

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
asset_idsNoIntegerArrayArray of asset IDs to include in ALE file
filter_onNoStringThe metadata field to filter on
filter_valuesNoStringArrayThe metadata field values to filter on
project_idYesIntegerThe proejct ID to export from

Response Paramaters
ParameterTypeDescription
ale_urlStringThe URL to download the ALE file from


Endpoint: /get/activity

Get activity and log events

Token Required: Yes
Array Response: Yes

Request Paramaters
ParameterRequiredTypeDescription
limitNoIntegerLimit number of events returned
offsetNoIntegerOffset for limit if limit used
project_idYesIntegerThe ID of the project to get events from
typeNoStringThe activity type to filter by
unique_viewsNoBooleanOnly show unique views for asset view events
updated_sinceNoDateOnly return activities since the supplied date (ISO format)
user_idNoStringThe user ID to filter by

Response Paramaters
ParameterTypeDescription
asset_idIntegerThe asset ID the event is related to
asset_nameStringThe name of the asset related to the event (if any)
asset_typeStringThe type of the asset related to the event (if any)
batch_idIntegerThe batch ID the event is related to
batch_nameStringThe name of the batch related to the event (if any)
cityStringEvent location city (based on IP geolocation)
comment_descriptionStringThe comment description related to the event (if any)
comment_idIntegerThe comment ID the event is related to
countryStringEvent location country (based on IP geolocation)
country_codeStringEvent location country code (based on IP geolocation)
dayIntegerEvent day of the month
hourIntegerEvent hour
idIntegerThe log entry ID
ip_addressStringThe IP address of the user which created the event
latitudeFloatEvent location latitude (based on IP geolocation)
longitudeFloatEvent location longitude (based on IP geolocation)
minuteIntegerEvent minute
monthIntegerEvent month of the year
playlink_idIntegerThe playlink ID the event is related to
playlink_nameStringThe name of the playlink related to the event (if any)
project_idIntegerThe project ID the event is related to
project_user_idIntegerThe user ID of the project user who initiated this event
regionStringEvent location region (based on IP geolocation)
secondIntegerEvent second
textStringThe event text description (if any)
timeDateThe data and time of the event
typeEnum [UNKNOWN, UPLOAD, VIEW, DOWNLOAD, DELETE, INVITE, JOIN, COMMENT, LEAVE]The event type
user_first_nameStringThe first name of the user who created the event
user_idIntegerThe user ID this event is related to
user_last_nameStringThe last name of the user who created the event
yearIntegerEvent year


Endpoint: /get/asset

Fetch a single asset

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesStringThe asset ID or UUID

Response Paramaters
ParameterTypeDescription
batch_idIntegerThe batch ID this asset was belongs to
createdDateThe date/time this asset was created
descStringThe asset description
durationFloatThe asset duration (in seconds)
extStringThe original asset file extenstion
idIntegerThe asset ID
nameStringThe asset file name (without original file extenstion)
project_idIntegerThe project ID this asset belongs to
scrub_jpg_framesIntegerThe number of frames in the scrub JPG
scrub_jpg_urlStringThe URL for the scrub JPG
scrub_urlStringThe URL for the thumbnail scrubber
scrub_url_framesIntegerThe number of frames in the thumbnail scrubber
statusEnum [ACTIVE, TRANSCODING, PROCESSING, DELETED]The asset status
subclip_durationFloatIf > 0 then this asset is a subclip with this duration (in seconds)
subclip_startFloatIf > 0 then this asset is a subclip starting at this position (in seconds)
tagsIntegerArrayThe tag IDs for this asset
thumbnail_urlStringThe primary thumbnail URL for this asset
transcode_progressFloatThe total transcoding progress percentage
typeEnum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN]The asset type
user_idIntegerThe user ID this asset was created/uploaded by
uuidStringThe asset UUID (if set)


Endpoint: /get/asset/files

Get all of the files associated with an asset or if not asset ID suuplied return all asset files the user has access to

Token Required: Yes
Array Response: Yes

Request Paramaters
ParameterRequiredTypeDescription
idNoIntegerThe asset ID
playable_onlyNoBooleanOnly return web playable MP4 files
projectsNoIntegerArrayOnly get files for projects with those ids
updated_sinceNoDateOnly return assets created or updated since the supplied date (ISO format)

Response Paramaters
ParameterTypeDescription
aspect_ratioStringThe file aspect ratio
asset_idIntegerThe asset ID this file belongs to
audio_channelsIntegerThe number of audio channels
audio_codecStringThe file audio codec
audio_rateIntegerThe file audio sample rate
batch_idIntegerThe batch ID this file belongs to
bitrateFloatThe file bitrate (expressed in kbps)
containerStringThe file container format
file_nameStringThe full file name (with file extension)
frame_rateFloatThe file framerate (expressed in FPS)
heightIntegerThe file height
idIntegerThe file ID
is_dashBooleanTrue if this file points to dash manifest
is_playableBooleanTrue if this file can be played natively in the browser
project_idIntegerThe project ID this file belongs to
resolutionStringThe video resolution
statusEnum [ACTIVE, DELETED]The file status
urlStringThe signed URL where this file can be accessed
used_bytesIntegerThe file size in bytes
user_idIntegerThe user ID this file was created/uploaded by
video_codecStringThe file video codec
widthIntegerThe file width


Endpoint: /get/asset/metadata

Get a single asset including all its metadata

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesStringThe asset ID or UUID

Response Paramaters
ParameterTypeDescription
*StringWill return any key->value data
tagsIntegerArrayAsset tags
uploadedDateDate of upload


Endpoint: /get/assets

Get all assets within a batch or project or return all assets the user has access to if no batch/project ID supplied

Token Required: Yes
Array Response: Yes

Request Paramaters
ParameterRequiredTypeDescription
batch_idNoIntegerThe batch ID
project_idNoIntegerThe project ID
projectsNoIntegerArrayOnly get assets for projects with those ids
sort_byNoEnum [NEWEST, OLDEST, NAME]Sort by
updated_sinceNoDateOnly return assets created or updated since the supplied date (ISO format)

Response Paramaters
ParameterTypeDescription
batch_idIntegerThe batch ID this asset was belongs to
createdDateThe date/time this asset was created
descStringThe asset description
durationFloatThe asset duration (in seconds)
extStringThe original asset file extenstion
idIntegerThe asset ID
metadataObjectThe assets metadata
nameStringThe asset file name (without original file extenstion)
project_idIntegerThe project ID this asset belongs to
scrub_urlStringThe URL for the thumbnail scrubber
scrub_url_framesIntegerThe number of frames in the thumbnail scrubber
statusEnum [ACTIVE, TRANSCODING, PROCESSING, DELETED]The asset status
subclip_durationFloatIf > 0 then this asset is a subclip with this duration (in seconds)
subclip_startFloatIf > 0 then this asset is a subclip starting at this position (in seconds)
tagsIntegerArrayThe tag IDs for this asset
thumbnail_urlStringThe primary thumbnail URL for this asset
transcode_progressFloatThe total transcoding progress percentage
typeEnum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN]The asset type
user_idIntegerThe user ID this asset was created/uploaded by
uuidStringThe asset UUID (if set)


Endpoint: /get/batch

Get a single batch by the batch ID

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesIntegerThe batch ID

Response Paramaters
ParameterTypeDescription
createdStringThe batch creation time
creatorIntegerThe creator of this batch (user ID)
idIntegerThe batch ID
nameStringThe batch name
ownerIntegerThe owner of this batch (user ID)
project_idIntegerThe project ID this batch belongs to
statusEnum [ACTIVE, DELETED]The batch status


Endpoint: /get/batches

Get all batches from a project or if no project ID supplied return all batches the user has access to

Token Required: Yes
Array Response: Yes

Request Paramaters
ParameterRequiredTypeDescription
include_assetsNoBooleanReturn array of asset IDs belonging to the batch
project_idNoIntegerThe project ID
projectsNoIntegerArrayOnly get batches for projects with those ids
sort_byNoEnum [NEWEST, OLDEST, NAME]Sort by

Response Paramaters
ParameterTypeDescription
assetsIntegerArrayArray of asset IDs contained in this batch
createdStringThe batch creation time
creatorIntegerThe creator of this batch (user ID)
idIntegerThe batch ID
nameStringThe batch name
ownerIntegerThe owner of this batch (user ID)
project_idIntegerThe project ID this batch belongs to
statusEnum [ACTIVE, DELETED]The batch status


Endpoint: /get/comments

Get all of the comments associated with an asset or get all commets the user has access to if no asset ID supplied

Token Required: Yes
Array Response: Yes

Request Paramaters
ParameterRequiredTypeDescription
asset_idNoStringThe asset ID or UUID to get comments from
projectsNoIntegerArrayOnly get comments for projects with those ids
updated_sinceNoDateOnly return comments created/updated since the supplied date (ISO format)

Response Paramaters
ParameterTypeDescription
asset_idIntegerThe asset ID this comment belongs to
colorStringThe color of this indicator (in hex format)
createdDateThe date/time this comment was created
creator_emailStringThe comment creators email
creator_nameStringThe comment creators name
creator_roleStringThe comment creators role
descriptionStringThe actual comment text
has_markerBooleanIs this comment attached to a timeline marker
has_replyBooleanHas this comment been replied to
idIntegerThe comment ID
is_expiredBooleanIs this comment expired and can no longer be edited or changed
is_ownerBooleanIs the requesting user the owner/creator of this comment
is_replyBooleanIs this comment a reply to another comment
marker_durationFloatThe marker duration (only set if the comment has a marker)
marker_timeFloatThe time offset in seconds for the comment marker (only set if the comment has a maker)
parent_idIntegerThe comment ID of the parent comment (only set if this comment is a reply)
project_idIntegerThe project ID this comment belongs to
user_first_nameStringFirst name of comment owner
user_idIntegerThe user ID of the person who created this comment
user_last_nameStringLast name of comment owner
user_project_roleStringProject role of comment owner
uuidStringThe comment UUID (if set)


Endpoint: /get/group/projects

Get available projects for a given group

Token Required: Yes
Array Response: Yes

Request Paramaters
ParameterRequiredTypeDescription
idYesIntegerThe group ID
sort_byNoStringSort the groups by: name, company, created, accessed

Response Paramaters
ParameterTypeDescription
accessedDateDate/time when the project was last accessed/updated
can_delete_assetsBooleanUser can delete assets from this project
can_downloadBooleanUser can download from this project
can_invite_usersBooleanUser can invite new users to this project
can_offlineBooleanUser can store assets for offline viewing
can_uploadBooleanUser can upload into this project
can_viewBooleanUser can view assets in this project
companyStringThe project company
createdDateDate/time when the project was created
descriptionStringThe project description
drm_enabledBooleanIs DRM enabled for this project
idIntegerThe project id
is_adminBooleanIs the user who requested this project a project admin
is_nomineeBooleanIf the requesting user a nominee on the group
is_ownerBooleanIs the user who requested this project the project owner
mfa_enabledBooleanIs MFA enabled for this project
nameStringThe project name
overlay_custom_textBooleanDisplay custom text on the overlay
overlay_custom_text_valueStringOverlay custom text value
overlay_email_addressBooleanDisplay email address on the overlay
overlay_font_sizeFloatOverlay text size
overlay_opacityFloatOverlay text opacity
overlay_positionIntegerOverlay text alignment
overlay_project_nameBooleanDisplay project name on the overlay
ownerIntegerThe user id of the project owner
owner_nameStringThe name of the project owner
playout_percentFloatPercentage of playout this project has used relative to its plan limits
playout_totalIntegerTotal amount of playout this project has available
playout_usedIntegerAmount of playout this project has used in bytes
roleStringThe project role this user has on the project
sharedBooleanTrue if the project is shared with the requesting user
sizesStringThe trancode sizes for this project
statusEnum [ACTIVE, DELETED, ARCHIVED]The project status
storage_percentFloatPercentage of storage this project has used relative to its plan limits
storage_totalIntegerTotal amount of storage this project has available
storage_usedIntegerAmount of storage this project is using in bytes
sync_metadata_fromIntegerSync metadata from project
sync_metadata_from_nameBooleanExtract metadata from the actual asset name
sync_metadata_overrideBooleanSync metadata overrride existing data
sync_metadata_patternStringSync metadata name matching pattern
thumbnail_positionFloatDefault thumbnail position (0-1)
trans_mins_percentFloatPercentage of transcode minutes this project has used relative to its plan limits
trans_mins_totalIntegerTotal amount of transcode minutes this project has available
trans_mins_usedIntegerAmount of transcode minutes this project has used


Endpoint: /get/groups

Get available groups

Token Required: Yes
Array Response: Yes

Request Paramaters
ParameterRequiredTypeDescription
include_projectsNoBooleanReturn array of project IDs belonging to the groups
sort_byNoStringSort the groups by: name, company, created, accessed

Response Paramaters
ParameterTypeDescription
colorIntegerGroup color
idIntegerThe group ID
is_nomineeBooleanIf the requesting user a nominee on the group
is_ownerBooleanIf the requesting user is the owner
nameStringThe group name
ownerIntegerThe user id of the group owner
projectsIntegerArrayArray of project IDs contained in this group
sharedBooleanIf the group has been shared with the requesting user


Endpoint: /get/indicators

Get all of the indicators associated with a comment or get all indicators the user has access to if no comment ID supplied

Token Required: Yes
Array Response: Yes

Request Paramaters
ParameterRequiredTypeDescription
comment_idNoStringThe comment ID or UUID to get indicators from
updated_sinceNoDateOnly return indicators created/updated since the supplied date (ISO format)

Response Paramaters
ParameterTypeDescription
beacon_xFloatThe indicator beacons X position relative to the frame
beacon_yFloatThe indicator beacons Y position relative to the frame
colorStringThe color of this indicator (in hex format)
comment_idIntegerThe comment ID this indicator belongs to
createdDateThe date/time this indicator was created
drawing_dataStringThe raw drawing/path data JSON
has_replyBooleanHas this indicator been replied to
idIntegerThe indicator ID
is_expiredBooleanIs this indicator expired and can no longer be edited or changed
is_ownerBooleanIs the requesting user the owner/creator of this indicator
typeStringThe indicator type will be either BEACON or DRAWING
user_idIntegerThe user ID of the person who created this comment


Endpoint: /get/project

Get a single project by project ID

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesIntegerThe project ID

Response Paramaters
ParameterTypeDescription
accessedDateDate/time when the project was last accessed/updated
can_delete_assetsBooleanUser can delete assets from this project
can_downloadBooleanUser can download from this project
can_invite_usersBooleanUser can invite new users to this project
can_offlineBooleanUser can store assets for offline viewing
can_uploadBooleanUser can upload into this project
can_viewBooleanUser can view assets in this project
companyStringThe project company
createdDateDate/time when the project was created
descriptionStringThe project description
drm_enabledBooleanIs DRM enabled for this project
idIntegerThe project id
is_adminBooleanIs the user who requested this project a project admin
is_nomineeBooleanIf the requesting user a nominee on the group
is_ownerBooleanIs the user who requested this project the project owner
mfa_enabledBooleanIs MFA enabled for this project
nameStringThe project name
overlay_custom_textBooleanDisplay custom text on the overlay
overlay_custom_text_valueStringOverlay custom text value
overlay_email_addressBooleanDisplay email address on the overlay
overlay_font_sizeFloatOverlay text size
overlay_opacityFloatOverlay text opacity
overlay_positionIntegerOverlay text alignment
overlay_project_nameBooleanDisplay project name on the overlay
ownerIntegerThe user id of the project owner
owner_nameStringThe name of the project owner
playout_percentFloatPercentage of playout this project has used relative to its plan limits
playout_totalIntegerTotal amount of playout this project has available
playout_usedIntegerAmount of playout this project has used in bytes
roleStringThe project role this user has on the project
sizesStringThe trancode sizes for this project
statusEnum [ACTIVE, DELETED, ARCHIVED]The project status
storage_percentFloatPercentage of storage this project has used relative to its plan limits
storage_totalIntegerTotal amount of storage this project has available
storage_usedIntegerAmount of storage this project is using in bytes
sync_metadata_fromIntegerSync metadata from project
sync_metadata_from_nameBooleanExtract metadata from the actual asset name
sync_metadata_overrideBooleanSync metadata overrride existing data
sync_metadata_patternStringSync metadata name matching pattern
thumbnail_positionFloatDefault thumbnail position (0-1)
trans_mins_percentFloatPercentage of transcode minutes this project has used relative to its plan limits
trans_mins_totalIntegerTotal amount of transcode minutes this project has available
trans_mins_usedIntegerAmount of transcode minutes this project has used


Endpoint: /get/project/filters

Get list of unique metadata filters for this project (based on existing assets and their metadata)

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesIntegerThe project ID

Response Paramaters
ParameterTypeDescription
batchStringArrayList of unique batch names
reelStringArrayList of unique reel names
sceneStringArrayList of unique scene names


Endpoint: /get/project/user

Get a project user

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
project_idYesIntegerThe project ID
user_idYesIntegerThe user ID

Response Paramaters
ParameterTypeDescription
accessedDateLast time the user accessed the system
account_statusEnum [INVITED, ACTIVE, DELETED]The user account status
autoplay_videoBooleanIf video should automatically begin playback
billing_countryStringUsers country set for billing
can_delete_assetsBooleanUser can delete assets from this project
can_downloadBooleanUser can download from this project
can_invite_usersBooleanUser can invite new users to this project
can_offlineBooleanUser can store assets for offline viewing
can_uploadBooleanUser can upload into this project
can_viewBooleanUser can view assets in this project
cityStringPresent user city (based on IP geolocation)
companyStringUsers company name
countryStringPresent user country (based on IP geolocation)
country_codeStringPresent user country code (based on IP geolocation)
dateformatStringUsers current date and time format
emailStringUsers email
email_notification_commentBooleanGet email notifications when someone comments
email_notification_deleteBooleanGet email notifications when someone deletes assets
email_notification_downloadBooleanGet email notifications when someone downloads
email_notification_uploadBooleanGet email notifications when someone uploads
email_notification_viewBooleanGet email notifications when someone views an asset
first_nameStringUsers first name
idIntegerThe user ID
ip_addressStringPresent users IP address
last_nameStringUsers last name
latitudeFloatPresent user latitude (based on IP geolocation)
longitudeFloatPresent longitude (based on IP geolocation)
phoneStringUsers phone number
planIntegerThe plan ID the user is currently on
playout_percentFloatPercentage of playout used relative to the plan limits
playout_totalIntegerTotal amount of playout available
playout_usedIntegerAmount of playout used in bytes
project_roleStringThe users new project role
project_security_groupIntegerUsers security group on the current project (only set for project related requests)
regionStringPresent user region (based on IP geolocation)
security_groupIntegerThe users new security group ID
sequential_playbackBooleanIf the next asset should load automatically after playback completes for the current asset
statusEnum [ONLINE, OFFLINE, CHATTING, VIEWING, UPLOADING, IDLE]Users current activity status
storage_percentFloatPercentage of storage used relative to the plan limits
storage_totalIntegerTotal amount of storage available
storage_usedIntegerAmount of storage used in bytes
sysopBooleanUser is a SysOp
timezoneStringUsers current timezone
trans_mins_percentFloatPercentage of transcode minutes used relative to the plan limits
trans_mins_totalIntegerTotal amount of transcode minutes available
trans_mins_usedIntegerAmount of transcode minutes used


Endpoint: /get/projects

Get available projects

Token Required: Yes
Array Response: Yes

Request Paramaters
ParameterRequiredTypeDescription
include_batchesNoBooleanReturn array of batch IDs belonging to this project
include_usersNoBooleanReturn array of user IDs belonging to this project (only active users)
is_ownerNoBooleanOnly get projects the user is the owner of
projectsNoIntegerArrayOnly get projects with those ids
sort_byNoStringSort the projects by: name, company, created, accessed
statusNoEnum [ACTIVE, DELETED, ARCHIVED]Get projects only wity the project status

Response Paramaters
ParameterTypeDescription
accessedDateDate/time when the project was last accessed/updated
batchesIntegerArrayArray of user IDs
can_delete_assetsBooleanUser can delete assets from this project
can_downloadBooleanUser can download from this project
can_invite_usersBooleanUser can invite new users to this project
can_offlineBooleanUser can store assets for offline viewing
can_uploadBooleanUser can upload into this project
can_viewBooleanUser can view assets in this project
companyStringThe project company
createdDateDate/time when the project was created
descriptionStringThe project description
drm_enabledBooleanIs DRM enabled for this project
groupIntegerThe group associated with the project (if grouped)
idIntegerThe project id
is_adminBooleanIs the user who requested this project a project admin
is_nomineeBooleanIf the requesting user a nominee on the group
is_ownerBooleanIs the user who requested this project the project owner
mfa_enabledBooleanIs MFA enabled for this project
nameStringThe project name
overlay_custom_textBooleanDisplay custom text on the overlay
overlay_custom_text_valueStringOverlay custom text value
overlay_email_addressBooleanDisplay email address on the overlay
overlay_font_sizeFloatOverlay text size
overlay_opacityFloatOverlay text opacity
overlay_positionIntegerOverlay text alignment
overlay_project_nameBooleanDisplay project name on the overlay
ownerIntegerThe user id of the project owner
owner_nameStringThe name of the project owner
playout_percentFloatPercentage of playout this project has used relative to its plan limits
playout_totalIntegerTotal amount of playout this project has available
playout_usedIntegerAmount of playout this project has used in bytes
roleStringThe project role this user has on the project
sizesStringThe trancode sizes for this project
statusEnum [ACTIVE, DELETED, ARCHIVED]The project status
storage_percentFloatPercentage of storage this project has used relative to its plan limits
storage_totalIntegerTotal amount of storage this project has available
storage_usedIntegerAmount of storage this project is using in bytes
sync_metadata_fromIntegerSync metadata from project
sync_metadata_from_nameBooleanExtract metadata from the actual asset name
sync_metadata_overrideBooleanSync metadata overrride existing data
sync_metadata_patternStringSync metadata name matching pattern
thumbnail_positionFloatDefault thumbnail position (0-1)
trans_mins_percentFloatPercentage of transcode minutes this project has used relative to its plan limits
trans_mins_totalIntegerTotal amount of transcode minutes this project has available
trans_mins_usedIntegerAmount of transcode minutes this project has used
usersIntegerArrayArray of user IDs


Endpoint: /get/report

Generate a report for assets specified

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
asset_idsNoIntegerArrayArray of asset IDs to filter by, if not supplied all assets are returned
asset_orderYesStringAsset ordering
comments_reportNoBooleanSwitch report style to comments mode and include all asset comments
group_byNoStringGroup assets by
include_imagesNoBooleanInclude source images in the report ZIP
metadataYesBooleanFlag indicating if metadata files (LUT, CDL, ALE etc) should be included with the report
only_commentsNoBooleanIf comments report mode, only include assets that actually have comments
project_idYesIntegerThe project ID
save_reportNoBooleanSave this report into the project under a batch called 'Reports'

Response Paramaters
ParameterTypeDescription
zipFileStringThe CDN URL to download the generated report


Endpoint: /get/tag

Fetch a single tag

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesIntegerThe tag ID

Response Paramaters
ParameterTypeDescription
colorStringThe tag color
idIntegerThe tag ID
nameStringThe tag name
project_idIntegerThe proejct ID this tag belongs to


Endpoint: /get/tags

Fetch all tags that belongs to a project

Token Required: Yes
Array Response: Yes

Request Paramaters
ParameterRequiredTypeDescription
project_idYesIntegerThe project ID

Response Paramaters
ParameterTypeDescription
colorStringThe tag color
idIntegerThe tag ID
nameStringThe tag name
project_idIntegerThe proejct ID this tag belongs to


Endpoint: /get/user

Get this users details (the currently connected user)

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription

Response Paramaters
ParameterTypeDescription
accessedDateLast time the user accessed the system
account_statusEnum [INVITED, ACTIVE, DELETED]The user account status
autoplay_videoBooleanIf video should automatically begin playback
billing_countryStringUsers country set for billing
card_numberStringUsers currently stored credit card number (masked)
cityStringPresent user city (based on IP geolocation)
companyStringUsers company name
countryStringPresent user country (based on IP geolocation)
country_codeStringPresent user country code (based on IP geolocation)
dateformatStringUsers current date and time format
emailStringUsers email
email_notification_commentBooleanGet email notifications when someone comments
email_notification_deleteBooleanGet email notifications when someone deletes assets
email_notification_downloadBooleanGet email notifications when someone downloads
email_notification_uploadBooleanGet email notifications when someone uploads
email_notification_viewBooleanGet email notifications when someone views an asset
first_nameStringUsers first name
idIntegerThe user ID
ip_addressStringPresent users IP address
last_nameStringUsers last name
latitudeFloatPresent user latitude (based on IP geolocation)
longitudeFloatPresent longitude (based on IP geolocation)
phoneStringUsers phone number
planIntegerThe plan ID the user is currently on
playout_percentFloatPercentage of playout used relative to the plan limits
playout_totalIntegerTotal amount of playout available
playout_usedIntegerAmount of playout used in bytes
project_roleStringUsers role on the current project (only set for project related requests)
project_security_groupIntegerUsers security group on the current project (only set for project related requests)
regionStringPresent user region (based on IP geolocation)
remember_playback_positionBooleanRemember the playback position for video
sequential_playbackBooleanIf the next asset should load automatically after playback completes for the current asset
session_dataStringUsers persistent app session data
statusEnum [ONLINE, OFFLINE, CHATTING, VIEWING, UPLOADING, IDLE]Users current activity status
storage_percentFloatPercentage of storage used relative to the plan limits
storage_totalIntegerTotal amount of storage available
storage_usedIntegerAmount of storage used in bytes
sysopBooleanUser is a SysOp
timezoneStringUsers current timezone
trans_mins_percentFloatPercentage of transcode minutes used relative to the plan limits
trans_mins_totalIntegerTotal amount of transcode minutes available
trans_mins_usedIntegerAmount of transcode minutes used


Endpoint: /move/asset

Move a single asset

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
batch_idYesIntegerThe batch ID this asset will be moved into
idYesIntegerThe asset ID

Response Paramaters
ParameterTypeDescription
movedBooleanTrue if the asset was moved


Endpoint: /ping

Send a server ping (with user credentials)

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription

Response Paramaters
ParameterTypeDescription
maintenance_modeBooleanIf true server has gone into maintenance mode, client should reconnect to next available server
pongBooleanAlways true
timeStringCurrent server time in ISO format


Endpoint: /server-status

Check the server status

Token Required: No
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription

Response Paramaters
ParameterTypeDescription
okBooleanShould be true unless theres a problem...
status_errorStringAny error messages


Endpoint: /sync/metadata

Sync metadata from a master project to all slave projects

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
master_idYesIntegerThe master project ID
slave_idYesIntegerThe slave project ID

Response Paramaters
ParameterTypeDescription
updatedIntegerThe total number of assets updated after syncing


Endpoint: /update/asset

Update metadata on a single asset

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
*NoStringWill accept any key->value data to be applied to the assets metadata
idYesStringThe asset ID or UUID
tagsNoIntegerArraySet the tags for the asset
uuidNoStringSet the UUID for the asset

Response Paramaters
ParameterTypeDescription
updatedBooleanTrue if the asset was updated


Endpoint: /update/asset/thumbnail

Update the thumbnail position for an asset

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesStringThe asset ID or UUID
thumbnail_positionYesFloatThe new thumbnail position (0-1)

Response Paramaters
ParameterTypeDescription
batch_idIntegerThe batch ID this asset was belongs to
createdDateThe date/time this asset was created
descStringThe asset description
durationFloatThe asset duration (in seconds)
extStringThe original asset file extenstion
idIntegerThe asset ID
nameStringThe asset file name (without original file extenstion)
project_idIntegerThe project ID this asset belongs to
scrub_urlStringThe URL for the thumbnail scrubber
scrub_url_framesIntegerThe number of frames in the thumbnail scrubber
statusEnum [ACTIVE, TRANSCODING, PROCESSING, DELETED]The asset status
subclip_durationFloatIf > 0 then this asset is a subclip with this duration (in seconds)
subclip_startFloatIf > 0 then this asset is a subclip starting at this position (in seconds)
tagsIntegerArrayThe tag IDs for this asset
thumbnail_updatedBooleanTrue if new thumbnail set
thumbnail_urlStringThe primary thumbnail URL for this asset
transcode_progressFloatThe total transcoding progress percentage
typeEnum [VIDEO, IMAGE, TEXT, ZIP, AUDIO, UNKNOWN]The asset type
user_idIntegerThe user ID this asset was created/uploaded by
uuidStringThe asset UUID (if set)


Endpoint: /update/assets

Bulk update metadata on an array of assets

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
*NoStringWill accept any key->value data to be applied to the assets metadata
assetsYesIntegerArrayArray of asset IDs
tagsNoIntegerArraySet the tags for the asset

Response Paramaters
ParameterTypeDescription
updatedBooleanTrue if the assets have been updated


Endpoint: /update/batch

Update a batch

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
idYesIntegerThe batch ID
nameYesStringThe batch name

Response Paramaters
ParameterTypeDescription
createdStringThe batch creation time
creatorIntegerThe creator of this batch (user ID)
idIntegerThe batch ID
nameStringThe batch name
ownerIntegerThe owner of this batch (user ID)
project_idIntegerThe project ID this batch belongs to
statusEnum [ACTIVE, DELETED]The batch status


Endpoint: /update/beacon

Update a beacon

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
beacon_xYesFloatThe indicator beacons X position relative to the frame
beacon_yYesFloatThe indicator beacons Y position relative to the frame
idYesIntegerThe indicator ID

Response Paramaters
ParameterTypeDescription
beacon_xFloatThe indicator beacons X position relative to the frame
beacon_yFloatThe indicator beacons Y position relative to the frame
colorStringThe color of this indicator (in hex format)
comment_idIntegerThe comment ID this indicator belongs to
createdDateThe date/time this indicator was created
drawing_dataStringThe raw drawing/path data JSON
has_replyBooleanHas this indicator been replied to
idIntegerThe indicator ID
is_expiredBooleanIs this indicator expired and can no longer be edited or changed
is_ownerBooleanIs the requesting user the owner/creator of this indicator
typeStringThe indicator type will be either BEACON or DRAWING
updatedBooleanTrue if comment has been updated
user_idIntegerThe user ID of the person who created this comment


Endpoint: /update/comment

Update a comment or create a new comment if it does not exist

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
asset_idNoStringThe asset ID or UUID this comment belongs to
colorNoStringThe color of this comment (in hex format)
createdNoDateThe date/time this comment was created (ISO format UTC)
creator_emailNoStringThe comment creators email
creator_nameNoStringThe comment creators name
creator_roleNoStringThe comment creators role
descriptionNoStringThe actual comment text
has_markerNoBooleanIs this comment attached to a timeline marker
idNoStringThe comment ID or UUID
is_replyNoBooleanIs this comment a reply to another comment
marker_durationNoFloatThe marker duration (only set if the comment has a marker)
marker_timeNoFloatThe time offset in seconds for the comment marker (only set if the comment has a marker)
parent_idNoIntegerThe comment ID of the parent comment (only set if this comment is a reply)

Response Paramaters
ParameterTypeDescription
asset_idIntegerThe asset ID this comment belongs to
colorStringThe color of this indicator (in hex format)
createdDateThe date/time this comment was created
creator_emailStringThe comment creators email
creator_nameStringThe comment creators name
creator_roleStringThe comment creators role
descriptionStringThe actual comment text
has_markerBooleanIs this comment attached to a timeline marker
has_replyBooleanHas this comment been replied to
idIntegerThe comment ID
is_expiredBooleanIs this comment expired and can no longer be edited or changed
is_ownerBooleanIs the requesting user the owner/creator of this comment
is_replyBooleanIs this comment a reply to another comment
marker_durationFloatThe marker duration (only set if the comment has a marker)
marker_timeFloatThe time offset in seconds for the comment marker (only set if the comment has a maker)
parent_idIntegerThe comment ID of the parent comment (only set if this comment is a reply)
project_idIntegerThe project ID this comment belongs to
updatedBooleanTrue if comment has been updated
user_first_nameStringFirst name of comment owner
user_idIntegerThe user ID of the person who created this comment
user_last_nameStringLast name of comment owner
user_project_roleStringProject role of comment owner
uuidStringThe comment UUID (if set)


Endpoint: /update/drawing

Create or update drawing data for an comment marker

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
comment_idYesStringThe comment ID or UUID this indicator belongs to
drawing_dataYesStringThe drawing data JSON

Response Paramaters
ParameterTypeDescription
beacon_xFloatThe indicator beacons X position relative to the frame
beacon_yFloatThe indicator beacons Y position relative to the frame
colorStringThe color of this indicator (in hex format)
comment_idIntegerThe comment ID this indicator belongs to
createdDateThe date/time this indicator was created
drawing_dataStringThe raw drawing/path data JSON
has_replyBooleanHas this indicator been replied to
idIntegerThe indicator ID
is_expiredBooleanIs this indicator expired and can no longer be edited or changed
is_ownerBooleanIs the requesting user the owner/creator of this indicator
typeStringThe indicator type will be either BEACON or DRAWING
user_idIntegerThe user ID of the person who created this comment


Endpoint: /update/group

Update a group

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
colorNoIntegerThe group color
idYesIntegerThe group ID
nameNoStringThe group name
removedNoIntegerShould the group be marked as deleted

Response Paramaters
ParameterTypeDescription
colorIntegerGroup color
idIntegerThe group ID
is_nomineeBooleanIf the requesting user a nominee on the group
is_ownerBooleanIf the requesting user is the owner
nameStringThe group name
ownerIntegerThe user id of the group owner
sharedBooleanIf the group has been shared with the requesting user
updatedBooleanTrue if project has been updated


Endpoint: /update/project

Update a project

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
companyNoStringThe company this project belongs to
descriptionNoStringThe project description
drm_enabledNoBooleanDRM enabled
idYesIntegerThe project ID
mfa_enabledNoBooleanMFA enabled
nameNoStringThe project name
overlay_custom_textNoBooleanDisplay custom text on the overlay
overlay_custom_text_valueNoStringOverlay custom text value
overlay_email_addressNoBooleanDisplay email address on the overlay
overlay_font_sizeNoFloatOverlay text size
overlay_opacityNoFloatOverlay text opacity
overlay_positionNoIntegerOverlay text alignment
overlay_project_nameNoBooleanDisplay project name on the overlay
sizesNoStringThe trancode sizes for this project
statusNoEnum [ACTIVE, DELETED, ARCHIVED]The project status
sync_metadata_fromNoIntegerSync metadata from project
sync_metadata_from_nameNoBooleanSync metadata by etracting scene/take data from the actual asset name
sync_metadata_overrideNoBooleanSync metadata overrride existing data
sync_metadata_patternNoStringSync metadata name matching pattern
thumbnail_positionNoFloatDefault thumbnail position (0-1)

Response Paramaters
ParameterTypeDescription
accessedDateDate/time when the project was last accessed/updated
can_delete_assetsBooleanUser can delete assets from this project
can_downloadBooleanUser can download from this project
can_invite_usersBooleanUser can invite new users to this project
can_offlineBooleanUser can store assets for offline viewing
can_uploadBooleanUser can upload into this project
can_viewBooleanUser can view assets in this project
companyStringThe project company
createdDateDate/time when the project was created
descriptionStringThe project description
drm_enabledBooleanIs DRM enabled for this project
idIntegerThe project id
is_adminBooleanIs the user who requested this project a project admin
is_nomineeBooleanIf the requesting user a nominee on the group
is_ownerBooleanIs the user who requested this project the project owner
mfa_enabledBooleanIs MFA enabled for this project
nameStringThe project name
overlay_custom_textBooleanDisplay custom text on the overlay
overlay_custom_text_valueStringOverlay custom text value
overlay_email_addressBooleanDisplay email address on the overlay
overlay_font_sizeFloatOverlay text size
overlay_opacityFloatOverlay text opacity
overlay_positionIntegerOverlay text alignment
overlay_project_nameBooleanDisplay project name on the overlay
ownerIntegerThe user id of the project owner
owner_nameStringThe name of the project owner
playout_percentFloatPercentage of playout this project has used relative to its plan limits
playout_totalIntegerTotal amount of playout this project has available
playout_usedIntegerAmount of playout this project has used in bytes
roleStringThe project role this user has on the project
sizesStringThe trancode sizes for this project
statusEnum [ACTIVE, DELETED, ARCHIVED]The project status
storage_percentFloatPercentage of storage this project has used relative to its plan limits
storage_totalIntegerTotal amount of storage this project has available
storage_usedIntegerAmount of storage this project is using in bytes
sync_metadata_fromIntegerSync metadata from project
sync_metadata_from_nameBooleanExtract metadata from the actual asset name
sync_metadata_overrideBooleanSync metadata overrride existing data
sync_metadata_patternStringSync metadata name matching pattern
thumbnail_positionFloatDefault thumbnail position (0-1)
trans_mins_percentFloatPercentage of transcode minutes this project has used relative to its plan limits
trans_mins_totalIntegerTotal amount of transcode minutes this project has available
trans_mins_usedIntegerAmount of transcode minutes this project has used
updatedBooleanTrue if project has been updated


Endpoint: /update/tag

Update a tag

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
colorNoStringThe tag color
idYesIntegerThe tag ID
nameNoStringThe tag name

Response Paramaters
ParameterTypeDescription
colorStringThe tag color
idIntegerThe tag ID
nameStringThe tag name
project_idIntegerThe proejct ID this tag belongs to


Endpoint: /upload

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:

Token Required: Yes
Array Response: No

Request Paramaters
ParameterRequiredTypeDescription
X-Asset-IDNoHTTP HEADERThe 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
X-Batch-IDNoHTTP HEADERThe batch ID this upload is going to
X-Batch-NameNoHTTP HEADERIf set, create a new batch with the given name and upload into
X-Project-IDYesHTTP HEADERThe project ID this upload is going to
X-TokenYesHTTP HEADERYour API token
qqfileYesBinaryThe actual binary file content (multipart/form-data)
qquuidYesStringA unique ID for this file (multipart/form-data)

Response Paramaters
ParameterTypeDescription
asset_idIntegerThe ID of the newly created or updated asset
asset_uuidStringThe UUID of the newly created or updated asset
successBooleanTrue if upload has completed