# RecordEngine Documentation

## Docs

- [Authentication](https://docs.recordengine.ai/api-reference/authentication.md): How to authenticate API requests and secure your webhook endpoints.
- [Documents API](https://docs.recordengine.ai/api-reference/documents.md): Upload documents, retrieve extracted data, update statuses, and manage documents programmatically.
- [API Overview](https://docs.recordengine.ai/api-reference/overview.md): Everything you need to know about the RecordEngine REST API before making your first call.
- [Outbound Webhooks](https://docs.recordengine.ai/api-reference/webhooks.md): How RecordEngine pushes structured data to your external systems — payload schemas, configuration, and testing.
- [Deploying on Linux with Docker](https://docs.recordengine.ai/deployment/docker-linux.md): Complete deployment guide for RecordEngine on a Linux server — GPU setup, Docker Compose, SSL, and first-run configuration.
- [Updating RecordEngine](https://docs.recordengine.ai/deployment/updating.md): How to safely update RecordEngine to a new version — code updates and Docker image rebuilds.
- [Frequently Asked Questions](https://docs.recordengine.ai/faq.md): Answers to the most common questions about RecordEngine.
- [Installation](https://docs.recordengine.ai/getting-started/installation.md): Install RecordEngine on a Linux server in under an hour — step by step.
- [Introduction](https://docs.recordengine.ai/getting-started/introduction.md): What RecordEngine is, how it works, and why enterprises choose it for document intelligence.
- [Quick Start Tutorial](https://docs.recordengine.ai/getting-started/quick-start.md): Get from zero to your first processed document in under 10 minutes.
- [System Requirements](https://docs.recordengine.ai/getting-started/system-requirements.md): Hardware, software, and network requirements for running RecordEngine on-premise.
- [Your First Document](https://docs.recordengine.ai/getting-started/your-first-document.md): Upload a document, watch the AI extract structured data, and walk through the full review and approval workflow.
- [How CRM Correlation Works](https://docs.recordengine.ai/integrations/how-crm-correlation-works.md): The architecture behind external_refs — how RecordEngine links documents to CRM records without a native integration.
- [HubSpot Integration](https://docs.recordengine.ai/integrations/hubspot.md): Link RecordEngine documents to HubSpot contacts, companies, and deals — and push extracted data back to HubSpot automatically.
- [Lark / Feishu Integration](https://docs.recordengine.ai/integrations/lark-feishu-integration.md): Automatically ingest documents into RecordEngine by dropping files into a Lark or Feishu group chat.
- [Microsoft Dynamics 365 Integration](https://docs.recordengine.ai/integrations/microsoft-dynamics.md): Link RecordEngine documents to Dynamics 365 records and push extracted data to Accounts, Opportunities, and Invoices.
- [Integrations Overview](https://docs.recordengine.ai/integrations/overview.md): How RecordEngine connects to the rest of your software stack — without sending any data to the cloud.
- [QuickBooks Integration](https://docs.recordengine.ai/integrations/quickbooks.md): Automatically create Bills and Invoices in QuickBooks from RecordEngine's extracted document data.
- [Salesforce Integration](https://docs.recordengine.ai/integrations/salesforce.md): Link RecordEngine documents to Salesforce Opportunities, Accounts, and Contacts — and push extracted data back to Salesforce automatically.
- [WeCom (WeChat Work) Integration](https://docs.recordengine.ai/integrations/wecom.md): Send RecordEngine document notifications to WeCom — and submit documents for processing directly from WeCom chats.
- [Workflow Automation](https://docs.recordengine.ai/integrations/workflow-automation.md): How to connect RecordEngine to any external system using an automation platform — the patterns, principles, and building blocks.
- [Xero Integration](https://docs.recordengine.ai/integrations/xero.md): Automatically create Bills and invoices in Xero from RecordEngine's extracted document data.
- [AI Processing Issues](https://docs.recordengine.ai/troubleshooting/ai-processing.md): Diagnose slow processing, empty extractions, low confidence scores, and model errors.
- [General Troubleshooting](https://docs.recordengine.ai/troubleshooting/general.md): Diagnose and fix the most common RecordEngine issues — containers, AI processing, and the UI.
- [Integration Troubleshooting](https://docs.recordengine.ai/troubleshooting/integration-issues.md): Diagnosing and fixing problems with webhooks, API calls, and external system integrations.
- [Performance & Capacity](https://docs.recordengine.ai/troubleshooting/performance.md): Optimise RecordEngine throughput, manage GPU memory, and plan for growing document volumes.
- [Advanced Search](https://docs.recordengine.ai/user-guide/advanced-search.md): Find any document across your entire RecordEngine instance using full-text search, status, confidence score, date ranges, and extracted field values.
- [AI Chat & Document Q&A](https://docs.recordengine.ai/user-guide/ai-chat.md): Ask questions across all your documents in plain language — no search queries, no manual lookups.
- [AI Extraction](https://docs.recordengine.ai/user-guide/ai-extraction.md): How RecordEngine's AI reads your documents, extracts structured data, and how to get the best results.
- [Audio Transcription](https://docs.recordengine.ai/user-guide/audio-transcription.md): How RecordEngine transcribes meeting recordings, voice memos, and audio files — and extracts structured data from the transcript.
- [Audit Log](https://docs.recordengine.ai/user-guide/audit-log.md): A complete, tamper-evident record of every action taken on every document in your RecordEngine instance.
- [Batch Operations](https://docs.recordengine.ai/user-guide/batch-operations.md): Approve, export, move, and delete multiple documents at once — without opening each one individually.
- [AI Confidence Scoring](https://docs.recordengine.ai/user-guide/confidence-scoring.md): How RecordEngine scores every document and how to use that score in your review workflow.
- [Contacts & Folders](https://docs.recordengine.ai/user-guide/contacts-and-folders.md): How to organise your documents using contacts and folders — the core structure of RecordEngine.
- [Dashboard & Analytics](https://docs.recordengine.ai/user-guide/dashboard.md): A real-time overview of everything happening in your RecordEngine instance.
- [AI Model Comparison](https://docs.recordengine.ai/user-guide/docs_ai_model_comparison.md): Compare local and cloud AI models available in RecordEngine — speed, accuracy, cost, and best use cases.
- [AI Providers](https://docs.recordengine.ai/user-guide/docs_ai_providers.md): Configure RecordEngine to use local or cloud AI models for document extraction, OCR, and chat.
- [API-Mode Deployment](https://docs.recordengine.ai/user-guide/docs_api_mode_deployment.md): Deploy RecordEngine on a CPU-only cloud instance for customers who bring their own AI API keys.
- [Case Management](https://docs.recordengine.ai/user-guide/docs_case_management.md): Track document review work items, assign them to team members, and automate resolution workflows.
- [Rules Engine](https://docs.recordengine.ai/user-guide/docs_rules_engine.md): Automate document and case workflows with event-driven rules, scheduled scans, and multi-step approval chains.
- [Document Versioning](https://docs.recordengine.ai/user-guide/document-versioning.md): How RecordEngine handles multiple versions of the same document — replacements, revisions, and version history.
- [Document Workflow](https://docs.recordengine.ai/user-guide/document-workflow.md): How documents move through RecordEngine — the 9 statuses, what each means, and how to manage transitions.
- [Email Intake](https://docs.recordengine.ai/user-guide/email-intake.md): Send documents to RecordEngine by email — attachments are automatically extracted and processed.
- [Exporting Data](https://docs.recordengine.ai/user-guide/exporting-data.md): How to get data out of RecordEngine — webhook export, CSV, PDF reports, and the original file.
- [Extraction Profiles](https://docs.recordengine.ai/user-guide/extraction-profiles.md): How to use and create extraction profiles — the templates that tell the AI exactly what to extract from each document type.
- [Rules Engine](https://docs.recordengine.ai/user-guide/rules-engine.md): Automate your document workflow — automatically flag, move, notify, and export based on any combination of conditions.
- [Settings & Configuration](https://docs.recordengine.ai/user-guide/settings.md): Configure webhooks, API tokens, user accounts, email intake, AI models, and backups.
- [Themes & Customization](https://docs.recordengine.ai/user-guide/themes-and-customization.md): Change the visual theme of your RecordEngine interface — three built-in themes plus a full Theme Builder.
- [Uploading Documents](https://docs.recordengine.ai/user-guide/uploading-documents.md): Every way to get documents into RecordEngine — web upload, email, watched folder, and API.
- [Webhooks](https://docs.recordengine.ai/user-guide/webhooks.md): Push real-time event data from RecordEngine to Make.com, Google Sheets, Feishu Base, or any external system.

## OpenAPI Specs

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