Document

Documentation Index

Fetch the complete documentation index at: https://docs.wellapp.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

API operations

​

Data model

​

Attributes

​

Relationships

​

System-computed

• document_id is generated by gen_random_uuid() at INSERT time and is the public API identifier. The internal pk (auto-increment integer) is never exposed.
• created_at is set once via MikroORM onCreate: () => new Date() and never changed thereafter.
• updated_at is set by both onCreate and onUpdate hooks, so it reflects the latest ORM flush against this row.
• deleted_at is the soft-delete sentinel. Active queries must filter deleted_at IS NULL. No physical row deletion occurs; the column is set to the deletion timestamp.
• content_checksum is computed by the upload service after stripping format-specific metadata bytes (EXIF for JPEG, metadata chunks for PNG, /Info+date+ID for PDF), then taking SHA-256. It equals the raw file SHA-256 for unsupported types. The partial unique index idx_documents_workspace_content_checksum_active enforces per-workspace L2 deduplication: (workspace_pk, content_checksum) WHERE deleted_at IS NULL AND content_checksum IS NOT NULL.
• document_type is classified by the AI enrichment pipeline. The @Enrichable decorator marks this field for the enrichment worker. Until classification completes, the field is NULL. normalizeDocumentTypeCode() maps unrecognised values to DocumentTypeCodeEnum.OTHER (999).
• uploaded_at is set by the caller (upload controller or connector sync) and may represent the file’s original creation time from the provider rather than the time of ingest into Well.
• The partial index idx_documents_workspace_created_active (workspace_pk, created_at DESC WHERE deleted_at IS NULL) optimises the default records-page sort for the documents root.
• sourceWorkspaceConnector carries ingestion provenance. NULL means user-originated upload; non-NULL means the document was created by a connector sync flow.
• DocumentWorkspaceConnector junction rows are appended (never mutated) to track each connector that ingested (direction=input) or received (direction=output) the document. A single Document can have multiple DWC rows from different connectors. Note: the inverse collection is NOT declared on the Document entity — DWC rows are accessed via the DocumentWorkspaceConnector repository, not via a collection on Document.
• DocumentExtraction rows (one per document × parser pair) cache parsed text output to avoid redundant LlamaParse / LiteParse calls. The partial unique index uniq_document_extraction_per_parser_checksum on (document_pk, parser_name, parser_version, COALESCE(source_checksum, ”)) WHERE deleted_at IS NULL enforces one extraction row per parser version per document content state.
• DocumentStructuredExtraction rows extend the extraction pipeline with structured field output beyond raw text (see Migration20260528120000_document_structured_extractions).

​

Example

{
  "data": {
    "type": "document",
    "id": "c7e3f2a1-84d5-4b9e-a012-3f6c8d9e1b47",
    "attributes": {
      "document_id": "c7e3f2a1-84d5-4b9e-a012-3f6c8d9e1b47",
      "path": "workspaces/9f3a7c21-e8b4-4d0f-b3c1-2a5d8e6f0c19/documents/2026/05/facture-fournisseur-mai.pdf",
      "filename": "facture-fournisseur-mai.pdf",
      "bucket": "well-app-documents-prod",
      "type": "application/pdf",
      "size": 348291,
      "content_checksum": "a3f8d1c2e7b049561a84f2c3d6e9b0a1f5c2d8e4b7a3c6f9d2e1b4a7c0f3e6d9",
      "document_type": "380",
      "local_file_name": null,
      "uploaded_at": "2026-05-14T09:23:11.000Z",
      "created_at": "2026-05-14T09:23:12.341Z",
      "updated_at": "2026-05-14T09:24:05.882Z",
      "deleted_at": null
    },
    "relationships": {
      "workspace": {
        "data": { "type": "workspace", "id": "9f3a7c21-e8b4-4d0f-b3c1-2a5d8e6f0c19" }
      },
      "collect": {
        "data": null
      },
      "source_workspace_connector": {
        "data": { "type": "workspace_connector", "id": "b2d4e6a8-c0f2-4e8d-a6b0-c2e4f6a8d0b2" }
      },
      "invoices": {
        "data": [
          { "type": "invoice", "id": "d9e1b3a5-c7f9-4d2e-b4a6-c8d0e2f4b6a8" }
        ]
      },
      "transaction_documents": {
        "data": [
          { "type": "transaction_document", "id": "e1f3a5b7-d9c1-4e3f-a5b7-d9e1f3a5b7c9" }
        ]
      }
    }
  }
}