# Flatfile

```json
{
  "name": "Flatfile",
  "slug": "flatfile",
  "url": "https://composio.dev/toolkits/flatfile",
  "markdown_url": "https://composio.dev/toolkits/flatfile.md",
  "logo_url": "https://logos.composio.dev/api/flatfile",
  "categories": [
    "data & analytics"
  ],
  "is_composio_managed": false,
  "updated_at": "2026-08-20T15:31:56.458Z"
}
```

![Flatfile logo](https://logos.composio.dev/api/flatfile)

## Description

Securely connect your AI agents and chatbots (Claude, ChatGPT, Cursor, etc) with Flatfile MCP or direct API to validate imported records, transform files, manage spaces, and review jobs through natural language.

## Summary

Flatfile is a data exchange platform for collecting, validating, and transforming structured data.
Use it to run cleaner imports and collaborative data onboarding workflows.

## Categories

- data & analytics

## Toolkit Details

- Tools: 12

## Images

- Logo: https://logos.composio.dev/api/flatfile

## Authentication

- **Api Key**
  - Type: `api_key`
  - Description: Api Key authentication for Flatfile.
  - Setup:
    - Configure Api Key credentials for Flatfile.
    - Use the credentials when creating an auth config in Composio.

## Suggested Prompts

- Validate customer CSV imports in Flatfile
- List failed records from latest workbook
- Create Flatfile space for vendor onboarding

## Supported Tools

| Tool slug | Name | Description |
|---|---|---|
| `FLATFILE_DELETE_RECORDS` | Delete Records | Permanently delete one to 100 explicitly identified records from one Flatfile sheet. This action never performs an unfiltered delete. Flatfile hooks are disabled, so these deletions do not trigger hook-driven workflows. |
| `FLATFILE_GET_JOB` | Get Job | Get detailed status, outcome, result, and diagnostic information for one Flatfile asynchronous job. |
| `FLATFILE_GET_SHEET` | Get Sheet | Get one sheet's field configuration and record counts before reading or writing records. |
| `FLATFILE_GET_SPACE` | Get Space | Get safe metadata for one Flatfile space without exposing transient access credentials or token-bearing guest links. |
| `FLATFILE_INSERT_RECORDS` | Insert Records | Insert one or more rows into a Flatfile sheet using simple field-key to value objects. Returns Flatfile's success receipt and commit ID, not created record IDs. Use List Records separately when later work requires IDs; only attribute matches that are unambiguous for caller-controlled unique values. Hooks are disabled for this mutation. |
| `FLATFILE_LIST_ENVIRONMENTS` | List Environments | List Flatfile environments visible to the connected environment secret key and return the IDs needed to find spaces. |
| `FLATFILE_LIST_FILES` | List Files | Discover import or export files and their processing status, optionally within a Flatfile space. |
| `FLATFILE_LIST_JOBS` | List Jobs | Find asynchronous Flatfile jobs by environment, space, workbook, file, or parent job and inspect progress at a glance. |
| `FLATFILE_LIST_RECORDS` | List Records | Read one page of records from a Flatfile sheet, optionally filtering by validity, field, record ID, search value, or FFQL expression. |
| `FLATFILE_LIST_SPACES` | List Spaces | Find Flatfile spaces by environment, text, namespace, archive state, or template status. |
| `FLATFILE_LIST_WORKBOOKS` | List Workbooks | List workbooks, optionally within a space, with their nested sheets so an agent can continue to sheet and record tasks. |
| `FLATFILE_UPDATE_RECORDS` | Update Records | Update one or more existing Flatfile records by ID using simple field-key to value objects. Flatfile hooks are disabled, so these updates do not trigger hook-driven workflows. |

## Supported Triggers

None listed.

## Installation and MCP Setup

### Path 1: SDK Installation

#### Path 1, Step 1: Install Composio

Install the Composio SDK
```python
pip install composio_openai
```

```typescript
npm install @composio/openai
```

#### Path 1, Step 2: Initialize Composio and Create Tool Router Session

Import and initialize Composio client, then create a Tool Router session
```python
from openai import OpenAI
from composio import Composio
from composio_openai import OpenAIResponsesProvider

composio = Composio(provider=OpenAIResponsesProvider())
openai = OpenAI()
session = composio.create(user_id='your-user-id')
```

```typescript
import OpenAI from 'openai';
import { Composio } from '@composio/core';
import { OpenAIResponsesProvider } from '@composio/openai';

const composio = new Composio({
  provider: new OpenAIResponsesProvider(),
});
const openai = new OpenAI({});
const session = await composio.create('your-user-id');
```

#### Path 1, Step 3: Execute Flatfile Tools via Tool Router with Your Agent

Get tools from Tool Router session and execute Flatfile actions with your Agent
```python
tools = session.tools
response = openai.responses.create(
  model='gpt-4.1',
  tools=tools,
  input=[{
    'role': 'user',
    'content': 'List recent Flatfile spaces and summarize failed record validations'
  }]
)
result = composio.provider.handle_tool_calls(
  response=response,
  user_id='your-user-id'
)
print(result)
```

```typescript
const tools = session.tools;
const response = await openai.responses.create({
  model: 'gpt-4.1',
  tools: tools,
  input: [{
    role: 'user',
    content: 'List recent Flatfile spaces and summarize failed record validations'
  }],
});
const result = await composio.provider.handleToolCalls(
  'your-user-id',
  response.output
);
console.log(result);
```

### Path 2: MCP Server Setup

#### Path 2, Step 1: Install Composio

Install the Composio SDK for Python or TypeScript
```python
pip install composio claude-agent-sdk
```

```typescript
npm install @composio/core ai @ai-sdk/openai @ai-sdk/mcp
```

#### Path 2, Step 2: Initialize Client and Create Tool Router Session

Import and initialize the Composio client, then create a Tool Router session for Flatfile
```python
from composio import Composio
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

composio = Composio(api_key='your-composio-api-key')
session = composio.create(user_id='your-user-id')
url = session.mcp.url
```

```typescript
import { Composio } from '@composio/core';

const composio = new Composio({ apiKey: 'your-api-key' });
const session = await composio.create('your-user-id');
console.log(`Tool Router session created: ${session.mcp.url}`);
```

#### Path 2, Step 3: Connect to AI Agent

Use the MCP server with your AI agent (Anthropic Claude or Mastra)
```python
import asyncio

options = ClaudeAgentOptions(
    permission_mode='bypassPermissions',
    mcp_servers={
        'tool_router': {
            'type': 'http',
            'url': url,
            'headers': {
                'x-api-key': 'your-composio-api-key'
            }
        }
    },
    system_prompt='You are a helpful assistant with access to Flatfile tools.',
    max_turns=10
)

async def main():
    async with ClaudeSDKClient(options=options) as client:
        await client.query('Find validation errors in the latest Flatfile workbook')
        async for message in client.receive_response():
            if hasattr(message, 'content'):
                for block in message.content:
                    if hasattr(block, 'text'):
                        print(block.text)

asyncio.run(main())
```

```typescript
import { openai } from '@ai-sdk/openai';
import { experimental_createMCPClient as createMCPClient } from '@ai-sdk/mcp';
import { generateText } from 'ai';

const client = await createMCPClient({
  transport: {
    type: 'http',
    url: session.mcp.url,
    headers: {
      'x-api-key': 'your-composio-api-key',
    },
  },
});

const tools = await client.tools();
const { text } = await generateText({
  model: openai('gpt-4o'),
  tools,
  messages: [{
    role: 'user',
    content: 'Find validation errors in the latest Flatfile workbook'
  }],
  maxSteps: 5,
});

console.log(`Agent: ${text}`);
```

## Why Use Composio?

### 1. AI Native Flatfile Integration

- Supports both Flatfile MCP and direct API based integrations
- Structured, LLM-friendly schemas for reliable Flatfile tool execution
- Rich coverage for spaces, workbooks, sheets, records, jobs, and collaborative data workflows

### 2. Secure API Key Auth

- Flatfile uses API key auth, and Composio keeps those credentials out of your agent code
- Use auth_configs.create() and connected_accounts.link() when you want lower-level control over Flatfile credential setup
- Per user and per environment credentials instead of hard-coded keys in prompts, scripts, or repos

### 3. Agent Optimized Design

- Tools are shaped so agents can understand Flatfile concepts like spaces, workbooks, sheets, records, and jobs
- Comprehensive execution logs so you can see which Flatfile action ran, when it ran, and on whose behalf
- Use mcp.create() for custom MCP flows when you need more control around agent access

### 4. Enterprise Grade Security

- Fine-grained RBAC so you control which agents and users can access Flatfile workflows
- Scoped, least privilege access to Flatfile resources and data exchange operations
- Full audit trail of agent actions to support review, compliance, and debugging

## Use Flatfile with any AI Agent Framework

Choose a framework you want to connect Flatfile with:

None listed.

## Related Toolkits

- [Excel](https://composio.dev/toolkits/excel) - Microsoft Excel is a robust spreadsheet application for organizing, analyzing, and visualizing data. It's the go-to tool for calculations, reporting, and flexible data management.
- [21risk](https://composio.dev/toolkits/_21risk) - 21RISK is a web app built for easy checklist, audit, and compliance management. It streamlines risk processes so teams can focus on what matters.
- [Abstract](https://composio.dev/toolkits/abstract) - Abstract provides a suite of APIs for automating data validation and enrichment tasks. It helps developers streamline workflows and ensure data quality with minimal effort.
- [Adafruit IO](https://composio.dev/toolkits/adafruit_io) - Adafruit IO is Adafruit's cloud platform for connected device and IoT project data. It helps you store, visualize, and act on sensor feeds without running your own backend.
- [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time.
- [Agentql](https://composio.dev/toolkits/agentql) - Agentql is a toolkit that connects AI agents to the web using a specialized query language. It enables structured web interaction and data extraction for smarter automations.
- [Agenty](https://composio.dev/toolkits/agenty) - Agenty is a web scraping and automation platform for extracting data and automating browser tasks—no coding needed. It streamlines data collection, monitoring, and repetitive online actions.
- [Ambee](https://composio.dev/toolkits/ambee) - Ambee is an environmental data platform providing real-time, hyperlocal APIs for air quality, weather, and pollen. Get precise environmental insights to power smarter decisions in your apps and workflows.
- [Ambient weather](https://composio.dev/toolkits/ambient_weather) - Ambient Weather is a platform for personal weather stations with a robust API for accessing local, real-time, and historical weather data. Get detailed environmental insights directly from your own sensors for smarter apps and automations.
- [Anonyflow](https://composio.dev/toolkits/anonyflow) - Anonyflow is a service for encryption-based data anonymization and secure data sharing. It helps organizations meet GDPR, CCPA, and HIPAA data privacy compliance requirements.
- [ApexVerify](https://composio.dev/toolkits/apexverify) - ApexVerify is a contact-data validation service for emails and phone numbers. Use it to normalize, verify, and clean leads before they enter your systems.
- [Api ninjas](https://composio.dev/toolkits/api_ninjas) - Api ninjas offers 120+ public APIs spanning categories like weather, finance, sports, and more. Developers use it to supercharge apps with real-time data and actionable endpoints.
- [Api sports](https://composio.dev/toolkits/api_sports) - Api sports is a comprehensive sports data platform covering 2,000+ competitions with live scores and 15+ years of stats. Instantly access up-to-date sports information for analysis, apps, or chatbots.
- [Apify](https://composio.dev/toolkits/apify) - Apify is a cloud platform for building, deploying, and managing web scraping and automation tools called Actors. It lets you automate data extraction and workflow tasks at scale—no infrastructure headaches.
- [Autom](https://composio.dev/toolkits/autom) - Autom is a lightning-fast search engine results data platform for Google, Bing, and Brave. Developers use it to access fresh, low-latency SERP data on demand.
- [Beaconchain](https://composio.dev/toolkits/beaconchain) - Beaconchain is a real-time analytics platform for Ethereum 2.0's Beacon Chain. It provides detailed insights into validators, blocks, and overall network performance.
- [Big data cloud](https://composio.dev/toolkits/big_data_cloud) - BigDataCloud provides APIs for geolocation, reverse geocoding, and address validation. Instantly access reliable location intelligence to enhance your applications and workflows.
- [Bigpicture io](https://composio.dev/toolkits/bigpicture_io) - BigPicture.io offers APIs for accessing detailed company and profile data. Instantly enrich your applications with up-to-date insights on 20M+ businesses.
- [Bitquery](https://composio.dev/toolkits/bitquery) - Bitquery is a blockchain data platform offering indexed, real-time, and historical data from 40+ blockchains via GraphQL APIs. Get unified, reliable access to complex on-chain data for analytics, trading, and research.
- [Brightdata](https://composio.dev/toolkits/brightdata) - Brightdata is a leading web data platform offering advanced scraping, SERP APIs, and anti-bot tools. It lets you collect public web data at scale, bypassing blocks and friction.

## Frequently Asked Questions

### Do I need my own developer credentials to use Flatfile with Composio?

Yes, Flatfile requires you to configure your own API key credentials. Once set up, Composio handles secure credential storage and API request handling for you.

### Can I use multiple toolkits together?

Yes! Composio's Tool Router enables agents to use multiple toolkits. [Learn more](https://docs.composio.dev/tool-router/overview).

### Is Composio secure?

Composio is SOC 2 and ISO 27001 compliant with all data encrypted in transit and at rest. [Learn more](https://trust.composio.dev).

### What if the API changes?

Composio maintains and updates all toolkit integrations automatically, so your agents always work with the latest API versions.

---
[See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)