Schemas

Human-readable message. Not stable across releases — do not branch on this value.

Stable machine-readable identifier for this failure. Branch on this. The full list is generated from errorCodes.ts.

Additional detail. Present on authentication failures.

Unnormalised status as stored.

Parse/extract manifest with internal filesystem paths removed. Fetch artifacts through the links object on ArtifactManifest.

Null for system roles.

Knowledgebases this agent may read.

Page count, when the parse produced one.

Parse/extract manifest with internal filesystem paths removed. Fetch artifacts through the links object on ArtifactManifest.

Fetch each non-null link with GET /v1/artifacts/{manifestId}/{artifactKey}. Null means the parse did not produce that artifact.

Includes sync_relative_path, sync_artifact_fingerprint, sync_size and sync_last_modified for files imported through a folder sync.

Set by the soft delete; the row is retained.

File row plus its current version. Additional columns may appear; the properties below are the stable contract.

File row plus its current version. Additional columns may appear; the properties below are the stable contract.

Returned only when onboarding creates the user.

Per-table row counts removed.

Opaque bundle key. Fetch artifacts through the links below instead.

Latest job of this kind for the file, or null if none has run.

Latest job of this kind for the file, or null if none has run.

stale means the parse artifacts changed since the last index run.

Page box for PDFs and images; sheet range for spreadsheets.

File row plus its current version. Additional columns may appear; the properties below are the stable contract.

Page box for PDFs and images; sheet range for spreadsheets.

A bare array, not an envelope.

Artifact URLs, one per page image.

Detected used-range tables.

The same documents grouped by knowledgebase name.

Populated only once status is completed.

Queued document workflow. Poll GET /v1/operations/{operationId} until status is completed or failed; output is null until then.

Model call counts, token usage and duration.

Model call counts, token usage and duration.

Credits debited by this run.

Credits debited by this run.

Credits debited by this run.

Effective permissions and resource grants for this user.

Better Auth user plus the resolved DocAI workspace context.

A bare array, not an envelope.

A bare array, not an envelope. Every version of the document, oldest first.

Server-local or mounted directory containing raw files plus matching parsed JSON and markdown artifacts.

Optional metadata. Manual parsed import always validates raw + parsed JSON + parsed markdown and does not dispatch processing.

Optional normalized bundle keys from pending_decisions. When omitted, every queueable raw bundle from the import is queued.

Optional parse options passed to the processing job.

Incremental reindexes changed files only.

Reindex even when the snapshot is fresh.

Limit the run to these files.

Run inline and answer 200 instead of queueing with 202.

Lexical full-text query over parsed grounding evidence.

Defaults to 30. Above 80 is rejected with 400.

Restrict hits to table segments.

Optional seconds until expiry.

Null means no monthly quota cap.

Present when view=activity. Parse page debits are grouped by document/job.

Optional override. Defaults to parse:{file_version_id}:{options_hash}.

Optional override. Defaults to extract:{file_version_id}:{schema_hash}:{options_hash}.