Import/Export

Introduction

The Import/Export feature allows you to share agents with other Serenity* Star users through public links. This enables collaboration and knowledge sharing within the Serenity* Star community by allowing users to replicate successful agent setups.

When you export an agent, you generate a public shareable link that contains the complete agent of a specific version. Other users can use this link to import the agent into their own accounts, where they can review, modify, and create their own version of the agent.

How to Export an Agent

Getting Started

To share an agent with other users, access your agent's version grid where you can select which version to make available to others.

Step 1: Navigate to Agent Versions

1. Go to your agent's grid and navigate to the versions section.

2. You'll see a grid displaying all available versions of your agent.

3. The "Shared" column shows the sharing status of each version.

   

Step 2: Select Version to Share

1. Choose the version you want to share.

2. Click the "Share" button for that version.

   

Step 3: Review and Generate Public Link

1. A side panel will open.

2. Review the security considerations.

3. Click "Generate public link" to create the shareable link.

   

Step 4: Access and Share Your Agent

1. After clicking "Generate public link", the side panel will show "Your public link is ready!"

   

2. The panel displays the generated public link with multiple sharing options.

3. The "Shared" column will update to indicate that this version is being shared.

   

Sharing Options Available

Scan or Copy Section:

• Scan QR Code: A QR code is automatically generated for easy mobile sharing

• Copy the URL: Click "Copy to clipboard" to copy the public link for sharing via email, chat, or other channels

  

What Gets Exported

When you share an agent, the following elements are included in the shared link:

✅ Included in Shared Agent

• AI Model Settings: Model selection, temperature, max tokens, and other parameters
• System Prompts: Instructions and behavior definitions
• Skill Configurations: Enabled skills and their basic configuration structure
• Knowledge Files: Actual knowledge files are copied and made available to the importing user
• Agent Metadata: Agent name, description, and basic configurations
• Metacontrol Settings: Advanced agent control configurations

❌ Not Included in Shared Agent

• Skills Sensitive Data: API keys, usernames, passwords, connection strings, and other sensitive skill settings are automatically removed
• Permissions: Agent access permissions and user restrictions
• CORS Policies: Cross-origin resource sharing configurations

How to Import an Agent

When someone shares an agent link with you:

1. Click the shared link or scan the QR code

2. You'll be redirected to Serenity* Star (login required if not already authenticated)

3. The agent creation screen will open with the imported agent pre-loaded

4. Review and modify the agent configuration as needed

5. Click "Create Agent" to add it to your account

   

Important: Skills are imported with their basic configuration, but sensitive data such as usernames, passwords, and connection strings are excluded for security reasons. You'll need to configure these manually for the skills to function properly.

Managing Shared Agents

Check Sharing Status

You can easily see which agent versions are currently being shared:

1. Navigate to your agent's versions grid

2. Check the "Shared" column to see the sharing status of each version

3. Shared versions will be clearly marked in this column

   

Revoke Sharing

To stop sharing an agent and deactivate its public link:

1. Click the "Share" button for the version you want to stop sharing

2. In the share management side panel, scroll down to the "Revoke public link" section

3. Click the "Revoke Access" button

4. The system will immediately deactivate the link and anyone with the link or QR code will no longer be able to import that version of your agent.

   

Important: Once revoked, the public link becomes inactive, and anyone who had it will no longer be able to import that version of your agent. The link becomes permanently inactive and cannot be restored. You'll need to generate a new sharing link to share the agent again.

Best Practices and Security Considerations

Before Sharing

By generating a public link, you are allowing external users to clone your agent's information. Make sure that your agent does not contain any sensitive or confidential information.

We recommend the following actions:

• Review Your Agent Carefully: Verify that no sensitive or confidential information is present. Check:

  • Skill Configurations: Ensure no API keys, credentials, or private endpoints are exposed.
  • Knowledge Files: Check that attached files do not contain confidential data.
  • Custom Instructions: Review prompts and other instructional content for sensitive details.
  • Agent Metadata: Validate that names, descriptions, and other metadata are appropriate for public sharing.

• Create Dedicated Versions: Consider creating specific, "sanitized" versions intended for public sharing.

• Use Clear Descriptions: Provide helpful descriptions for shared agents so others know what they are importing.

• Regularly Review Shared Agents: Periodically review your shared agent versions to ensure their public availability is still intended.

• Version Control: Keep track of which versions you've shared publicly.

When Importing

• Verify Source: Only import agents from trusted sources.
• Review Thoroughly: Always review imported agents before activation to understand their configuration.
• Test Safely: Test imported agents in a safe environment first.
• Customize Appropriately: Adapt imported agents to your specific use cases and re-configure any necessary sensitive data.