Skip to main content

Base URL

https://your-api-domain.com/api/v1

Authentication

All requests require: Authorization: Bearer <supabase_jwt_token>

Endpoints Overview

Authentication

MethodEndpointDescription
GET/auth/meGet current user profile
POST/auth/refreshRefresh JWT token

Workspaces

MethodEndpointDescription
GET/workspacesList user workspaces
POST/workspacesCreate new workspace
GET/workspaces/{id}Get workspace details
PATCH/workspaces/{id}Update workspace
DELETE/workspaces/{id}Delete workspace

Standards

MethodEndpointDescription
GET/standards/commonGet common standards catalog
GET/standardsList standards (paginated)
POST/standardsCreate new standard
GET/standards/{id}Get standard details
PATCH/standards/{id}/attestAttest standard ownership
DELETE/standards/{id}Delete standard
POST/standards/{id}/uploads/initInitialize file upload
POST/standards/{id}/uploads/{upload_id}/completeComplete file upload

Work Products

MethodEndpointDescription
GET/work-productsList work products (paginated)
GET/work-products/{id}Get work product details
PATCH/work-products/{id}Update work product
DELETE/work-products/{id}Delete work product
POST/work-products/uploads/initInitialize file upload
POST/work-products/uploads/{file_id}/completeComplete file upload

Analysis

MethodEndpointDescription
GET/analysis/overviewGet analysis overview
GET/analysis/standards/{id}/drilldownGet standard drill-down
POST/analysis/gapsStart gap analysis
GET/analysis/evidenceGet evidence mapping
GET/analysis/analysesList persisted analyses
GET/analysis/analyses/{id}Get analysis by ID (with gaps/recommendations)
GET/analysis/gapsList persisted gaps (filters supported)
PATCH/analysis/gaps/{gap_id}Update gap status (open/in_progress/resolved/accepted)

Reports

MethodEndpointDescription
GET/reportsList reports (paginated)
POST/reportsCreate new report
GET/reports/{id}Get report details
DELETE/reports/{id}Delete report
GET/reports/{id}/downloadDownload report

Traceability

MethodEndpointDescription
GET/traceability/matrixGet traceability matrix
GET/traceability/gapsGet traceability gaps
GET/traceability/completenessGet workspace completeness metrics
GET/traceability/analyzeRun comprehensive traceability analysis
GET/traceability/linksList links with filters
POST/traceability/linksCreate traceability link

Detailed API Reference

View complete API documentation with examples