Skip to content

Import a Tool as a Version

Use the Import functionality under Tools > Configurations to add a tool as a version of a parent tool. You should back up the current in-development version to preserve its configuration definitions. The export file is saved as 'Exported_ToolName.zip.’

When you import an tool 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 tool's canvas definitions (node definitions) and AI node configurations, including prompts, hyperparameters, and timeout information.
  • App definition file: Upload the required app_definition.json file, which includes general information about the tool version and guardrails.
  • Environment variable file: Upload the required env_variables.json file, which includes the environment variables set for the tool. Any conflicts between environment variables in the parent tool and the imported version must be resolved. Learn more.

Steps to Import a Tool

Note

To import a tool as a version, the parent tools must be deployed in your account.

To import a tool as a version, follow the steps below:

  1. Log in to your account and click Tools under Agent Platform Modules. access tools

  2. Click the Tools tab on the top navigation bar, and select the tool you want to import.

  3. Click Configurations on the left menu.

  4. Scroll down to the Import tool section and click Import. import tool configuration

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

    import confirmation

Note

Backing up automatically exports and saves the .zip package of the tool definition files to the designated location when the import is initiated. If you choose not to back up/export the tool configurations, unselect the back-up option and proceed to the next step.

  1. Click Import in the confirmation dialog.
  2. In the Import Tool window, upload the required JSON files and click Import.

Note

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

The imported tool is validated, and if no errors exist, the tool is imported successfully.

The imported version is added under the parent tool.

Important

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

Conflicting Environment Variables

When importing environment variables during tool version import, conflicts may arise between those of the parent tool and the imported version. If neither tool 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 tool) to ensure a smooth import process.

Steps to Resolve Conflicting Variables

When conflicting environment variables are detected, you must resolve them with the following steps:

  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. import tool

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.
    edit variable

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

  4. Click Save.
    save variable

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

  • Create a Tool- Create a new tool and configure its flow.
  • Export a Tool- Export the set configurations of a tool for data sharing and preservation.
  • Deploy a Tool- Explore synchronous and asynchronous deployment methods for tool integration.
  • Configure a Tool- Modify the tool's details, configure settings, or undeploy and delete it if unused.