# Abacus Docs

- [Abacus Docs help centre](https://help.abacusdocs.com/index.md): Upload documents, extract structured data with schemas, process batches, and ask questions in chat — the Abacus Docs help centre.
- [What is Abacus Docs?](https://help.abacusdocs.com/introduction.md): Abacus Docs extracts text and structured fields from documents, then lets you batch, share, and ask questions.
- [Quickstart: upload your first document](https://help.abacusdocs.com/quickstart.md): Sign in with Auth0, upload a PDF or image, and open the document viewer.
- [Sign in and API keys](https://help.abacusdocs.com/authentication.md): Auth0 Universal Login for the web app, and one sk-abacus-* API key per organisation.
- [Upload and your library](https://help.abacusdocs.com/guides/uploading-documents.md): My Documents accepts PDF and images up to 64 MB, 20 files per upload.
- [Document viewer](https://help.abacusdocs.com/concepts/document-processing.md): Split-pane viewer: original file beside Sections, Transcription, Schema, Chat, and Warnings.
- [Translation](https://help.abacusdocs.com/guides/translation.md): Translate schema fields and the document transcription — not a standalone Translate product.
- [What is a schema?](https://help.abacusdocs.com/schemas/overview.md): A schema names the fields Abacus Docs should extract from a document.
- [Schema builder walkthrough](https://help.abacusdocs.com/schemas/builder.md): Create a schema in the three-column builder: sample, fields, and AI chat.
- [Form vs Document mode](https://help.abacusdocs.com/schemas/form-vs-document.md): Form mode for fixed layouts, Document mode for variable ones.
- [Publish, versions, and the test set](https://help.abacusdocs.com/schemas/publish-and-versions.md): Publishing snapshots an immutable version; test sets catch regressions.
- [Extract Chat](https://help.abacusdocs.com/guides/chat-and-analysis.md): Sidebar Chat attaches documents and batches, including analytics over a batch grid.
- [Deep Reader — chat on one document](https://help.abacusdocs.com/chat/deep-reader.md): The Chat tab on a document answers questions about that file only.
- [Create a batch job](https://help.abacusdocs.com/guides/batch-processing.md): Start a job from Batch Processing. Pick a schema and add up to 1,024 files.
- [Batch results, edits, and export](https://help.abacusdocs.com/guides/exporting-results.md): Edit the batch grid and export CSV, Excel, JSON, or an archive.
- [Public share links](https://help.abacusdocs.com/sharing/public-links.md): Read-only public links at /s/<token>/ from the document Share menu.
- [Org Library and Direct Share](https://help.abacusdocs.com/sharing/org-library.md): Org Library (enterprise, mod approval) and Direct Share (/share/<token>/).
- [Members, roles, and usage](https://help.abacusdocs.com/sharing/members.md): Owner, Admin, and Member seats on Settings, plus the Usage tab.
- [Credits and billing](https://help.abacusdocs.com/account/credits.md): 1,000 welcome credits, USD packs, and what happens when the balance hits zero.
- [What gets billed](https://help.abacusdocs.com/account/what-gets-billed.md): Pages vs model usage: what each product surface spends, and what is free.
- [Black Hole](https://help.abacusdocs.com/black-hole.md): Allowlisted ingest: agent drop, classify, default batch or mod Route/Dismiss.
- [Digital documents](https://help.abacusdocs.com/digital-documents.md): Coming soon: docx, xlsx, csv, md, html, pptx, adoc. Not uploadable today.
- [Data Privacy at Abacus Docs: Your Rights Explained](https://help.abacusdocs.com/security/data-privacy.md): Learn how Abacus Docs protects your documents, what we do with your personal data, and how to exercise your full rights under UK and EU GDPR.
- [Data Retention, Security, and Your Abacus Docs Account](https://help.abacusdocs.com/security/data-retention.md): See how long Abacus Docs keeps your data, the security measures that protect it, our 72-hour breach policy, and what closing your account means.
- [Abacus Docs API](https://help.abacusdocs.com/api-reference/overview.md): REST + SSE on the same host as the app. Paths are /api/v2/….
- [Abacus Docs API Authentication Guide and Key Management](https://help.abacusdocs.com/api-reference/authentication.md): Learn how to generate, secure, and rotate Abacus Docs API keys, and authenticate every REST API request with the Bearer token scheme.
- [Abacus Docs API Error Codes, HTTP Statuses and Handling](https://help.abacusdocs.com/api-reference/errors.md): A complete reference of Abacus Docs API error codes, HTTP statuses, and guidance for resolving the most common integration issues.
- [Get current user](https://help.abacusdocs.com/api-reference/me.md): Current user profile and organisation snapshot.
- [List documents](https://help.abacusdocs.com/api-reference/documents/list-attachments.md): Canonical library list. Each row is a ChatAttachment.
- [Get a document](https://help.abacusdocs.com/api-reference/documents/get-attachment.md): Full ChatAttachment projection for the unified viewer.
- [Edit document metadata](https://help.abacusdocs.com/api-reference/documents/patch-attachment.md): Patch document metadata such as the display name.
- [Edit an extraction cell](https://help.abacusdocs.com/api-reference/documents/edit-cell.md): Override one extracted field on a document.
- [Download the file](https://help.abacusdocs.com/api-reference/documents/attachment-file.md): Serve the stored document file.
- [Rendered markdown](https://help.abacusdocs.com/api-reference/documents/attachment-markdown.md): Whole-document markdown for one language.
- [Move to another batch](https://help.abacusdocs.com/api-reference/documents/move-batch.md): Move a document to another batch and re-extract.
- [Reprocess a document](https://help.abacusdocs.com/api-reference/documents/reprocess.md): Re-extract a document, optionally with a new schema.
- [Sections](https://help.abacusdocs.com/api-reference/documents/attachment-sections.md): Per-language sections for the unified viewer.
- [Processing progress (SSE)](https://help.abacusdocs.com/api-reference/documents/attachment-stream.md): SSE progress for a single document.
- [List documents (chat id)](https://help.abacusdocs.com/api-reference/documents/list-chats.md): Chat-centric document list. Id is a Deep Reader chat pk.
- [Upload documents (chat id)](https://help.abacusdocs.com/api-reference/documents/upload-chat.md): Upload into a Deep Reader chat.
- [Get document (chat id)](https://help.abacusdocs.com/api-reference/documents/get-chat.md): Get a Deep Reader chat document by chat pk.
- [Delete document (chat id)](https://help.abacusdocs.com/api-reference/documents/delete-chat.md): Soft-delete a Deep Reader document chat.
- [Retry a chat-id document](https://help.abacusdocs.com/api-reference/documents/retry-chat.md): Retry a failed Deep Reader document by chat id.
- [Chat-id file bytes](https://help.abacusdocs.com/api-reference/documents/chat-file.md): Download the original file for a Deep Reader chat.
- [Chat-id progress](https://help.abacusdocs.com/api-reference/documents/chat-progress.md): Poll processing progress for a Deep Reader chat.
- [Chat-id sections](https://help.abacusdocs.com/api-reference/documents/chat-sections.md): List parsed sections for a Deep Reader chat.
- [Chat-id events](https://help.abacusdocs.com/api-reference/documents/chat-events.md): Record a viewer event on a Deep Reader document.
- [List document share links](https://help.abacusdocs.com/api-reference/documents/list-share-links.md): List public share links for a Deep Reader chat.
- [Issue a document share link](https://help.abacusdocs.com/api-reference/documents/create-share-link.md): Create a public share link for a Deep Reader chat.
- [Revoke a document share link](https://help.abacusdocs.com/api-reference/documents/revoke-share-link.md): Revoke a public document share link.
- [List schemas](https://help.abacusdocs.com/api-reference/schemas/list.md): List extraction schemas for the organisation.
- [Create a schema](https://help.abacusdocs.com/api-reference/schemas/create.md): Create a draft extraction schema.
- [Publish a schema](https://help.abacusdocs.com/api-reference/schemas/publish.md): Publish the draft as an immutable schema version.
- [Get a schema](https://help.abacusdocs.com/api-reference/schemas/get.md): Get an extraction schema by slug.
- [Update a schema draft](https://help.abacusdocs.com/api-reference/schemas/update.md): Patch the working draft of a schema.
- [List schema versions](https://help.abacusdocs.com/api-reference/schemas/versions.md): List published versions of a schema.
- [Delete a schema](https://help.abacusdocs.com/api-reference/schemas/delete.md): Delete or archive an extraction schema.
- [Copy a schema](https://help.abacusdocs.com/api-reference/schemas/copy.md): Clone a schema's current published version.
- [Diff a schema](https://help.abacusdocs.com/api-reference/schemas/diff.md): Diff the working draft against the last published version.
- [Restore a schema version](https://help.abacusdocs.com/api-reference/schemas/restore.md): Restore a published version into the working draft.
- [Get a schema version](https://help.abacusdocs.com/api-reference/schemas/get-version.md): Get one published schema version.
- [Deprecate a schema version](https://help.abacusdocs.com/api-reference/schemas/deprecate.md): Deprecate a published schema version.
- [Undeprecate a schema version](https://help.abacusdocs.com/api-reference/schemas/undeprecate.md): Clear the deprecate flag on a published schema version.
- [List batches](https://help.abacusdocs.com/api-reference/batches/list.md): List batches visible to the caller.
- [Cancel batch documents](https://help.abacusdocs.com/api-reference/batches/cancel.md): Cancel pending or processing documents in a batch.
- [Upload and add files](https://help.abacusdocs.com/api-reference/batches/upload-and-add.md): Upload files into an existing batch and extract.
- [Reprocess batch documents](https://help.abacusdocs.com/api-reference/batches/reprocess.md): Re-extract documents in a batch.
- [Add library documents to a batch](https://help.abacusdocs.com/api-reference/batches/add-documents.md): Add existing library documents to a batch.
- [Edit a batch cell](https://help.abacusdocs.com/api-reference/batches/edit-cell.md): Override one extracted field on a batch document.
- [Export batch JSON](https://help.abacusdocs.com/api-reference/batches/export-json.md): Export a batch extraction grid as JSON.
- [Set a batch default schema](https://help.abacusdocs.com/api-reference/batches/default-version.md): Set the default published schema version for new batch documents.
- [Reassign a document schema](https://help.abacusdocs.com/api-reference/batches/reassign-version.md): Pin a published schema version onto one batch document.
- [Resume a batch](https://help.abacusdocs.com/api-reference/batches/resume.md): Resume pending and failed documents in a batch.
- [List chats](https://help.abacusdocs.com/api-reference/chats/list.md): List Extract chat threads.
- [Create a chat](https://help.abacusdocs.com/api-reference/chats/create.md): Create an Extract chat thread.
- [Start a chat turn](https://help.abacusdocs.com/api-reference/chats/start-turn.md): Start a chat turn and receive the SSE Location.
- [Stream a chat turn](https://help.abacusdocs.com/api-reference/chats/stream.md): SSE tail of a chat turn.
- [List Extract workflows](https://help.abacusdocs.com/api-reference/chats/workflows.md): List active Extract chat workflow types.
- [Get a chat](https://help.abacusdocs.com/api-reference/chats/get.md): Retrieve an Extract chat including message history.
- [Update a chat](https://help.abacusdocs.com/api-reference/chats/update.md): Patch an Extract chat title or workflow.
- [Delete a chat](https://help.abacusdocs.com/api-reference/chats/delete.md): Soft-delete an Extract chat.
- [List chat documents](https://help.abacusdocs.com/api-reference/chats/list-attachments.md): List documents attached to an Extract chat.
- [Upload to a chat](https://help.abacusdocs.com/api-reference/chats/upload-attachment.md): Upload a document into an Extract chat.
- [Unlink a chat document](https://help.abacusdocs.com/api-reference/chats/unlink-attachment.md): Unlink or remove a document from an Extract chat.
- [Link an existing document](https://help.abacusdocs.com/api-reference/chats/link-attachment.md): Link an existing visible document into a chat.
- [Clone from knowledge base](https://help.abacusdocs.com/api-reference/chats/kb-clone.md): Clone a knowledge-base file into an Extract chat.
- [List attached batches](https://help.abacusdocs.com/api-reference/chats/list-batch-attachments.md): List batches attached to an Extract chat.
- [Attach a batch](https://help.abacusdocs.com/api-reference/chats/attach-batch.md): Attach a visible batch as Extract chat context.
- [Detach a batch](https://help.abacusdocs.com/api-reference/chats/detach-batch.md): Detach a batch from an Extract chat.
- [Reset a chat](https://help.abacusdocs.com/api-reference/chats/reset.md): Clear an Extract chat's messages.
- [Cancel a chat turn](https://help.abacusdocs.com/api-reference/chats/cancel-turn.md): Cancel an in-flight Extract chat turn.
- [Most recent chat](https://help.abacusdocs.com/api-reference/chats/recent.md): Return the caller's most recent Extract chat.
- [List notifications](https://help.abacusdocs.com/api-reference/notifications/list.md): List the caller's in-app library notifications.
- [Mark a notification read](https://help.abacusdocs.com/api-reference/notifications/mark-read.md): Mark one library notification as read.
- [Mark all notifications read](https://help.abacusdocs.com/api-reference/notifications/mark-all-read.md): Mark every library notification as read.
- [Unread notification count](https://help.abacusdocs.com/api-reference/notifications/unread-count.md): Return the caller's unread library-notification count.
- [Register an ingest agent](https://help.abacusdocs.com/api-reference/ingest/register-agent.md): Register a Black Hole desktop agent.
- [Ingest items feed](https://help.abacusdocs.com/api-reference/ingest/items.md): Keyset-cursor feed of ingest items.
- [Start an ingest upload](https://help.abacusdocs.com/api-reference/ingest/start-upload.md): Start a Black Hole resumable upload session.
- [Complete an ingest upload](https://help.abacusdocs.com/api-reference/ingest/complete-upload.md): Mark a Black Hole upload complete after GCS put.
- [Ingest schemas](https://help.abacusdocs.com/api-reference/ingest/schemas.md): List schemas participating in Black Hole.
- [Match an ingest item](https://help.abacusdocs.com/api-reference/ingest/match-item.md): Manually match one ingest item to a schema.
- [Auto-match ingest items](https://help.abacusdocs.com/api-reference/ingest/auto-match.md): Auto-match scored ingest items into participating schemas.
- [Process ingest items](https://help.abacusdocs.com/api-reference/ingest/process-items.md): Enqueue classified ingest items for extraction.
- [Latest ingest batch](https://help.abacusdocs.com/api-reference/ingest/latest-batch.md): Get the latest default batch for an ingest schema.
- [List org-library shares](https://help.abacusdocs.com/api-reference/sharing/list-shares.md): List org-library share rows.
- [Issue a direct-share link](https://help.abacusdocs.com/api-reference/sharing/create-link.md): Create a direct-share link for a schema or batch.
- [Approve a library share](https://help.abacusdocs.com/api-reference/sharing/approve-share.md): Approve a pending org-library share.
- [Reject a library share](https://help.abacusdocs.com/api-reference/sharing/reject-share.md): Reject a pending org-library share.
- [Revoke a library share](https://help.abacusdocs.com/api-reference/sharing/revoke-share.md): Revoke an approved org-library share.
- [Kick a library share](https://help.abacusdocs.com/api-reference/sharing/kick-share.md): Kick an approved org-library share.
- [Pending share count](https://help.abacusdocs.com/api-reference/sharing/pending-count.md): Count pending org-library shares.
- [List direct-share links](https://help.abacusdocs.com/api-reference/sharing/list-links.md): List direct-share links the caller issued.
- [Revoke a direct-share link](https://help.abacusdocs.com/api-reference/sharing/revoke-link.md): Revoke a direct-share link token.
- [Accept a direct-share link](https://help.abacusdocs.com/api-reference/sharing/accept-link.md): Accept a direct-share token as the recipient.
- [Decline a direct-share link](https://help.abacusdocs.com/api-reference/sharing/decline-link.md): Decline a direct-share token as the recipient.
- [Request a library share](https://help.abacusdocs.com/api-reference/sharing/request-share.md): Request an org-library share for a schema or batch.
- [Remove a direct-share acceptance](https://help.abacusdocs.com/api-reference/sharing/remove-acceptance.md): Remove a recipient's direct-share acceptance.

## OpenAPI Specs

- [abacus-docs-openapi](https://gist.githubusercontent.com/MoHayat/4b48b87f8182c8e0dc85741b402ce034/raw/abacus-docs-openapi.yml)