Import an Agent

Using import functionality, GALE enables you to create a new agent or add it as a version to an existing agent in your account. The import process preserves agent configuration while handling environment variables, errors, and role permissions.

Creating a new agent involves importing a .zip package from your local system with the flow definition, app definition, and environment variables JSON files from another environment. During the creation journey, assign the imported agent a unique name to avoid conflicts with existing agents. Learn more.

When importing an agent version to a parent agent, the imported flow definition becomes the new in-dev version, overriding the flow, app definition, and environment variable files. The previous version is renamed and saved in the list, with optional backup of the current version available.

Once the import is complete, the agent flow canvas is updated with the latest configuration changes.

Note

Users with only Viewer permissions cannot import an agent.

Import to Create a New Agent

To initiate an agent creation journey through the import functionality, follow the steps below:

1. Sign in to your GALE account.
2. Click Agents on the top menu.
3. Do one of the following based on your requirements:

• If you don't have any existing agents and want to create one by importing from another environment, click Import Agent.
• If you already have agents deployed, the following page is displayed. To import an agent, select the relevant tab on the Agents dashboard and click the Import Agent icon.

4. In the Import Agent window, providing the following information is mandatory.
• Agent Name: Provide a unique agent name to avoid the following error.
• Flow definition file: Upload the required flow_definition.json file from your local directory. The file includes the agent's canvas definitions (node definitions) and GenAI node configurations, including prompts, hyperparameters, and timeout information.

Providing the following information is optional:

• App definition file: Upload the required app_definition.json file, which includes general information about the agent version and guardrails
• Environment variable file: Upload the required env_variables.json file, which includes the environment variables set for the agent.

Note

• The Import button is enabled when the required information is provided.
• GenAI node models and guardrail configurations may not be available in the current account. Reconfigure them before running the agent.
• The model name from the original agent is imported as a placeholder into the GenAI node's Select Model field. Later, you can assign a value from the available options.
• The values for System Prompt, Prompt, Timeout, and Hyperparameters are imported for the GenAI node.

5. Click Import.

When import is in progress, the following message is displayed.

When the agent is imported successfully, the following messages are displayed.

Once the import is complete, the system will redirect you to the Agent Flow page, where you can access the new agent’s flow canvas by clicking Go to Flow.

The imported agent is listed under All Agents and My Agents on the Agents dashboard.

Important

• The status of the imported agent is set to "In Development.”
• The node types, agent descriptions, input and output variables, scanners, and sync/async setup are kept intact during the import.
• If the GenAI node's model doesn't match any available models in the current account, the model field is kept empty, but all prompt definitions are imported.
• API keys are not transferred during the import process.
• The imported agent cannot be shared with other users.

Failure Scenarios

The import may fail due to an incompatible agent version, a corrupt file, an internal error, or missing guardrails in the current account, triggering an error notification.

Import Agent as a Version

Use the Import functionality under Agents > Configurations to add an agent as a version of a parent agent, replacing the existing one. You should back up the current in-development version to preserve its configuration definitions. The export file is saved as 'Exported_AgentName.zip.’

When you import an agent as a version, you must upload all the following files:

• Flow definition file: Upload the required flow_definition.json file from your local directory. The file includes the agent's canvas definitions (node definitions) and GenAI node configurations, including prompts, hyperparameters, and timeout information.
• App definition file: Upload the required app_definition.json file, which includes general information about the agent version and guardrails.
• Environment variable file: Upload the required env_variables.json file, which includes the environment variables set for the agent. Any conflicts between environment variables in the parent agent and the imported version must be resolved. Learn more.

Steps to Import an Agent

Note

To import an agent as a version, the parent agents must be deployed in your account.

To import an agent as a version, follow the steps below:

1. Sign in to your GALE account.

2. Click Agents on the top menu.

3. Click the agent in the listing to proceed further.

4. Click Configurations on the left menu.

5. Scroll down to the Import Agent section and click Import.

6. (Optional) In the following dialog, select the Back up your current agent option to preserve the data of the version being replaced.

Note

Backing up automatically exports and saves the .zip package of the agent definition files to the designated location when the import is initiated. Learn more

If you choose not to back up/export the agent configurations, unselect the back-up option and proceed to the next step.

7. Click Import in the confirmation dialog.
8. In the Import Agent window, upload the required JSON files and click Import.

Note

Agent Name is not required since the current version’s name is assigned.

The imported agent is validated, and if no errors exist, the following message is displayed.

The imported version is added under the parent agent.

Important

• The status of the parent agent is set to "In Development.”
• Updated on reflects the date the version was imported.

Conflicting Environment Variables

When importing environment variables during agent version import, conflicts may arise between those of the parent agent and the imported version. If neither agent has environment variables, no conflicts occur.

Important

Verify the environment variables before importing. For conflicting values, the existing ones are retained if not changed.

You must resolve conflicting variables by either keeping the existing value (of the version being replaced) or replacing them (with values from the imported agent) to ensure a smooth import process.

When GALE detects conflicting environment variables, it displays the following window. To resolve conflicts, follow the steps below:

1. Select the Conflicting variables tab.

2. Select either Overwrite to replace the existing variable with the imported one or select Keep existing.

3. Click Proceed to continue importing.

Editing Existing and Imported Variables

To resolve conflicts by editing either the existing or imported environment variables, select the relevant tab in the Edit Environment Variable window and follow the steps provided.

1. Click the Three-dots (Ellipsis) icon of the required variable.

2. Select Edit.

3. Change the required values in the Edit Variable window.

4. Click Save.

To cancel the import process during the conflicting environment variables resolution, click Cancel in the Edit Environment Variable window, then click Confirm in the following window.

Related Links

• Create an Agent- Create a new agent and configure its flow.
• Export an Agent- Export the set configurations of an agent for data sharing and preservation.
• 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.