# Flatfile Developer Docs
## Docs
- [Welcome to Flatfile](https://flatfile.com/docs/index.md)
- [Getting Started with AutoBuild](https://flatfile.com/docs/getting-started/quickstart/autobuild.md): Get up and running with Flatfile in minutes using AutoBuild to create a complete data import solution
- [Creating Your First Project](https://flatfile.com/docs/getting-started/quickstart/first-project.md): Running through the import flow with your Flatfile App
- [Overview](https://flatfile.com/docs/core-concepts/overview.md): Understanding Flatfile's building blocks and architecture
- [Environments](https://flatfile.com/docs/core-concepts/environments.md): Use Environments for testing and authentication
- [Apps](https://flatfile.com/docs/core-concepts/apps.md): The anatomy of an App
- [Spaces](https://flatfile.com/docs/core-concepts/spaces.md): Micro-applications for content and data storage
- [Blueprints](https://flatfile.com/docs/core-concepts/blueprints.md): Define your data schema to structure exactly how data should look, behave, and connect
- [Documents](https://flatfile.com/docs/core-concepts/documents.md): Standalone webpages within Flatfile Spaces for guidance and dynamic content
- [Workbooks](https://flatfile.com/docs/core-concepts/workbooks.md): Database-like containers with type-strict Blueprints for data import
- [Sheets](https://flatfile.com/docs/core-concepts/sheets.md): Individual data tables within Workbooks that organize and structure imported data
- [Fields](https://flatfile.com/docs/core-concepts/fields.md): Blueprint definitions that define the structure and validation rules for your data in Flatfile
- [Records](https://flatfile.com/docs/core-concepts/records.md): Individual data rows that represent your imported data in Flatfile
- [Events and Listeners](https://flatfile.com/docs/core-concepts/listeners.md): The anatomy of Events and Listeners - core components of the Flatfile Platform
- [Jobs](https://flatfile.com/docs/core-concepts/jobs.md): Discrete tasks executed asynchronously in response to events
- [Actions](https://flatfile.com/docs/core-concepts/actions.md): User-triggered operations in Flatfile
- [Plugins](https://flatfile.com/docs/core-concepts/plugins.md): Reusable functionality modules that extend Flatfile's capabilities
- [Coding Tutorial](https://flatfile.com/docs/coding-tutorial/overview.md): Learn to build Event Listeners that configure and customize Flatfile through hands-on coding tutorials
- [01: Creating Your First Listener](https://flatfile.com/docs/coding-tutorial/101-your-first-listener/101.01-first-listener.md): Learn to set up a basic Listener with Space configuration to define your data structure and workspace layout.
- [02: Adding Validation to Your Listener](https://flatfile.com/docs/coding-tutorial/101-your-first-listener/101.02-adding-validation.md): Enhance your listener with data validation capabilities to ensure data quality and provide real-time feedback to users.
- [03: Adding Actions to Your Listener](https://flatfile.com/docs/coding-tutorial/101-your-first-listener/101.03-adding-actions.md): Build on your basic Listener by adding user Actions to create interactive data processing workflows.
- [Overview](https://flatfile.com/docs/plugins/index.md): Extend your Flatfile data engine with powerful plugins for extraction, transformation, validation, and integration
- [Autocast Plugin](https://flatfile.com/docs/plugins/autocast.md): Automatically convert data in a Flatfile Sheet to match the data types defined in the corresponding Blueprint
- [Automap Plugin](https://flatfile.com/docs/plugins/automap.md): Automatically map columns for headless data import workflows in Flatfile with configurable confidence levels
- [Boolean Validator](https://flatfile.com/docs/plugins/boolean.md): Comprehensive boolean validation plugin for Flatfile that handles various representations of boolean values with multi-language support and flexible configuration options.
- [Constraints Plugin](https://flatfile.com/docs/plugins/constraints.md): Extend Flatfile validation capabilities with custom validation logic for complex field and sheet-level constraints
- [Currency Conversion Plugin](https://flatfile.com/docs/plugins/currency.md): Automatically converts currency values from a source currency to a target currency using Open Exchange Rates API with support for historical exchange rates.
- [Date Format Normalizer](https://flatfile.com/docs/plugins/date.md): Automatically parse and standardize date values during data import, converting various date formats into a consistent output format.
- [Deduplicate Sheet Records](https://flatfile.com/docs/plugins/dedupe.md): A Flatfile plugin that provides functionality to find and remove duplicate records from a sheet based on specified field values or custom logic.
- [Delimited File Zip Exporter](https://flatfile.com/docs/plugins/delimited-zip.md): Export data from all sheets within a Flatfile Workbook into delimited text files and compress them into a single ZIP archive for download.
- [Delimiter Extractor Plugin](https://flatfile.com/docs/plugins/delimiter-extractor.md): Parse text files with custom delimiters and automatically extract structured data for import into Flatfile
- [Email Validation Plugin](https://flatfile.com/docs/plugins/email.md): Validate email addresses in Flatfile data imports with format checking, required field validation, and disposable domain blocking
- [Export Workbook Plugin](https://flatfile.com/docs/plugins/export-workbook.md): A server-side utility for Flatfile that allows users to export data from an entire Flatfile Workbook into a single, downloadable Microsoft Excel (.xlsx) file.
- [Foreign Database Extractor for Microsoft SQL Server](https://flatfile.com/docs/plugins/foreign-db-extractor.md): Automatically extract data from Microsoft SQL Server backup files (.bak) into Flatfile Workbooks for easy data review and processing.
- [Geocode Address Data](https://flatfile.com/docs/plugins/geocode.md): Automatically enrich location data using the Google Maps Geocoding API to convert addresses into geographic coordinates and vice-versa.
- [GPX File Parser and Analyzer](https://flatfile.com/docs/plugins/gpx.md): Automatically processes GPX (GPS Exchange Format) files to extract waypoints, tracks, routes, and calculate geographic statistics like distance and elevation gain.
- [GraphQL Schema to Flatfile Blueprint Converter](https://flatfile.com/docs/plugins/graphql-schema.md): Automatically generate Flatfile Space configurations by converting GraphQL schemas into Workbooks and Sheets, streamlining data import setup for GraphQL APIs.
- [HTML Table Extractor](https://flatfile.com/docs/plugins/html-table.md): Parse HTML files and extract data from tables within them, converting structured data into Flatfile-compatible format
- [ISBN Validator Plugin](https://flatfile.com/docs/plugins/isbn.md): A Flatfile plugin that validates and formats International Standard Book Number (ISBN) data during the import process, supporting both ISBN-10 and ISBN-13 standards with automatic formatting and conversion capabilities.
- [Job Handler Plugin](https://flatfile.com/docs/plugins/job-handler.md): A Flatfile plugin that streamlines the handling of asynchronous Jobs by managing their lifecycle, progress reporting, and completion status.
- [JSON Extractor](https://flatfile.com/docs/plugins/json-extractor.md): Parse JSON and JSON Lines files uploaded to Flatfile and extract data into Sheets within a Workbook
- [JSON Schema Converter](https://flatfile.com/docs/plugins/json-schema.md): Automatically transform JSON Schema into Flatfile Blueprint for streamlined data model setup
- [Markdown File Extractor](https://flatfile.com/docs/plugins/markdown.md): Automatically parse Markdown files and extract tables into Flatfile Sheets
- [Merge.dev Connection Plugin](https://flatfile.com/docs/plugins/merge-connection.md): Connect Flatfile to the Merge.dev unified API platform to sync data from hundreds of third-party integrations including HRIS, ATS, CRM, and Accounting systems.
- [Number Validation Plugin](https://flatfile.com/docs/plugins/number.md): Comprehensive validation for numeric data during the Flatfile import process with support for ranges, formats, and special number types.
- [OpenAPI Schema to Flatfile Blueprint Converter](https://flatfile.com/docs/plugins/openapi-schema.md): Automatically converts OpenAPI v3.0.3 schemas into Flatfile Blueprints to streamline Space setup using existing API data structures
- [PDF Extractor Plugin](https://flatfile.com/docs/plugins/pdf-extractor.md): Extract tabular data from PDF files and convert them to CSV format using the pdftables.com service
- [Phone Number Validation and Formatting Plugin](https://flatfile.com/docs/plugins/phone.md): Validates and formats phone numbers in Flatfile using country-specific validation with libphonenumber-js library
- [Pivot Table Exporter](https://flatfile.com/docs/plugins/pivot-table.md): A Flatfile plugin that performs data analysis and summarization by generating pivot tables from workbook data and uploading them as Markdown documents.
- [Record Hook Plugin](https://flatfile.com/docs/plugins/record-hook.md): Execute custom logic on individual data records within a Flatfile Sheet with support for validation, transformation, enrichment, and cleaning.
- [Rollout: Automatic Workbook Updates](https://flatfile.com/docs/plugins/rollout.md): Automatically apply schema changes to existing, live workbooks when a new version of a Flatfile Agent is deployed
- [Sentiment Analysis Plugin](https://flatfile.com/docs/plugins/sentiment.md): Automatically analyze sentiment in text fields and add sentiment scores and categories to your Flatfile records
- [Space Configure from Template](https://flatfile.com/docs/plugins/space-configure-from-template.md): Automatically configure new Flatfile Spaces by cloning an existing Space Template, including workbooks, documents, and settings.
- [Flatfile Space Configuration Plugin](https://flatfile.com/docs/plugins/space-configure.md): Programmatically set up and configure a new Flatfile Space with workbooks, sheets, documents, and metadata from a single configuration object.
- [SQL DDL to Flatfile Blueprint Converter](https://flatfile.com/docs/plugins/sql-ddl-converter.md): Automatically create Flatfile Blueprints from SQL Data Definition Language (DDL) files to streamline database schema imports.
- [Stored Constraints Plugin](https://flatfile.com/docs/plugins/stored-constraints.md): Automatically applies server-side validation rules to records during the data import process using reusable JavaScript functions defined at the App level.
- [String Validator Plugin](https://flatfile.com/docs/plugins/string.md): A comprehensive plugin for validating and transforming string data during the Flatfile import process with configurable validation rules, pattern matching, and automatic data corrections.
- [Text Summarization and Key Phrase Extraction Plugin](https://flatfile.com/docs/plugins/summarize.md): Automatically enriches Flatfile data by performing text summarization and key phrase extraction on specified text fields using natural language processing.
- [Field Translation using Google Translate API](https://flatfile.com/docs/plugins/translate.md): Automatically translate text content in specified fields using Google Translate API and create new fields with translated content
- [View Mapped Data Plugin](https://flatfile.com/docs/plugins/view-mapped.md): Automatically hides unmapped columns after the mapping stage to provide a cleaner data review experience
- [Webhook Egress](https://flatfile.com/docs/plugins/webhook-egress.md): Send workbook data from Flatfile to external webhook endpoints for seamless integration with your systems
- [Webhook Event Forwarder](https://flatfile.com/docs/plugins/webhook-event-forwarder.md): Forward all Flatfile events to a webhook URL for language-agnostic integration with external systems
- [What3Words Converter Plugin](https://flatfile.com/docs/plugins/what3words.md): Automatically convert What3Words addresses into standard geographic data including country codes, nearest places, and latitude/longitude coordinates using the official What3Words API.
- [Excel Extractor](https://flatfile.com/docs/plugins/xlsx-extractor.md): Parse various Excel file formats (.xls, .xlsx, .xlsm, .xlsb, .xltx, .xltm) and extract structured data with support for header detection, merged cells, and hierarchical spreadsheets.
- [XML Extractor](https://flatfile.com/docs/plugins/xml-extractor.md): A Flatfile plugin for parsing XML files, flattening nested structures and attributes, and converting them into tabular format for easy import into Flatfile Sheets.
- [YAML Schema to Flatfile Blueprint Converter](https://flatfile.com/docs/plugins/yaml-schema.md): Automates the creation of a Flatfile Blueprint (Workbook and Sheets) from one or more YAML schema definitions, streamlining the setup of a Flatfile Space by converting existing data models into a Flatfile-compatible format.
- [Zip Extractor](https://flatfile.com/docs/plugins/zip-extractor.md): Automatically decompress .zip files uploaded to a Flatfile Space and extract their contents as individual files
- [Guides Overview](https://flatfile.com/docs/guides/overview.md): Comprehensive guides to help you master Flatfile's features and capabilities
- [Authentication and Authorization](https://flatfile.com/docs/guides/authentication.md): Complete guide to authenticating with Flatfile using API keys, Personal Access Tokens, and managing roles and permissions
- [Actions](https://flatfile.com/docs/guides/using-actions.md): Trigger custom operations based on user input
- [Using Record Hooks](https://flatfile.com/docs/guides/using-record-hooks.md): Process data with Record Hooks
- [Accepting Additional Fields](https://flatfile.com/docs/guides/accepting-additional-fields.md): Create additional fields on the fly
- [Advanced Filters](https://flatfile.com/docs/guides/advanced-filters.md): Learn how to use Flatfile's Advanced Filters to efficiently filter and search through your data
- [Custom Extractors](https://flatfile.com/docs/guides/custom-extractors.md): Build custom file processing plugins to handle unique data formats and transform files into structured data
- [Theming](https://flatfile.com/docs/guides/theme-your-space.md): Learn how to customize the look and feel of Flatfile to match your brand
- [Internationalization](https://flatfile.com/docs/guides/translating-your-space.md): Translate and customize your Space with text overrides
- [Data Egress](https://flatfile.com/docs/guides/egress.md): Get data out of Flatfile using various transmission methods and file formats
- [Metadata](https://flatfile.com/docs/guides/utilizing-metadata.md): Store descriptive information or data that provides additional context
- [Multi-Part Jobs](https://flatfile.com/docs/guides/multi-part-jobs.md): Split up Jobs into Parts
- [Namespaces and Filters](https://flatfile.com/docs/guides/namespaces-and-filters.md): Isolate and organize your Flatfile Listeners using namespace filtering and advanced Event filtering patterns
- [Secrets](https://flatfile.com/docs/guides/share-secrets.md): Securely use credentials in listeners
- [Overview](https://flatfile.com/docs/embedding/overview.md): Embed Flatfile data import directly into your application
- [JavaScript Embedding](https://flatfile.com/docs/embedding/javascript.md): Embed Flatfile using vanilla JavaScript
- [React Embedding](https://flatfile.com/docs/embedding/react.md): Embed Flatfile in React applications
- [Angular Embedding](https://flatfile.com/docs/embedding/angular.md): Embed Flatfile in Angular applications
- [Vue Embedding](https://flatfile.com/docs/embedding/vue.md): Embed Flatfile in Vue.js applications
- [Advanced Configuration](https://flatfile.com/docs/embedding/advanced-configuration.md): Complete configuration reference for embedded Flatfile
- [Server Setup for Space Reuse](https://flatfile.com/docs/embedding/server-setup.md): Server-side implementation guide for reusing existing spaces
- [Event Reference](https://flatfile.com/docs/reference/events.md): Complete reference for all Flatfile events, their payloads, and when they are triggered
- [Icon Reference](https://flatfile.com/docs/reference/icons.md): Reference of all available icons
- [CLI Reference](https://flatfile.com/docs/reference/cli.md): Command line interface for developing, deploying, and managing Flatfile Agents
- [Flatfile Query Language](https://flatfile.com/docs/reference/ffql.md): Learn how to filter data in Sheets with FFQL.
- [For LLMs](https://flatfile.com/docs/reference/for-llms.md): AI-optimized documentation formats and tools for better LLM integration
- [V2 Records API](https://flatfile.com/docs/reference/v2-records-api.md): Using the V2 Records API with the Flatfile TypeScript API package
## OpenAPI Specs
- [openapi](https://flatfile.com/docs/api-reference/openapi.json)
- [package](https://flatfile.com/docs/package.json)
- [package-lock](https://flatfile.com/docs/package-lock.json)
- [.prettier](https://flatfile.com/docs/.prettier.json)
## Optional
- [API Reference](https://reference.flatfile.com)
- [Changelog](https://flatfile.com/docs/changelog)
- [Platform](https://platform.flatfile.com)
Measured from the saved file
Linked document
UTF-8 text size
16.9 KB17348 bytes
Token count
3609o200k_base encoding
Markdown links
101101 distinct URLs
Fenced code blocks
0111 lines in the file
Size measures the captured UTF-8 text, not compressed transfer size. Tokens are counted with a named tokenizer; other models can count differently. Neither measure establishes context compatibility or answer quality.
Project H1
Flatfile Developer Docs
Context architecture
How the content is divided
3 H2 sections organize 101 parsed Markdown links. 94 links point to .md or .markdown paths; 2 link occurrences use another hostname. Linked destinations have not been recursively validated.
H2 section
Links
UTF-8 bytes
Tokens
DocsLine 3
94
16900
3493
OpenAPI SpecsLine 100
4
238
64
OptionalLine 107 · Optional
3
146
38
Link counts exclude parsed fenced and inline code and resolve relative destinations against the final endpoint. Section sizes cover the text below each H2 until the next H2.
Embedded material
Code, installation and API examples
Fenced blocks
0 closed
Declared languages
No fenced blocks detected
Package-install commands
0 detected in fenced or inline code
Authentication examples
0 fenced lines match API-key, Authorization, Bearer, OAuth or access-token patterns
HTTP request examples
0 fenced lines match request-method patterns
Authentication links
1 links have authentication-related labels
Embedded example text and links to further documentation are counted separately. A code block does not establish that a sample runs or that an authentication flow succeeds.
Publisher prioritization
The Optional section
1 H2 section named “Optional” contain 3 parsed links. 98 links sit outside those sections. That puts 3.0% of the file’s parsed links under Optional.
The community proposal uses Optional by convention for secondary links that can be skipped for a shorter context. This label does not establish that everything outside it is critical, or that the material inside it is deprecated.
Machine-readable routes
MCP references and configuration text
No MCP or Model Context Protocol term was detected in the captured file. 0 links have MCP-related labels or paths. 0 fenced lines match mcpServers, mcp_servers or an mcp add command.
These are text and link observations. No MCP server connection, authentication or tool call was tested.
A verified text response establishes a companion at the checked URL. It does not prove the bundle contains all product documentation, that generation is automated, or that it fits an assistant’s context window.
Change evidence
What can be said about freshness
This capture establishes a baseline. Update frequency cannot be determined from one observation.
Linked release and migration material
1 links have release, changelog, deprecation or migration terms in their labels or paths. These provide places to investigate product changes separately.
File changes can reveal documentation edits or navigation changes. They do not by themselves measure product release velocity, accuracy, agent adoption or AI visibility.
Counts use a deterministic parser, not a spec-compliance grade. Unusual Markdown and indented code can fall outside its recognized patterns. See the llms.txt proposal and tokenizer implementation.