Export and import Rovo agents

Copy a custom Rovo agent on the same site or to another site by exporting its configuration as a JSON file and importing that file into Rovo. Exporting doesn't change the source agent. Importing creates a separate agent with a new ID, and the person who imports it becomes its creator.

This feature is available on all plans that include Rovo. You can export and import one agent at a time.

Before you begin

  • Publish the custom agent you want to export. You can't export a draft, deactivated, system, or out-of-the-box agent.

  • Make sure you're the agent's creator, an agent administrator, or an organization administrator on the source site.

  • Make sure you have permission to create agents on the target site.

  • Check that the target site has the apps, content, and permissions needed by the source agent. Some items that aren't available on the target site may be skipped during import.

Export an agent

Export an agent to download its configuration as a JSON file.

  1. Open the published custom agent you want to export.

  2. Open the agent's actions, then select Export agent.

Rovo downloads a file named <agent-name>-export.json. Keep this file available for the import.

Import an agent

Import the JSON file to create a separate agent on the target site.

  1. On the target site, open the Rovo agent creation screen.

    1. Or you can go into an agent in the dropdown and select to import an agent configuration

  2. Select Import an agent.

  3. In Import agent details, select Upload agent details and select the exported JSON file. You can also drag the file into the upload area.

  4. When the file shows Ready to import, select Confirm.

  5. When the import finishes, select View agent.

The imported agent starts as a draft. Review and test it, then publish it when it's ready for people to use.

If Rovo can't recreate part of the source configuration on the target site, the import can still succeed. The result shows Agent imported with warnings and lists the items that Rovo skipped.

Review the imported agent

Review the draft before you publish it.

  1. Review any import warnings and note which knowledge sources, actions, or subagents were skipped.

  2. Check the agent's name, description, instructions, conversation starters, and web search settings.

  3. Check each knowledge source and confirm that the required content is available to the agent on the target site.

  4. Check each action or other tool. Reconnect apps and provide any required configuration.

  5. Check each subagent and restore any configuration that couldn't be imported.

  6. Review the agent's access settings and add any required administrators or collaborators.

  7. Test the agent on the target site.

  8. Select Publish when the agent is ready to use. 

What gets imported

The export file contains an agent's portable configuration, but it isn't a complete clone or deployment package.

Item

Import behavior

Name, description, and icon

Imported into the new agent.

Instructions and settings

Scenario instructions, conversation starters, and web search settings are imported. Review them before publishing.

Knowledge sources

Rovo attempts to import the source references. Some unavailable or inaccessible sources are skipped with a warning. Verify every source on the target site.

Actions and other tools

Rovo attempts to import actions and tools available on the target site. Connections, authentication, and configured inputs aren't transferred, so review and reconfigure them.

Subagents

Imported when their configuration is valid and the target site has capacity for them. A subagent that can't be created is skipped with a warning.

Creator and access settings

Not copied. The person importing the file becomes the new creator, and the new agent starts with default access settings.

Publication state

Not copied. The imported agent starts as a draft.

Agent and scenario IDs

Not copied. Rovo creates new IDs on the target site.

Troubleshoot agent export and import

The agent can't be exported

Check that:

  • The agent is a published custom agent.

  • The agent isn't deactivated.

  • You're the agent's creator, an agent administrator, or an organization administrator.

If the agent is a draft, publish it and retry the export.

Import an agent isn't available

Make sure Rovo is available on the target site and that you have permission to create agents. If you still can't see Import an agent, contact your organization administrator.

The JSON file can't be imported

Make sure you selected a JSON file created by Export agent. If the file is invalid or can't be read, export the source agent again and retry with the new file.

The agent was imported with warnings

The valid parts of the agent were imported, but Rovo skipped one or more items that couldn't be recreated on the target site. Open the imported draft and use the warning list to review it.

  • For a missing knowledge source, confirm that the content and its app are available on the target site, then add the source again.

  • For a missing action or tool, confirm that its app or definition is available, then add and configure it again.

  • For a skipped subagent, check the target site's subagent limit and the subagent's required knowledge and actions, then recreate it if needed.

After resolving the warnings, test the agent before publishing it.



Still need help?

The Atlassian Community is here for you.