# fileAI Docs

## Docs

- [Welcome to fileAI](https://docs.file.ai/index.md): The foundation for reliable, scalable AI workflows.
- [Quickstart Guide](https://docs.file.ai/docs-user-guide/get-started/getting-started.md): Get started on fileAI
- [fileAI best practices](https://docs.file.ai/docs-user-guide/get-started/best-practice.md): Guidelines to get the best output from fileAI
- [Frequently Asked Questions](https://docs.file.ai/docs-user-guide/get-started/faqs.md): Your questions, answered
- [AI Schemas](https://docs.file.ai/docs-user-guide/core/ai-schemas.md): AI Schemas let you produce a deterministic data schema, from a single file, cross-file or with online data fetch capabilities
- [Folders](https://docs.file.ai/docs-user-guide/core/folders.md): Folders are digital containers used to group related files together in a meaningful way. They support both manual organization and future logic-based automation.
- [Citations & Validations](https://docs.file.ai/docs-user-guide/core/citations-and-validations.md): Citations & Validations address one of the biggest concerns in AI-driven automation: trust.
- [File Intelligence](https://docs.file.ai/docs-user-guide/core/file-intelligence.md)
- [Notifications](https://docs.file.ai/docs-user-guide/core/notifications.md)
- [Account Set Up](https://docs.file.ai/docs-user-guide/account/account1.md): How to set up your fileAI account
- [Billing & Support](https://docs.file.ai/docs-user-guide/account/billing.md)
- [About the fileAI API](https://docs.file.ai/docs-api/api-intro.md): Explore the core capabilities of the fileAI API
- [Quick Start](https://docs.file.ai/docs-api/quick-start.md): Get up and running quickly with simple steps to authenticate, upload files, and extract data using the fileAI API.
- [Upload](https://docs.file.ai/docs-api/upload.md): Understanding fileAI's Upload endpoint
- [AI OCR models](https://docs.file.ai/docs-api/api-ai-ocr-models.md): We’re excited to bring advanced AI Optical Character Recognition (OCR) capabilities to your applications through our latest AI models to support a variety of use cases.
- [AI Schemas](https://docs.file.ai/docs-api/api-ai-schema.md): AI Schemas let you produce a deterministic data schema, from a single file, cross-file or with online data fetch capabilities
- [Supported Data Types](https://docs.file.ai/docs-api/api-supported-data-types.md): Our API accepts the following data types for inputs and outputs. Please ensure that your data conforms to one of these types for compatibility.
- [Extraction prompts](https://docs.file.ai/docs-api/api-extraction-prompts.md): Best practices for writing effective prompts to extract structured data in fileAI
- [Schema Locking](https://docs.file.ai/docs-api/api-schema-locking.md): Description of your new file.
- [Processing callback](https://docs.file.ai/docs-api/api-processing-callback.md): Real-time updates for your file processing pipeline through secure webhook callbacks.
- [Incremental Data Loading](https://docs.file.ai/docs-api/api-incremental-data-loading.md): Sync files incrementally to data warehouses using Change Data Capture patterns with the GET /files endpoint.
- [Pagination](https://docs.file.ai/docs-api/api-pagination.md): Page through large result sets with cursor pagination, or keep using the legacy page/limit parameters.
- [Idempotent requests](https://docs.file.ai/docs-api/api-idempotency.md): Send an Idempotency-Key header so a retried write cannot be applied twice.
- [Error responses](https://docs.file.ai/docs-api/api-errors.md): Every fileAI API error is an RFC 9457 problem document with a stable machine-readable code and a request correlation id.
- [Get all files](https://docs.file.ai/api-reference/endpoint/get-all-files.md): Get all files of the current organization and workspace.
- [Update file export status](https://docs.file.ai/api-reference/endpoint/update-file-export-status.md): This endpoint allows integrated systems to update the export status of a file.
- [Delete multiple files](https://docs.file.ai/api-reference/endpoint/delete-multiple-files.md): This endpoint is used to delete multiple files.
- [Upload a file](https://docs.file.ai/api-reference/endpoint/upload-a-file.md): Upload a file to the server, this will return a presigned upload url to be used for the upload.
- [Upload a large file using multipart upload](https://docs.file.ai/api-reference/endpoint/upload-a-large-file-using-multipart-upload.md): Initiate a multipart upload for large files (typically >100MB). This will return presigned URLs for each part.
- [Complete a multipart upload](https://docs.file.ai/api-reference/endpoint/complete-a-multipart-upload.md): Complete a multipart upload after all parts have been uploaded to S3.
- [Get a file upload processing steps for that uploadId](https://docs.file.ai/api-reference/endpoint/get-a-file-upload-processing-steps-for-that-uploadid.md): Get a file upload processing steps for that uploadId
- [Create a file preview](https://docs.file.ai/api-reference/endpoint/create-a-file-preview.md): Create a file preview using a S3 Path.
- [Create file previews in batch](https://docs.file.ai/api-reference/endpoint/create-file-previews-in-batch.md): Create presigned preview URLs for several S3 paths in a single request.
- [Update a file's schema field definitions](https://docs.file.ai/api-reference/endpoint/update-file-schema.md): This endpoint is used to patch the schema fields that are associated with the file types in the workspace.
- [Get file schema values by fileIds](https://docs.file.ai/api-reference/endpoint/get-file-schema-values-by-fileids.md): Get file schema values by fileIds of the current organization and workspace.
- [Update a file's extracted values (fields and table/list cells)](https://docs.file.ai/api-reference/endpoint/update-file-values.md): Update document form values for a file, for both scalar fields and table/list cells.
- [Get file ocr](https://docs.file.ai/api-reference/endpoint/get-file-ocr.md): Get file ocr (Optical Character Recognition).
- [Rerun file form filling](https://docs.file.ai/api-reference/endpoint/rerun-file-form-filling.md): This endpoint is used to rerun the form filling of a file.
- [Get file types](https://docs.file.ai/api-reference/endpoint/get-file-types.md): This endpoint is used to get all the file types that are available in the workspace.
- [Approve a file type](https://docs.file.ai/api-reference/endpoint/approve-a-file-type.md): This endpoint is used to approve a file type.
- [Rename a file type](https://docs.file.ai/api-reference/endpoint/rename-a-file-type.md): This endpoint is used to rename a file type.
- [Get all schemas](https://docs.file.ai/api-reference/endpoint/get-all-schemas.md): This endpoint is used to get all schemas.
- [[Deprecated] Patch workspace schema field definitions](https://docs.file.ai/api-reference/endpoint/patch-a-schema.md): **Deprecated.** To update extracted field values of a file — including regular fields (string, number, enum, date, boolean) and list/table cell values — use `PATCH /files/{fileId}/values` instead.
- [Get file type schemas](https://docs.file.ai/api-reference/endpoint/get-file-type-schemas.md): This endpoint is used to get the file type schemas that are available in the workspace.
- [Get project setting](https://docs.file.ai/api-reference/endpoint/get-project-setting.md): This endpoint is used to get the setting of the project.
- [Update project setting](https://docs.file.ai/api-reference/endpoint/update-project-setting.md): This endpoint is used to update the setting of the project.
- [Get all directories (folders)](https://docs.file.ai/api-reference/endpoint/get-all-directories.md): Retrieve all directories (folders) in the workspace with hierarchical structure.
- [Create a new directory (folder)](https://docs.file.ai/api-reference/endpoint/create-a-directory.md): Create a new directory (folder) to organize your files within the workspace.
- [Get workspace subscription](https://docs.file.ai/api-reference/endpoint/get-workspace-subscription.md): This endpoint is used to get the subscription of the workspace.
- [Export schemas](https://docs.file.ai/api-reference/endpoint/export-schemas.md): Export one or more schemas to a downloadable zip file.
- [Import schemas](https://docs.file.ai/api-reference/endpoint/import-schemas.md): Import schemas from a previously exported zip file.
- [Execute a query builder configuration](https://docs.file.ai/api-reference/endpoint/execute-a-query.md): Executes a query builder configuration using the workspace and organization bound to the API key.
- [Get workflow by id](https://docs.file.ai/api-reference/endpoint/get-workflow-by-id.md): Retrieve a single workflow by its ID within the current organization and workspace.
- [Get workflow result groups by unique identifiers](https://docs.file.ai/api-reference/endpoint/get-workflow-result-groups.md): Retrieve workflow execution result groups for one or more execution group unique identifiers (e.g. folder or subfolder ids).
- [fileAI MCP Server overview](https://docs.file.ai/docs-mcp/get-started-mcp.md): What can our MCP server do?
- [MCP Server Configuration](https://docs.file.ai/docs-mcp/mcp-server-configuration.md): How to run our MCP server on Cursor and Claude.

## OpenAPI Specs

- [cleaned_openapi](https://docs.file.ai/api-reference/cleaned_openapi.json)
- [openapi](https://docs.file.ai/api-reference/openapi.json)

## Optional

- [Website](https://www.file.ai/)
- [Discord](https://discord.com/invite/jQZxvPy9uX)
- [Support](mailto:support@file.ai)