# Flatfile | API Reference ## Instructions for AI Agents - For clean Markdown of any page, append `.md` to the page URL - For section-specific indexes, append `/llms.txt` to any section URL - For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://reference.flatfile.com/_mcp/server ## Docs - [Welcome](https://reference.flatfile.com/overview/welcome.md) - [Authentication](https://reference.flatfile.com/overview/auth.md) - [Using Environments](https://reference.flatfile.com/overview/using-environments.md) ## API Docs - API Reference > Accounts [Get the current account](https://reference.flatfile.com/api-reference/accounts/get-current.md) - API Reference > Accounts [Update the current account](https://reference.flatfile.com/api-reference/accounts/update-current.md) - API Reference > Actions [Create an action](https://reference.flatfile.com/api-reference/actions/create.md) - API Reference > Actions [Create several actions](https://reference.flatfile.com/api-reference/actions/bulk-create.md) - API Reference > Actions [Get all actions for the space](https://reference.flatfile.com/api-reference/actions/get-all.md) - API Reference > Actions [Get an action](https://reference.flatfile.com/api-reference/actions/get.md) - API Reference > Actions [Update an action](https://reference.flatfile.com/api-reference/actions/update.md) - API Reference > Actions [Delete an action](https://reference.flatfile.com/api-reference/actions/delete.md) - API Reference > Agent Exports [List agent exports](https://reference.flatfile.com/api-reference/agent-exports/list.md) - API Reference > Agent Exports [Get an agent export](https://reference.flatfile.com/api-reference/agent-exports/get.md) - API Reference > Agent Exports [Download an agent export](https://reference.flatfile.com/api-reference/agent-exports/download.md) - API Reference > Agent Exports [Delete an agent export](https://reference.flatfile.com/api-reference/agent-exports/delete.md) - API Reference > Agents [List agents](https://reference.flatfile.com/api-reference/agents/list.md) - API Reference > Agents [Create an agent](https://reference.flatfile.com/api-reference/agents/create.md) - API Reference > Agents [Get an agent](https://reference.flatfile.com/api-reference/agents/get.md) - API Reference > Agents [List agent versions for an agent](https://reference.flatfile.com/api-reference/agents/list-versions.md) - API Reference > Agents [Revert to a specific agent version](https://reference.flatfile.com/api-reference/agents/revert.md) - API Reference > Agents [List Agent Roles](https://reference.flatfile.com/api-reference/agents/list-agent-roles.md) - API Reference > Agents [Assign Role to Agent](https://reference.flatfile.com/api-reference/agents/assign-agent-role.md) - API Reference > Agents [Remove Role from Agent](https://reference.flatfile.com/api-reference/agents/delete-agent-role.md) - API Reference > Agents [Get logs for an agent](https://reference.flatfile.com/api-reference/agents/get-agent-logs.md) - API Reference > Agents [Get an agent log](https://reference.flatfile.com/api-reference/agents/get-agent-log.md) - API Reference > Agents [Get all agent logs in your environment](https://reference.flatfile.com/api-reference/agents/get-environment-agent-logs.md) - API Reference > Agents [Get all executions in your environment](https://reference.flatfile.com/api-reference/agents/get-environment-agent-executions.md) - API Reference > Agents [Delete an agent](https://reference.flatfile.com/api-reference/agents/delete.md) - API Reference > Apps [List apps](https://reference.flatfile.com/api-reference/apps/list.md) - API Reference > Apps [Get an app](https://reference.flatfile.com/api-reference/apps/get.md) - API Reference > Apps [Update an app](https://reference.flatfile.com/api-reference/apps/update.md) - API Reference > Apps [Create an app](https://reference.flatfile.com/api-reference/apps/create.md) - API Reference > Apps [Delete an app](https://reference.flatfile.com/api-reference/apps/delete.md) - API Reference > Apps [Get constraints](https://reference.flatfile.com/api-reference/apps/get-constraints.md) - API Reference > Apps [Create constraint](https://reference.flatfile.com/api-reference/apps/create-constraint.md) - API Reference > Apps [Get constraint by ID](https://reference.flatfile.com/api-reference/apps/get-constraint-by-id.md) - API Reference > Apps [Get constraint versions](https://reference.flatfile.com/api-reference/apps/get-constraint-versions.md) - API Reference > Apps [Get constraint version](https://reference.flatfile.com/api-reference/apps/get-constraint-version.md) - API Reference > Apps [Update constraint](https://reference.flatfile.com/api-reference/apps/update-constraint.md) - API Reference > Apps [Delete constraint](https://reference.flatfile.com/api-reference/apps/delete-constraint.md) - API Reference > Assistant [List prompts](https://reference.flatfile.com/api-reference/assistant/list.md) - API Reference > Assistant [Get a prompt](https://reference.flatfile.com/api-reference/assistant/get.md) - API Reference > Assistant [Update a prompt](https://reference.flatfile.com/api-reference/assistant/update.md) - API Reference > Assistant [Create a prompt](https://reference.flatfile.com/api-reference/assistant/create.md) - API Reference > Assistant [Delete a prompts](https://reference.flatfile.com/api-reference/assistant/delete.md) - API Reference > Auth [Obtain the publishable key for a specific environment](https://reference.flatfile.com/api-reference/auth/get-publishable-key.md) - API Reference > Auth [Get SFTP credentials for Space](https://reference.flatfile.com/api-reference/auth/get-sftp-credentials.md) - API Reference > Canvas Areas [List canvas areas](https://reference.flatfile.com/api-reference/canvas-areas/list.md) - API Reference > Canvas Areas [Create a canvas area](https://reference.flatfile.com/api-reference/canvas-areas/create.md) - API Reference > Canvas Areas [Get a canvas area](https://reference.flatfile.com/api-reference/canvas-areas/get.md) - API Reference > Canvas Areas [Update a canvas area](https://reference.flatfile.com/api-reference/canvas-areas/update.md) - API Reference > Canvas Areas [Delete a canvas area](https://reference.flatfile.com/api-reference/canvas-areas/delete.md) - API Reference > Commits [Get a commit version](https://reference.flatfile.com/api-reference/commits/get.md) - API Reference > Commits [Complete a commit version](https://reference.flatfile.com/api-reference/commits/complete.md) - API Reference > Commits [Replay a commit version](https://reference.flatfile.com/api-reference/commits/replay.md) - API Reference > Data Clips [Create](https://reference.flatfile.com/api-reference/data-clips/create.md) - API Reference > Data Clips [Update](https://reference.flatfile.com/api-reference/data-clips/update.md) - API Reference > Data Clips [Delete](https://reference.flatfile.com/api-reference/data-clips/delete.md) - API Reference > Data Clips [Get](https://reference.flatfile.com/api-reference/data-clips/get.md) - API Reference > Data Clips [Add Records To Clip](https://reference.flatfile.com/api-reference/data-clips/add-records-to-clip.md) - API Reference > Data Clips [List](https://reference.flatfile.com/api-reference/data-clips/list.md) - API Reference > Data Clips [Get Resolutions](https://reference.flatfile.com/api-reference/data-clips/get-resolutions.md) - API Reference > Data Clips [Get Resolution Index](https://reference.flatfile.com/api-reference/data-clips/get-resolution-index.md) - API Reference > Data Clips [Update Resolution](https://reference.flatfile.com/api-reference/data-clips/update-resolution.md) - API Reference > Data Clips [Refresh Resolutions](https://reference.flatfile.com/api-reference/data-clips/refresh-resolutions.md) - API Reference > Data Retention Policies [List data retention policies](https://reference.flatfile.com/api-reference/data-retention-policies/list.md) - API Reference > Data Retention Policies [Create a data retention policy](https://reference.flatfile.com/api-reference/data-retention-policies/create.md) - API Reference > Data Retention Policies [Get a data retention policy](https://reference.flatfile.com/api-reference/data-retention-policies/get.md) - API Reference > Data Retention Policies [Update a data retention policy](https://reference.flatfile.com/api-reference/data-retention-policies/update.md) - API Reference > Data Retention Policies [Delete a data retention policy](https://reference.flatfile.com/api-reference/data-retention-policies/delete.md) - API Reference > Documents [List documents](https://reference.flatfile.com/api-reference/documents/list.md) - API Reference > Documents [Create a document](https://reference.flatfile.com/api-reference/documents/create.md) - API Reference > Documents [Get a document](https://reference.flatfile.com/api-reference/documents/get.md) - API Reference > Documents [Update a document](https://reference.flatfile.com/api-reference/documents/update.md) - API Reference > Documents [Delete a document](https://reference.flatfile.com/api-reference/documents/delete.md) - API Reference > Entitlements [List entitlements](https://reference.flatfile.com/api-reference/entitlements/list.md) - API Reference > Environments [List environments](https://reference.flatfile.com/api-reference/environments/list.md) - API Reference > Environments [Create an environment](https://reference.flatfile.com/api-reference/environments/create.md) - API Reference > Environments [Get environment subscription credentials](https://reference.flatfile.com/api-reference/environments/get-environment-event-token.md) - API Reference > Environments [Get an environment](https://reference.flatfile.com/api-reference/environments/get.md) - API Reference > Environments [Update an environment](https://reference.flatfile.com/api-reference/environments/update.md) - API Reference > Environments [Delete an environment](https://reference.flatfile.com/api-reference/environments/delete.md) - API Reference > Environments [List guides](https://reference.flatfile.com/api-reference/environments/list-guides.md) - API Reference > Environments [Get a guide](https://reference.flatfile.com/api-reference/environments/get-guide.md) - API Reference > Environments [Update a guide](https://reference.flatfile.com/api-reference/environments/update-guide.md) - API Reference > Environments [Create a guide](https://reference.flatfile.com/api-reference/environments/create-guide.md) - API Reference > Environments [Delete a guide](https://reference.flatfile.com/api-reference/environments/delete-guide.md) - API Reference > Environments [Get guide version](https://reference.flatfile.com/api-reference/environments/get-guide-version.md) - API Reference > Events [List events](https://reference.flatfile.com/api-reference/events/list.md) - API Reference > Events [Create an event](https://reference.flatfile.com/api-reference/events/create.md) - API Reference > Events [Get an event](https://reference.flatfile.com/api-reference/events/get.md) - API Reference > Events [Acknowledge an event](https://reference.flatfile.com/api-reference/events/ack.md) - API Reference > Events [Get subscription credentials](https://reference.flatfile.com/api-reference/events/get-event-token.md) - API Reference > Files [List files](https://reference.flatfile.com/api-reference/files/list.md) - API Reference > Files [Upload a file](https://reference.flatfile.com/api-reference/files/upload.md) - API Reference > Files [Get a file](https://reference.flatfile.com/api-reference/files/get.md) - API Reference > Files [Delete a file](https://reference.flatfile.com/api-reference/files/delete.md) - API Reference > Files [Update a file](https://reference.flatfile.com/api-reference/files/update.md) - API Reference > Files [Download a file](https://reference.flatfile.com/api-reference/files/download.md) - API Reference > Files [Clone a file](https://reference.flatfile.com/api-reference/files/clone.md) - API Reference > Files [Detect header](https://reference.flatfile.com/api-reference/files/detect-header.md) - API Reference > Flags [Create](https://reference.flatfile.com/api-reference/flags/create.md) - API Reference > Flags [List](https://reference.flatfile.com/api-reference/flags/list.md) - API Reference > Flags [Get](https://reference.flatfile.com/api-reference/flags/get.md) - API Reference > Flags [Update](https://reference.flatfile.com/api-reference/flags/update.md) - API Reference > Flags [Delete](https://reference.flatfile.com/api-reference/flags/delete.md) - API Reference > Flags [Bulk Mutate](https://reference.flatfile.com/api-reference/flags/bulk-mutate.md) - API Reference > Guests [List guests](https://reference.flatfile.com/api-reference/guests/list.md) - API Reference > Guests [Create a guest](https://reference.flatfile.com/api-reference/guests/create.md) - API Reference > Guests [Get a guest](https://reference.flatfile.com/api-reference/guests/get.md) - API Reference > Guests [Delete a guest](https://reference.flatfile.com/api-reference/guests/delete.md) - API Reference > Guests [Update a guest](https://reference.flatfile.com/api-reference/guests/update.md) - API Reference > Guests [Get guest token](https://reference.flatfile.com/api-reference/guests/get-guest-token.md) - API Reference > Guests [List Guest Roles](https://reference.flatfile.com/api-reference/guests/list-guest-roles.md) - API Reference > Guests [Assign Role to Guest](https://reference.flatfile.com/api-reference/guests/assign-guest-role.md) - API Reference > Guests [Remove Role from Guest](https://reference.flatfile.com/api-reference/guests/delete-guest-role.md) - API Reference > Guests [Invite guests](https://reference.flatfile.com/api-reference/guests/invite.md) - API Reference > Jobs [List jobs](https://reference.flatfile.com/api-reference/jobs/list.md) - API Reference > Jobs [Create a job](https://reference.flatfile.com/api-reference/jobs/create.md) - API Reference > Jobs [Get a job](https://reference.flatfile.com/api-reference/jobs/get.md) - API Reference > Jobs [Update a job](https://reference.flatfile.com/api-reference/jobs/update.md) - API Reference > Jobs [Delete a job](https://reference.flatfile.com/api-reference/jobs/delete.md) - API Reference > Jobs [Execute a job](https://reference.flatfile.com/api-reference/jobs/execute.md) - API Reference > Jobs [Get a job's execution plan](https://reference.flatfile.com/api-reference/jobs/get-execution-plan.md) - API Reference > Jobs [Replace a job's plan](https://reference.flatfile.com/api-reference/jobs/update-execution-plan.md) - API Reference > Jobs [Update a job's plan](https://reference.flatfile.com/api-reference/jobs/update-execution-plan-fields.md) - API Reference > Jobs [Acknowledge a job](https://reference.flatfile.com/api-reference/jobs/ack.md) - API Reference > Jobs [Acknowledge a job outcome](https://reference.flatfile.com/api-reference/jobs/ack-outcome.md) - API Reference > Jobs [Complete a job](https://reference.flatfile.com/api-reference/jobs/complete.md) - API Reference > Jobs [Fail a job](https://reference.flatfile.com/api-reference/jobs/fail.md) - API Reference > Jobs [Cancel a job](https://reference.flatfile.com/api-reference/jobs/cancel.md) - API Reference > Jobs [Retry a failed job](https://reference.flatfile.com/api-reference/jobs/retry.md) - API Reference > Jobs [Preview a mutation](https://reference.flatfile.com/api-reference/jobs/preview-mutation.md) - API Reference > Jobs [Split a job](https://reference.flatfile.com/api-reference/jobs/split.md) - API Reference > Mapping [Create a mapping between two schemas](https://reference.flatfile.com/api-reference/mapping/create-mapping-program.md) - API Reference > Mapping [Delete all history for the authenticated user](https://reference.flatfile.com/api-reference/mapping/delete-all-history-for-user.md) - API Reference > Mapping [List mapping programs](https://reference.flatfile.com/api-reference/mapping/list-mapping-programs.md) - API Reference > Mapping [Get a mapping program](https://reference.flatfile.com/api-reference/mapping/get-mapping-program.md) - API Reference > Mapping [Update a mapping program](https://reference.flatfile.com/api-reference/mapping/update-mapping-program.md) - API Reference > Mapping [Delete a mapping program](https://reference.flatfile.com/api-reference/mapping/delete-mapping-program.md) - API Reference > Mapping [Add mapping rules to a program](https://reference.flatfile.com/api-reference/mapping/create-rules.md) - API Reference > Mapping [Delete multiple mapping rules](https://reference.flatfile.com/api-reference/mapping/delete-multiple-rules.md) - API Reference > Mapping [List mapping rules](https://reference.flatfile.com/api-reference/mapping/list-rules.md) - API Reference > Mapping [Get a mapping rule](https://reference.flatfile.com/api-reference/mapping/get-rule.md) - API Reference > Mapping [Update a mapping rule](https://reference.flatfile.com/api-reference/mapping/update-rule.md) - API Reference > Mapping [Update a list of mapping rules](https://reference.flatfile.com/api-reference/mapping/update-rules.md) - API Reference > Mapping [Delete a mapping rule](https://reference.flatfile.com/api-reference/mapping/delete-rule.md) - API Reference > Records [Get records](https://reference.flatfile.com/api-reference/records/get.md) - API Reference > Records [Get record Indices](https://reference.flatfile.com/api-reference/records/indices.md) - API Reference > Records [Update records](https://reference.flatfile.com/api-reference/records/update.md) - API Reference > Records [Insert records](https://reference.flatfile.com/api-reference/records/insert.md) - API Reference > Records [Delete records](https://reference.flatfile.com/api-reference/records/delete.md) - API Reference > Records [Finds and replaces field values matching search criteria ](https://reference.flatfile.com/api-reference/records/find-and-replace.md) - API Reference > Records [Bulk update records with field values ](https://reference.flatfile.com/api-reference/records/bulk-update.md) - API Reference > Roles [List roles](https://reference.flatfile.com/api-reference/roles/list.md) - API Reference > Routines [List routines](https://reference.flatfile.com/api-reference/routines/list.md) - API Reference > Routines [Get a routine](https://reference.flatfile.com/api-reference/routines/get.md) - API Reference > Routines [Create a routine](https://reference.flatfile.com/api-reference/routines/create.md) - API Reference > Routines [Update a routine](https://reference.flatfile.com/api-reference/routines/update.md) - API Reference > Routines [Delete a routine](https://reference.flatfile.com/api-reference/routines/delete.md) - API Reference > Runbooks [List runbooks](https://reference.flatfile.com/api-reference/runbooks/list.md) - API Reference > Runbooks [Get a runbook](https://reference.flatfile.com/api-reference/runbooks/get.md) - API Reference > Runbooks [Create a runbook](https://reference.flatfile.com/api-reference/runbooks/create.md) - API Reference > Runbooks [Update a runbook](https://reference.flatfile.com/api-reference/runbooks/update.md) - API Reference > Runbooks [Delete a runbook](https://reference.flatfile.com/api-reference/runbooks/delete.md) - API Reference > Secrets [List secrets](https://reference.flatfile.com/api-reference/secrets/list.md) - API Reference > Secrets [Upsert a Secret](https://reference.flatfile.com/api-reference/secrets/upsert.md) - API Reference > Secrets [Delete a secret by it's Id](https://reference.flatfile.com/api-reference/secrets/delete.md) - API Reference > Sheets [List sheets](https://reference.flatfile.com/api-reference/sheets/list.md) - API Reference > Sheets [Get a sheet](https://reference.flatfile.com/api-reference/sheets/get.md) - API Reference > Sheets [Delete a sheet](https://reference.flatfile.com/api-reference/sheets/delete.md) - API Reference > Sheets [Duplicate a sheet](https://reference.flatfile.com/api-reference/sheets/duplicate-sheet.md) - API Reference > Sheets [Validate a sheet](https://reference.flatfile.com/api-reference/sheets/validate.md) - API Reference > Sheets [Download records as a CSV file](https://reference.flatfile.com/api-reference/sheets/get-records-as-csv.md) - API Reference > Sheets [Get record counts](https://reference.flatfile.com/api-reference/sheets/get-record-counts.md) - API Reference > Sheets [List calculations](https://reference.flatfile.com/api-reference/sheets/get-calculations.md) - API Reference > Sheets [Get commit versions for a sheet](https://reference.flatfile.com/api-reference/sheets/get-sheet-commits.md) - API Reference > Sheets [Lock a sheet](https://reference.flatfile.com/api-reference/sheets/lock-sheet.md) - API Reference > Sheets [Unlock a sheet](https://reference.flatfile.com/api-reference/sheets/unlock-sheet.md) - API Reference > Sheets [Get record cells by field](https://reference.flatfile.com/api-reference/sheets/get-cell-values.md) - API Reference > Sheets [Update a sheet](https://reference.flatfile.com/api-reference/sheets/update-sheet.md) - API Reference > Snapshots [Create a snapshot](https://reference.flatfile.com/api-reference/snapshots/create-snapshot.md) - API Reference > Snapshots [List snapshots](https://reference.flatfile.com/api-reference/snapshots/list-snapshots.md) - API Reference > Snapshots [Get a snapshot](https://reference.flatfile.com/api-reference/snapshots/get-snapshot.md) - API Reference > Snapshots [Delete a snapshot](https://reference.flatfile.com/api-reference/snapshots/delete-snapshot.md) - API Reference > Snapshots [Restore a snapshot](https://reference.flatfile.com/api-reference/snapshots/restore-snapshot.md) - API Reference > Snapshots [Get records from a snapshot](https://reference.flatfile.com/api-reference/snapshots/get-snapshot-records.md) - API Reference > Spaces [List spaces](https://reference.flatfile.com/api-reference/spaces/list.md) - API Reference > Spaces [Create a space](https://reference.flatfile.com/api-reference/spaces/create.md) - API Reference > Spaces [Get a space](https://reference.flatfile.com/api-reference/spaces/get.md) - API Reference > Spaces [Delete a space](https://reference.flatfile.com/api-reference/spaces/delete.md) - API Reference > Spaces [Delete spaces](https://reference.flatfile.com/api-reference/spaces/bulk-delete.md) - API Reference > Spaces [Update a space](https://reference.flatfile.com/api-reference/spaces/update.md) - API Reference > Spaces [Archives a space](https://reference.flatfile.com/api-reference/spaces/archive-space.md) - API Reference > Spaces [Unarchives a space](https://reference.flatfile.com/api-reference/spaces/unarchive-space.md) - API Reference > Spaces [Create a new guidance](https://reference.flatfile.com/api-reference/spaces/create-guidance.md) - API Reference > Spaces [List guidances](https://reference.flatfile.com/api-reference/spaces/list-guidance.md) - API Reference > Spaces [Get a guidance](https://reference.flatfile.com/api-reference/spaces/get-guidance.md) - API Reference > Spaces [Update a guidance](https://reference.flatfile.com/api-reference/spaces/update-guidance.md) - API Reference > Spaces [Delete a guidance](https://reference.flatfile.com/api-reference/spaces/delete-guidance.md) - API Reference > Spaces [Create a draft of a space](https://reference.flatfile.com/api-reference/spaces/create-draft.md) - API Reference > Spaces [List drafts for a space](https://reference.flatfile.com/api-reference/spaces/list-space-drafts.md) - API Reference > Spaces [Get a draft](https://reference.flatfile.com/api-reference/spaces/get-space-draft.md) - API Reference > Spaces [Merge a draft](https://reference.flatfile.com/api-reference/spaces/merge-draft.md) - API Reference > Users [List users](https://reference.flatfile.com/api-reference/users/list.md) - API Reference > Users [Create and Invite User](https://reference.flatfile.com/api-reference/users/create-and-invite.md) - API Reference > Users [Resend User Invite](https://reference.flatfile.com/api-reference/users/resend-invite.md) - API Reference > Users [Update a user](https://reference.flatfile.com/api-reference/users/update.md) - API Reference > Users [Get a user](https://reference.flatfile.com/api-reference/users/get.md) - API Reference > Users [Delete a user](https://reference.flatfile.com/api-reference/users/delete.md) - API Reference > Users [List User Roles](https://reference.flatfile.com/api-reference/users/list-user-roles.md) - API Reference > Users [Assign Role to User](https://reference.flatfile.com/api-reference/users/assign-user-role.md) - API Reference > Users [Remove Role from User](https://reference.flatfile.com/api-reference/users/delete-user-role.md) - API Reference > Versions [Create Id](https://reference.flatfile.com/api-reference/versions/create-id.md) - API Reference > Views [List views by Sheet](https://reference.flatfile.com/api-reference/views/list.md) - API Reference > Views [Create a view](https://reference.flatfile.com/api-reference/views/create.md) - API Reference > Views [Get a view](https://reference.flatfile.com/api-reference/views/get.md) - API Reference > Views [Update a view](https://reference.flatfile.com/api-reference/views/update.md) - API Reference > Views [Delete a view](https://reference.flatfile.com/api-reference/views/delete.md) - API Reference > Workbooks [List workbooks](https://reference.flatfile.com/api-reference/workbooks/list.md) - API Reference > Workbooks [Create a workbook](https://reference.flatfile.com/api-reference/workbooks/create.md) - API Reference > Workbooks [Get a workbook](https://reference.flatfile.com/api-reference/workbooks/get.md) - API Reference > Workbooks [Delete a workbook](https://reference.flatfile.com/api-reference/workbooks/delete.md) - API Reference > Workbooks [Update a workbook](https://reference.flatfile.com/api-reference/workbooks/update.md) - API Reference > Workbooks [Get commits for a workbook](https://reference.flatfile.com/api-reference/workbooks/get-workbook-commits.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://reference.flatfile.com/openapi.json) - [OpenAPI YAML](https://reference.flatfile.com/openapi.yaml)