Skip to content

Concepts

  • Project: the unit of isolation. Keys, workflows, runs and results belong to one project; another project's resources answer 404.
  • Schema: a JSON Schema (2020-12) with x-dx hints that names the fields to extract.
  • Run: one execution over one document or packet. Statuses: queued, running, waiting_review, succeeded, partially_succeeded, failed, cancelled.
  • Result: typed data plus, per field, value, status, confidence and evidence. null is not found, never a guess.
  • Evidence: where a value comes from: page, quote, word range and boxes. Values without evidence are flagged.
  • Workflow: a graph of nodes (parse, extract, validate, branch, review, export…) with versions, aliases (invoices@prod) and a publish step. See the node guides.
  • Scopes and roles: a key's scopes (read, write, review, eval, admin) intersected with its role give its permissions (see Roles and permissions).
  • Approval: a person's go-ahead for one destructive action of an agent (see MCP).