Skip to main content

API Surfaces

The backend is API-first. Chatbot UI, dashboards, batch-upload tools, external integrations, and operational tools use FastAPI endpoints or the same service layer. There is no privileged side path for ingestion or querying.

Current public surfaces

SurfaceEndpointPurpose
HealthGET /healthzApp readiness for validation and deployment checks
Inline text ingestPOST /documents/txtSmall born-digital text ingestion
Multipart uploadPOST /documentsManual/batch frontend uploads
Batch ingestionPOST /ingestion/batchPrefix or manifest ingestion from object storage
Job statusGET /ingestion/jobs/{id}Poll async ingestion status
Document statusGET /documents/{id} and filtered listingInspect uploaded/ingested document state
SearchPOST /searchReturn ranked chunks without synthesis
QueryPOST /queryReturn grounded answer with citations

Security boundary

Upload, status, query, and related endpoints require the configured API key header. Production access is fronted by Huawei APIG, with RBAC and ABAC enforcement for user role, department, and document classification.

Frontend scope

Chatbot UI and dashboard applications are separate clients. They consume these APIs rather than embedding document-processing or retrieval logic directly.