Skip to content

Export an Agent

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

When you export an agent, GALE automatically creates a .zip file named after the agent. For example, if the agent 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 agent or add it as a version to an existing one, ensuring seamless restoration.

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

  • Name and description
  • API, Condition, GenAI, 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, agent endpoint, and audit logs are excluded from the exported package.

Note

Users with only Viewer permissions cannot export an agent.

Steps to Export an Agent

To export an agent’s version, follow the steps below:

  1. Sign in to your GALE account. To enable and sign in via SSO, click here.
  2. Click Agents on the top menu.
  3. Select the relevant tab to view the agent.

  4. Click the required agent’s name to proceed further. access agent

  5. Click Configurations on the left navigation menu.

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

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

  8. Click the Export button.

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

export in progress

export success

Note

Once export begins, the selected version cannot be changed.

Exported Information

The exported package includes the following JSON files encapsulating the agent’s configuration data:

  • flow_definition.json: It includes the agent's canvas definitions (node definitions) and GenAI node configurations, including prompts, hyperparameters, and timeout information.
  • app_definition.json: It includes general information about the agent version and guardrails.
  • env_variables.json: It includes the environment variables set for the agent. 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 an Agent - Create an agent by importing configurations or add it as a version to an existing agent.
  • Deploy an Agent - Explore synchronous and asynchronous deployment methods for agent integration.
  • Configure an Agent - Modify the agent's details, configure settings, or undeploy and delete it if unused.