API Surface

Last verified: 2026-07-26 against dev at f0388abb.

This is a navigational reference for the primary backend API areas. The interactive source of truth is the running backend's OpenAPI docs:

• Swagger UI: http://localhost:8000/docs

The fuller logical design lives in API logical design.

Assessments

Endpoint	Purpose
GET /assessments	List assessments.
GET /assessments/{id}	Get assessment details.
POST /assessments	Create an assessment and upload initial files.
DELETE /assessments/{id}	Delete an assessment and related records.
POST /assessments/{id}/documents	Upload additional documents.
POST /assessments/{id}/documents/{doc_id}/rerun	Rerun extraction for a document.
GET /assessments/{id}/completeness	Get assessment completeness.
GET /assessments/{id}/document-processing-details	Get document processing details.

Documents

Endpoint	Purpose
POST /documents/validate	Validate upload format/type.
GET /documents	List documents.
GET /documents/{id}	Get document details.
POST /documents	Upload documents.
DELETE /documents/{id}	Delete a document.
GET /documents/{id}/content	Stream file content.
GET /documents/{id}/extracted-items	Read extracted data.
POST /documents/{id}/extracted-items/{item_id}/validate	Validate one extracted item.
POST /documents/{id}/extracted-items/validate-all	Validate all extracted items for a document.
POST /documents/{id}/export/{exporter_name}	Export extracted data.

Processors, Batches, and Corrections

Area	Representative endpoints
Processors	GET /processors, GET /processors/{id}
Batches	GET /batches, POST /batches, POST /batches/process, POST /batches/{id}/runs
Batch documents	GET /batch-documents, PUT /batch-documents/{id}, DELETE /batch-documents/{id}
Corrections	POST /extracted-items/{item_id}/corrections, PUT /extracted-items/{item_id}/corrections/{corr_id}

Organization Scope

Collection and entity endpoints that touch assessments or derived records must respect organization_id. See Tenancy and permissions.