Forjinn Docs

Development Platform

Documentation v2.0
Made with
by Forjinn

Export Import

Learn about export import and how to implement it effectively.

3 min read
🆕Recently updated
Last updated: 12/9/2025

Exporting & Importing Workflows, Agents, and Configurations

Export/import functions are essential for sharing, backup, migration, and speedy onboarding of both simple and complex chatflows/agents in InnoSynth-Forjinn. This guide details best practices, step-by-step procedures, known edge cases, and troubleshooting for transferring workflows, templates, and configuration safely.

What Can Be Exported or Imported?

  • Chatflows: All nodes, wiring, configs, credentials references (not credential secrets).
  • Agent Flows & Agents: All agent nodes, instructions, tools, knowledge/context, metrics.
  • Component Library Items: Individual custom nodes/components.
  • Credentials Config: Metadata (not secrets).
  • Environment/Platform Settings: (if Admin) via backup/restore feature.
  • Templates: Pre-built or community-contributed flows.

Exporting a Workflow (UI)

  1. Navigate to the Chatflows or Agents section.
  2. Find your target workflow/agent.
  3. Click the ··· (three dots) dropdown and select Export.
  4. Downloaded file will be a .json file (sometimes zipped if lots of artifacts or images attached).
  5. [Screenshot Placeholder: Export Button in UI]

What is included?

  • All node configs, component settings, variables, layout.
  • Version, platform metadata (for compatibility checking).

What is NOT included?

  • API keys/secrets.
  • Live credentials.
  • Sensitive user data/history.

Importing a Workflow/Agent (UI)

  1. Start from the Chatflows page (or Agents if agent).
  2. Click the Import button (top right or via main menu).
  3. Upload the .json or zipped export file.
  4. System will validate format, show you a preview (name, type, nodes, etc).
  5. Accept/wizard lets you adjust names, remap missing components, and select target workspace if multi-tenant.
  6. Click Import to complete.
  7. Changes will appear in your workflow/agent list.

[Screenshot Placeholder: Import wizard preview]


API-based Export/Import

  • Export:
    GET /api/v1/chatflow/export/<chatflowId>
    
  • Import:
    POST /api/v1/chatflow/import
    Body: { file: "workflow.json" }
    
  • Repeat for /agents/ endpoints as well.
  • Supports automation of backups and migration between dev/prod environments.

Edge Cases & Best Practices

  • Missing Components: If some nodes aren’t available on import (custom, plugin, enterprise features), you’ll see a warning and can either
    • Remap to similar nodes (if available).
    • Disable affected branch (imported with warnings).
  • Credential Gaps: You must manually assign any referenced credentials after import.
  • Version Mismatch: Older or newer export formats may require using the "legacy import" toggle, or manually editing JSON to fix schema.

Tips for Smooth Import/Export:

  • Always export before making major changes, for easy rollback.
  • Use clear, unique names for workflows and agents to avoid overwriting existing ones.
  • If collaborating, include documentation in a Sticky Note within the exported flow.

Troubleshooting

  • Import fails ("Invalid File"/"Unknown Node Type"): Open JSON, confirm all referenced node types exist on your platform or have compatible replacements.
  • Nothing happens on upload: Clear browser cache, check network tab for API errors.
  • Permissions Error: Only permitted roles can import/export flows in secured workspaces.
  • Artifacts/Images missing: For image/data-heavy flows, use the platform's zipped export/import option.

This procedure is critical for platform upgrades, cloud-to-cloud migrations, or sharing advanced workflows without exposing credentials or sensitive user data.