Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Document Extraction Usage API
version: 1.0.0
description: 'Email sign-up at /app/api/auth/sign-up/email requires an x-turnstile-token
header in production. Failed or unavailable bot verification returns 403
with code BOT_CHECK_REQUIRED. Social sign-up is unaffected.
Documents in. Verified data out.
The public REST API (v1) turns documents (invoices, receipts, purchase
orders, bank statements, delivery notes, or custom schemas) into
structured, verified data. Every document reaches an explicit terminal
state. Every extracted table row is accounted for. Money fields are
cross-checked (crossfooting). Bank statements are balance-checked.
Every field links back to its source in the document.
Unsupported methods on registered API paths return an empty
405 Method Not Allowed response with an Allow header listing supported
methods. HEAD is supported wherever GET is registered; OPTIONS keeps its
existing preflight behavior. Unknown paths remain 404. Maintenance and
canonical-host redirects still take precedence.'
contact:
email: support@arkrel.com
servers:
- url: https://arkrel.com
description: Production, one Worker, one domain, same origin as the site itself (no separate api.<domain> host)
security:
- ApiKeyAuth: []
tags:
- name: Usage
paths:
/v1/usage:
get:
tags:
- Usage
operationId: getUsage
summary: Current billing period usage
description: Returns pages used/pending/overage/credits for the current billing period, plus the account's enforced limits. Autopilot includes 1,500 pages a month for $59/month, then uses optional one-time page packs. Uploads return 402 QUOTA_EXCEEDED when included pages and pack credits are exhausted. Only Business records metered overage.
responses:
'200':
description: Usage
content:
application/json:
schema:
$ref: '#/components/schemas/Usage'
'401':
$ref: '#/components/responses/Unauthorized'
components:
schemas:
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
field:
type: string
Limits:
type: object
description: 'Enforced server-side limits (not aspirational copy). See
api/src/lib/ratelimit.ts and api/src/lib/upload.ts for the
implementation these numbers must match.
'
required:
- documents_write_requests_per_minute
- general_requests_per_minute
- auth_requests_per_minute
- mutation_requests_per_minute
- webhook_test_requests_per_minute
- max_upload_size_mb
- max_pages_per_document
- supported_mime_types
properties:
documents_write_requests_per_minute:
type: integer
example: 60
description: Per-org limit on POST /v1/documents. Fixed (matches src/lib/ratelimit.ts's RATE_LIMITS.documentsWrite), typed as a plain integer, not a JSON Schema `const`, so the generated TS type (api/src/generated/openapiTypes.ts) stays a normal `number` a config-driven response can satisfy at compile time; the response contract test (Schemathesis) is what actually checks the live value.
general_requests_per_minute:
type: integer
example: 300
description: Per-org limit on all other /v1/* endpoints. Fixed, see above.
auth_requests_per_minute:
type: integer
example: 60
description: Per-IP limit on every dashboard sign-in/sign-up/2FA/passkey call (/app/api/auth/*). Fixed, see above.
mutation_requests_per_minute:
type: integer
example: 30
description: 'Per-org limit on every other state-changing endpoint: API keys,
webhooks (create/delete), schemas (create/update/delete), org
settings/invites/member removal, switching the active org, and
the session-cookie (/app/api/documents) twin of document
upload/delete. Fixed, see documents_write_requests_per_minute.
'
webhook_test_requests_per_minute:
type: integer
example: 10
description: 'Per-org limit on POST /app/api/webhooks/{id}/test, tighter than
the general mutation limit because each call makes the Worker
itself issue an outbound HTTP request to an org-supplied URL.
Fixed, see documents_write_requests_per_minute.
'
max_upload_size_mb:
type: integer
example: 25
description: Fixed, see documents_write_requests_per_minute.
max_pages_per_document:
type: integer
const: 500
max_image_megapixels:
type: integer
const: 50
description: 'Maximum decoded pixel count (width x height, in megapixels) for
a single frame of a PNG, WebP, or TIFF upload. These formats
have no safe reduced-resolution decode path, so a frame over
this ceiling is rejected outright with `IMAGE_DIMENSIONS_
TOO_LARGE` (413). Resize it, or send it as a JPEG or PDF
instead (see `max_jpeg_megapixels`).
'
max_jpeg_megapixels:
type: integer
const: 3200
description: 'Maximum decoded pixel count for a single JPEG frame, far
higher than max_image_megapixels because JPEG supports a
scaled ("draft mode") decode at 1/2, 1/4, or 1/8 resolution.
An ordinary 108MP or 200MP phone-camera photo is accepted and
decoded at a reduced resolution rather than rejected. A JPEG
whose dimensions still exceed this ceiling even at 1/8
resolution is rejected with `IMAGE_DIMENSIONS_TOO_LARGE` (413).
'
supported_mime_types:
type: array
items:
type: string
example:
- application/pdf
- image/png
- image/jpeg
- image/webp
- image/tiff
Usage:
type: object
required:
- period_start
- period_end
- pages_included
- pages_used
- pages_overage
properties:
period_start:
type: string
format: date-time
period_end:
type: string
format: date-time
pages_included:
type: integer
pages_included_used:
type: integer
minimum: 0
description: Confirmed monthly included pages consumed this period.
pages_catchup:
type: integer
minimum: 0
description: Confirmed pages covered by Catch-Up this period.
catchup_purchases:
type: array
description: Unrefunded Catch-Up purchases, including expired terms. Repurchases have independent clocks and page balances.
items:
type: object
required:
- tax_year
- purchased_at
- payment_settled_at
- expires_at
properties:
tax_year:
type: integer
purchased_at:
type: string
format: date-time
payment_settled_at:
type: string
format: date-time
nullable: true
expires_at:
type: string
format: date-time
catchup_pages_total:
type: integer
minimum: 0
description: 'Catch-Up capacity: 3,000 pages per unexpired active purchase on this business. Each purchase lasts 12 months from settlement.'
catchup_pages_used:
type: integer
minimum: 0
description: Pages consumed from currently active, unexpired Catch-Up purchases. Historical usage stays in the usage ledger.
catchup_pages_remaining:
type: integer
minimum: 0
description: Sum of unused pages on active, unexpired Catch-Up purchases. A repurchase starts with a fresh 3,000 pages. Pending pages reserve capacity separately; monthly included pages are used first, then Catch-Up, then packs.
pages_used:
type: integer
description: Confirmed pages from documents that reached a terminal state, allocated to monthly included pages, the cumulative Catch-Up pool, pack credits, or Business metered overage.
pages_pending:
type: integer
description: 'Estimated pages from documents still `queued`/`processing`,
reserved against the plan''s cap so a burst of uploads can''t
outrun quota enforcement before any of them finish processing.
Not billed until confirmed; excluded from `pages_used`.
'
pages_overage:
type: integer
description: 'Confirmed metered overage pages this period for Business. Autopilot records no new overage and its usage is not reported to Stripe. Historical allocations remain unchanged. Summed directly from each
billed document''s own recorded ledger split (`usage_events.
pages_overage`), never re-derived from `pages_used -
pages_included`, which would wrongly count pages a purchased
page-pack credit already covered as billed overage.
'
pages_credits:
type: integer
description: Confirmed pages this period covered by a purchased page-pack credit, neither included nor overage, and never billed.
appsumo_codes:
type: integer
description: 'Number of active AppSumo codes redeemed less than 12 months ago and not revoked. These codes on this organization, capped at 5. Redeemed at
POST /app/api/appsumo/redeem.
'
appsumo_pages_per_month:
type: integer
description: 'Pages/month contributed by AppSumo codes alone (300 per code),
already folded into `pages_included` above. These REPLACE the
Free plan''s 50 included pages while any code is active (no
stacking with a paid plan in v1).
'
plan:
type: string
limits:
$ref: '#/components/schemas/Limits'
example:
period_start: '2026-09-01T00:00:00Z'
period_end: '2026-10-01T00:00:00Z'
pages_included: 50
pages_included_used: 32
pages_catchup: 0
catchup_pages_total: 0
catchup_pages_used: 0
catchup_pages_remaining: 0
pages_used: 32
pages_pending: 3
pages_overage: 0
pages_credits: 0
appsumo_codes: 0
appsumo_pages_per_month: 0
plan: free
responses:
Unauthorized:
description: Missing or invalid API key
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
BusinessSession:
type: apiKey
in: cookie
name: better-auth.session_token
description: Better Auth session cookie. Mutations also require a same-origin Origin header.
EngineToken:
type: apiKey
in: header
name: X-Engine-Token
description: Shared operator token for internal maintenance.
SessionCookie:
type: apiKey
in: cookie
name: __Host-arkrel_session
description: Signed-in app session. Mutations also require a same-origin request. Sensitive actions by accounts with a password without completed protection receive 403 TWO_FACTOR_SETUP_REQUIRED as described in x-app-account-protection. The free first look and account deletion remain available.
ApiKeyAuth:
type: http
scheme: bearer
description: 'API key shown once at creation, e.g. `sk_live_...` / `sk_test_...`.
Stored server-side as a salted hash; only the prefix is retrievable
afterward.
API keys and MCP credentials are checked against their creating user on every request. If that user has a password without enabled TOTP, requests return HTTP 403 TWO_FACTOR_SETUP_REQUIRED. Organization/service keys with no creating user keep their existing behavior.
'
x-webhook-delivery-payload:
$ref: '#/components/schemas/WebhookDeliveryPayload'
x-app-email-signup:
path: /app/api/auth/sign-up/email
method: POST
header: x-turnstile-token
status: 403
code: BOT_CHECK_REQUIRED
description: A fresh single-use Turnstile token with action signup and hostname matching APP_BASE_URL is required in production. Missing, invalid, expired, or unavailable verification fails closed. Reset the widget after each submission. Google sign-up is unaffected. Local development without a configured secret does not require a challenge. This route is served by the mounted Better Auth handler.
x-app-account-protection:
status: 403
code: TWO_FACTOR_SETUP_REQUIRED
response:
$ref: '#/components/responses/TwoFactorSetupRequired'
description: 'Password accounts require verified TOTP before checkout or billing changes, reports and exports (PDF, CSV, accountant CSV, QuickBooks, Xero, OFX, JSON downloads, statement exports and data ZIP), share creation and use, API keys and MCP, bank or ledger connections, team changes, email/password changes, inbound sender allowlist changes, callback secrets, and uploads with webhook_url. Uploads that would consume paid page credits or record billable overage also return TWO_FACTOR_SETUP_REQUIRED before storage. Included monthly and purchased Catch-Up allowances remain available. Admission reserves pending pages, and settlement rechecks live protection against actual processed pages. Chart-of-accounts sync and all chart writes require protection; stored chart and categorization-settings reads do not contact a ledger provider. Session uploads with a callback return TWO_FACTOR_SETUP_REQUIRED before storing or scheduling the document when the password account needs setup. The same refusal applies when the business has an active saved outbound webhook, even if webhook_url is omitted. Queued webhook dispatch checks live creator and document-uploader protection before sending, including retries. Existing role, entitlement and step-up requirements remain. Linked passkeys or providers do not exempt password accounts. Passwordless accounts keep existing rules. Email verification remains required. Sign-up and sign-in do not redirect to setup. The free first look stays open: one statement upload or email-in, processing, merchant review, rules, My year and locked report previews, billing/pricing views, profile and business name, sign-out, and account deletion with its existing step-up. Sensitive actions prompt inline and resume after setup. Direct /protect-account links remain supported. Other app routes default to protection. Exemptions use explicit methods and complete route patterns; business settings changes other than name-only renames, session revocation, provider linking and token access require protection. Implicit same-email provider linking is disabled: sign in with the password first, protect the account and pass step-up, then link explicitly. Explicit linking and passkey registration require fresh step-up and recheck at credential creation or verification. Already-linked provider sign-in and first-time provider signup remain available. Authentication, recovery and TOTP enrollment ceremonies remain available. Credential mutation routes require protection, including passkey registration options and verification. OAuth and passkey removal also require fresh step-up (401 STEP_UP_REQUIRED). Password credential unlinking is refused with 403 PASSWORD_REMOVAL_NOT_ALLOWED even after enrollment and step-up, preserving the password account protection requirement. The server reads live enrollment. API keys and MCP credentials retain their creator check; creatorless service keys retain existing behavior. Share links created by an unprotected password account remain unavailable.'
open_workflows:
- Free first look and locked report preview
- Billing and pricing views
- Profile name and sign-out
- Account deletion with existing step-up
- Authentication and protection enrollment
session_status:
path: /app/api/auth/me
rate_limits:
window_seconds: 60
per_session: 180
per_ip: 600
status: 429
retry_header: Retry-After
description: Independent read budgets. The IP budget precedes session resolution; the session budget uses the resolved session ID before membership and protection reads. These reads do not consume credential budgets.
field: two_factor_setup_required
schema:
type: boolean
description: Present on authenticated responses. True means sensitive actions require enrollment; it does not block the free first look or redirect sign-in. Absent when user is null.
x-app-account-deletion:
description: An account deletion intent (pending, processing, or failed) ends access immediately, including while financial obligations delay purge. All user sessions are revoked atomically with the intent, along with user-created API keys, share links, invitations, webhooks and inbound email addresses across every business. Better Auth lookups hide retained identities and their credentials. Validation, reset, verification and challenge errors follow the native unknown-user or unknown-token behavior, including validation order and password work. Anonymous sign-up uses the generic duplicate response without sending mail or creating credentials. OAuth cannot recreate a reserved identity. Credential inserts, updates and deletes are fenced against deletion at SQL execution time. Old session and two-factor challenge cookies are ignored on the request. Deletion never sends cookie expirations, so delayed responses cannot erase another login. Auth revocation expires sessions that anchor Plaid compensation operations and retains their rows until those operations are removed by their own lifecycle. Step-up and invite acceptance return the existing unauthenticated HTTP 401 response. Removed magic-link endpoints remain HTTP 404 for everyone. The email is reserved until purge completes. Business-only deletion retains the login and other businesses, but hides and blocks the deleting business immediately, including while billing leases drain. API keys for deleting businesses return unauthenticated HTTP 401.
x-app-step-up:
window_seconds: 600
description: 'Sensitive app actions require fresh identity verification. GET /app/api/auth/step-up returns password, code, email, passkey, google, microsoft and fresh booleans. POST /app/api/auth/step-up accepts exactly one of password, code (TOTP/backup), or emailCode. POST /app/api/auth/step-up/email sends a six-digit code to the verified email of a passwordless account, at most three times per ten minutes per user. Codes are hashed, single-use, expire after ten minutes, permit five attempts, and are bound to the initiating live session, user, email and step-up purpose. Resending invalidates the previous code. Verification is rate-limited. Passkey ceremonies require x-arkrel-step-up: 1 on both challenge issuance and verification, biometric/PIN user verification, and a server-side purpose, user and session binding that expires after five minutes. Consumption requires the exact initiating live session. Provider users call sign-in/social with a linked google provider and additionalData.stepUp=true. The server rejects idToken shortcuts and binds OAuth state to the original user/session for five minutes. Google cannot force reauthentication and is opportunistic only. It requires a back-channel auth_time between initiation and completion; token issuance time never counts. Missing, stale or future auth_time is rejected. Passwordless users can use an email code or a registered passkey when Google cannot verify freshness. Successful passkey/provider verification rotates and elevates only the returning bound session. Password, TOTP and email checks elevate the initiating session. These app-only auth surfaces are not exposed by integrations or MCP.'
x-consumer-statement-admission:
description: App uploads and inbound email share one Free statement allowance per account. Additional app uploads return 402 FREE_STATEMENT_USED. Inbound attachments wait for an upgrade. Retries recover the original admitted attachment. Developer API per-page pricing is unchanged.
x-maintenance-bridge:
description: 'During the production cutover, an isolated maintenance Worker returns HTTP 503 for every method and path, including reads and health checks, with Retry-After: 60 and Cache-Control: no-store. API, MCP, internal, and webhook paths return error.code MAINTENANCE and error.message "Arkrel is updating. Please try again in a few minutes." MCP receives this plain JSON error instead of JSON-RPC while the bridge is deployed. Other paths return HTML. HEAD returns headers without a body. Retry after the indicated delay.'
x-maintenance-mode:
description: 'MAINTENANCE_MODE=1 freezes mutations across app, REST, MCP and engine routes. Mutations and OAuth or verification callbacks return 503 with Retry-After: 60. REST errors use code MAINTENANCE_MODE. MCP tool mutations use JSON-RPC code -32004. Reads, health and status remain available. Read-time refresh, audit, counters and automatic categorization are suspended. Cron writes are skipped; inbound email invocations fail before ingestion so delivery can be retried.'
x-stripe-billing-webhook:
path: /app/api/billing/webhook
authentication: Stripe-Signature
refund_events:
- charge.refunded
- refund.updated
- refund.failed
dispute_events:
- charge.dispute.created
- charge.dispute.updated
- charge.dispute.closed
description: Refund IDs and provider statuses are persisted. Catch-Up access and unused page credits are revoked only after a succeeded refund. Pending or failed refunds retain access. The dashboard refund response has refunded=false while an automatic refund is pending or failed, with auto=true indicating that the automatic request was submitted. Disputes suspend the charged subscription, Catch-Up year, or unused page credits. A won dispute restores only the saved access and original credit expiration, unless the payment was refunded or another dispute still holds it. Lost disputes remain suspended. Subscription updates cannot bypass a hold. Independent AppSumo codes are unaffected. The owner receives an operational email alert.
x-app-catchup-payment-clock:
path: /app/api/usage
field: catchup_purchases
items:
type: object
required:
- tax_year
- purchased_at
- payment_settled_at
- expires_at
properties:
tax_year:
type: integer
purchased_at:
type: string
format: date-time
description: Purchase record time. Do not use as an unresolved payment clock fallback.
expires_at:
type: string
format: date-time
description: Access and unused pages end at this instant, 12 months after settlement. Older test rows use their purchase timestamp until settlement is reconciled.
payment_settled_at:
type: string
format: date-time
nullable: true
description: Confirmed payment charge time, or null while confirmation is unresolved. The 30-day guarantee starts at this time.