Skip to main content

API Reference

The Supernal Coding API provides programmatic access to requirement management, compliance validation, and project monitoring capabilities.

API Endpoints​

Requirements Management API​

  • GET /api/requirements - List all requirements
  • POST /api/requirements - Create new requirement
  • GET /api/requirements/{id} - Get specific requirement
  • PUT /api/requirements/{id} - Update requirement
  • DELETE /api/requirements/{id} - Delete requirement

Validation API​

  • POST /api/validate - Validate requirements
  • GET /api/validate/{id} - Get validation results
  • POST /api/validate/batch - Batch validation

Compliance API​

  • GET /api/compliance/frameworks - List supported frameworks
  • GET /api/compliance/{framework} - Get framework details
  • POST /api/compliance/{framework}/assess - Run compliance assessment

Dashboard API​

  • GET /api/dashboard/metrics - Get project metrics
  • GET /api/dashboard/status - Get real-time status
  • GET /api/dashboard/reports - Generate reports

WebSocket API​

Real-time updates are available via WebSocket connections.

Authentication​

API endpoints require authentication via API keys.

Rate Limiting​

  • Standard: 1000 requests per hour
  • Premium: 10000 requests per hour
  • Enterprise: Unlimited

SDKs​

Official SDKs are available for:

  • JavaScript/TypeScript
  • Python
  • Go
  • Rust

Examples​

See the Integration Examples for detailed implementation guides.

For detailed endpoint documentation, see the OpenAPI specification at /api/docs.