Import & Export

SynapseOrch supports portable bundle files that contain agents, orchestrations, and MCP server configurations. Use them to share your work, back up configurations, or deploy across environments.

What's in a bundle

A bundle is a single JSON file containing:

Agent definitions (system prompts, tool lists, model overrides)
Workflow DAGs (steps, edges, guardrails)
MCP server configurations
Custom tool definitions

Vault files and conversation history are not included — bundles are configuration-only.

Knowledge bases are not included either. An agent's bases and a Retrieve or Ingest step's base travel by id, so on another install create the bases and pick them again — until then the agent searches none of them, and those steps fail their run.

Exporting

Via the UI

Go to Settings → Import / Export and choose Export
Tick the workflows, agents, apps and tools to bundle, and name the file under Export file
Click Export & download — a .json file is downloaded

Importing

Via the UI

Go to Settings → Import / Export and choose Import
Drop your export file on Drop your export file here (or click to browse)
Review the contents — workflows, agents, apps and tools
Click Import Now (or Configure Secrets → first, when the bundle needs secret values)

Existing items with the same ID are updated. New items are created.

Example bundles

SynapseOrch ships with example bundles for common use cases. Find them in Settings → Import / Export → Examples or in backend/examples/:

Pack	Contains
Starter Pack	A Personal Assistant with full tool access, a Web Research Agent, and a Content Research & Writing Pipeline — the fastest way to a working workspace
Developer Pack	Code Review Agent, Software Engineer Agent, QA Engineer, Deployment Monitor, and a Dev base and Strict Pipeline workflow, for engineering teams
Productivity Pack	Data Analyst, Content Writer, Jira Analyst, Slack Notifier, and a Market Intelligence workflow — business and content work
Simple Workflow Pack	A simple workflow: three agents research a topic, draft the piece and save it in the Vault. Good for reading how one is put together
Apps Pack	Ready-made apps for GitHub, Slack, Notion, Brave Search and more

Click Preview & Import on a pack to review it before it is added; Workflows → Templates lists the same packs. Each pack imports on its own: nothing it names lives only in another pack.

Bundle format

{
  "version": "1.0",
  "exported_at": "2024-11-15T14:30:00Z",
  "agents": [
    {
      "id": "agent-abc123",
      "name": "Research Agent",
      "type": "conversational",
      "tools": ["all"],
      "system_prompt": "...",
      "model": null
    }
  ],
  "orchestrations": [
    {
      "id": "orch-research-report",
      "name": "Research → Report",
      "steps": [ ... ]
    }
  ],
  "mcp_servers": [
    {
      "name": "github",
      "server_type": "remote",
      "url": "https://api.githubcopilot.com/mcp/"
    }
  ],
  "custom_tools": [
    {
      "name": "get_weather",
      "tool_type": "http",
      "method": "GET",
      "url": "https://api.weather.com/..."
    }
  ]
}

Version control

Commit your bundle files to git to version-control your agent configurations:

# Export current state
synapse export > bundles/production-v1.4.bundle.json
git add bundles/
git commit -m "chore: export agent configs v1.4"

# Restore on a new machine
synapse import bundles/production-v1.4.bundle.json

Share your bundles on GitHub or Discord to help others build similar workflows. The SynapseOrch community maintains a growing library of example bundles at github.com/synapseorch-ai/synapse-ai/examples.

Import & Export

On this page