# FileFeed DOCS

## Docs

- [API Library](https://docs.filefeed.io/api-library/overview.md): TypeScript SDK for programmatic access to FileFeed
- [Create client](https://docs.filefeed.io/api-reference/clients-deprecated/create-client.md): **Deprecated** as of API version `2026-05-25`. Use [`POST /connections`](#tag/connections/post/connections) instead. Sunset: 2027-05-25.
- [Delete client](https://docs.filefeed.io/api-reference/clients-deprecated/delete-client.md): **Deprecated** — use `DELETE /connections/{id}` instead.
- [Get client](https://docs.filefeed.io/api-reference/clients-deprecated/get-client.md): **Deprecated** — use `GET /connections/{id}` instead.
- [List clients](https://docs.filefeed.io/api-reference/clients-deprecated/list-clients.md): **Deprecated** as of API version `2026-05-25`. Use [`GET /connections`](#tag/connections/get/connections) instead. Sunset: 2027-05-25.
- [Test SFTP connection](https://docs.filefeed.io/api-reference/clients-deprecated/test-sftp-connection.md): **Deprecated** — use `POST /connections/{id}/test-connection` instead.
- [Update client](https://docs.filefeed.io/api-reference/clients-deprecated/update-client.md): **Deprecated** — use `PATCH /connections/{id}` instead.
- [Create connection](https://docs.filefeed.io/api-reference/connections/create-connection.md)
- [Delete connection](https://docs.filefeed.io/api-reference/connections/delete-connection.md)
- [Get connection](https://docs.filefeed.io/api-reference/connections/get-connection.md)
- [List connections](https://docs.filefeed.io/api-reference/connections/list-connections.md)
- [Test SFTP connection](https://docs.filefeed.io/api-reference/connections/test-sftp-connection.md): Verifies an SFTP connection with a live login. For an EMAIL connection this is a no-op that returns `success: false` with an explanatory message (still HTTP 200, not an error).
- [Update connection](https://docs.filefeed.io/api-reference/connections/update-connection.md)
- [Abort a multipart upload](https://docs.filefeed.io/api-reference/documents/abort-a-multipart-upload.md)
- [Browse documents](https://docs.filefeed.io/api-reference/documents/browse-documents.md): List one page of folders and files under a path within a connection (drive).
- [Complete a multipart upload](https://docs.filefeed.io/api-reference/documents/complete-a-multipart-upload.md)
- [Create a folder](https://docs.filefeed.io/api-reference/documents/create-a-folder.md)
- [Create a presigned upload ticket](https://docs.filefeed.io/api-reference/documents/create-a-presigned-upload-ticket.md): Server picks single (one PUT) or multipart (one PUT per part) based on size.
- [Delete a file](https://docs.filefeed.io/api-reference/documents/delete-a-file.md): Pass force=true (admin/owner only) to override pipeline-folder protection.
- [Delete a folder and its contents](https://docs.filefeed.io/api-reference/documents/delete-a-folder-and-its-contents.md): Pass force=true (admin/owner only) to override pipeline-folder protection.
- [Delete multiple items](https://docs.filefeed.io/api-reference/documents/delete-multiple-items.md): Returns the count deleted plus a per-item list of failures — a partial failure does not error.
- [Get a presigned download URL](https://docs.filefeed.io/api-reference/documents/get-a-presigned-download-url.md)
- [Get document metadata](https://docs.filefeed.io/api-reference/documents/get-document-metadata.md)
- [Move a file or folder](https://docs.filefeed.io/api-reference/documents/move-a-file-or-folder.md)
- [Rename a file or folder](https://docs.filefeed.io/api-reference/documents/rename-a-file-or-folder.md)
- [Get a processed JSON file by name](https://docs.filefeed.io/api-reference/files/get-a-processed-json-file-by-name.md): Retrieve a processed JSON file's content, located by connection name, file name, and pipeline. Supply offset/limit to page an array file.
- [Search across processed files](https://docs.filefeed.io/api-reference/files/search-across-processed-files.md): Search rows across processed files belonging to the given pipeline runs. pipelineRunIds is required; omit searchTerm to return all rows.
- [API Introduction](https://docs.filefeed.io/api-reference/introduction.md): Base URL, authentication, versioning, and conventions
- [Get notification preferences](https://docs.filefeed.io/api-reference/notifications/get-notification-preferences.md): List a connection's notification preferences, ordered by event type then channel. The path segment is named `clientId` for back-compat — it is the connection id.
- [Set notification preferences](https://docs.filefeed.io/api-reference/notifications/set-notification-preferences.md): Upsert a connection's preferences, matched on (eventType, channel). An enabled preference requires at least one recipient.
- [Abort outbound multipart upload and cleanup temp parts](https://docs.filefeed.io/api-reference/outbound-uploads/abort-outbound-multipart-upload-and-cleanup-temp-parts.md): Cancels an in-progress upload session, deletes all temporary parts from storage, and marks the session as aborted. Further uploads to this session will be rejected.
- [Complete outbound multipart upload and trigger processing](https://docs.filefeed.io/api-reference/outbound-uploads/complete-outbound-multipart-upload-and-trigger-processing.md): Combines all uploaded parts into one file, stores it in S3, and triggers pipeline processing. The number of parts listed must match `totalParts`.
- [Get outbound multipart upload status](https://docs.filefeed.io/api-reference/outbound-uploads/get-outbound-multipart-upload-status.md): Returns the current state of an upload session including which parts have been uploaded.
- [Initialize an outbound multipart upload session](https://docs.filefeed.io/api-reference/outbound-uploads/initialize-an-outbound-multipart-upload-session.md): Creates a new upload session for pushing JSON data into an outbound pipeline. The pipeline must have `direction: "outbound"`.
- [Upload one part for an outbound upload session](https://docs.filefeed.io/api-reference/outbound-uploads/upload-one-part-for-an-outbound-upload-session.md): Upload a single part (JSON array of objects). Part numbers are 1-based and must not exceed `totalParts`.
- [Acknowledge a pipeline run](https://docs.filefeed.io/api-reference/pipeline-runs/acknowledge-a-pipeline-run.md)
- [Compare two pipeline runs (delta)](https://docs.filefeed.io/api-reference/pipeline-runs/compare-two-pipeline-runs-delta.md): Compares the processed files of two runs of the SAME pipeline (for example yesterday's ingest vs today's) and returns the records added and removed. The diff is a whole-record multiset difference — the platform has no record-identity key, so a changed row surfaces as one removed plus one added. Both…
- [Get a pipeline run](https://docs.filefeed.io/api-reference/pipeline-runs/get-a-pipeline-run.md)
- [Get pipeline run data (paginated)](https://docs.filefeed.io/api-reference/pipeline-runs/get-pipeline-run-data-paginated.md)
- [Get presigned URL for original file](https://docs.filefeed.io/api-reference/pipeline-runs/get-presigned-url-for-original-file.md)
- [Get presigned URL for processed file](https://docs.filefeed.io/api-reference/pipeline-runs/get-presigned-url-for-processed-file.md)
- [Get runs by pipeline](https://docs.filefeed.io/api-reference/pipeline-runs/get-runs-by-pipeline.md)
- [List pipeline runs](https://docs.filefeed.io/api-reference/pipeline-runs/list-pipeline-runs.md)
- [Reprocess a pipeline run](https://docs.filefeed.io/api-reference/pipeline-runs/reprocess-a-pipeline-run.md)
- [Create pipeline](https://docs.filefeed.io/api-reference/pipelines/create-pipeline.md)
- [Delete pipeline](https://docs.filefeed.io/api-reference/pipelines/delete-pipeline.md)
- [Get pipeline](https://docs.filefeed.io/api-reference/pipelines/get-pipeline.md)
- [List pipelines](https://docs.filefeed.io/api-reference/pipelines/list-pipelines.md)
- [Toggle pipeline active status](https://docs.filefeed.io/api-reference/pipelines/toggle-pipeline-active-status.md)
- [Update pipeline](https://docs.filefeed.io/api-reference/pipelines/update-pipeline.md)
- [Create schema](https://docs.filefeed.io/api-reference/schemas/create-schema.md)
- [Delete schema](https://docs.filefeed.io/api-reference/schemas/delete-schema.md)
- [Get schema](https://docs.filefeed.io/api-reference/schemas/get-schema.md)
- [List schemas](https://docs.filefeed.io/api-reference/schemas/list-schemas.md)
- [Update schema](https://docs.filefeed.io/api-reference/schemas/update-schema.md)
- [Validate data against a schema](https://docs.filefeed.io/api-reference/schemas/validate-data-against-a-schema.md)
- [Create webhook](https://docs.filefeed.io/api-reference/webhooks/create-webhook.md)
- [Delete webhook](https://docs.filefeed.io/api-reference/webhooks/delete-webhook.md)
- [Get webhook](https://docs.filefeed.io/api-reference/webhooks/get-webhook.md)
- [List webhook deliveries](https://docs.filefeed.io/api-reference/webhooks/list-webhook-deliveries.md)
- [List webhooks](https://docs.filefeed.io/api-reference/webhooks/list-webhooks.md)
- [Subscribe Zapier to pipeline-run events](https://docs.filefeed.io/api-reference/webhooks/subscribe-zapier-to-pipeline-run-events.md): Registers a workspace-level PIPELINE_RUN_EVENT webhook that fires on every run.
- [Unsubscribe Zapier from pipeline-run events](https://docs.filefeed.io/api-reference/webhooks/unsubscribe-zapier-from-pipeline-run-events.md)
- [Update webhook](https://docs.filefeed.io/api-reference/webhooks/update-webhook.md)
- [Email Flow](https://docs.filefeed.io/automated-flows/email.md): Receive files by email — a dedicated inbound address per connection, with sender, format, and subject controls
- [Outbound (API) Flow](https://docs.filefeed.io/automated-flows/outbound.md): Push data into FileFeed programmatically via the outbound multipart upload API
- [Overview](https://docs.filefeed.io/automated-flows/overview.md): Learn about FileFeed's automated file processing workflows
- [SFTP Flow](https://docs.filefeed.io/automated-flows/sftp.md): Complete guide to integrating with FileFeed through SFTP, webhooks, and REST API
- [Changelog](https://docs.filefeed.io/changelog.md): API version history and breaking-change log
- [Core Concepts](https://docs.filefeed.io/core-concepts.md): Understand FileFeed fundamentals: Connections, Schemas, Pipelines, Pipeline Runs, and Webhooks
- [Configuration](https://docs.filefeed.io/embedded-importers/configuration.md): Configure workbooks, fields, transforms, and validations
- [Overview](https://docs.filefeed.io/embedded-importers/overview.md): Learn about FileFeed's embedded importers and how they work
- [React SDK](https://docs.filefeed.io/embedded-importers/react-sdk.md): Integrate FileFeed importers into your React applications
- [Welcome to FileFeed](https://docs.filefeed.io/index.md): Powerful file import and processing platform for modern applications
- [MCP Server](https://docs.filefeed.io/mcp-server/overview.md): Use FileFeed with AI assistants via the Model Context Protocol
- [Available Tools](https://docs.filefeed.io/mcp-server/tools.md): Complete reference of all 38 MCP tools
- [Upgrade to 2026-05-25](https://docs.filefeed.io/migration/v1-to-v2.md): Rename Client to Connection across the API and SDK
- [Quick Start](https://docs.filefeed.io/quickstart.md): Get up and running with FileFeed in minutes

## OpenAPI Specs

- [openapi](https://docs.filefeed.io/api-reference/openapi.json)