Skip to content

Export a Workflow

AI for Process offers the ability to export specific workflow versions from your account as self-contained packages for data preservation and sharing. This feature also allows users to transfer workflow configurations without compromising the integrity and security of the workflow setup.

When you export a workflow, AI for Process automatically creates a .zip file named after the workflow. For example, if the workflow is named "Banking Assistant," the exported file will be "Banking Assistant.zip". You can save this folder in the desired location on your local machine.

The exported package can be reimported to create a new workflow or add it as a version to an existing one, ensuring seamless restoration.

The exported package preserves the following workflow configurations within JSON files:

  • Name and description
  • API, Condition, AI, and Script node configurations
  • Input/output variables and scanners
  • Environment variables
  • Sync/Async setup

To maintain security, sensitive information such as API keys, sharing permissions, workflow endpoint, and audit logs are excluded from the exported package.

Note

Users with only Viewer permissions can't export an workflow.

Steps to Export a Workflow

To export an workflow's version, follow the steps below:

  1. Log in to your AI for Process account.
  2. Select the workflow you want to export. The Workflow flow page is displayed.
  3. Click Configurations on the left navigation menu.

  4. Scroll down to the Export workflow section. By default, the currently deployed version is selected in the dropdown. export agent

  5. To change, click and choose another version from the list. change version

  6. Click the Export button.

The export process begins, and a success message is displayed after the workflow validation is completed and the export process finishes.

export success

Note

Once export begins, the selected version can't be changed.

Exported Information

The exported package includes the following JSON files encapsulating the workflow's configuration data:

  • flow_definition.json: It includes the workflow's canvas definitions (node definitions) and AI node configurations, including prompts, hyperparameters, and timeout information.
  • app_definition.json: It includes general information about the workflow version and guardrails.
  • env_variables.json: It includes the environment variables set for the workflow. Learn more.

exported files

To view the files, right-click and select View file.

view exported file

The file information is displayed as follows:

file example

  • Import a workflow - Create a workflow by importing configurations or add it as a version to an existing workflow.
  • Deploy a workflow - Explore synchronous and asynchronous deployment methods for workflow integration.
  • Configure a workflow - Modify the workflow's details, configure settings, or undeploy and delete it if unused.