Adobe Premiere Pro Agent REST API

Modified on Sun, 5 Nov, 2023 at 5:17 PM

Embrace developed an Adobe Premiere Pro Extension designed for Pulse-IT or Automate-IT controls the app directly inside a worker node.

Adobe Premiere Pro must be started (by the node app feature) to have a response.

open_project

Open the PPro project and close the previously opened project.

Return the name and the GUID of the active sequence. Don't close project after execution.

URL

http://localhost:8009

POST

{
     "job":"open_project", // job name
     "path":"//path//of//PPro//project.pproj" // path of the project to open
}

RESPONSE IF SUCESS

{
     "succes":true, // bool
     "activeSequence":"name of the active sequence", // string
     "itemGUID": "0000-0000-0000-0000-0000" // string  unique ID of the sequence
}

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"No active sequence" // string
}

get_project_data

Open the PPro project and close the previously opened project.

Return the name and the GUID of the active sequence. Close project after execution.

URL

http://localhost:8009

POST

{
     "job":"get_project_data", // job name
     "path":"//path//of//PPro//project.pproj" // path of the project to open
}

RESPONSE IF SUCESS

{
     "succes":true, // bool
     "activeSequence":"name of the active sequence", // string
     "itemGUID": "0000-0000-0000-0000-0000" // string  unique ID of the sequence
}

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"No active sequence" // string
}

set_enabled_proxies

Open the PPro project and close the previously opened project.

Determines whether proxy usage is currently enabled.

Return the name and the GUID of the active sequence. Close project after execution.

URL

http://localhost:8009

POST

{
     "job":"set_enabled_proxies", // job name
     "path":"//path//of//PPro//project.pproj", // path of the project to open
     "proxies_value":0 // 0 PPro dont'use proxies / 1 PPro uses proxies 
}

RESPONSE IF SUCESS

{
     "succes":true, // bool
     "activeSequence":"name of the active sequence", // string
     "itemGUID": "0000-0000-0000-0000-0000" // string  unique ID of the sequence
}

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"No active sequence" // string
}

open_project_get_mogrt_data

Open PPro project and get mogrt data from active sequence.

Return an array with all MOGRT.

Close project after execution.

URL

http://localhost:8009

POST

{
     "job":"open_project_get_mogrt_data", // job name
     "path":"//path//of//PPro//project.pproj" // path of the project to open
}

RESPONSE IF SUCESS

{
    "succes": true,
    "data": [
        {
            "type": "Graphics overlay",
            "displayProperty": "TEXTE AVEC CONTOUR",
            "value": "Le Koweït met fin à la\nmixité dans la principale\nuniversité du pays.\n\nLes hommes et les\nfemmes ne pourront\nplus étudier ensemble. ",
            "PropertieIndex": 1,
            "in": 0,
            "in_tc": "00:00:00:00",
            "out": 5.72,
            "out_tc": "00:00:05:18",
            "videoTrackIdx": 1,
            "videoTrackName": "Video 2",
            "id": "1696508799592",
            "source": "MOGRT_CARTON TIKTOK_CARTON_CENTRE_V8"
        },
        {
            "type": "Graphics overlay",
            "displayProperty": "TEXTE AVEC FOND",
            "value": "Je vous raconte.",
            "PropertieIndex": 2,
            "in": 0,
            "in_tc": "00:00:00:00",
            "out": 5.72,
            "out_tc": "00:00:05:18",
            "videoTrackIdx": 1,
            "videoTrackName": "Video 2",
            "id": "1696508799592",
            "source": "MOGRT_CARTON TIKTOK_CARTON_CENTRE_V8"
        },
        {
            "type": "Graphics overlay",
            "displayProperty": "Version",
            "value": "8",
            "PropertieIndex": 4,
            "in": 0,
            "in_tc": "00:00:00:00",
            "out": 5.72,
            "out_tc": "00:00:05:18",
            "videoTrackIdx": 1,
            "videoTrackName": "Video 2",
            "id": "1696508799592",
            "source": "MOGRT_CARTON TIKTOK_CARTON_CENTRE_V8"
        },
        {
            "type": "Graphics overlay",
            "displayProperty": "NOM_JOURNALISTE",
            "value": "Anastasia Nicolas",
            "PropertieIndex": 1,
            "in": 70.28,
            "in_tc": "00:01:10:07",
            "out": 72.12,
            "out_tc": "00:01:12:03",
            "videoTrackIdx": 2,
            "videoTrackName": "Video 3",
            "id": "1696508799966",
            "source": "OUTRO_TIKTOK_JUILLET"
        }
    ],
    "activeSequence": "#EDIT_FRANCE SHORT_TO_COPY"
}

type: will be always "Graphics overlay", reserved for future usage.

displayProperty: the name of the property inside the MOGRT.

value: the text sting exported from the MOGRT.

PropertieIndex: index pf the propertie inside the MOGRT.

in: start time of the MOGRT

in_TC: start timecode of the MOGRT

out: end time of the MOGRT

out_TC: out timecode of the MOGRT

videoTrackIdx: index of the video track inside the sequence containing the MOGRT

videoTrackName: name of the video track inside the sequence containing the MOGRT

id: unique id of the instance of the MOGRT (added by this call)

source: name of the MOGRT template file

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"No active sequence" // string
}

open_project_update_mogrt_data_save

Open the PPro project and close the previously opened project.

Update MOGRT data inside active sequence.

Save a copy of the updated PPro project

URL

http://localhost:8009

POST

{
     "job":"open_project_update_mogrt_data_save", // job name
     "original_path":"//path//of//PPro//project.pproj", // path of the project to open
     "translate_data":  [...],  // array of MOGRT data (same structure as open_project_get_mogrt_data)
     "target_language":"EN",// string of the language code used to rename the sequence,
     "target_path":" //path//of//PPro//project_translated.pproj", // path of the project to save

RESPONSE IF SUCESS

{
     "succes":true, // bool
     "activeSequence":"name of the active sequence translated", // string
     "message":"5  item(s) updated" // message with the number of item updated
}

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"No active sequence" // string
}

disable_tracks_save

Open the PPro project and close the previously opened project.

Disable the Video or Audio tracks in the active sequence provided in the list_tracks key (name of the tracks separated by a comma).

Save a copy of the updated PPro project

URL

http://localhost:8009

POST

{
     "job":"disable_tracks_save", // job name
     "path":"//path//of//PPro//project.pproj", // path of the project to open
     "list_tracks":  "Voice Over,Graphics,Video 3"  // list of a track name separated with a comma to disable 
     "target_path":" //path//of//PPro//project_translated.pproj", // path of the project to save

RESPONSE IF SUCESS

{
     "succes":true, // bool
     "activeSequence":"name of the active sequence translated", // string
     "itemGUID": "0000-0000-0000-0000-0000" // string  unique ID of the sequence
}

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"No active sequence" // string
}

srt_to_mogrt_save

Open the PPro project and close the previously opened project.

From a standart srt file, the job will create new MOGRT instance from the srt data.

A new video track will be added to the active sequence

Save and Close project after execution.

URL

http://localhost:8009

POST

{
     "job":"srt_to_mogrt_save", // job name
     "path":"//path//of//PPro//project.pproj", // path of the project to open
     "srt_file_path":"//path//of//file.srtj", // path of the srt file
     "srt_mpgrt_path":"//path//of//file.mogrt" // path of the mogrt file
}

RESPONSE IF SUCESS

{
     "succes":true, // bool
     "activeSequence":"name of the active sequence translated", // string
     "itemGUID": "0000-0000-0000-0000-0000" // string  unique ID of the sequence
}

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"No active sequence" // string
}

remove_audio_tracks

Open the PPro project and close the previously opened project.

Empty all audio tracks of the active sequence.

Save and Close project after execution.

URL

http://localhost:8009

POST

{
     "job":"remove_audio_tracks", // job name
     "path":"//path//of//PPro//project.pproj", // path of the project to open
}

RESPONSE IF SUCESS

{
     "succes":true, // bool
     "activeSequence":"name of the active sequence translated", // string
     "itemGUID": "0000-0000-0000-0000-0000" // string  unique ID of the sequence
}

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"No active sequence" // string
}

rename_item

Open the PPro project and close the previously opened project.

Search and rename an item inside the project

Save and Close project after execution.

URL

http://localhost:8009

POST

{
     "job":"rename_item", // job name
     "path":"//path//of//PPro//project.pproj", // path of the project to open
     "item_name":"original seq name",
     "target_name":"updated seq name"
}

RESPONSE IF SUCESS

{
     "succes":true // bool
}

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"PPro project not found" // string
}

import_file_edit_audio_save

Open the PPro project and close the previously opened project.

Import and edit (everwrite) an audio file to the active sequence

Save and Close project after execution.

URL

http://localhost:8009

POST

{
     "job":"import_file_edit_audio_save", // job name
     "path":"//path//of//PPro//project.pproj", // path of the project to open
     "input_file":"//path//of//PPro//file.av", // path of the audio file to add in the active seq
}

RESPONSE IF SUCESS

{
     "succes":true, // bool
     "activeSequence":"name of the active sequence translated", // string
     "itemGUID": "0000-0000-0000-0000-0000" // string  unique ID of the sequence
}

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"No active sequence" // string
}

search_offline_items

Open the PPro project and close the previously opened project.

Return the list of offline time

Close project after execution.

URL

http://localhost:8009

POST

{
     "job":"search_offline_items", // job name
     "path":"//path//of//PPro//project.pproj", // path of the project to open
}

RESPONSE IF SUCESS

{
     "succes":true, // bool
     "activeSequence":"name of the active sequence", // string
     "itemGUID": "0000-0000-0000-0000-0000", // string  unique ID of the sequence
     "offline_items":[
           "/Users/montage28/Desktop/TRANSCO/Transcodé_FR_IA_DATA SPORT/FLECHE 2.mov",
          "/Users/montage28/Desktop/TRANSCO/Transcodé_FR_IA_DATA SPORT/CES 2022 SPORT IA AFP-TV_20220107_HTH_USA_SportPandemie_9VP7YH_fr.mp4"
     ]
}

RESPONSE IF ERROR

{
     "succes":false, // bool
     "message":"No active sequence" // string
}