API Reference

Full interactive documentation is generated by the API itself (NestJS + Swagger) — run it locally and browse http://localhost:3000/api/docs. This page covers the core endpoint so you don’t have to boot the server just to see the shape of a request.

POST /api/classification/all

Classifies one CTG feature set against FIGO, NICE, and ACOG simultaneously.

Request

POST /api/classification/all
Content-Type: application/json

{
  "baseline": 145,
  "variability": 8,
  "accelerationCount": 2,
  "lateDecelCount": 0,
  "earlyDecelCount": 1,
  "variableDecelCount": 0,
  "prolongedDecelCount": 0,
  "repetitiveVariable": false,
  "contractionsPer10Min": 3,
  "totalDecelCount": 1
}

Response

{
  "FIGO": "Normal",
  "NICE": "Atypical",
  "ACOG": "Category II"
}

Branding endpoints

• GET /api/branding/:orgSlug — fetch a tenant’s theme (colors, logo) as CSS custom properties.
• PUT /api/branding/:orgSlug — update a tenant’s theme.

Other

• GET /api/health — liveness check.

For request validation rules, DTOs, and the full guideline-strategy contract, see the Swagger UI or the classification module source under apps/api/src/modules/classification/.

← Back to docs home