SysBridge API - Calls

File System

Performing file system operations

ListFiles

Return all files in the given directory.

Params

Key	Type	Default	Description
Path	STRING	-	Absolute path of the directory
Recursive	BOOLEAN OPTIONAL	`false`	Should include directories in the given path.
Filter	STRING ARRAY OPTIONAL	-	An array of strings representing filters. Only the files with extension present in the provided array will be returned.

Examples

Example 1 - Success Response

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "ListFiles",
    "ID": "1"
}
{
    "Params": {
        "Path": "C:\\Pixotope"
    }
}

CallResult

JSON

{
    "Result": {
        "Status": "OK",
        "Data": [
            {
                "Path": "C:\\Pixotope\\0.0.0-7150\\Services\\DirectorServices\\_PX_SysBridge.exe",
                "Name": "_PX_SysBridge.exe"
            }
        ]
    }
}

Example 2 - Error Response

Request can be failed for multiple reasons that can be determined from the returned error response.

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "ListFiles",
    "ID": "1"
}
{
    "Params": {
        "Path": "C:\\Pixotope\\INVALID_DIR"
    }
}

CallResult

JSON

{
    "Result": {
        "Status": "ERROR",
        "Message": "DirectoryDoesNotExist"
    }
}

Example 3 - Success Response with Filter

Call (you send)

JSON

Topic: {
    "Type":"Call",
    "Target":"AB-SysBridge",
    "RespondTo":"Explorer",
    "Method":"ListFiles",
    "ID":"1"
}
{
    "Params":{
        "Path":"C:\\Pixotope\\25.3.0.15810\\Logs",
        "Filter":[
            "json"
        ]
    }
}

CallResult

JSON

{
    "Result": {
        "Status": "OK",
        "Data": [
            {
                "Path": "C:\\Pixotope\\25.3.0.15810\\Logs\\.0db07c0e2465123783a2518a71688528eb979970-audit.json",
                "Name": ".0db07c0e2465123783a2518a71688528eb979970-audit.json"
            },
            {
                "Path": "C:\\Pixotope\\25.3.0.15810\\Logs\\.10fa645bfa8769b657e2877ffcfee9bb008edaac-audit.json",
                "Name": ".10fa645bfa8769b657e2877ffcfee9bb008edaac-audit.json"
            },
            {
                "Path": "C:\\Pixotope\\25.3.0.15810\\Logs\\.3fa52654c1443df1bfcadc466cac6c361e7fdfa1-audit.json",
                "Name": ".3fa52654c1443df1bfcadc466cac6c361e7fdfa1-audit.json"
            },
            {
                "Path": "C:\\Pixotope\\25.3.0.15810\\Logs\\.48015ac949d0c1616dc3079f27629abf4fe237da-audit.json",
                "Name": ".48015ac949d0c1616dc3079f27629abf4fe237da-audit.json"
            }
        ]
    }
}

ListDir

List file and folder information.

Params

Key	Type	Default	Description
Path	STRING	-	Absolute path of the directory

Examples

Example 1 - Success Response

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "ListDir",
    "ID": "1"
}
{
    "Params":{
        "Path":"C:\\Pixotope\\25.3.0.15810\\Logs"
    }
}

CallResult

JSON

{
    "Result": {
        "Status": "OK",
        "Data": [
            {
                "Path": "C:\\Pixotope\\25.3.0.15810\\Logs\\.0db07c0e2465123783a2518a71688528eb979970-audit.json",
                "Name": ".0db07c0e2465123783a2518a71688528eb979970-audit.json",
                "EntryType": "File"
            },
            {
                "Path": "C:\\Pixotope\\25.3.0.15810\\Logs\\.d0dae9289dd0152dce76343bf82b4df0d4cc7d5b-audit.json",
                "Name": ".d0dae9289dd0152dce76343bf82b4df0d4cc7d5b-audit.json",
                "EntryType": "File"
            },
            {
                "Path": "C:\\Pixotope\\25.3.0.15810\\Logs\\ControlPanel.2025-09-01.log",
                "Name": "ControlPanel.2025-09-01.log",
                "EntryType": "File"
            },
            {
                "Path": "C:\\Pixotope\\25.3.0.15810\\Logs\\.ea2ddecd1d78fa8f355ac29d37f5dd8ee725be24-audit.json",
                "Name": ".ea2ddecd1d78fa8f355ac29d37f5dd8ee725be24-audit.json",
                "EntryType": "File"
            },
            // more similar data entries here ......
            {
                "Path": "C:\\Pixotope\\25.3.0.15810\\Logs\\WebHost",
                "Name": "WebHost",
                "EntryType": "Directory"
            },
            {
                "Path": "C:\\Pixotope\\25.3.0.15810\\Logs\\zmqProxy",
                "Name": "zmqProxy",
                "EntryType": "Directory"
            }
        ]
    }
}

FileExist

Given path, check if the path exists and resolves to a file.

Params

Key	Type	Default	Description
Path	STRING	-	Absolute path of the file

Examples

Example 1 - Success Response

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "FileExist",
    "ID": "1"
}
{
    "Params": {
        "Path": "C:\\Pixotope\\example.txt"
    }
}

CallResult

JSON

{
    "Result": {
        "Status": "OK",
        "Data": true // file exist on file system
    }
}

DirExist

Given path, check if the path exists and resolves to a directory.

Params

Key	Type	Default	Description
Path	STRING	-	Absolute path of the directory

Examples

Example 1 - Success Response

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "DirExist",
    "ID": "1"
}
{
    "Params": {
        "Path": "C:\\Pixotope"
    }
}

CallResult

JSON

{
    "Result": {
        "Status": "OK",
        "Data": true // directory exist on file system
    }
}

IsDirEmpty

Given path, check if the path resolves to an empty directory

Params

Key	Type	Default	Description
Path	STRING	-	Absolute path of the directory

Examples

Example 1 - Success Response

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "IsDirEmpty",
    "ID": "1"
}
{
    "Params": {
        "Path": "C:\\Pixotope"
    }
}

CallResult

JSON

{
    "Result": {
        "Status": "OK",
        "Data": false // directory is not empty
    }
}

CreateDir

Given path, check if the path resolves to an empty directory

Params

Key	Type	Default	Description
Path	STRING	-	Absolute path of the directory to create

Examples

Example 1 - Success Response

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "IsDirEmpty",
    "ID": "1"
}
{
    "Params": {
        "Path": "C:\\Pixotope\\MyNewDir"
    }
}

CallResult

JSON

{
    "Result": {
        "Status": "OK",
        "Data": true // directory was created successfully
    }
}

System Dialog API

The System Dialog API provides endpoints for interacting with system-level dialogs, such as file selection, folder selection, and save file dialogs.

AskFileSelection

Opens a file selection dialog and returns the selected file(s).

Payload

TYPESCRIPT

{
  "Filter": [
    {
      "Name": string,
      "Extensions": string[]
    }
  ],
  "Title": string,
  "Directory": string,
  "CaptureWindowAsParent": boolean,
  "Multiple": boolean
}

Field Descriptions

Field	Type	Default	Description
Filter	ARRAY OPTIONAL	All file types/extension can be selected	The filters to limit user to only select files of specified type
Title	STRING OPTIONAL	Choose file	The title of the file dialog.
Directory	STRING OPTIONAL	-	The initial directory to open the file dialog in.
CaptureWindowAsParent	BOOLEAN OPTIONAL	`false`	Whether to capture the current window as the parent of the dialog.
Multiple	BOOLEAN OPTIONAL	`false`	Whether to allow multiple file selection.

Response

Example 1 - Success response single selectoin

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "AskFileSelection",
    "ID": "1"
}
{
    "Params": {
        "Filter": [
            {
                "Name": "Text Files",
                "Extensions": ["txt", "md"]
            }
        ],
        "Title": "Select a file",
        "Directory": "C:\\Users\\Documents",
        "CaptureWindowAsParent": true,
        "Multiple": false
    }
}

CallResult

JSON

{
    "ExecutedOn": "SERVICE_NAME",
    "ID": "1",
    "Method": "AskFileSelection",
    "Target": "Explorer",
    "Result": {
        "Status": "OK",
        "Data": ["C:\\Users\\Documents\\example.txt"] // only one path in array
    }
}

Example 2 - Success response multiple selections

Call (you send)

JSON

Topic: {
    // ...
}
{
    "Params": {
        // ...
        "Multiple": true
    }
}

CallResult

JSON

{
    "ExecutedOn": "SERVICE_NAME",
    "ID": "1",
    "Method": "AskFileSelection",
    "Target": "Explorer",
    "Result": {
        "Status": "OK",
        "Data": [
            "C:\\Users\\Pictures\\image1.png",
            "C:\\Users\\Pictures\\image2.jpg",
            "C:\\Users\\Pictures\\image3.jpeg"
        ]
    }
}

Example 3 - Failure response

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "AB-SysBridge",
    "RespondTo": "AB-Director",
    "Method": "AskFileSelection",
    "ID": "1"
}
{
    "Params": {
        "Directory": "C:\\Pixotope\\24.3.0-7329"
    }
}

CallResult

JSON

Topic: {
    "Type": "CallResult",
    "Target": "AB-Director",
    "ExecutedOn": "AB-SysBridge",
    "Method": "AskFileSelection",
    "ID": "92951333-da33-4a3e-add5-ff6833f0f26b"
}
{
    "Result": {
        "Status": "ERROR",
        "Message": "Cancelled" // Explains what went wrong
    }
}

AskFolderSelection

Opens a folder selection dialog and returns the selected folder(s).

Payload

TYPESCRIPT

{
  "Title": string,
  "Directory": string,
  "CaptureWindowAsParent": boolean,
  "Multiple": boolean
}

Field Descriptions

Field	Type	Default	Description
Title	STRING OPTIONAL	Choose folder	The title of the file dialog.
Directory	STRING OPTIONAL	-	The initial directory to open the file dialog in.
CaptureWindowAsParent	BOOLEAN OPTIONAL	`false`	Whether to capture the current window as the parent of the dialog.
Multiple	BOOLEAN OPTIONAL	`false`	Whether to allow multiple file selection.

Response

Example 1 - Success response single selectoin

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "AskFolderSelection",
    "ID": "1"
}
{
    "Params": {
        "Title": "Select a folder",
        "Directory": "C:\\Users",
        "CaptureWindowAsParent": true,
        "Multiple": false
    }
}

CallResult

JSON

{
    "ExecutedOn": "SERVICE_NAME",
    "ID": "1",
    "Method": "AskFolderSelection",
    "Target": "Explorer",
    "Result": {
        "Status": "OK",
        "Data": ["C:\\Users\\Documents"] // only one path in array
    }
}

Example 2 - Success response multiple selections

Call (you send)

JSON

Topic: {
    // ...
}
{
    "Params": {
        // ...
        "Multiple": true
    }
}

CallResult

JSON

{
    "ExecutedOn": "SERVICE_NAME",
    "ID": "1",
    "Method": "AskFolderSelection",
    "Target": "Explorer",
    "Result": {
        "Status": "OK",
        "Data": [
            "C:\\Users\\Documents",
            "C:\\Users\\Pictures",
            "C:\\Users\\Music"
        ]
    }
}

Example 3 - Failure response

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "AB-SysBridge",
    "RespondTo": "AB-Director",
    "Method": "AskFileSelection",
    "ID": "1"
}
{
    "Params": {
        "Directory": "C:\\Pixotope\\24.3.0-7329"
    }
}

CallResult

JSON

Topic: {
    "Type": "CallResult",
    "Target": "AB-Director",
    "ExecutedOn": "AB-SysBridge",
    "Method": "AskFileSelection",
    "ID": "92951333-da33-4a3e-add5-ff6833f0f26b"
}
{
    "Result": {
        "Status": "ERROR",
        "Message": "Cancelled" // Explains what went wrong
    }
}

AskSaveFile

Opens a save file dialog and returns the selected save path.

Payload

TYPESCRIPT

{
  "Title": string,
  "Directory": string,
  "Filters": [
    {
      "Name": string,
      "Extensions": string[]
    }
  ],
  "FileName": string,
  "CaptureWindowAsParent": boolean
}

Field Descriptions

Field	Type	Default	Description
Title	STRING OPTIONAL	Choose folder	The title of the file dialog.
Directory	STRING OPTIONAL	-	The initial directory to open the file dialog in.
FileName	STRING OPTIONAL	`""`	Default filled file name
Filters	ARRAY OPTIONAL	All	The filters to limit user to only save files of specified type. NOTE: If no filter is provided and `FileName` does not include and extension, user will have to explicitly define file extension. HINT: Provide one filter or pass `FileName` with extension in Params
CaptureWindowAsParent	BOOLEAN OPTIONAL	`false`	Whether to capture the current window as the parent of the dialog.

Response

Example 1 - Success response

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "AskSaveFile",
    "ID": "1"
}
{
    "Params": {
        "Title": "Save your document",
        "Directory": "C:\\Users\\Documents",
        "Filters": [
            {
                "Name": "Text Files",
                "Extensions": ["txt"]
            }
        ],
        "FileName": "mydocument.txt",
        "CaptureWindowAsParent": true
    }
}

CallResult

JSON

{
    "ExecutedOn": "MyMachine-SysBridge",
    "ID": "1",
    "Method": "AskSaveFile",
    "Target": "Explorer",
    "Result": {
        "Status": "OK",
        "Data": "C:\\Users\\Documents\\mydocument.txt"
    }
}

Example 2 - Cancel

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "AB-SysBridge",
    "RespondTo": "AB-Director",
    "Method": "AskFileSelection",
    "ID": "1"
}
{
    "Params": {
        "Directory": "C:\\Pixotope\\24.3.0-7329"
    }
}

CallResult

JSON

Topic: {
    "Type": "CallResult",
    "Target": "AB-Director",
    "ExecutedOn": "AB-SysBridge",
    "Method": "AskFileSelection",
    "ID": "1"
}
{
    "Result": {
        "Status": "Success",
        "Data": null // operation was cancelled
    }
}

RevealPath

Reveals a file or folder in the system's file explorer.

Payload

TYPESCRIPT

{
  "Path": string
}

Field Descriptions

Field	Type	Default	Description
Path	STRING	REQUIRED	The absolute path of the file or folder to reveal.
MoveInDirectory	BOOLEAN	`false`	When `true` and a folder path is passed in the `Path` parameter, File Explorer opens within that folder. When `false`, Explorer highlights the folder.

Response

Example 1 - Success

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "MyMachine-SysBridge",
    "RespondTo": "Explorer",
    "Method": "RevealPath",
    "ID": "1"
}
{
    "Params": {
        "Path": "C:\\Users\\Documents\\example.txt"
    }
}

CallResult

JSON

{
    "ExecutedOn": "SERVICE_NAME",
    "ID": "1",
    "Method": "RevealPath",
    "Target": "Explorer",
    "Result": {
        "Status": "OK",
        "Data": true // Reveal was successful
    }
}

Misc

OpenWithDefaultApp

Try to open given path with the default application.

Payload

TYPESCRIPT

{
  "Path": string
}

Field Descriptions

Field	Type	Default	Description
Path	STRING	REQUIRED	Path can be a Url which will be opened in the default browser Or a file path which will be opened in the default app.

Response

Example 1 - Open URL in default browser

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "AB-SysBridge",
    "RespondTo": "Explorer",
    "Method": "OpenWithDefaultApp",
    "ID": "1asdad13131"
}

Message: {
    "Params": {
        "Path": "https://google.com"
    }
}

CallResult

JSON

{
    "Result": {
        "Status": "OK",
        "Data": true // Successfully opened
    }
}

Example 1 - Open file path in default application

Call (you send)

JSON

Topic: {
    "Type": "Call",
    "Target": "AB-SysBridge",
    "RespondTo": "Explorer",
    "Method": "OpenWithDefaultApp",
    "ID": "1asdad13131"
}

Message: {
    "Params": {
        "Path": "D:\\images\\my-image.png"
    }
}

CallResult

JSON

{
    "Result": {
        "Status": "OK",
        "Data": true // Successfully opened
    }
}