Iconikconnector v1.0 | OneTeg Documentation

/v1/projects/{project_id}/members/

Required roles:

can_add_project_members

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Project Id`	The unique identifier of the project to which the member is added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	User ID in iconik
`Project Id`	The project identifier associated with the member record.
`System Domain Id`	The system domain identifier for the member.

/v1/{object_type}/{object_id}/shares/{share_id}/users/

Required roles:

can_write_shares

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Share Id`	The unique identifier of the share to which the user is added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (14)

Option Name	Description
`Access Count`	The number of times the share user has accessed the share.
`Email`	The email address of the share user.
`First Name`	The first name of the share user.
`Id`	The unique identifier for the share user record.
`Internal User Id`	The identifier of the internal user linked to this share user.
`Last Access Date`	The date and time of the last access by the share user.
`Last Name`	The last name of the share user.
`Object Id`	The object identifier for the share user.
`Object Type`	The object type for the share user.
`Password`	The password for the share user.
`Photo`	A URL or path to the share user's photo.
`Photo Big`	A URL or path to a larger version of the share user's photo.
`Photo Small`	A URL or path to a smaller version of the share user's photo.
`Share Id`	The share identifier for the share user.

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/properties/

Required roles:

can_write_transcriptions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Asset Id`	The asset identifier for the transcription properties.
`Id`	The unique identifier for the transcription properties record.
`Language`	The language code for the transcription.
`System Domain Id`	The system domain identifier for the transcription properties.
`Version Id`	The version identifier for the transcription properties.

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/subtitles/

Required roles:

can_write_transcriptions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Content`	The subtitle content to add.
`Delete Old Transcriptions`	Whether to delete existing transcriptions before adding the new one.
`Format`	The format of the subtitle content.
`Language`	The language code for the subtitles.
`Source Subtitle Id`	Set to source subtitle_id or do not set and use the content fields instead

/v1/playlists/{playlist_id}/items/

Required roles:

can_add_playlist_items

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Id`	The unique identifier for the playlist item.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Time End Milliseconds`	The end time in milliseconds for the playlist item.
`Time Start Milliseconds`	The start time in milliseconds for the playlist item.
`Version Id`	The version identifier of the object to add.

/v1/sequences/{sequence_id}/items/

Required roles:

can_add_sequence_items

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sequence Id`	The unique identifier of the sequence to which the item will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Id`	The unique identifier for the playlist item.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Position`	Position of the item in the sequence.If not provided, the item will be appended to the end of the sequence
`Version Id`	The version identifier of the object to add.

/v1/collections/{collection_id}/contents/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Collection Id`	An alternative way to specify the collection identifier, used when the object details are provided in the request body.
`Date Created`	The date and time when the member entry was created.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.

/v1/assets/{asset_id}/versions/

Required roles:

can_write_versions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Copy Metadata`	Indicates whether to copy metadata from the source version to the new version.
`Copy Persons`	Specifies whether to copy person associations from the source version.
`Copy Segments`	Determines if segments should be copied from the source version.
`Include Segment Types`	A list of segment type identifiers to include when copying segments from the source version.
`Source Version Id`	The identifier of the version from which to copy data; if omitted, the latest version is used.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/delete_queue/assets/

Required roles:

can_delete_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ids`	An array of asset identifiers to be added to the delete queue.

/v1/delete_queue/collections/

Required roles:

can_delete_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ids`	An array of collection identifiers to be added to the delete queue.

/v1/favorites/

Required roles:

can_write_favorites

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Object Ids`	An array of object identifiers to be added to the favorites.
`Object Type`	The type of the object being added to the playlist.

/v1/{object_type}/{object_id}/approvals/

Required roles:

can_write_approval_status

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Id`	The unique identifier of the object that the share belongs to.
`Object Type`	The type of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Change Date`	The date and time when the approval decision was made.
`External`	An external identifier or reference associated with the approval.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Status`	The approval status to set, such as approved or rejected.
`User`	The identifier of the user making the approval.
`Version Id`	The version identifier of the object to add.

/v1/delete_queue/bulk/

Required roles:

can_delete_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Content Only`	If set to False, will also delete entities of type object_type specified in object_ids.
`Object Ids`	An array of object identifiers to be added to the bulk delete queue.
`Object Type`	The type of the object being added to the playlist.

/v1/assets/

Required roles:

can_write_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/

Required roles:

can_write_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/shares/auth/token/

Verify whether a provided share authentication token is still valid.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Share-auth-token`	Provide the share authentication token to be validated.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/subcollections/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Copy Acl`	Copy collection acls.
`Copy Keyframes`	Copy collection keyframes.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Collection Id`	An alternative way to specify the collection identifier, used when the object details are provided in the request body.
`Date Created`	The date and time when the member entry was created.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.

/v1/approvals/bulk_remove/

Required roles:

can_write_approval_status_in_bulk

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Auth-token`	The authentication token for the request.
`App-id`	The application identifier used for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Object Ids`	An array of object identifiers to be added to the bulk delete queue.
`Object Type`	The type of the object being added to the playlist.

/v1/reindex/bulk/

Required roles:

can_reindex_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Auth-token`	The authentication token for the request.
`App-id`	The application identifier used for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Include Assets`	Set to true to include assets in the reindexing job.
`Include Collections`	Set to true to include collections in the reindexing job.
`Object Ids`	An array of object identifiers to be added to the bulk delete queue.
`Object Type`	The type of the object being added to the playlist.
`Realms`	Provide an array of realm identifiers to restrict reindexing to specific realms.
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/approvals/bulk/

Required roles:

can_write_approval_status_in_bulk

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Auth-token`	The authentication token for the request.
`App-id`	The application identifier used for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Object Ids`	An array of object identifiers to be added to the bulk delete queue.
`Object Type`	The type of the object being added to the playlist.
`Status`	The approval status to set, such as approved or rejected.

/v1/assets/

Required roles:

can_create_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Apply Default Acls`	Adds default ACLs to an asset
`Apply Collection Acls`	Adds containing collection's ACLs to an asset
`Assign To Collection`	Adds the asset to the collection specified in the body
`Generate Subclip Keyframes`	If the asset is a subclip, generate keyframes for it
`Response Type`	The response format expected from the API (e.g. application/json).

Options (35)

Option Name	Description
`Analyze Status`	Sets the analysis status of the asset, such as 'pending' or 'completed'.
`Archive Status`	Sets the archive status of the asset, for example 'archived' or 'not_archived'.
`Category`	Assigns a category to the asset for organizational purposes.
`Collection Id`	An alternative way to specify the collection identifier, used when the object details are provided in the request body.
`Created By User`	The user who created the member entry.
`Custom Keyframe`	Provides a URL or path to a custom keyframe image for the asset.
`Custom Poster`	Provides a URL or path to a custom poster image for the asset.
`Date Created`	The date and time when the member entry was created.
`Date Deleted`	Specifies the date and time when the asset was deleted.
`Date Imported`	Specifies the date and time when the asset was imported.
`Date Modified`	The date and time when the member entry was last modified.
`Date Viewed`	Specifies the date and time when the asset was last viewed.
`Deleted By User`	Specifies the user ID or name of the user who deleted the asset.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`External Link`	Provides an external URL associated with the asset.
`Face Recognition Status`	Sets the face recognition processing status for the asset.
`Favoured`	Indicates whether the asset is marked as a favorite (true or false).
`Has Unconfirmed Persons`	Indicates whether the asset has unconfirmed person detections (true or false).
`Id`	The unique identifier for the playlist item.
`Is Blocked`	Indicates whether the asset is blocked from distribution (true or false).
`Is Online`	Indicates whether the asset is currently online and accessible (true or false).
`Last Archive Restore Date`	Specifies the date and time when the asset was last restored from archive.
`Limit Download To Groups`	Specifies a list of group IDs that are allowed to download the asset.
`Original Asset Id`	Sets the ID of the original asset if this is a duplicate or version.
`Original Segment Id`	Sets the ID of the original segment if this asset is part of a segment.
`Original Version Id`	Sets the ID of the original version if this is a versioned asset.
`Person Ids`	Provides a list of person IDs to associate with the asset.
`Site Name`	Sets the name of the site or location associated with the asset.
`Status`	The approval status to set, such as approved or rejected.
`Time End Milliseconds`	The end time in milliseconds for the playlist item.
`Time Start Milliseconds`	The start time in milliseconds for the playlist item.
`Title`	Sets the title or name of the asset.
`Type`	Sets the asset type, such as 'video', 'image', or 'document'.
`Updated By User`	Specifies the user ID or name of the user who last updated the asset.
`Warning`	Sets a warning message or flag associated with the asset.

/v1/assets/{asset_id}/relations/

Required roles:

can_create_asset_relations

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Asset Id`	The asset identifier for the transcription properties.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Description`	Provides a description for the asset relation.
`Id`	The unique identifier for the playlist item.
`Related To Asset Id`	Specifies the ID of the asset to which the relation is created.
`Relation Type`	Sets the type of relation, such as 'derived_from' or 'related'.

/v1/assets/{asset_id}/relations/{relation_type}/{related_to_asset_id}/

Required roles:

can_create_asset_relations

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Relation Type`	The type of relation to create, for example 'parent' or 'derived'.
`Related To Asset Id`	The ID of the asset to relate to the current asset.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Asset Id`	The asset identifier for the transcription properties.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Description`	Provides a description for the asset relation.
`Id`	The unique identifier for the playlist item.
`Related To Asset Id`	Specifies the ID of the asset to which the relation is created.
`Relation Type`	Sets the type of relation, such as 'derived_from' or 'related'.

/v1/assets/relation_types/

Required roles:

can_read_asset_relations

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/relation_types/

Required roles:

can_write_asset_relation_types

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Description`	Provides a description for the asset relation.
`Destination Label`	The label for the destination side of the relation, displayed when the relation is directional.
`Is Directional`	Set to true if the relation has a direction, meaning it is not symmetric.
`Is System`	Set to true to mark this relation type as a system-defined type that cannot be deleted.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`Source Label`	The label for the source side of the relation, displayed when the relation is directional.

/v1/assets/{asset_id}/versions/from/assets/{source_asset_id}/

Required roles:

can_write_versions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Source Asset Id`	The ID of the asset whose latest version will be used as the source for the new version.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Copy Previous Version Persons`	Set to true to copy the persons assigned to the previous version of the source asset.
`Copy Previous Version Segments`	Set to true to copy the segments from the previous version of the source asset.
`Include Segment Types`	A list of segment type identifiers to include when copying segments from the source version.
`Source Metadata Asset Id`	The ID of a different asset whose metadata should be used instead of the source asset's metadata.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/assets/{asset_id}/versions/from/versions/{source_version_id}/

Required roles:

can_write_versions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Source Version Id`	The ID of the version to use as the source for the new version.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Copy Previous Version Persons`	Set to true to copy the persons assigned to the previous version of the source asset.
`Copy Previous Version Segments`	Set to true to copy the segments from the previous version of the source asset.
`Exclude Format Ids`	An array of format IDs to exclude from being copied into the new version.
`Include Segment Types`	A list of segment type identifiers to include when copying segments from the source version.
`Source Metadata Asset Id`	The ID of a different asset whose metadata should be used instead of the source version's metadata.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/collections/

Required roles:

can_create_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Apply Default Acls`	Adds default ACLs to a collection
`Apply Collection Acls`	Adds containing collection's ACLs to a collection
`Restrict Collection Acls`	Restricts ACLS to containing collection's ACLs
`Response Type`	The response format expected from the API (e.g. application/json).

Options (11)

Option Name	Description
`Category`	Assigns a category to the asset for organizational purposes.
`Custom Keyframe`	Provides a URL or path to a custom keyframe image for the asset.
`Custom Poster`	Provides a URL or path to a custom poster image for the asset.
`Date Created`	The date and time when the member entry was created.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`Is Root`	Indicates whether this collection is a root collection (true) or not (false).
`Keyframe Asset Ids`	An array of asset IDs to be used as keyframes for the collection.
`Parent Id`	The ID of the parent collection under which this collection should be created.
`Status`	The approval status to set, such as approved or rejected.
`Storage Id`	The ID of the storage where the collection's data will be stored.
`Title`	Sets the title or name of the asset.

/v1/playlists/

Required roles:

can_create_playlists

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	The unique identifier for the playlist item.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`Project Id`	The project identifier associated with the member record.
`Status`	The approval status to set, such as approved or rejected.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/projects/

Required roles:

can_create_projects

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (10)

Option Name	Description
`Collection Id`	ID of a collection that will become a project collection
`Collection Parent Id`	ID of a collection that the project should be a child of
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	The unique identifier for the playlist item.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`Status`	The approval status to set, such as approved or rejected.
`Storage Id`	The ID of the storage where the project's data will be stored.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/assets/{asset_id}/segments/

Required roles:

can_create_segments

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Share-user-email`	This header is used for shares by URL to identify user. Only valid emails are allowed.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (32)

Option Name	Description
`Asset Id`	The asset identifier for the transcription properties.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`Has Drawing`	Indicates whether the segment includes a drawing, as a boolean value.
`Id`	The unique identifier for the playlist item.
`Is Internal`	If set to true, the segment is only visible to internal iconik users
`Keyframe Id`	The unique identifier of the keyframe associated with the segment.
`Metadata`	A JSON string containing custom metadata for the segment.
`Metadata View Id`	The identifier of the metadata view to use when interpreting the metadata field.
`Parent Id`	The ID of the parent collection under which this collection should be created.
`Path`	The file path or location reference for the segment.
`Person Id`	The unique identifier of the person associated with the segment.
`Project Id`	ID of a project if the segment is created from a project
`Segment Checked`	Boolean flag indicating whether the segment has been reviewed or verified.
`Segment Color`	A color value (e.g., hex code) used to visually distinguish the segment.
`Segment Text`	Text content or label for the segment.
`Segment Track`	The track number or name where the segment should be placed.
`Segment Type`	The type or category of the segment (e.g., 'comment', 'marker').
`Share Id`	ID of a share if the segment is created from a share
`Share User Email`	The email address of a user with whom the segment is shared.
`Status`	The approval status to set, such as approved or rejected.
`Subclip Id`	The identifier of a subclip that the segment references.
`Time End Milliseconds`	The end time in milliseconds for the playlist item.
`Time Start Milliseconds`	The start time in milliseconds for the playlist item.
`Top Level`	Boolean flag indicating whether the segment is a top-level segment (not nested).
`Transcription Id`	The identifier of a transcription entry associated with the segment.
`User First Name`	The first name of the user who created or owns the segment.
`User Id`	The unique identifier of the user associated with the segment.
`User Last Name`	The last name of the user who created or owns the segment.
`User Photo`	A URL or path to the user's photo associated with the segment.
`Version Id`	The version identifier of the object to add.

/v1/sequences/

Required roles:

can_create_sequences

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	The unique identifier for the playlist item.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/share/{object_type}/

Required roles:

can_write_shares

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (26)

Option Name	Description
`Allow Approving Comments`	Set to true to allow recipients to approve comments on the shared objects.
`Allow Comments`	Set to true to allow recipients to add comments to the shared objects.
`Allow Custom Actions`	Set to true to allow recipients to execute custom actions on the shared objects.
`Allow Download`	Set to true to allow recipients to download the original files of the shared objects.
`Allow Download Proxy`	Set to true to allow recipients to download proxy versions of the shared objects.
`Allow Setting Approve Status`	Set to true to allow recipients to change the approval status of the shared objects.
`Allow Upload`	Set to true to allow recipients to upload new versions or files to the shared objects.
`Allow User Search For Mentions`	Set to true to allow recipients to search for other users when mentioning them in comments.
`Allow View Transcriptions`	Set to true to allow recipients to view transcriptions of audio or video content.
`Allow View Versions`	Set to true to allow recipients to view different versions of the shared objects.
`Emails`	A list of email addresses to which the share invitation will be sent.
`Expires`	The date and time when the share link will expire, in ISO 8601 format.
`Id`	The unique identifier for the playlist item.
`Is Approval`	Set to true to make this share an approval request rather than a simple share.
`Message`	A custom message to include in the share invitation email.
`Metadata Views`	A list of metadata view IDs that define which metadata fields are visible to recipients.
`Object Ids`	An array of object identifiers to be added to the bulk delete queue.
`Object Type`	The type of the object being added to the playlist.
`Owner Id`	The ID of the user who will be set as the owner of the share.
`Password`	The password for the share user.
`Review Experience Public Beta`	Set to true to enable the public beta review experience for this share.
`Share By Url`	Set to true to generate a shareable URL that does not require an email invitation.
`Show Watermark`	Set to true to display a watermark on previews of the shared objects.
`System Domain Id`	The system domain identifier for the transcription properties.
`Title`	Sets the title or name of the asset.
`Upload Storage Id`	The storage ID where uploaded files for this share will be stored.

/v1/{object_type}/{object_id}/shares/

Required roles:

can_write_shares

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (26)

Option Name	Description
`Allow Approving Comments`	Set to true to allow recipients to approve comments on the shared object.
`Allow Comments`	Set to true to allow recipients to add comments to the shared object.
`Allow Custom Actions`	Set to true to allow recipients to execute custom actions on the shared object.
`Allow Download`	Set to true to allow recipients to download the original file of the shared object.
`Allow Download Proxy`	Set to true to allow recipients to download a proxy version of the shared object.
`Allow Setting Approve Status`	Set to true to allow recipients to change the approval status of the shared object.
`Allow Upload`	Set to true to allow recipients to upload new versions or files to the shared object.
`Allow User Search For Mentions`	Set to true to allow recipients to search for other users when mentioning them in comments.
`Allow View Transcriptions`	Set to true to allow recipients to view transcriptions of audio or video content.
`Allow View Versions`	Set to true to allow recipients to view different versions of the shared object.
`Emails`	A list of email addresses to which the share invitation will be sent.
`Expires`	The date and time when the share link will expire, in ISO 8601 format.
`Id`	The unique identifier for the playlist item.
`Is Approval`	Set to true to make this share an approval request rather than a simple share.
`Message`	A custom message to include in the share invitation email.
`Metadata Views`	A list of metadata view IDs that define which metadata fields are visible to recipients.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Owner Id`	The ID of the user who will be set as the owner of the share.
`Password`	The password for the share user.
`Project Id`	Project ID if the share is created from a project
`Review Experience Public Beta`	Set to true to enable the public beta review experience for this share.
`Show Watermark`	Set to true to display a watermark on previews of the shared object.
`System Domain Id`	The system domain identifier for the transcription properties.
`Title`	Sets the title or name of the asset.
`Upload Storage Id`	The storage ID where uploaded files for this share will be stored.

/v1/sync/sessions/

Creates a new synchronization session to manage the transfer of assets between systems.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Current Dc Url`	Specifies the current datacenter URL for the sync session.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Dc Url`	Provides the target datacenter URL for the sync session.
`Id`	The unique identifier for the playlist item.
`Node`	Identifies the node responsible for the sync session.

/v1/assets/{asset_id}/history/

Required roles:

can_write_assets_history

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (12)

Option Name	Description
`Asset Id`	The asset identifier for the transcription properties.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	The unique identifier for the playlist item.
`Job Id`	Associates the history entry with a specific job ID.
`Operation Description`	Describes the operation performed on the asset.
`Operation Type`	Indicates the type of operation, such as create or update.
`Share Id`	The share identifier for the share user.
`Share User Id`	Specifies the user ID associated with a share operation.
`System Domain Id`	The system domain identifier for the transcription properties.
`User Id`	The unique identifier of the user associated with the segment.
`Version Id`	The version identifier of the object to add.

/v1/custom_actions/{context}/

Registers a new custom action that can be triggered for a given context.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Context`	Defines the context in which the custom action is available (e.g., asset, collection).
`Response Type`	The response format expected from the API (e.g. application/json).

Options (14)

Option Name	Description
`App Id`	Identifies the application that owns the custom action.
`Context`	Specifies an additional context for the custom action when it differs from the path context.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Disabled`	Indicates whether the custom action is disabled.
`Id`	The unique identifier for the playlist item.
`Last Error`	Stores the last error message encountered for the custom action.
`Last Error Date`	Records the date and time of the last error.
`Metadata View`	Specifies the metadata view associated with the custom action.
`Status`	The approval status to set, such as approved or rejected.
`System Domain Id`	The system domain identifier for the transcription properties.
`Title`	Sets the title or name of the asset.
`Type`	Sets the asset type, such as 'video', 'image', or 'document'.
`Url`	Provides the endpoint URL that the custom action calls.

/v1/assets/{asset_id}/segments/bulk/

Required roles:

can_create_segments

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/approvals/request/

Required roles:

can_write_approval_request

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Id`	The unique identifier of the object that the share belongs to.
`Object Type`	The type of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (13)

Option Name	Description
`Change Date`	The date and time when the approval decision was made.
`Externals`	A list of external users to include as approvers for the request.
`Groups`	A list of group IDs that should be assigned as approvers.
`Min Number`	The minimum number of approvals required for the request to be resolved.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Request Date`	The date the approval request is made, formatted as a string.
`Requested By`	The identifier of the user who is initiating the approval request.
`Share Id`	The share identifier for the share user.
`Status`	The approval status to set, such as approved or rejected.
`User Status`	The status to assign to the requesting user for this approval.
`Users`	A list of user IDs to include as individual approvers.
`Version Id`	The version identifier of the object to add.

/v1/assets/{asset_id}/

Required roles:

can_delete_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/relations/{relation_type}/{related_to_asset_id}/

Required roles:

can_delete_asset_relations

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Relation Type`	The type of relation to create, for example 'parent' or 'derived'.
`Related To Asset Id`	The ID of the asset to relate to the current asset.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/uploads/

Required roles:

can_create_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/versions/{version_id}/

Required roles:

can_delete_versions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Hard Delete`	completely remove the version
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/

Required roles:

can_delete_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/contents/{object_type}/{object_id}/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/playlists/{playlist_id}/

Required roles:

can_delete_playlists

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/playlists/{playlist_id}/items/{item_id}/

Required roles:

can_delete_playlist_items

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Item Id`	The unique identifier of the playlist item to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/projects/{project_id}/

Required roles:

can_delete_projects

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Project Id`	The unique identifier of the project to which the member is added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/projects/{project_id}/members/{member_id}/

Required roles:

can_delete_project_members

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Project Id`	The unique identifier of the project to which the member is added.
`Member Id`	Unique identifier of the project member to remove.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/segments/{segment_id}/

Required roles:

can_delete_segments

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Segment Id`	Unique identifier of the segment to delete.
`Soft Delete`	If set to true, mark the segment as deleted without permanently removing it.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/sequences/{sequence_id}/

Required roles:

can_delete_sequences

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sequence Id`	The unique identifier of the sequence to which the item will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/sequences/{sequence_id}/items/{item_id}/

Required roles:

can_delete_sequence_items

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sequence Id`	The unique identifier of the sequence to which the item will be added.
`Item Id`	The unique identifier of the playlist item to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/shares/{share_id}/

Required roles:

can_delete_object_shares

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Share Id`	The unique identifier of the share to which the user is added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/shares/{share_id}/users/{share_user_id}/

Required roles:

can_write_shares

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Share Id`	The unique identifier of the share to which the user is added.
`Share User Id`	Unique identifier of the share user to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/sync/sessions/{sync_session_id}/

Delete a specific sync session using its session ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sync Session Id`	Unique identifier of the sync session to remove.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/versions/old/

Required roles:

can_delete_versions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/relation_types/{relation_type}/

Required roles:

can_delete_asset_relation_types

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Relation Type`	The type of relation to create, for example 'parent' or 'derived'.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/delete_queue/assets/

Required roles:

can_write_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ids`	An array of collection identifiers to be added to the delete queue.

/v1/delete_queue/collections/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ids`	An array of collection identifiers to be added to the delete queue.

/v1/shares/bulk/

Required roles:

can_manage_shares

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Share Ids`	Provide an array of share ID strings representing the shares to delete.

/v1/shares/bulk/all/

Required roles:

can_manage_all_shares

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Share Ids`	Provide an array of share ID strings representing the shares to delete.

/v1/assets/{asset_id}/segments/bulk/

Required roles:

can_delete_segments

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Immediately`	If false, delete segments asynchronously
`Ignore Reindexing`	If false, reindex
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Segment Ids`	Provide an array of segment ID strings representing the segments to delete.
`Segment Type`	The type or category of the segment (e.g., 'comment', 'marker').
`Version Id`	The version identifier of the object to add.

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/{transcription_id}/properties/

Required roles:

can_delete_transcriptions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Transcription Id`	Provide the ID of the transcription whose properties should be deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/history/{history_entity_id}/

Required roles:

can_delete_assets_history

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`History Entity Id`	Provide the ID of the history entity to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/custom_actions/{context}/{action_id}/

Delete a custom action identified by its action ID within a given context. Use this to remove a custom action definition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Context`	Defines the context in which the custom action is available (e.g., asset, collection).
`Action Id`	Provide the ID of the custom action to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/approvals/request/

Required roles:

can_delete_approval_request

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Id`	The unique identifier of the object that the share belongs to.
`Object Type`	The type of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/approvals/

Delete the approval status for a specific object, removing all approval records associated with it. Use this to reset or clear an object's approval state.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Id`	The unique identifier of the object that the share belongs to.
`Object Type`	The type of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/approvals/external/{email}/

Required roles:

can_delete_approval_status

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Id`	The unique identifier of the object that the share belongs to.
`Object Type`	The type of the object that the share belongs to.
`Email`	Provide the email address of the external user whose approval status should be deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/approvals/user/{user_id}/

Required roles:

can_delete_approval_status

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Id`	The unique identifier of the object that the share belongs to.
`Object Type`	The type of the object that the share belongs to.
`User Id`	Provide the user ID of the user whose approval status should be deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/favorites/

Required roles:

can_delete_favorites

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Object Ids`	An array of object identifiers to be added to the bulk delete queue.
`Object Type`	The type of the object being added to the playlist.

/v1/collections/{collection_id}/contents/ordering/custom/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/sync/sessions/{sync_session_id}/

Edit a sync session. If the session doesn't exist, a new one is created.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sync Session Id`	Unique identifier of the sync session to remove.
`Update If None`	Update only if the field is not set (set to None) in the database
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Current Dc Url`	Specifies the current datacenter URL for the sync session.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Dc Url`	Provides the target datacenter URL for the sync session.
`Id`	The unique identifier for the playlist item.
`Node`	Identifies the node responsible for the sync session.

/v1/sync/sessions/{sync_session_id}/

Edit a sync session. If the session doesn't exist, a new one is created.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sync Session Id`	Unique identifier of the sync session to remove.
`Update If None`	Update only if the field is not set (set to None) in the database
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Current Dc Url`	Specifies the current datacenter URL for the sync session.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Dc Url`	Provides the target datacenter URL for the sync session.
`Id`	The unique identifier for the playlist item.
`Node`	Identifies the node responsible for the sync session.

/v1/assets/{asset_id}/versions/{version_id}/

Required roles:

can_write_versions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (13)

Option Name	Description
`Analyze Status`	Sets the analysis status of the asset, such as 'pending' or 'completed'.
`Archive Status`	Sets the archive status of the asset, for example 'archived' or 'not_archived'.
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Face Recognition Status`	Sets the face recognition processing status for the asset.
`Has Unconfirmed Persons`	Indicates whether the asset has unconfirmed person detections (true or false).
`Id`	The unique identifier for the playlist item.
`Is Online`	Indicates whether the asset is currently online and accessible (true or false).
`Person Ids`	Provides a list of person IDs to associate with the asset.
`Status`	The approval status to set, such as approved or rejected.
`Transcribe Status`	Specify the transcription status to set for the asset version.
`Transcribed Languages`	A list of languages that have been transcribed for the asset version.
`Version Number`	The new version number to assign to the asset version.

/v1/assets/{asset_id}/versions/{version_id}/

Required roles:

can_write_versions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (13)

Option Name	Description
`Analyze Status`	Sets the analysis status of the asset, such as 'pending' or 'completed'.
`Archive Status`	Sets the archive status of the asset, for example 'archived' or 'not_archived'.
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Face Recognition Status`	Sets the face recognition processing status for the asset.
`Has Unconfirmed Persons`	Indicates whether the asset has unconfirmed person detections (true or false).
`Id`	The unique identifier for the playlist item.
`Is Online`	Indicates whether the asset is currently online and accessible (true or false).
`Person Ids`	Provides a list of person IDs to associate with the asset.
`Status`	The approval status to set, such as approved or rejected.
`Transcribe Status`	Specify the transcription status to set for the asset version.
`Transcribed Languages`	A list of languages that have been transcribed for the asset version.
`Version Number`	The new version number to assign to the asset version.

/v1/assets/{asset_id}/segments/bulk/

Required roles:

can_write_segments

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Generate Subclip Keyframes`	If the segment is a subclip, generate keyframes for it
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/approvals/request/

Required roles:

can_write_approval_request

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Id`	The unique identifier of the object that the share belongs to.
`Object Type`	The type of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (13)

Option Name	Description
`Change Date`	The date and time when the approval decision was made.
`Externals`	A list of external users to include as approvers for the request.
`Groups`	A list of group IDs that should be assigned as approvers.
`Min Number`	The minimum number of approvals required for the request to be resolved.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Request Date`	The date the approval request is made, formatted as a string.
`Requested By`	The identifier of the user who is initiating the approval request.
`Share Id`	The share identifier for the share user.
`Status`	The approval status to set, such as approved or rejected.
`User Status`	The status to assign to the requesting user for this approval.
`Users`	A list of user IDs to include as individual approvers.
`Version Id`	The version identifier of the object to add.

/v1/{object_type}/{object_id}/approvals/request/

Required roles:

can_write_approval_request

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Id`	The unique identifier of the object that the share belongs to.
`Object Type`	The type of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (13)

Option Name	Description
`Change Date`	The date and time when the approval decision was made.
`Externals`	A list of external users to include as approvers for the request.
`Groups`	A list of group IDs that should be assigned as approvers.
`Min Number`	The minimum number of approvals required for the request to be resolved.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Request Date`	The date the approval request is made, formatted as a string.
`Requested By`	The identifier of the user who is initiating the approval request.
`Share Id`	The share identifier for the share user.
`Status`	The approval status to set, such as approved or rejected.
`User Status`	The status to assign to the requesting user for this approval.
`Users`	A list of user IDs to include as individual approvers.
`Version Id`	The version identifier of the object to add.

/v1/collections/{collection_id}/contents/ordering/custom/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Custom Order Sort`	Initial sort order for an ordered collection. Specified as a comma separated list of fieldnames with direction. For example - date_created,asc;status,desc

/v1/{object_type}/{object_id}/shares/url/

Required roles:

can_write_shares

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (22)

Option Name	Description
`Allow Approving Comments`	Set to true to allow recipients to approve comments on the shared object.
`Allow Comments`	Set to true to allow recipients to add comments to the shared object.
`Allow Custom Actions`	Set to true to allow recipients to execute custom actions on the shared object.
`Allow Download`	Set to true to allow recipients to download the original file of the shared object.
`Allow Download Proxy`	Set to true to allow recipients to download a proxy version of the shared object.
`Allow Setting Approve Status`	Set to true to allow recipients to change the approval status of the shared object.
`Allow Upload`	Set to true to allow recipients to upload new versions or files to the shared object.
`Allow User Search For Mentions`	Set to true to allow recipients to search for other users when mentioning them in comments.
`Allow View Transcriptions`	Set to true to allow recipients to view transcriptions of audio or video content.
`Allow View Versions`	Set to true to allow recipients to view different versions of the shared object.
`Expires`	The date and time when the share link will expire, in ISO 8601 format.
`Is Approval`	Set to true to make this share an approval request rather than a simple share.
`Metadata Views`	A list of metadata view IDs that define which metadata fields are visible to recipients.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Owner Id`	The ID of the user who will be set as the owner of the share.
`Password`	The password for the share user.
`Review Experience Public Beta`	Set to true to enable the public beta review experience for this share.
`Show Watermark`	Set to true to display a watermark on previews of the shared object.
`System Domain Id`	The system domain identifier for the transcription properties.
`Title`	Sets the title or name of the asset.
`Upload Storage Id`	The storage ID where uploaded files for this share will be stored.

/v1/shares/all/

Required roles:

can_manage_all_shares

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Title`	Filter by title
`Object Type`	Filter by object_type
`Object Id`	Filter by object_id
`Owner Id`	Filter by owner_id
`Member Id`	Filter by member_id
`Ids`	Filter list of id:s (comma separated)
`Query`	Filter by other parameter with wildcard support
`Exists`	Filter shares that have all fields specified in _exists_ (comma separated)
`Date Created`	Filter by date_created. Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk * to make the query open ended. For example: 2018-01-01T10:00:00Z;2018-01-01T15:00:00Z
`Date Modified`	Filter by date_modified Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk `` to make the query open ended. For example: ;1544450400
`Expires`	Filter by expires Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk `` to make the query open ended. For example: ;1544450400
`Page`	Which page number to fetch
`Per Page`	The number of items for each page
`Scroll`	If true passed then uses scroll pagination instead of default one
`Scroll Id`	In order to get next batch of results using scroll pagination the scroll_id is required
`Sort`	A comma separated list of fieldnames with order. For example - title,asc;object_type,desc
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/properties/

Required roles:

can_read_transcriptions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/shares/

Required roles:

can_manage_shares

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Title`	Filter by title
`Object Type`	Filter by object_type
`Object Id`	Filter by object_id
`Ids`	Filter list of id:s (comma separated)
`Query`	Filter by title with wildcard support
`Exists`	Filter shares that have all fields specified in _exists_ (comma separated)
`Date Created`	Filter by date_created. Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk * to make the query open ended. For example: 2018-01-01T10:00:00Z;2018-01-01T15:00:00Z
`Date Modified`	Filter by date_modified Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk `` to make the query open ended. For example: ;1544450400
`Expires`	Filter by expires Can either be a single ISO8601 timestamp or two timestamps separated by a semicolon ;. The timestamp can also be expressed as number of milliseconds since Jan 1 1970 (epoch). Either timestamp can also be replaced with an asterisk `` to make the query open ended. For example: ;1544450400
`Include Member Of`	Include shares where the current user is a member of the share
`Page`	Which page number to fetch
`Per Page`	The number of items for each page
`Scroll`	If true passed then uses scroll pagination instead of default one
`Scroll Id`	In order to get next batch of results using scroll pagination the scroll_id is required
`Sort`	A comma separated list of fieldnames with order. For example - title,asc;object_type,desc
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/relation_types/{relation_type}/

Required roles:

can_read_asset_relations

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Relation Type`	The type of relation to create, for example 'parent' or 'derived'.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/segments/{segment_id}/

Required roles:

can_read_segments

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Segment Id`	Unique identifier of the segment to delete.
`Scroll`	If true passed then uses scroll pagination instead of default one
`Scroll Id`	In order to get next batch of results using scroll pagination the scroll_id is required
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/{transcription_id}/properties/

Required roles:

can_read_transcriptions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Transcription Id`	Provide the ID of the transcription whose properties should be deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/content/info/

The returned information includes count of assets and sub-collections,
total size of all assets (in bytes) and total duration of video and audio assets (in milliseconds).
The returned information includes count of assets and sub-collections,
total size of all assets (in bytes) and total duration of video and audio assets (in milliseconds).
Required roles:

can_read_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Only Active`	If false, include all the contents
`Include Subcollections`	Compute total stats including assets from sub-collections
`Format Name`	Compute total size only for files with the specified format name (default - ORIGINAL)
`By Storage Id`	Group results by storage_id / storage_method
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/persons/{person_id}/

Retrieve a list of assets that are associated with a specified person, or filter to specific versions of a particular asset that also contain that person.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Person Id`	The unique identifier of the person whose associated assets you want to retrieve.
`Page`	The page number of results to return, used for pagination through large result sets.
`Per Page`	The number of results to include per page when paginating.
`Asset Id`	An optional asset identifier to narrow the results to specific versions of that asset containing the person.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/custom_actions/{context}/{action_id}/

Required roles:

can_read_custom_actions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Context`	Defines the context in which the custom action is available (e.g., asset, collection).
`Action Id`	Provide the ID of the custom action to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/history/{history_entity_id}/

Required roles:

can_read_assets_history

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`History Entity Id`	Provide the ID of the history entity to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/delete_queue/assets/

Required roles:

can_read_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Sort`	A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc
`Filter`	A comma separated list of fieldnames with order For example - first_name,eq,Vlad;last_name,eq,Gudkov
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/shares/all/

collections and playlists that contain the assetcollections and playlists that contain the asset
Required roles:

can_read_shares

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/

Required roles:

can_read_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Scroll`	If true passed then uses scroll pagination instead of default one
`Scroll Id`	In order to get next batch of results using scroll pagination the scroll_id is required
`Sort`	A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc
`Field Name`	filter by field_name
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/shares/all/

sharing collections that contain the collectionsharing collections that contain the collection
Required roles:

can_read_shares

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/

Required roles:

can_read_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Scroll`	If true passed then uses scroll pagination instead of default one
`Scroll Id`	In order to get next batch of results using scroll pagination the scroll_id is required
`Sort`	A comma separated list of fieldnames with order. For example - title,asc;is_root,desc
`Is Root`	Filter by is_root
`Status`	Filter by status
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/delete_queue/collections/

Required roles:

can_read_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Sort`	A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc
`Filter`	A comma separated list of fieldnames with order For example - first_name,eq,Vlad;last_name,eq,Gudkov
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/custom_actions/

Required roles:

can_read_custom_actions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/custom_actions/{context}/

Required roles:

can_read_custom_actions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Context`	Defines the context in which the custom action is available (e.g., asset, collection).
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/favorites/

Required roles:

can_read_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Per Page`	The number of objects for each page
`Page`	Which page number to fetch
`Sort`	A comma separated list of fieldnames with order. For example - title,asc;date_created,desc
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/history/

Required roles:

can_read_assets_history

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Sort`	A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc
`Filter`	A comma separated list of fieldnames with order For example - first_name,eq,Vlad;last_name,eq,Gudkov
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/shares/

Required roles:

can_read_shares

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Per Page`	The number of items for each page
`Last Id`	The ID of the last share in the previous page to retrieve the next set of results.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/playlists/{playlist_id}/items/

Required roles:

can_read_playlists

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Per Page`	The number of items for each page
`Ids`	Filter list of id:s (comma separated)
`Page`	Which page number to fetch
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/playlists/

Required roles:

can_read_playlists

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Scroll`	If true passed then uses scroll pagination instead of default one
`Scroll Id`	In order to get next batch of results using scroll pagination the scroll_id is required
`Sort`	A comma separated list of fieldnames with order. For example - title,asc;date_created,desc
`Status`	Filter by status
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/projects/{project_id}/members/

Required roles:

can_read_projects

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Project Id`	The unique identifier of the project to which the member is added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/projects/

Required roles:

can_read_projects

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Scroll`	If true passed then uses scroll pagination instead of default one
`Scroll Id`	In order to get next batch of results using scroll pagination the scroll_id is required
`Sort`	A comma separated list of fieldnames with order. For example - title,asc;date_created,desc
`Status`	Filter by status
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/sequences/{sequence_id}/items/

Required roles:

can_read_sequences

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sequence Id`	The unique identifier of the sequence to which the item will be added.
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/sequences/

Required roles:

can_read_sequences

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Scroll`	If true passed then uses scroll pagination instead of default one
`Scroll Id`	In order to get next batch of results using scroll pagination the scroll_id is required
`Sort`	A comma separated list of fieldnames with order. For example - title,asc;date_created,desc
`Status`	Filter by status
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/shares/{share_id}/users/

Required roles:

can_read_shares

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Share Id`	The unique identifier of the share to which the user is added.
`Per Page`	The number of items for each page
`Last Id`	The ID of the last user in the previous page to retrieve the next set of results.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/full/path/

Required roles:

can_read_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Get Upload Path`	Use to get the upload path instead of the full path
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/segments/

Required roles:

can_read_segments

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Sort`	Sort on field (Comma separated)
`Ids`	Only include these segments (Comma separated)
`Query`	Search using query
`Includes`	Only include fields (Comma separated)
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Scroll`	If true passed then uses scroll pagination instead of default one
`Scroll Id`	In order to get next batch of results using scroll pagination the scroll_id is required
`Transcription Id`	Filter segments by transcription_id
`Version Id`	Filter segments by version_id
`Segment Type`	Filter segments by segment_type
`Segment Color`	Filter segments by segment_color
`Time Start Milliseconds`	Filter segments by time_start_milliseconds
`Time End Milliseconds`	Filter segments by time_end_milliseconds
`Time Start Milliseconds Gte`	Get segments with start time greater than or equal to time_start_milliseconds__gte
`Time End Milliseconds Lte`	Get segments with end time less than or equal to time_end_milliseconds__lte
`Status`	Filter segments by status
`Person Id`	Filter segments by person_id
`Share Id`	Filter segments by share_id
`Project Id`	Filter segments by project_id
`Include Users`	Include segment's authors info
`Include All Versions`	If true return asset's segments for all versions
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/segments/{segment_type}/

Required roles:

can_read_segments

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Segment Type`	The type of segment to list, for example keyframe or marker.
`Sort`	Sort on field (Comma separated)
`Ids`	Only include these segments (Comma separated)
`Query`	Search using query
`Includes`	Only include fields (Comma separated)
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Scroll`	If true passed then uses scroll pagination instead of default one
`Scroll Id`	In order to get next batch of results using scroll pagination the scroll_id is required
`Time Start Milliseconds`	Filter segments by time_start_milliseconds
`Time End Milliseconds`	Filter segments by time_end_milliseconds
`Time Start Milliseconds Gte`	Get segments with start time greater than or equal to time_start_milliseconds__gte
`Time End Milliseconds Lte`	Get segments with end time less than or equal to time_end_milliseconds__lte
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/segments/csv/

Required roles:

can_read_segments

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Ids`	Only include these segments (Comma separated)
`Query`	Search using query
`Transcription Id`	Filter segments by transcription_id
`Version Id`	Filter segments by version_id
`Segment Type`	Filter segments by segment_type
`Segment Color`	Filter segments by segment_color
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/segments/srt/

Required roles:

can_read_segments

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Ids`	Only include these segments (Comma separated)
`Query`	Search using query
`Transcription Id`	Filter segments by transcription_id
`Version Id`	Filter segments by version_id
`Segment Type`	Filter segments by segment_type
`Segment Color`	Filter segments by segment_color
`Words Per Line`	Limit the number of words per subtitle line
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/segments/vtt/

Required roles:

can_read_segments

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Ids`	Only include these segments (Comma separated)
`Query`	Search using query
`Transcription Id`	Filter segments by transcription_id
`Version Id`	Filter segments by version_id
`Segment Type`	Filter segments by segment_type
`Segment Color`	Filter segments by segment_color
`Words Per Line`	Limit the number of words per subtitle line
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/shares/auth/login/

Authenticate a user for a shared link by providing either a hash or a token. Use this action to obtain a session token for subsequent share operations.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`App Id`	Identifies the application that owns the custom action.
`Hash`	The hash identifier for the shared link, used as an alternative authentication method to the token.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Password`	The password for the share user.
`Token`	The authentication token for the share, used as an alternative to the hash.

/v1/assets/{asset_id}/views/

Required roles:

can_read_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/keyframes/

Required roles:

can_reindex_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Asset Ids`	An array of up to three asset IDs to set as keyframes for the collection.

/v1/assets/{asset_id}/versions/{version_id}/promote/

Required roles:

can_write_versions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/delete_queue/purge/all/

Required roles:

can_purge_assets
can_purge_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/delete_queue/assets/purge/all/

Required roles:

can_purge_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/delete_queue/collections/purge/all/

Required roles:

can_purge_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/delete_queue/assets/purge/

Required roles:

can_purge_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ids`	An array of collection identifiers to be added to the delete queue.

/v1/delete_queue/collections/purge/

Required roles:

can_purge_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ids`	An array of collection identifiers to be added to the delete queue.

/v1/assets/{asset_id}/purge/

Required roles:

can_purge_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/purge/

Required roles:

can_purge_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/shares/auth/token/

Refresh an existing share authentication token to extend its validity. Use this when the current token is about to expire or has been revoked.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Share-auth-token`	Provide the share authentication token to be validated.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/reindex/

Required roles:

can_reindex_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Realms`	Provide an array of realm identifiers to restrict reindexing to specific realms.
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/assets/{asset_id}/history/{history_entity_id}/reindex/

Required roles:

can_reindex_assets_history

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`History Entity Id`	Provide the ID of the history entity to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/segments/{segment_id}/reindex/

Required roles:

can_reindex_segments

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Segment Id`	Unique identifier of the segment to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Ignore Comments`	When set to true, comments are excluded from the reindexing process.
`Realms`	Provide an array of realm identifiers to restrict reindexing to specific realms.
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/assets/{asset_id}/segments/reindex/

Required roles:

can_reindex_segments

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Ignore Comments`	When set to true, comments are excluded from the reindexing process.
`Realms`	Provide an array of realm identifiers to restrict reindexing to specific realms.
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/collections/{collection_id}/reindex/

Required roles:

can_reindex_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Realms`	Provide an array of realm identifiers to restrict reindexing to specific realms.
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/collections/{collection_id}/reindex/contents/

Required roles:

can_reindex_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/contents/{object_type}/{object_id}/reindex/

Required roles:

can_reindex_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/playlists/{playlist_id}/reindex/

Required roles:

can_reindex_playlists

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/projects/{project_id}/reindex/

Required roles:

can_reindex_projects

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Project Id`	The unique identifier of the project to which the member is added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/sequences/{sequence_id}/reindex/

Required roles:

can_reindex_sequences

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sequence Id`	The unique identifier of the sequence to which the item will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/{object_type}/{object_id}/shares/{share_id}/reindex/

Required roles:

can_reindex_shares

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Share Id`	The unique identifier of the share to which the user is added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/favorites/all/

Required roles:

can_delete_favorites

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/favourites/all/

Required roles:

can_delete_favorites

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/delete_queue/assets/restore/all/

Required roles:

can_write_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/delete_queue/collections/restore/all/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/restore/

Required roles:

can_write_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/restore/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/

Required roles:

can_read_assets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Include Collections`	include collection membership
`Include Users`	include info about the users who have interacted with this asset
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/

Required roles:

can_read_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/playlists/{playlist_id}/

Required roles:

can_read_playlists

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/projects/{project_id}/

Required roles:

can_read_projects

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Project Id`	The unique identifier of the project to which the member is added.
`Include Users`	include info about the users who have interacted with this project
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/projects/{project_id}/members/{member_id}/

Required roles:

can_read_projects

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Project Id`	The unique identifier of the project to which the member is added.
`Member Id`	Unique identifier of the project member to remove.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/sequences/{sequence_id}/

Required roles:

can_read_sequences

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sequence Id`	The unique identifier of the sequence to which the item will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/shares/{share_id}/

Retrieve details of a specific share associated with an object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Share Id`	The unique identifier of the share to which the user is added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/shares/{share_id}/users/{share_user_id}/

Required roles:

can_read_shares

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Share Id`	The unique identifier of the share to which the user is added.
`Share User Id`	Unique identifier of the share user to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/sync/sessions/{sync_session_id}/

a new one is created

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sync Session Id`	Unique identifier of the sync session to remove.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/relations/

Required roles:

can_read_asset_relations

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Include Deleted`	Also show assets from recycle bin in relations
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Sort`	A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/approvals/

Required roles:

can_read_approval_request

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Id`	The unique identifier of the object that the share belongs to.
`Object Type`	The type of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/approvals/request/

Required roles:

can_read_approval_request

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Id`	The unique identifier of the object that the share belongs to.
`Object Type`	The type of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/versions/{version_id}/approvals/

Required roles:

can_read_approval_request

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Version Id`	The unique identifier of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/{object_type}/{object_id}/versions/{version_id}/approvals/request/

Required roles:

can_read_approval_request

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Version Id`	The unique identifier of the version.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/relations/{relation_type}/

Required roles:

can_read_asset_relations

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Relation Type`	The type of relation to create, for example 'parent' or 'derived'.
`Include Deleted`	Also show assets from recycle bin in relations
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/contents/

Required roles:

can_read_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Object Types`	Comma separated list of content types. Example - assets,collections
`Object Ids`	Comma separated list of content ids.
`External Id`	Filter the collection contents by the external identifier of an item.
`Per Page`	The number of items for each page
`Page`	Which page number to fetch
`Sort`	A comma separated list of fieldnames with order. For example - first_name,asc;last_name,desc
`Filter`	A comma separated list of fieldnames with order For example - first_name,eq,Vlad;last_name,eq,Gudkov
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/ancestors/

Required roles:

can_read_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/collections/{collection_id}/size/

Required roles:

can_read_collections

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Format Name`	Compute total size only for files with the specified format name
`Include Subcollections`	Compute total size for all files including sub_collections' assets
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/assets/{asset_id}/relations/{relation_type}/{related_to_asset_id}/reverse/

Required roles:

can_create_asset_relations

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Relation Type`	The type of relation to create, for example 'parent' or 'derived'.
`Related To Asset Id`	The ID of the asset to relate to the current asset.
`Response Type`	The response format expected from the API (e.g. application/json).

/v1/custom_actions/{context}/{action_id}/callback/

Required roles:

can_read_custom_actions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Context`	Defines the context in which the custom action is available (e.g., asset, collection).
`Action Id`	Provide the ID of the custom action to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Asset Ids`	An array of up to three asset IDs to set as keyframes for the collection.
`Collection Ids`	Provide an array of collection identifiers to apply the custom action to those specific collections.
`From Collection Id`	ID of a collection that the custom action was triggered from
`Metadata View Id`	The identifier of the metadata view to use when interpreting the metadata field.
`Saved Search Ids`	Provide an array of saved search identifiers to apply the custom action to the assets returned by those searches.

/v1/custom_actions/shared/{context}/{action_id}/callback/

Required roles:

can_read_custom_actions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Context`	Defines the context in which the custom action is available (e.g., asset, collection).
`Action Id`	Provide the ID of the custom action to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Asset Ids`	An array of up to three asset IDs to set as keyframes for the collection.
`Collection Ids`	Provide an array of collection identifiers to apply the custom action to those specific collections.
`From Collection Id`	ID of a collection that the custom action was triggered from
`Metadata View Id`	The identifier of the metadata view to use when interpreting the metadata field.
`Saved Search Ids`	Provide an array of saved search identifiers to apply the custom action to the assets returned by those searches.

/v1/assets/reindex/

Required roles:

can_reindex_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Asset Ids`	An array of up to three asset IDs to set as keyframes for the collection.
`Realms`	Provide an array of realm identifiers to restrict reindexing to specific realms.
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/collections/reindex/

Required roles:

can_reindex_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Collection Ids`	Provide an array of collection identifiers to reindex only those collections instead of all collections.
`Realms`	Provide an array of realm identifiers to restrict reindexing to specific realms.

/v1/assets/segments/reindex/

Required roles:

can_reindex_segments

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Asset Ids`	An array of up to three asset IDs to set as keyframes for the collection.
`Ignore Comments`	When set to true, comments are excluded from the reindexing process.
`Realms`	Provide an array of realm identifiers to restrict reindexing to specific realms.
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/segments/reindex/

Required roles:

can_reindex_segments

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Ignore Comments`	When set to true, comments are excluded from the reindexing process.
`Realms`	Provide an array of realm identifiers to restrict reindexing to specific realms.
`Segment Ids`	Provide an array of segment ID strings representing the segments to delete.
`Sync To Another Dc`	Set to true to synchronize the reindexing to another data center.

/v1/playlists/{playlist_id}/

Required roles:

can_write_playlists

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	The unique identifier for the playlist item.
`Item Count`	Provide the updated total number of items in the playlist.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`Project Id`	The project identifier associated with the member record.
`Status`	The approval status to set, such as approved or rejected.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/playlists/{playlist_id}/

Required roles:

can_write_playlists

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	The unique identifier for the playlist item.
`Item Count`	Provide the updated total number of items in the playlist.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`Project Id`	The project identifier associated with the member record.
`Status`	The approval status to set, such as approved or rejected.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/playlists/{playlist_id}/items/{item_id}/

Required roles:

can_update_playlist_items

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Item Id`	The unique identifier of the playlist item to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Id`	The unique identifier for the playlist item.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Time End Milliseconds`	The end time in milliseconds for the playlist item.
`Time Start Milliseconds`	The start time in milliseconds for the playlist item.
`Version Id`	The version identifier of the object to add.

/v1/playlists/{playlist_id}/items/{item_id}/

Required roles:

can_update_playlist_items

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Item Id`	The unique identifier of the playlist item to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Id`	The unique identifier for the playlist item.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Time End Milliseconds`	The end time in milliseconds for the playlist item.
`Time Start Milliseconds`	The start time in milliseconds for the playlist item.
`Version Id`	The version identifier of the object to add.

/v1/playlists/{playlist_id}/items/{item_id}/position/

Required roles:

can_update_playlist_items_position

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Playlist Id`	The unique identifier of the playlist.
`Item Id`	The unique identifier of the playlist item to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Position`	New position of the item in the playlist.If not provided, the item will be appended to the end of the playlist

/v1/sequences/{sequence_id}/

Required roles:

can_write_sequences

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sequence Id`	The unique identifier of the sequence to which the item will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	The unique identifier for the playlist item.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/sequences/{sequence_id}/

Required roles:

can_write_sequences

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sequence Id`	The unique identifier of the sequence to which the item will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	The unique identifier for the playlist item.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/sequences/{sequence_id}/items/{item_id}/position/

Required roles:

can_add_sequence_items

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Sequence Id`	The unique identifier of the sequence to which the item will be added.
`Item Id`	The unique identifier of the playlist item to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Position`	New position of the item in the sequence.If not provided, the item will be appended to the end of the sequence

/v1/assets/relation_types/{relation_type}/

Required roles:

can_write_asset_relation_types

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Relation Type`	The type of relation to create, for example 'parent' or 'derived'.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Description`	Provides a description for the asset relation.
`Destination Label`	The label for the destination side of the relation, displayed when the relation is directional.
`Is Directional`	Set to true if the relation has a direction, meaning it is not symmetric.
`Is System`	Set to true to mark this relation type as a system-defined type that cannot be deleted.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`Source Label`	The label for the source side of the relation, displayed when the relation is directional.

/v1/assets/relation_types/{relation_type}/

Required roles:

can_write_asset_relation_types

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Relation Type`	The type of relation to create, for example 'parent' or 'derived'.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (8)

Option Name	Description
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Description`	Provides a description for the asset relation.
`Destination Label`	The label for the destination side of the relation, displayed when the relation is directional.
`Is Directional`	Set to true if the relation has a direction, meaning it is not symmetric.
`Is System`	Set to true to mark this relation type as a system-defined type that cannot be deleted.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`Source Label`	The label for the source side of the relation, displayed when the relation is directional.

/v1/custom_actions/{context}/{action_id}/

Partially update the properties of an existing custom action identified by context and action ID.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Context`	Defines the context in which the custom action is available (e.g., asset, collection).
`Action Id`	Provide the ID of the custom action to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (14)

Option Name	Description
`App Id`	Identifies the application that owns the custom action.
`Context`	Specifies an additional context for the custom action when it differs from the path context.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Disabled`	Indicates whether the custom action is disabled.
`Id`	The unique identifier for the playlist item.
`Last Error`	Stores the last error message encountered for the custom action.
`Last Error Date`	Records the date and time of the last error.
`Metadata View`	Specifies the metadata view associated with the custom action.
`Status`	The approval status to set, such as approved or rejected.
`System Domain Id`	The system domain identifier for the transcription properties.
`Title`	Sets the title or name of the asset.
`Type`	Sets the asset type, such as 'video', 'image', or 'document'.
`Url`	Provides the endpoint URL that the custom action calls.

/v1/custom_actions/{context}/{action_id}/

Replace the entire definition of an existing custom action identified by context and action ID.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Context`	Defines the context in which the custom action is available (e.g., asset, collection).
`Action Id`	Provide the ID of the custom action to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (14)

Option Name	Description
`App Id`	Identifies the application that owns the custom action.
`Context`	Specifies an additional context for the custom action when it differs from the path context.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Disabled`	Indicates whether the custom action is disabled.
`Id`	The unique identifier for the playlist item.
`Last Error`	Stores the last error message encountered for the custom action.
`Last Error Date`	Records the date and time of the last error.
`Metadata View`	Specifies the metadata view associated with the custom action.
`Status`	The approval status to set, such as approved or rejected.
`System Domain Id`	The system domain identifier for the transcription properties.
`Title`	Sets the title or name of the asset.
`Type`	Sets the asset type, such as 'video', 'image', or 'document'.
`Url`	Provides the endpoint URL that the custom action calls.

/v1/collections/{collection_id}/contents/{object_type}/{object_id}/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`After Object Id`	Identifier of the content object that the current object should be placed after in the collection order.
`Before Object Id`	Identifier of the content object that the current object should be placed before in the collection order.
`Position`	Position the member will be moved to. To insert athe the end send -1

/v1/assets/{asset_id}/

Required roles:

can_write_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Generate Subclip Keyframes`	If the asset is a subclip, generate keyframes for it
`Response Type`	The response format expected from the API (e.g. application/json).

Options (35)

Option Name	Description
`Analyze Status`	Sets the analysis status of the asset, such as 'pending' or 'completed'.
`Archive Status`	Sets the archive status of the asset, for example 'archived' or 'not_archived'.
`Category`	Assigns a category to the asset for organizational purposes.
`Created By User`	The user who created the member entry.
`Custom Keyframe`	Provides a URL or path to a custom keyframe image for the asset.
`Custom Poster`	Provides a URL or path to a custom poster image for the asset.
`Date Created`	The date and time when the member entry was created.
`Date Deleted`	Specifies the date and time when the asset was deleted.
`Date Imported`	Specifies the date and time when the asset was imported.
`Date Modified`	The date and time when the member entry was last modified.
`Date Viewed`	Specifies the date and time when the asset was last viewed.
`Deleted By User`	Specifies the user ID or name of the user who deleted the asset.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`External Link`	Provides an external URL associated with the asset.
`Face Recognition Status`	Sets the face recognition processing status for the asset.
`Favoured`	Indicates whether the asset is marked as a favorite (true or false).
`Has Unconfirmed Persons`	Indicates whether the asset has unconfirmed person detections (true or false).
`Id`	The unique identifier for the playlist item.
`In Collections`	Specify a list of collection IDs to which the asset should belong. This replaces the current set of collections.
`Is Blocked`	Indicates whether the asset is blocked from distribution (true or false).
`Is Online`	Indicates whether the asset is currently online and accessible (true or false).
`Last Archive Restore Date`	Specifies the date and time when the asset was last restored from archive.
`Limit Download To Groups`	Specifies a list of group IDs that are allowed to download the asset.
`Original Asset Id`	Sets the ID of the original asset if this is a duplicate or version.
`Original Segment Id`	Sets the ID of the original segment if this asset is part of a segment.
`Original Version Id`	Sets the ID of the original version if this is a versioned asset.
`Person Ids`	Provides a list of person IDs to associate with the asset.
`Site Name`	Sets the name of the site or location associated with the asset.
`Status`	The approval status to set, such as approved or rejected.
`Time End Milliseconds`	The end time in milliseconds for the playlist item.
`Time Start Milliseconds`	The start time in milliseconds for the playlist item.
`Title`	Sets the title or name of the asset.
`Type`	Sets the asset type, such as 'video', 'image', or 'document'.
`Updated By User`	Specifies the user ID or name of the user who last updated the asset.
`Warning`	Sets a warning message or flag associated with the asset.

/v1/assets/{asset_id}/

Required roles:

can_write_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Generate Subclip Keyframes`	If the asset is a subclip, generate keyframes for it
`Response Type`	The response format expected from the API (e.g. application/json).

Options (35)

Option Name	Description
`Analyze Status`	Sets the analysis status of the asset, such as 'pending' or 'completed'.
`Archive Status`	Sets the archive status of the asset, for example 'archived' or 'not_archived'.
`Category`	Assigns a category to the asset for organizational purposes.
`Created By User`	The user who created the member entry.
`Custom Keyframe`	Provides a URL or path to a custom keyframe image for the asset.
`Custom Poster`	Provides a URL or path to a custom poster image for the asset.
`Date Created`	The date and time when the member entry was created.
`Date Deleted`	Specifies the date and time when the asset was deleted.
`Date Imported`	Specifies the date and time when the asset was imported.
`Date Modified`	The date and time when the member entry was last modified.
`Date Viewed`	Specifies the date and time when the asset was last viewed.
`Deleted By User`	Specifies the user ID or name of the user who deleted the asset.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`External Link`	Provides an external URL associated with the asset.
`Face Recognition Status`	Sets the face recognition processing status for the asset.
`Favoured`	Indicates whether the asset is marked as a favorite (true or false).
`Has Unconfirmed Persons`	Indicates whether the asset has unconfirmed person detections (true or false).
`Id`	The unique identifier for the playlist item.
`In Collections`	Specify a list of collection IDs to which the asset should belong. This replaces the current set of collections.
`Is Blocked`	Indicates whether the asset is blocked from distribution (true or false).
`Is Online`	Indicates whether the asset is currently online and accessible (true or false).
`Last Archive Restore Date`	Specifies the date and time when the asset was last restored from archive.
`Limit Download To Groups`	Specifies a list of group IDs that are allowed to download the asset.
`Original Asset Id`	Sets the ID of the original asset if this is a duplicate or version.
`Original Segment Id`	Sets the ID of the original segment if this asset is part of a segment.
`Original Version Id`	Sets the ID of the original version if this is a versioned asset.
`Person Ids`	Provides a list of person IDs to associate with the asset.
`Site Name`	Sets the name of the site or location associated with the asset.
`Status`	The approval status to set, such as approved or rejected.
`Time End Milliseconds`	The end time in milliseconds for the playlist item.
`Time Start Milliseconds`	The start time in milliseconds for the playlist item.
`Title`	Sets the title or name of the asset.
`Type`	Sets the asset type, such as 'video', 'image', or 'document'.
`Updated By User`	Specifies the user ID or name of the user who last updated the asset.
`Warning`	Sets a warning message or flag associated with the asset.

/v1/collections/{collection_id}/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Change Parent Mode`	Set to 'move' or 'copy'. Ignored if 'parent_id' hasn't changed
`Response Type`	The response format expected from the API (e.g. application/json).

Options (11)

Option Name	Description
`Category`	Assigns a category to the asset for organizational purposes.
`Custom Keyframe`	Provides a URL or path to a custom keyframe image for the asset.
`Custom Poster`	Provides a URL or path to a custom poster image for the asset.
`Date Created`	The date and time when the member entry was created.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`Is Root`	Indicates whether this collection is a root collection (true) or not (false).
`Keyframe Asset Ids`	An array of asset IDs to be used as keyframes for the collection.
`Parent Id`	The ID of the parent collection under which this collection should be created.
`Status`	The approval status to set, such as approved or rejected.
`Storage Id`	The ID of the storage where the project's data will be stored.
`Title`	Sets the title or name of the asset.

/v1/collections/{collection_id}/

Required roles:

can_write_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Change Parent Mode`	Set to 'move' or 'copy'. Ignored if 'parent_id' hasn't changed
`Response Type`	The response format expected from the API (e.g. application/json).

Options (11)

Option Name	Description
`Category`	Assigns a category to the asset for organizational purposes.
`Custom Keyframe`	Provides a URL or path to a custom keyframe image for the asset.
`Custom Poster`	Provides a URL or path to a custom poster image for the asset.
`Date Created`	The date and time when the member entry was created.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`Is Root`	Indicates whether this collection is a root collection (true) or not (false).
`Keyframe Asset Ids`	An array of asset IDs to be used as keyframes for the collection.
`Parent Id`	The ID of the parent collection under which this collection should be created.
`Status`	The approval status to set, such as approved or rejected.
`Storage Id`	The ID of the storage where the project's data will be stored.
`Title`	Sets the title or name of the asset.

/v1/assets/{asset_id}/search_document/

Required roles:

can_reindex_assets

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (47)

Option Name	Description
`Analyze Status`	Sets the analysis status of the asset, such as 'pending' or 'completed'.
`Ancestor Collections`	Unordered list of all ancestor collection ids
`Archive Status`	Sets the archive status of the asset, for example 'archived' or 'not_archived'.
`Category`	Assigns a category to the asset for organizational purposes.
`Comments Count`	Number of comments associated with the asset.
`Created By User`	The user who created the member entry.
`Custom Keyframe`	Provides a URL or path to a custom keyframe image for the asset.
`Custom Poster`	Provides a URL or path to a custom poster image for the asset.
`Date Created`	The date and time when the member entry was created.
`Date Deleted`	Specifies the date and time when the asset was deleted.
`Date Imported`	Specifies the date and time when the asset was imported.
`Date Modified`	The date and time when the member entry was last modified.
`Date Viewed`	Specifies the date and time when the asset was last viewed.
`Deleted By User`	Specifies the user ID or name of the user who deleted the asset.
`Duration Milliseconds`	Duration of the asset in milliseconds.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`External Link`	Provides an external URL associated with the asset.
`Face Recognition Status`	Sets the face recognition processing status for the asset.
`Favoured`	Indicates whether the asset is marked as a favorite (true or false).
`Files`	JSON string representing file information for the asset.
`Formats`	JSON string representing format details of the asset.
`Has Unconfirmed Persons`	Indicates whether the asset has unconfirmed person detections (true or false).
`Id`	The unique identifier for the playlist item.
`In Collections`	Specify a list of collection IDs to which the asset should belong. This replaces the current set of collections.
`Is Blocked`	Indicates whether the asset is blocked from distribution (true or false).
`Is Online`	Indicates whether the asset is currently online and accessible (true or false).
`Keyframes`	JSON string representing keyframe data for the asset.
`Last Archive Restore Date`	Specifies the date and time when the asset was last restored from archive.
`Limit Download To Groups`	Specifies a list of group IDs that are allowed to download the asset.
`Media Type`	Type of media (e.g., video, audio, image) for the asset.
`Metadata`	A JSON string containing custom metadata for the segment.
`Object Type`	The type of the object being added to the playlist.
`Original Asset Id`	Sets the ID of the original asset if this is a duplicate or version.
`Original Segment Id`	Sets the ID of the original segment if this asset is part of a segment.
`Original Version Id`	Sets the ID of the original version if this is a versioned asset.
`Person Ids`	Provides a list of person IDs to associate with the asset.
`Position`	Position or order index of the asset within a collection or timeline.
`Proxies`	JSON string representing proxy file information for the asset.
`Site Name`	Sets the name of the site or location associated with the asset.
`Status`	The approval status to set, such as approved or rejected.
`Time End Milliseconds`	The end time in milliseconds for the playlist item.
`Time Start Milliseconds`	The start time in milliseconds for the playlist item.
`Title`	Sets the title or name of the asset.
`Type`	Sets the asset type, such as 'video', 'image', or 'document'.
`Updated By User`	Specifies the user ID or name of the user who last updated the asset.
`Versions Number`	Number of versions available for the asset.
`Warning`	Sets a warning message or flag associated with the asset.

/v1/collections/{collection_id}/search_document/

Required roles:

can_reindex_collections

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Collection Id`	The unique identifier of the collection where the object will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (26)

Option Name	Description
`Category`	Assigns a category to the asset for organizational purposes.
`Created By User`	The user who created the member entry.
`Custom Keyframe`	Provides a URL or path to a custom keyframe image for the asset.
`Custom Order Status`	Specify a custom order status for the collection as a string value.
`Custom Poster`	Provides a URL or path to a custom poster image for the asset.
`Date Created`	The date and time when the member entry was created.
`Date Deleted`	Specifies the date and time when the asset was deleted.
`Date Modified`	The date and time when the member entry was last modified.
`Deleted By User`	Specifies the user ID or name of the user who deleted the asset.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`Favoured`	Indicates whether the asset is marked as a favorite (true or false).
`Id`	The unique identifier for the playlist item.
`In Collections`	Specify a list of collection IDs to which the asset should belong. This replaces the current set of collections.
`Is Root`	Indicates whether this collection is a root collection (true) or not (false).
`Keyframe Asset Ids`	An array of asset IDs to be used as keyframes for the collection.
`Keyframes`	JSON string representing keyframe data for the asset.
`Metadata`	A JSON string containing custom metadata for the segment.
`Object Type`	The type of the object being added to the playlist.
`Parent Id`	The ID of the parent collection under which this collection should be created.
`Parents`	Provide a list of parent collection IDs to set as the collection's parents.
`Permissions`	Provide a list of permission strings to define access rights for the collection.
`Position`	Position or order index of the asset within a collection or timeline.
`Project Id`	The project identifier associated with the member record.
`Status`	The approval status to set, such as approved or rejected.
`Storage Id`	The ID of the storage where the project's data will be stored.
`Title`	Sets the title or name of the asset.

/v1/projects/{project_id}/

Required roles:

can_write_projects

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Project Id`	The unique identifier of the project to which the member is added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Collection Id`	An alternative way to specify the collection identifier, used when the object details are provided in the request body.
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	The unique identifier for the playlist item.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`Status`	The approval status to set, such as approved or rejected.
`Storage Id`	The ID of the storage where the project's data will be stored.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/projects/{project_id}/

Required roles:

can_write_projects

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Project Id`	The unique identifier of the project to which the member is added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Collection Id`	An alternative way to specify the collection identifier, used when the object details are provided in the request body.
`Created By User`	The user who created the member entry.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`Id`	The unique identifier for the playlist item.
`Name`	The unique name of the relation type, used as the relation_type parameter when creating relations.
`Status`	The approval status to set, such as approved or rejected.
`Storage Id`	The ID of the storage where the project's data will be stored.
`System Domain Id`	The system domain identifier for the transcription properties.

/v1/assets/{asset_id}/segments/{segment_id}/

Required roles:

can_write_segments

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Segment Id`	Unique identifier of the segment to delete.
`Generate Subclip Keyframes`	If the segment is a subclip, generate keyframes for it
`Response Type`	The response format expected from the API (e.g. application/json).

Options (31)

Option Name	Description
`Asset Id`	The asset identifier for the transcription properties.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`Id`	The unique identifier for the playlist item.
`Is Internal`	If set to true, the segment is only visible to internal iconik users
`Keyframe Id`	The unique identifier of the keyframe associated with the segment.
`Metadata`	A JSON string containing custom metadata for the segment.
`Metadata View Id`	The identifier of the metadata view to use when interpreting the metadata field.
`Parent Id`	The ID of the parent collection under which this collection should be created.
`Path`	The file path or location reference for the segment.
`Person Id`	The unique identifier of the person associated with the segment.
`Project Id`	ID of a project if the segment is created from a project
`Segment Checked`	Boolean flag indicating whether the segment has been reviewed or verified.
`Segment Color`	A color value (e.g., hex code) used to visually distinguish the segment.
`Segment Text`	Text content or label for the segment.
`Segment Track`	The track number or name where the segment should be placed.
`Segment Type`	The type or category of the segment (e.g., 'comment', 'marker').
`Share Id`	ID of a share if the segment is created from a share
`Share User Email`	The email address of a user with whom the segment is shared.
`Status`	The approval status to set, such as approved or rejected.
`Subclip Id`	The identifier of a subclip that the segment references.
`Time End Milliseconds`	The end time in milliseconds for the playlist item.
`Time Start Milliseconds`	The start time in milliseconds for the playlist item.
`Top Level`	Boolean flag indicating whether the segment is a top-level segment (not nested).
`Transcription Id`	The identifier of a transcription entry associated with the segment.
`User First Name`	The first name of the user who created or owns the segment.
`User Id`	The unique identifier of the user associated with the segment.
`User Last Name`	The last name of the user who created or owns the segment.
`User Photo`	A URL or path to the user's photo associated with the segment.
`Version Id`	The version identifier of the object to add.

/v1/assets/{asset_id}/segments/{segment_id}/

Required roles:

can_write_segments

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Segment Id`	Unique identifier of the segment to delete.
`Generate Subclip Keyframes`	If the segment is a subclip, generate keyframes for it
`Response Type`	The response format expected from the API (e.g. application/json).

Options (31)

Option Name	Description
`Asset Id`	The asset identifier for the transcription properties.
`Date Created`	The date and time when the member entry was created.
`Date Modified`	The date and time when the member entry was last modified.
`External Id`	Sets an external identifier for the asset to integrate with other systems.
`Id`	The unique identifier for the playlist item.
`Is Internal`	If set to true, the segment is only visible to internal iconik users
`Keyframe Id`	The unique identifier of the keyframe associated with the segment.
`Metadata`	A JSON string containing custom metadata for the segment.
`Metadata View Id`	The identifier of the metadata view to use when interpreting the metadata field.
`Parent Id`	The ID of the parent collection under which this collection should be created.
`Path`	The file path or location reference for the segment.
`Person Id`	The unique identifier of the person associated with the segment.
`Project Id`	ID of a project if the segment is created from a project
`Segment Checked`	Boolean flag indicating whether the segment has been reviewed or verified.
`Segment Color`	A color value (e.g., hex code) used to visually distinguish the segment.
`Segment Text`	Text content or label for the segment.
`Segment Track`	The track number or name where the segment should be placed.
`Segment Type`	The type or category of the segment (e.g., 'comment', 'marker').
`Share Id`	ID of a share if the segment is created from a share
`Share User Email`	The email address of a user with whom the segment is shared.
`Status`	The approval status to set, such as approved or rejected.
`Subclip Id`	The identifier of a subclip that the segment references.
`Time End Milliseconds`	The end time in milliseconds for the playlist item.
`Time Start Milliseconds`	The start time in milliseconds for the playlist item.
`Top Level`	Boolean flag indicating whether the segment is a top-level segment (not nested).
`Transcription Id`	The identifier of a transcription entry associated with the segment.
`User First Name`	The first name of the user who created or owns the segment.
`User Id`	The unique identifier of the user associated with the segment.
`User Last Name`	The last name of the user who created or owns the segment.
`User Photo`	A URL or path to the user's photo associated with the segment.
`Version Id`	The version identifier of the object to add.

/v1/{object_type}/{object_id}/shares/{share_id}/

Required roles:

can_write_shares

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Share Id`	The unique identifier of the share to which the user is added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (27)

Option Name	Description
`Allow Approving Comments`	Set to true to allow recipients to approve comments on the shared object.
`Allow Comments`	Set to true to allow recipients to add comments to the shared object.
`Allow Custom Actions`	Set to true to allow recipients to execute custom actions on the shared object.
`Allow Download`	Set to true to allow recipients to download the original file of the shared object.
`Allow Download Proxy`	Set to true to allow recipients to download a proxy version of the shared object.
`Allow Setting Approve Status`	Set to true to allow recipients to change the approval status of the shared object.
`Allow Upload`	Set to true to allow recipients to upload new versions or files to the shared object.
`Allow User Search For Mentions`	Set to true to allow recipients to search for other users when mentioning them in comments.
`Allow View Transcriptions`	Set to true to allow recipients to view transcriptions of audio or video content.
`Allow View Versions`	Set to true to allow recipients to view different versions of the shared object.
`Date Created`	The date and time when the member entry was created.
`Expires`	The date and time when the share link will expire, in ISO 8601 format.
`Has Password`	Specifies whether the share requires a password to access. Provide a boolean value (true or false).
`Id`	The unique identifier for the playlist item.
`Is Approval`	Set to true to make this share an approval request rather than a simple share.
`Message`	A custom message to include in the share invitation email.
`Metadata Views`	A list of metadata view IDs that define which metadata fields are visible to recipients.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Owner Id`	The ID of the user who will be set as the owner of the share.
`Project Id`	Project ID if the share is created from a project
`Review Experience Public Beta`	Set to true to enable the public beta review experience for this share.
`Show Watermark`	Set to true to display a watermark on previews of the shared object.
`System Domain Id`	The system domain identifier for the transcription properties.
`Title`	Sets the title or name of the asset.
`Upload Storage Id`	The storage ID where uploaded files for this share will be stored.
`Url`	Provides the endpoint URL that the custom action calls.

/v1/{object_type}/{object_id}/shares/{share_id}/users/{share_user_id}/

Required roles:

can_write_shares

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Share Id`	The unique identifier of the share to which the user is added.
`Share User Id`	Unique identifier of the share user to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (14)

Option Name	Description
`Access Count`	The number of times the share user has accessed the share.
`Email`	The email address of the share user.
`First Name`	The first name of the share user.
`Id`	The unique identifier for the playlist item.
`Internal User Id`	The identifier of the internal user linked to this share user.
`Last Access Date`	The date and time of the last access by the share user.
`Last Name`	The last name of the share user.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Password`	The password for the share user.
`Photo`	A URL or path to the share user's photo.
`Photo Big`	A URL or path to a larger version of the share user's photo.
`Photo Small`	A URL or path to a smaller version of the share user's photo.
`Share Id`	The share identifier for the share user.

/v1/{object_type}/{object_id}/shares/{share_id}/users/{share_user_id}/

Required roles:

can_write_shares

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Object Type`	The type of the object that the share belongs to.
`Object Id`	The unique identifier of the object that the share belongs to.
`Share Id`	The unique identifier of the share to which the user is added.
`Share User Id`	Unique identifier of the share user to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (14)

Option Name	Description
`Access Count`	The number of times the share user has accessed the share.
`Email`	The email address of the share user.
`First Name`	The first name of the share user.
`Id`	The unique identifier for the playlist item.
`Internal User Id`	The identifier of the internal user linked to this share user.
`Last Access Date`	The date and time of the last access by the share user.
`Last Name`	The last name of the share user.
`Object Id`	The identifier of the object to add as a playlist item.
`Object Type`	The type of the object being added to the playlist.
`Password`	The password for the share user.
`Photo`	A URL or path to the share user's photo.
`Photo Big`	A URL or path to a larger version of the share user's photo.
`Photo Small`	A URL or path to a smaller version of the share user's photo.
`Share Id`	The share identifier for the share user.

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/{transcription_id}/properties/

Required roles:

can_write_transcriptions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Transcription Id`	Provide the ID of the transcription whose properties should be deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Asset Id`	The asset identifier for the transcription properties.
`Id`	The unique identifier for the playlist item.
`Language`	The language code for the subtitles.
`System Domain Id`	The system domain identifier for the transcription properties.
`Version Id`	The version identifier of the object to add.

/v1/assets/{asset_id}/versions/{version_id}/transcriptions/{transcription_id}/properties/

Required roles:

can_write_transcriptions

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`App-id`	The application identifier used for authentication.
`Auth-token`	The authentication token for the request.
`Asset Id`	The unique identifier of the asset.
`Version Id`	The unique identifier of the version.
`Transcription Id`	Provide the ID of the transcription whose properties should be deleted.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Asset Id`	The asset identifier for the transcription properties.
`Id`	The unique identifier for the playlist item.
`Language`	The language code for the subtitles.
`System Domain Id`	The system domain identifier for the transcription properties.
`Version Id`	The version identifier of the object to add.

General (196)