​
What is AutoBuild?

The easiest way to get started with Flatfile is using AutoBuild.

With AutoBuild, you can transform existing import templates or documentation into a fully functional Flatfile app in minutes. Simply drop your example files into AutoBuild, and it will automatically create and deploy a Blueprint (for schema definition) and a Listener (for validations and transformations) to your Flatfile App.

Once you’ve started with AutoBuild, you can always download your Listener code and continue building with code from there!

​
Setting Up Your Account

To get started, you’ll need to sign up for a Flatfile account.

During account setup, enter your company name and select “Start with an existing template or project file.”

​
Uploading Files and Context

Next, you’ll upload files and provide additional context to the AutoBuild agent.

You can upload any of the following to help the AI understand your requirements:

  • Import templates
  • System documentation
  • Complete data files
  • Any other files that provide useful context

You may also provide an additional prompt to guide the AutoBuild agent. Use this to give context about your uploaded files, explain specific data challenges, or outline additional requirements.

When you’re ready, click “Get Started.” The Flatfile AutoBuild agent will now build your space template.

​
Working in Build Mode

After a few moments, you’ll be taken to your new Flatfile app in Build Mode, which you can access anytime to make changes.

On the right side, you’ll see the blueprint of your space. Here you can inspect and edit the sheets and fields that the AutoBuild agent has generated. You can easily add or remove fields, update constraints and validations, or make other basic edits to your blueprint.

For more advanced changes, you can chat with the Flatfile Assistant. The Assistant can help you with anything from small tweaks to complex validations, data egress actions, or large reorganization of your sheets.

At any point, you can check the Data Preview tab to see what your Flatfile project will look like for your users. You can add or edit data to test your validations and transformations.

​
Deploying Your App

When you’re finished building your space, click “Configure & Deploy.”

You’ll be prompted to give your app a name, and then it’s ready to be deployed!

From here, you’ll be taken to your new app in the dashboard.

Your autobuild agent is deployed and you’re ready to create your first project and start importing data!