🎉
Helmut4
v4.6.1
v4.9.1v4.9.0v4.8.1v4.8.0v4.7.2v4.7.1v4.7.0v4.6.2v4.6.14.6.0v4.5.0
v4.6.1
v4.9.1v4.9.0v4.8.1v4.8.0v4.7.2v4.7.1v4.7.0v4.6.2v4.6.14.6.0v4.5.0
  • 👋Welcome to the official Helmut4 documentation
  • GETTING STARTED
    • Overview
      • How to start
      • Helmut4 Modules
      • Deployment Options
    • Tech Specs
      • Helmut4 Server
      • Helmut4 Clients
    • Installation Guide
      • Helmut4 Server
        • Helmut4 Single Server
        • Helmut4 Cluster System
      • Helmut4 Client
    • Upgrade Guide
      • Helmut4 Server
      • Helmut4 Client
    • Release Cycles
    • Supported Adobe Versions
    • Open API
    • Misc
      • SSL Certificate
      • Commonly used ports
  • Helmut4 components
    • HelmutFX
      • Dashboard
      • Projects
        • Add Project
        • Open Project
        • Refresh Button
        • Projects Action Menu
        • Search Bar
        • Filter
        • Collection Tag
        • Custom User Button
        • Log Out Button
        • Connected Button
        • Hover Icon
        • Blank Space/ Hidden Overlay
        • Project Type Icon
        • Add Filter Button
        • Header
        • Viewing
        • Project Status
      • Users
        • Side Bar
        • Action Button Menu
        • Main functionalities
          • Add Group
          • Access Preset
      • Templates
        • Add Category
        • Blank Space - Hidden Overlay
      • Preferences
        • Backup
        • Restore
        • Projects
        • Templates
        • Profiles
        • Default Languages
        • Path Mapping
        • Variables
        • Temporary Project Import Directory
        • Job Database Cleanup
        • Modules
          • Flow Module
          • QScan Module
          • ActiveDirectory Module
          • MediaLoopster Module
          • CatDV Module
          • SwatIO Module
          • Grass Valley Stratus Module
          • Active Directory Auto Module
          • Editshare Module
          • RevApp Module
          • Hue Bridges Module
      • Languages
      • Metadata
      • Streams
        • FX Event Triggers
          • CONNECTED
          • CREATE_CATEGORY
          • CREATE_GROUP
          • CREATE_PROJECT
          • CREATE_USER
          • CUSTOM_FX
          • CUSTOM_USER
          • DELETE_CATEGORY
          • DELETE_GROUP
          • DELETE_PROJECT
          • DELETE_TEMPLATE
          • DELETE_USER
          • DISCONNECTED
          • DUPLICATE_PROJECT
          • EDIT_PROJECT
          • IMPORT_PROJECT
          • OPEN_PROJECT
          • POST_CREATE_PROJECT
          • RESTORE_SAVE
          • UNASSIGNED
          • UNLOCK_PROJECT
          • UPLOAD_PROJECT
        • Main Functionalities
          • Export Streams
          • Import Streams
          • Debug Streams
          • Add Stream
          • Table View
      • License
    • HelmutIO
      • Dashboard
        • Filter
        • Blank Space
        • Source Type Icon
        • Job Type Icon
        • Job Name
        • Progress
        • Render Node Name
        • Start Date
        • Priority
        • Action Button
        • Viewing
        • Refresh
      • Users
      • Profiles
        • Profiles Dashboard
        • Add Profile
      • Wachfolder
        • Add Watchfolder
      • Preferences
      • Languages
      • Metadata
      • Streams
        • IO Event Triggers
          • AUTOIMPORT
          • CUSTOM_IO
          • EXPORT
          • IMPORT (legacy)
          • PANEL_IMPORT
          • PRESTREAM
          • WATCHFOLDER
      • License
    • HelmutCO
      • Dashboard
      • Projects
        • Search Bar
        • Filter
        • Create Folder
        • Upload Assets
        • Upload Dialog
        • Import Assets
        • Project Level
        • Refresh Button
        • Type Icon
        • Name
        • MIME Type
        • Size
        • Folder (Breadcrumb)
        • Synced
        • Online
        • Modified
        • Action Button
      • Users
      • Profiles
      • Preferences
      • Languages
      • Metadata
      • Streams
        • CO Event Triggers
          • ADDED_ASSET
          • INDEXED_ASSET
          • INDEXED_PROJECT
          • UNINDEXED_ASSET
          • WEB_EXPORT
          • WEB_IMPORT
          • WEB_UPLOAD
      • License
    • HelmutHK
      • Dashboard
      • Projects
      • Tasks
        • Add Task
        • Action Button
      • Cron
        • Add Cron Job
      • Users
      • Profiles
        • Add Profile
      • Preferences
      • Languages
      • Streams
        • HK Event Triggers
          • ARCHIVE
          • BACKUP
          • CONSOLIDATE
          • COPY
          • DELETE
          • MOVE
          • RESTORE
      • License
    • Stream Designer
      • Layout
        • Save
        • Snapshots
        • Screenshot
        • Test
        • Reload
        • Exchange
        • Variables
        • Debug - Stream Debugger
        • Settings
        • Edit Dialog
        • Node Pallet
        • Shortcuts
      • Nodes
        • Actions
          • Project
            • Project Create Action
            • Project File Action
            • Project Metadata Changer Action
            • Project File Download Action
            • Project File Upload Action
            • Project Metadata Remove Action
            • Project Set Category Action
            • Project Set Group Action
            • Project Set Name Action
            • Project Set Path Action
            • Project Set Tag Action
            • Project Set Template Action
            • Project As JSON
            • Project Delete Action
            • Project from JSON Action
            • Project Import Action
            • Project Import to External Helmut Action
            • Project Lock Action
            • Project Status Update Action
            • Project Update Modification Date Action
            • Project Duplicate Action
          • Job Action
            • Job Metadata Remove Action
            • Job Metadata Changer Action
            • Job Priority Action
            • Job QScan Action
            • Job Render AAF In Premiere Action
            • Job Render in AME Action
            • Job Render Proxy in AME Action
            • Job Render In Premiere Action
            • Job Render with FFMEPG Action
            • Job Start Premiere Action
            • Job Status Update Action
            • Job As JSON Action
            • Job From JSON Action
            • Job Set Project ID Action
            • Job Create Job Action
            • Job Delete Action
            • Job Execute Extendscript in Premiere Action
            • Job File Copy Action
            • Job Folder Copy Action
            • Job RClone Copy Action
            • Job RClone MkDir Action
            • Job RClone Move Action
            • Job RClone Purge Action
            • Job RClone RmDir Action
            • Job Export FCP XML in Premiere
            • Job Create Split Jobs Action (BETA)
            • Job Stitch Splits Action (BETA)
          • Premiere
            • Premiere Generate UUID Action
            • Premiere Alert Dialog Action
            • Premiere Confirm Dialog Action
            • Premiere Force Native Lock Action
            • Premiere Native Lock Action
            • Premiere OS Path Mapper Action
            • Premiere Open Choose Dialog Action
            • Premiere Path Settings Action
            • Premiere Prompt Dialog Action
            • Premiere Start Helmut Panel Action
            • Premiere Version Converter Action
          • Cosmo
            • Cosmo Add Asset To Project Action
            • Cosmo Add Info To Sequence Action
            • Cosmo Add Proxy To Project Action
            • Cosmo Change Asset Action
            • Cosmo Get Project Assets Action
            • Cosmo Change Project Asset Action
            • Cosmo Project File Index Action
            • Cosmo Get Project Sequences Action
            • Cosmo Asset Report Action
            • Cosmo Sequence Report Action
            • Cosmo Change Asset Metadata Action
            • Cosmo Delete Asset Metadata Action
            • Cosmo Get Asset Metadata Action
          • After Effects
            • After Effects OS Path Mapper Action
            • After Effects Alert Dialog Action
            • After Effects Open Choose Dialog Action
            • After Effects Prompt Dialog Action
            • After Effects Start Helmut Panel Action
            • Job Execute ExtendScript In After Effects Action
            • Job Start After Effects Action
          • Third Party
            • Editshare Set ACL Action
            • Editshare Delete ACL Action
            • EFS Create User Action
            • EFS Delete User Action
            • EFS Add Users To Group Action
            • EFS Remove User From Group Action
            • EFS Add Users To Media Space Action
            • EFS Remove Users From Media Space Action
            • EFS Create Group Action
            • EFS Remove Group Action
            • EFS Add Group To Media Space Action
            • EFS Remove Group From Media Space Action
            • EFS Create Media Space Action
            • EFS Delete Media Space Action
            • EFS Update Media Space Action
            • EFS Get Media Space DATA Action
            • EFS Get Free Space Of Media Space Action
            • Hue Bridge Group On Action
            • Hue Bridge Group Change Action
            • Hue Bridge Group Off Action
            • Hue Bridge Lamp On Action
            • Hue Bridge Lamp Change Action
            • Hue Bridge Lamp Off Action
            • CatDV Add Asset to Catalog Action
            • CatDV Create Catalog Path Action
            • CatDV Delete Catalog Path Action
            • Flow Add Asset To Project Action
            • Flow Create Path Action
            • Flow Delete Path Action
            • Flow Toggle Private Project Action
            • SwatIO Job Upload Action
            • Medialoopster Add Asset To Project Action
            • Medialoopster Create Project Action
            • Medialoopster Delete Asset From Project Action
            • Medialoopster Delete Project Action
            • Medialoopster Update Project Delete Date Action
            • Mount EFS Volume (MacOS) Action
            • Mount EFS Volume (Windows) Action
            • Stratus Create Asset Action
            • Stratus Create Project Action
            • Stratus Generate Unique ID Action
            • Stratus Patch Asset Action
            • Stratus Project Indexed Action
            • Stratus Project Status Action
            • Stratus Transfer Asset Action
            • Stratus Trigger Momentum Action
            • Stratus Add Asset to Folder Action
            • Stratus Get All Folders Action
            • Stratus Create Folder Action
            • Stratus Update Project Path Action
            • Stratus Asset Add Folder Membership Action
            • Stratus Change Project Metadata Action
            • Aurora Submit Job Action
            • RevApp Share Asset By Email Action
            • RevApp Share Asset Public Link Action
            • RevApp Share Asset with Internal Group Action
            • RevApp Upload Asset To Namespace Action
            • RevApp Delete Asset From Namespace Action
            • Hiscale Jobs Start Process Action
            • VPMS Check-in Action
            • VPMS Metadata Update Action
            • Elements
              • Elements Add Permissions To Workspace Action
              • Elements Add Users To Groups Action
              • Elements Compare To Helmut User Action
              • Elements Copy Files Action
              • Elements Create API token Action
              • Elements Create Groups Action
              • Elements Create Directories Action
              • Elements Create Media Root Action
              • Elements Create Production Action
              • Elements Create Share Action
              • Elements Create Users Action
              • Elements Create Workspace Action
              • Elements Delete Files Action
              • Elements Delete Files From Media Library Action
              • Elements Delete Groups Action
              • Elements Delete Directories Action
              • Elements Delete Media Root Action
              • Elements Delete Production Action
              • Elements Delete Share Action
              • Elements Delete Users Action
              • Elements Delete Workspaces Action
              • Elements Get Client Key Action
              • Elements Get Free Space Of Workspace Action
              • Elements HTTP Request Action
              • Elements Mount Workspaces On Client Action
              • Elements Move Files Action
              • Elements Remove Permissions From Workspace Action
              • Elements Remove Users From Groups Action
              • Elements Start Job Action
              • Elements Unmount Workspaces From Client Action
              • Elements Update Workspace Quota Action
              • Elements Upload File Into Media Library Action
            • Vantage
              • Vantage Submit Job Action
              • Vantage Remove Job Action
            • Vidicore
              • VidiCore Add Collection To Collection Action
              • VidiCore Add Deletion Lock To Collection Action
              • VidiCore Add Deletion Lock To File Action
              • VidiCore Add Deletion Lock To Item Action
              • VidiCore Add External ID To Item Action
              • VidiCore Add Item To Collection Action
              • VidiCore Add Key Value Metadata To File Action
              • VidiCore Add Key Value Metadata To Library Action
              • VidiCore Add Library To Collection Action
              • VidiCore Add Metadata Field Values To Collection Action
              • VidiCore Add Metadata Field Values To Item Action
              • VidiCore Create Collection Action
              • VidiCore Delete Collection Action
              • VidiCore Delete Item Action
              • VidiCore Get Item ID By File Path Action
              • VidiCore Get Token
              • VidiCore Import File Into New Item Action
              • VidiCore Remove Collection From Collection Action
              • VidiCore Remove Deletion Lock From Collection Action
              • VidiCore Remove Deletion Lock From File Action
              • VidiCore Remove Deletion Lock From Item Action
              • VidiCore Remove Item From Collection Action
              • VidiCore Remove Key Value Metadata From File Action
              • VidiCore Remove Key Value Metadata From Library Action
              • VidiCore Remove Library From Collection Action
              • VidiCore Remove Metadata Field Values From Collection Action
              • VidiCore Remove Metadata Field Values From Item Action
              • VidiFlow Trigger Workflow
            • Diva
              • Diva Archive Content Action
              • Diva Delete Content Action
              • Diva Restore Content Action
          • File and Folder
            • File Copy Action
            • File Create Action
            • File Delete Action
            • File Increment Name Action
            • File Move Action
            • File Open Action
            • File Rename Action
            • File Replace Content Action
            • Folder Content Delete Action
            • Folder Copy Action
            • Folder Create Action
            • Folder Delete Action
            • Folder Increment Name Action
            • Folder Move Action
            • Folder Rename Action
            • XSquare File Check In Action
            • 7-Zip Archive Action
            • 7-Zip Extract Action
            • 7-Zip CLI Action
            • Get Files From Folder Action
            • Get Folder From Folder Action
          • User
            • Send Message to User
            • Send Notification to User
          • OS
            • Commandline Execute Action
            • Unmount A Share Action
          • MISC
            • Execute Javascript Action
            • Fail Action
            • HTTP Request Action
            • JSON Extract Action
            • Metadata Auto Mapper Action
            • Regex Apply Action
            • Sleep Action
            • Split Stream Action
            • Stream Execute Generic Stream Action
            • Stream Set Temporary Variable Action
            • Stream Set Store Variable Action
            • Stream Get Store Variable Action
            • Stream Delete Store Variable Action
            • Success Action
            • XPath Action
        • Conditions
          • Project
            • Project Category Condition
            • Project Creator Condition
            • Project Extension Condition
            • Project Group Condition
            • Project Name Condition
            • Project Personal Condition
            • Project Template Condition
            • Project Version of Premiere Condition
          • User
            • User Displayname Condition
            • User Group Condition
            • User Role Condition
            • User Name Condition
          • File and Folder
            • File Content Condition
            • File Exists Condition
            • File Growing Condition
            • File Name Condition
            • File Size Condition
            • Folder Empty Condition
            • Folder Exists Condition
            • Folder Name Condition
          • OS
            • Operating System Condition
          • Media Info
            • Audio Channel Condition
            • Audio Streams Condition
            • Bitrate Codec Condition
            • FPS Condition
            • Media Codec Condition
            • Media Color Space Condition
            • Media Length Condition
            • Media Resolution Condition
          • MISC
            • Empty String Condition
            • IP Condition
            • Regex Match Condition
            • Wildcard Condition
            • Match Multiple Patterns Condition
        • Outputs
          • File and Folder
            • Write File Output
          • OS
            • MacOS System Notification Output
          • User
            • Send Message to User
            • Send Notification to User
          • MISC
            • Send Email Output
            • Telegram Output
            • Send Message To Teams Channel
      • Wildcards
        • General Wildcards
          • Job Breadcrumb Wildcard
          • Job Destination Wildcard
          • Job Proxy Wildcard
        • Functional Wildcards
          • Convert Date To Timestamp ?
          • Convert Timestamp To Date ?
          • Convert Timestamp To Datetime ?
          • Date Day ?
          • Date Month ?
          • Date Month Textual ?
          • Date Month Textual Short ?
          • Date Year ?
          • Date Shortyear ?
          • File Content ?
          • File Exists ?
          • File MD5 ?
          • File Modified ?
          • File Size ?
          • Folder Content ?
          • Folder Exists ?
          • Folder Modified ?
          • Folder Size ?
          • Helmut Variable ?
          • Job metadata ?
          • Job custom ?
          • Project custom ?
          • Local Environment ?
          • Local Profile ?
          • Local Registry ?
          • Path Basename ?
          • Path Map To Unix ?
          • Path Map To Win ?
          • Path Map Auto ?
          • Path Map To JSON ?
          • Path Name ?
          • Path Parent ?
          • Path Split ?
          • Project Metadata?
          • Stream Variable ?
          • String Split ?
          • String length ?
          • String Case To Camel ?
          • String Case To Kebab ?
          • String Case To Lower ?
          • String Case To Pascal ?
          • String Case To Snake ?
          • String Case To Upper ?
          • Node Result ?
          • Job Tries
      • Stream Debugger
    • Streaming Engine
    • Helmut4 Client
    • Panel extensions
  • Release Notes
    • What's New
    • Changelog
    • Known Issues
  • Support
    • Requesting Support
    • Response and Resolution Times
Powered by GitBook
On this page
  1. GETTING STARTED

Open API

Helmut4 follows an API-first approach where all of the UI is based on our API. For cases where you may want to automate or connect Helmut4 to other third-party systems, our open API comes in handy as it offers an extremely powerful set of functionalities

The link to our OpenAPI documentation can be accessed here

If you have any questions regarding the use of our OpenAPI, please reach out to our support team via the support portal for assistance.

Please be aware that the current accessible API definition is always referring to the latest Helmut4 release. https://docs.helmut.de/helmut4-releases/getting-started/open-api

PreviousSupported Adobe VersionsNextMisc

Last updated 1 year ago