mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "flatfile.com",
  "logo": {
    "dark": "/logo/dark.svg",
    "light": "/logo/light.svg",
    "href": "https://flatfile.com"
  },
  "isWhiteLabeled": true,
  "api": {
    "baseUrl": "https://platform.flatfile.com/api",
    "auth": {
      "method": "bearer"
    }
  },
  "favicon": "/favicon.jpg",
  "colors": {
    "primary": "#000",
    "light": "#fff",
    "dark": "#000",
    "background": {
      "dark": "#000",
      "light": "#fff"
    }
  },
  "codeBlock": {
   "mode": "auto"
},
  "feedback": {
    "raiseIssue": true,
    "suggestEdit": true
  },
  "modeToggle": {
    "default": "dark"
  },
  "redirects": [
    {
      "source": "/guides/upgrade/v2_upgrade",
      "destination": "/upgrade/v2_upgrade"
    },
    {
      "source": "/upgrade/v2_repo",
      "destination": "https://github.com/FlatFilers/Upgrade-Portal"
    },
    {
      "source": "/developer-tools/mapping-libraries/flatfile-mapping-python",
      "destination": "https://pypi.org/project/flatfile-mapping/"
    },
    {
      "source": "/plugins",
      "destination": "https://flatfile.com/plugins/"
    },
    {
      "source": "/plugins/extractors/xlsx-extractor",
      "destination": "https://flatfile.com/plugins/xlsx-extractor"
    },
    {
      "source": "/plugins/extractors/json-extractor",
      "destination": "https://flatfile.com/plugins/plugin-json-extractor"
    },
    {
      "source": "/plugins/extractors/xml-extractor",
      "destination": "https://flatfile.com/plugins/plugin-xml-extractor"
    },
    {
      "source": "/plugins/extractors/zip-extractor",
      "destination": "https://flatfile.com/plugins/plugin-zip-extractor"
    },
    {
      "source": "/plugins/extractors/delimiter-extractor",
      "destination": "https://flatfile.com/plugins/plugin-delimiter-extractor"
    },
    {
      "source": "/plugins/extractors/pdf-extractor",
      "destination": "https://flatfile.com/plugins/plugin-pdf-extractor"
    },
    {
      "source": "/plugins/transform/record-hook",
      "destination": "https://flatfile.com/plugins/record-hook"
    },
    {
      "source": "/plugins/transform/autocast",
      "destination": "https://flatfile.com/plugins/plugin-autocast"
    },
    {
      "source": "/plugins/transform/dedupe",
      "destination": "https://flatfile.com/plugins/plugin-dedupe"
    },
    {
      "source": "/plugins/automations/automap",
      "destination": "/https://flatfile.com/plugins/plugin-automap"
    },
    {
      "source": "/plugins/export/workbook",
      "destination": "https://flatfile.com/plugins/plugin-export-workbook"
    },
    {
      "source": "/plugins/export/webhook",
      "destination": "https://flatfile.com/plugins/plugin-webhook-egress"
    },
    {
      "source": "/plugins/schemas/convert-json-schema",
      "destination": "https://flatfile.com/plugins/plugin-convert-json-schema"
    },
    {
      "source": "/plugins/schemas/convert-yaml-schema",
      "destination": "https://flatfile.com/plugins/plugin-convert-yaml-schema"
    },
    {
      "source": "/plugins/schemas/convert-sql-ddl",
      "destination": "https://flatfile.com/plugins/plugin-convert-sql-ddl"
    },
    {
      "source": "/plugins/schemas/convert-openapi",
      "destination": "https://flatfile.com/plugins/plugin-convert-openapi-schema"
    },
    {
      "source": "/plugins/migrations/dxp-configure",
      "destination": "https://flatfile.com/plugins/plugin-dxp-configure"
    },
    {
      "source": "/plugins/core/job-handler",
      "destination": "https://flatfile.com/plugins/plugin-job-handler"
    },
    {
      "source": "/plugins/core/space-configure",
      "destination": "https://flatfile.com/plugins/plugin-space-configure"
    },
        {
      "source": "/plugins/utils/extractor",
      "destination": "https://flatfile.com/plugins/util-extractor"
    },
    {
      "source": "/plugins/utils/file-buffer",
      "destination": "https://flatfile.com/plugins/util-file-buffer"
    },
    {
      "source": "/plugins/utils/response-rejection",
      "destination": "https://flatfile.com/plugins/util-response-rejection"
    }
  ],
  "topbarLinks": [
    {
      "name": "Create account",
      "url": "https://flatfile.com/account/sign-up/"
    }
  ],
  "topbarCtaButton": {
    "name": "Sign in",
    "url": "https://platform.flatfile.com/oauth/dashboard"
  },
  "versions": [
    "latest",
    {
      "name": "v3",
      "url": "https://flatfile.com/versioned-docs/3.0"
    },
    {
      "name": "v2",
      "url": "https://flatfile.com/versioned-docs/2.0"
    }
  ],
  "anchors": [
    {
      "name": "API Reference",
      "icon": "asterisk",
      "url": "https://reference.flatfile.com"
    },
    {
      "name": "Join our community",
      "icon": "slack",
      "url": "https://flatfile.com/join-slack/"
    }
  ],
  "navigation": [
    {
      "group": "Documentation",
      "pages": ["overview", "starter-projects"]
    },
    {
      "group": "Highlights",
      "pages": [
        "changelog/platform",
        "changelog/sdks",
        "changelog/sdks/plugins/highlights"
      ]
    },
    {
      "group": "Core Libraries",
      "pages": ["changelog/sdks/core/cli", "changelog/sdks/core/listener"]
    },
    {
      "group": "Embedded Wrappers",
      "pages": [
        "changelog/sdks/wrappers/javascript",
        "changelog/sdks/wrappers/react",
        "changelog/sdks/wrappers/angular",
        "changelog/sdks/wrappers/vue"
      ]
    },
    {
      "group": "Plugins",
      "pages": [
        {
          "group": "Extractors",
          "pages": [
            "changelog/sdks/plugins/extractors/xlsx-extractor",
            "changelog/sdks/plugins/extractors/json-extractor",
            "changelog/sdks/plugins/extractors/xml-extractor",
            "changelog/sdks/plugins/extractors/zip-extractor",
            "changelog/sdks/plugins/extractors/delimiter-extractor",
            "changelog/sdks/plugins/extractors/pdf-extractor"
          ]
        },
        {
          "group": "Transform",
          "pages": [
            "changelog/sdks/plugins/transform/record-hook",
            "changelog/sdks/plugins/transform/autocast",
            "changelog/sdks/plugins/transform/dedupe"
          ]
        },
        {
          "group": "Automation",
          "pages": ["changelog/sdks/plugins/automations/automap"]
        },
        {
          "group": "Export",
          "pages": [
            "changelog/sdks/plugins/export/export-workbook",
            "changelog/sdks/plugins/export/webhook-egress"
          ]
        },
        {
          "group": "Schemas",
          "pages": [
            "changelog/sdks/plugins/schemas/json-schema",
            "changelog/sdks/plugins/schemas/yaml-schema",
            "changelog/sdks/plugins/schemas/sql-ddl-converter",
            "changelog/sdks/plugins/schemas/openapi-schema"
          ]
        },
        {
          "group": "Migrations",
          "pages": ["changelog/sdks/plugins/migrations/dxp-configure"]
        },
        {
          "group": "Core",
          "pages": [
            "changelog/sdks/plugins/core/job-handler",
            "changelog/sdks/plugins/core/space-configure"
          ]
        },
        {
          "group": "Utils",
          "pages": [
            "changelog/sdks/plugins/utils/extractor",
            "changelog/sdks/plugins/utils/file-buffer",
            "changelog/sdks/plugins/utils/response-rejection"
          ]
        }
      ]
    },
    {
      "group": "Platform Apps",
      "pages": [
        {
          "group": "Portal",
          "icon": "person-to-portal",
          "pages": [
            "apps/embedding/overview",
            {
              "group": "Javascript",
              "icon": "js",
              "pages": [
                "apps/embedding/javascript/guide",
                "apps/embedding/javascript/new_space_quickstart",
                {
                  "group": "Advanced",
                  "icon": "settings",
                  "pages": [
                    "apps/embedding/javascript/new_space",
                    "apps/embedding/javascript/reuse_space"
                  ]
                }
              ]
            },
            {
              "group": "React",
              "icon": "react",
              "pages": [
                "apps/embedding/react/guide",
                "apps/embedding/react/new_space_quickstart",
                "apps/embedding/react/components",
                {
                  "group": "Legacy",
                  "icon": "settings",
                  "pages": ["apps/embedding/react/legacy"]
                }
              ]
            },
            {
              "group": "Vue.js",
              "icon": "vuejs",
              "pages": [
                "apps/embedding/vue/guide",
                "apps/embedding/vue/new_space",
                {
                  "group": "Advanced",
                  "icon": "settings",
                  "pages": ["apps/embedding/vue/reuse_space"]
                }
              ]
            },
            {
              "group": "Angular",
              "icon": "angular",
              "pages": [
                "apps/embedding/angular/guide",
                "apps/embedding/angular/new_space_quickstart",
                {
                  "group": "Advanced",
                  "icon": "settings",
                  "pages": [
                    "apps/embedding/angular/new_space",
                    "apps/embedding/angular/reuse_space"
                  ]
                }
              ]
            },
            {
              "group": "Reference",
              "icon": "asterisk",
              "pages": [
                "apps/embedding/reference/simple",
                "apps/embedding/reference/common",
                "apps/embedding/reference/advanced"
              ]
            }
          ]
        },
        "apps/projects/overview",
        "apps/workbooks",
        {
          "group": "Build an app",
          "icon": "grid-2",
          "pages": [
            "apps/custom/tutorial-landing",
            "apps/custom/meet-the-listener",
            "apps/custom/meet-the-workbook",
            "apps/custom/add-data-transformation",
            "apps/custom/submit-action",
            "apps/custom/deploying"
          ]
        }
      ]
    },
    {
      "group": "By Feature",
      "pages": [
        "guides/handling-data",
        "guides/actions",
        "guides/dynamic-configurations",
        "guides/namespaces",
        "guides/metadata",
        "guides/egress",
        "guides/theming",
        "guides/guest_sidebar",
        "guides/documents",
        "guides/secrets",
        "guides/automap",
        "guides/localization",
        "guides/additional-fields",
        "guides/flatfile_query_language",
        "guides/data-retention",
        "guides/api",
        "guides/ai"
      ]
    },
    {
      "group": "By Integration",
      "pages": ["guides/bubble-io"]
    },
    {
      "group": "Orchestration",
      "pages": [
        "orchestration/listeners",
        "orchestration/events",
        "orchestration/actions",
        "orchestration/jobs"
      ]
    },
    {
      "group": "Blueprint",
      "pages": [
        "blueprint/overview",
        "blueprint/sheet-options",
        "blueprint/field-types",
        "blueprint/constraints",
        "blueprint/relationships",
        "blueprint/access"
      ]
    },
    {
      "group": "Upgrade",
      "pages": ["upgrade/overview"]
    },
    {
      "group": "Reference",
      "pages": ["reference/icons"]
    },
    {
      "group": "Portal - version 2",
      "pages": [
        "upgrade/v2_upgrade",
        "upgrade/v2_upgrade_concepts",
        "upgrade/v2_repo"
      ]
    },
    {
      "group": "Portal - version 3",
      "pages": [
        "upgrade/v3_upgrade",
        "upgrade/v3_dxp_configure",
        "upgrade/v3_repo"
      ]
    },
    {
      "group": "Overview",
      "pages": [
        {
          "group": "Developing with Flatfile",
          "icon": "square-terminal",
          "pages": [
            "developer-tools/developing/running-local",
            "developer-tools/developing/check-for-agents"
          ]
        },
        "developer-tools/deploying"
      ]
    },
    {
      "group": "Core Architecture",
      "pages": ["developer-tools/environment", "developer-tools/spaces"]
    },
    {
      "group": "Security",
      "pages": [
        "developer-tools/security/authentication",
        "developer-tools/security/account-token",
        "developer-tools/security/roles-and-permissions"
      ]
    },
    {
      "group": "Core libraries",
      "pages": [
        "developer-tools/core-libraries/flatfile",
        "developer-tools/core-libraries/listener",
        "developer-tools/versioning"
      ]
    },
    {
      "group": "APIs",
      "pages": [
        "developer-tools/core-libraries/api",
        "developer-tools/core-libraries/api-python",
        "developer-tools/core-libraries/api-go",
        "developer-tools/core-libraries/api-java"
      ]
    },
    {
      "group": "Embedded Wrappers",
      "pages": [
        "developer-tools/core-libraries/wrappers/vanilla",
        "developer-tools/core-libraries/wrappers/react",
        "developer-tools/core-libraries/wrappers/angular",
        "developer-tools/core-libraries/wrappers/vuejs"
      ]
    },
    {
      "group": "Mapping",
      "pages": ["developer-tools/mapping-libraries/flatfile-mapping-python"]
    }
  ],
  "footerSocials": {
    "website": "https://flatfile.com",
    "github": "https://github.com/FlatFilers"
  },
  "analytics": {
    "gtm": {
      "tagId": "GTM-W673X2W"
    }
  },
  "integrations": {
    "intercom": "q8ccrv3f"
  },
  "search": {
    "prompt": "Ask any question (ChatGPT powered)"
  },
  "tabs": [
    {
      "name": "Changelog",
      "url": "changelog"
    },
    {
      "name": "Guides",
      "url": "guides"
    },
    {
      "name": "Blueprint",
      "url": "blueprint"
    },
    {
      "name": "Plugins",
      "url": "https://flatfile.com/plugins"
    },
    {
      "name": "CLI",
      "url": "developer-tools"
    },
    {
      "name": "Upgrade",
      "url": "upgrade"
    }
  ]
}