Skip to main content
This reference is generated from the published OpenAPI 3.1 catalog for /api/v2/. The playground on each endpoint page is that operation. Nothing here invents a second host or a /v1/documents/{id}/transcribe job API — those are not in the spec.

​
Base URL

Same origin as the web app:
Every path already includes /api/v2/. Example: GET https://abacusdocs.com/api/v2/me/. There is no api.abacusdocs.com.

​
Who this API is for

/api/v2/ is the surface the SPA and integrations use: documents, schemas, batches, chat (including SSE), org library, notifications, and — for allowlisted organizations — Black Hole ingest. A smaller /api/v1/ surface (documents, batches, schemas) is served on the same host and documented on the in-app API page. It is not in this OpenAPI export, so it is not listed below.

​
Authenticate

Send one of: Ingest refuses API keys. That group is Auth0-only, with ingest:read / ingest:write scopes, and 404s if the organization is not on the allowlist. See Authentication.

​
Conventions that apply everywhere

  • JSON request and response bodies, except file uploads (multipart/form-data) and a few downloads (file bytes, CSV/JSON export, SSE).
  • Trailing slashes are part of the path (/api/v2/batches/, not /api/v2/batches).
  • Pagination on lists is page-based: ?page= (1-indexed) and ?page_size=. Envelopes carry page, page_size, total, has_more. The ingest items feed is the exception — keyset cursor ?since= + ?limit=.
  • Tenancy. The credential names the organization. Cross-tenant or unknown ids are 404, not 403, so the API never confirms another tenant’s row. Same-org “you can see it but cannot do that” is 403.
  • Credits. Completed extraction, reprocess, schema tests, and chat turns spend credits from the organization balance. Viewing, cell edits, and export do not. Rates: What gets billed.

​
Resources

Authentication

API keys, Auth0, and which surfaces refuse a key.

Errors

Status codes you will actually see. No invented envelope.

Documents

Library + unified attachment routes (canonical document id).

Schemas

Draft, publish, versions, copy, deprecate.

Batches

List, add documents, cells, reprocess, export.

Chats

Threads, attachments, SSE turns.

Sharing

Org library and direct-share links.

Notifications

In-app library notifications for the signed-in user.

Ingest

Black Hole desktop agent. Auth0 + allowlist.