API Endpoints Salient exposes a REST API via FastAPI. The full interactive reference is available at /docs (Swagger UI) and /redoc (ReDoc) when the backend is running.
Interactive docs
Visit https://your-domain.com/docs for the full Swagger UI with request/response schemas and a "Try it out" feature.
Endpoint Groups Scenarios Method Path Description GET/api/list-scenarios/List available scenario files GET/{filename}Get full scenario JSON POST/api/scenarios/Create/upload a new scenario DELETE/api/scenarios/{filename}Delete a user-uploaded scenario
Sessions Method Path Description GET/api/sessions/List exercise sessions POST/api/sessions/Save a new exercise session GET/api/sessions/{id}/scores/Get session scoring results POST/api/sessions/{id}/evaluation/Write AI evaluation to session
Dashboard & Profile Method Path Description GET/api/dashboard/Dashboard summary (scores, counts, trends) GET/api/trends/Maturity score trends over time GET/api/org-profile/Get organization profile PUT/api/org-profile/Update organization profile
Twin Intelligence Method Path Description POST/api/twin/query/Natural language twin query GET/api/twin/facts/List mined organizational facts GET/api/twin/facts/summary/Fact counts and summary GET/api/twin/patterns/Detect recurring gap patterns GET/api/twin/recommend/Scenario recommendations POST/api/twin/event-bridge/{event_id}Bridge event to training
Posture Method Path Description POST/api/posture/assess/Generate posture assessment GET/api/posture/report/Board-ready posture report GET/api/posture/timeline/Posture evolution over time
Connectors Method Path Description GET/api/connectors/List connectors and status GET/api/connectors/coverage/Twin coverage analysis POST/api/connectors/{id}/discover/Discovery scan POST/api/connectors/okta/configure/Configure Okta POST/api/connectors/okta/test/Test Okta connection POST/api/connectors/okta/sync/Sync Okta data POST/api/connectors/entra-id/configure/Configure Entra ID POST/api/connectors/entra-id/test/Test Entra ID connection POST/api/connectors/entra-id/sync/Sync Entra ID data
Compliance Method Path Description GET/api/compliance/frameworks/List supported frameworks GET/api/compliance/frameworks/{id}/scores/Framework control scores GET/api/compliance/report/{id}/Framework compliance report
Threat Intel Method Path Description POST/api/threat-intel/ingest/Ingest from URL GET/api/threat-intel/List ingested intel POST/api/threat-intel/{id}/generate-scenario/Generate scenario from intel
Playbooks Method Path Description POST/api/playbooks/generate/{session_id}Generate playbook from session GET/api/playbooks/{session_id}Get generated playbook
Events & Operations Method Path Description GET/api/events/List security events POST/api/events/Create security event POST/api/events/{id}/triage/AI-powered event triage GET/api/operations/List purple team operations POST/api/operations/Create operation
Members & Settings Method Path Description GET/api/members/List table members POST/api/members/invite/Invite member GET/api/settings/Get org settings PUT/api/settings/Update org settings
Auth Method Path Description GET/auth/github/loginInitiate GitHub OAuth GET/auth/github/callbackGitHub OAuth callback GET/auth/google/loginInitiate Google OAuth GET/auth/google/callbackGoogle OAuth callback GET/auth/meGet current user POST/auth/update-ipSelf-service IP update