API Reference

The API reference is intended for self-hosted deployments. Local-first review works without these routes.

Health

• GET /api/health: app status, upload limit, and whether S3-backed model storage is available

Models

• GET /api/models: list stored models
• POST /api/models: upload IFC bytes. Use x-model-name for the display name
• GET /api/models/[id]: read model metadata
• GET /api/models/[id]/file: download model bytes
• POST /api/models/[id]/writeback: export edited IFC bytes for a server model

Model routes return 503 when S3-compatible storage is not configured.

Drafts

• GET /api/models/[id]/draft
• PUT /api/models/[id]/draft
• DELETE /api/models/[id]/draft

Rules And Compute

• GET /api/rules/config: read the current user's validation config
• PUT /api/rules/config: save a validation config
• POST /api/rules/evaluate: evaluate validation rows against a config
• GET /api/rule-templates: list available validation templates
• GET /api/rule-templates/[id]: read one validation template
• GET /api/rule-templates/[id]?format=config: download a template config
• GET /api/rule-templates/[id]?format=source: download a template source file when available
• POST /api/data-table/excel/export
• POST /api/data-table/excel/import

Rules config and template config use the version 2 clause model documented in Clause data model.

Upload Limits

COREY_MAX_MODEL_BYTES controls the maximum accepted upload size. The default is 250 MiB.