Flatfile API Reference

Name: Flatfile API Reference API
Brand: Flatfile API Reference
Availability: InStock

★ Only Publicly Available OpenAPI DocumentData EnrichmentData Transformationhttp222 EndpointsREST

For Agents

Build and run customer data-onboarding workflows on Flatfile — workspaces, agents, actions, and exports — through a 222-endpoint REST API.

Connect the Flatfile API Reference to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Flatfile API Reference, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Flatfile API Reference API.

Trigger a bulk action across imported records to apply transformations in one API call

Manage Flatfile agents and roll back to a previous version when a deployment misbehaves

Generate and download agent exports for offline review or downstream loading

Inspect the current Flatfile account to confirm tenant context before issuing operations

GET STARTED

Start building with Flatfile API Reference API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Flatfile API Reference, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Flatfile's API, keeping it validated and agent-ready. Flatfile is a data-onboarding platform that helps teams import, validate, and transform customer-supplied spreadsheets and CSVs at scale. The 222-endpoint API exposes accounts, actions, agents, agent exports, and the broader workspace primitives that power custom data onboarding flows. Use it to embed bring-your-own-data import experiences inside an application without writing a parsing pipeline.

Use Cases

Patterns agents use Flatfile API Reference API for, with concrete tasks.

★ Embedded Data Onboarding for SaaS Customers

A B2B SaaS app needs to let customers import legacy spreadsheets without bespoke parsing. The team configures a Flatfile workspace, then an agent provisions per-customer onboarding sessions through the API, watches the actions queue for completion, and pulls the cleaned data back into the product. Importing a customer's first dataset goes from days to minutes.

Create a Flatfile action for the new customer dataset, watch /actions/{actionId} until it completes, and pull the output

Bulk Validation and Cleanup Pipelines

Operations teams importing thousands of records at once need a single bulk action rather than per-row calls. The /actions/bulk endpoint runs validation and transformation across the whole import in one request. The agent reads the action result and surfaces invalid rows for human review before the data lands in production.

POST to /actions/bulk with the validation rules, then GET /actions/{actionId} until completion and surface invalid rows

Versioned Flatfile Agents with Rollback

When an updated Flatfile agent introduces a regression, ops needs an immediate rollback path. /agents/{agentId}/versions lists prior versions and /agents/{agentId}/versions/{agentVersionId}/revert restores the chosen one. Bad releases are recoverable in a single API call rather than a deploy cycle.

List versions for the misbehaving agent, identify the last known-good version, and POST the revert endpoint

Scheduled Export of Onboarded Data

Some customers want a nightly export of the records they imported into Flatfile. An agent triggers /agent-exports for each tracked workspace, polls /agent-exports/{agentExportId} for completion, then downloads the file via /agent-exports/{agentExportId}/download. The export ends up in object storage for downstream loading.

Trigger a Flatfile agent export, poll for completion, and download the resulting file to storage

AI Agent Data Onboarding via Jentic

An AI agent embedded in a SaaS product helps customers map their messy spreadsheets to the canonical schema. The agent uses Jentic to find the right Flatfile actions and agent operations, runs validations, and reports any rejects back to the customer. The 222-endpoint surface stays out of the developer's prompt.

Use Jentic to find the Flatfile bulk-action operation, execute it with the validation config, and parse the resulting reject list

Key Endpoints

222 endpoints — jentic publishes the only available openapi specification for flatfile's api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/accounts/current

Retrieve the current account context

GET

/actions

List actions in the workspace

POST

/actions/bulk

Run a bulk action across many records

GET

/agents

List configured agents

GET

/agents/{agentId}/versions

List version history for an agent

POST

/agents/{agentId}/versions/{agentVersionId}/revert

Revert an agent to a prior version

POST

/agent-exports

Create a new agent export

GET

/agent-exports/{agentExportId}/download

Download a completed export

GET

/accounts/current

Retrieve the current account context

GET

/actions

List actions in the workspace

POST

/actions/bulk

Run a bulk action across many records

GET

/agents

List configured agents

GET

/agents/{agentId}/versions

List version history for an agent

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Flatfile bearer secrets are stored encrypted in the Jentic vault. Agents drive actions, agent versions, and exports through Jentic without seeing the raw secret, which keeps tenant credentials out of model context.

Intent-based discovery

Agents search Jentic with intents like 'run a flatfile bulk action' and Jentic returns the matching operation with its schema across the 222-endpoint surface, including the bulk action body shape.

Time to first call

Direct Flatfile integration: 2-4 days to map the action and agent lifecycle plus async export polling. Through Jentic: under an hour per use case.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Airbyte

Airbyte focuses on ETL between SaaS sources; Flatfile focuses on customer-supplied spreadsheet onboarding.

Pick Airbyte when the source is another SaaS API; choose Flatfile when the source is a customer's CSV or Excel file.

Complementary

Zapier

Zapier wires Flatfile actions into downstream CRM, spreadsheet, and notification tools without custom glue code.

Pair them when an action completion in Flatfile should fan out to other systems automatically.

Complementary

Shopify

Shopify is a common downstream target for Flatfile-imported product or customer records.

Use both when customers upload a product CSV through Flatfile and the cleaned data is loaded into Shopify.

FAQs

Specific to using Flatfile API Reference API through Jentic.

Why is there no official OpenAPI spec for Flatfile?

Flatfile does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Flatfile API Reference via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Flatfile API use?

Flatfile uses HTTP bearer authentication. Send your Flatfile secret as a bearer token in the Authorization header. Through Jentic, the secret is held in the credential vault and injected at execution time, so the raw key never enters agent prompts.

Can I run a bulk transformation with the Flatfile API?

Yes. POST /actions/bulk applies a transformation across many records in a single request. Watch the action's status with GET /actions/{actionId} until it completes, then read the resulting record set or rejects.

What are the rate limits for the Flatfile API?

The spec does not declare numeric rate limits; Flatfile enforces tenant-level limits at the platform layer. Build retries with backoff on 429, and prefer bulk endpoints (such as /actions/bulk) over per-record calls when importing many rows.

How do I revert a misbehaving Flatfile agent through Jentic?

Install the SDK with `pip install jentic`. Search Jentic for `revert flatfile agent version`, load the schema for POST /agents/{agentId}/versions/{agentVersionId}/revert, and execute it with the agent id and the version id you want to restore.

Can I export records out of Flatfile?

Yes. POST /agent-exports to create a new export job, poll /agent-exports/{agentExportId} for completion, and call /agent-exports/{agentExportId}/download to fetch the resulting file.