API Reference

Integrate SentinelNexus security intelligence directly into your CI/CD pipelines and developer workflows.

Production Base URL

https://final-sentinelnexus-clerkoauth.onrender.com/api/v1

Authentication

All endpoints except webhooks require a Bearer JWT token from Clerk. In the browser, this is handled automatically via session cookies.

Rate Limiting

Standard tier allows 100 requests per minute per user. Enterprise users can request higher limits via support.

Authentication & Identity

WEBHOOK/auth/clerk/webhookAuth: Public (Svix Header Required)

Clerk User Sync Webhook. Hardened with Svix signature verification. Automatically synchronizes user creation, updates, and deletion events from Clerk to the SentinelNexus database.

GET/users/meAuth: Clerk JWT

Retrieve current authenticated user profile and session data.

AI Agents (OpenRouter LLM)

POST/ai-agents/chatAuth: Clerk JWT

Interact with Red Team, Blue Team, and Compliance AI Agents. Streams responses using the OpenRouter API.

{ "agent_type": "red_team", "messages": [...] }

Scanning Engine

POST/scansAuth: Clerk JWT

Initialize a new security scan. Supports 'code', 'prompt', and 'text' types.

{ "content": "...", "scan_type": "code", "project_id": "..." }

GET/scans/:idAuth: Clerk JWT

Get detailed results, CVSS scores, and findings for a specific scan.

Project Management

GET/projectsAuth: Clerk JWT

List all active security projects for the current workspace.

POST/projectsAuth: Clerk JWT

Create a new project container for grouped vulnerability tracking.

{ "name": "API v2", "description": "..." }

Reports & Intelligence

POST/reports/generate/:scan_idAuth: Clerk JWT

Generate a comprehensive PDF security report with CWE mappings.

GET/dashboard/statsAuth: Clerk JWT

Aggregation data for risk heatmaps and severity distribution.

Trust & Digital Twin

GET/trust/scoreAuth: Clerk JWT

Calculate and return the dynamic Trust Score for the organization based on active threats and posture.

GET/trust/digital-twinAuth: Clerk JWT

Generate the organizational Digital Twin attack graph for real-time risk visualization.

GET/trust/certificateAuth: Clerk JWT

Retrieve a verified, shareable Trust Certificate reflecting the current security score.

Threat Intelligence & Zero-Day

GET/threats/predictionsAuth: Clerk JWT

Predict and fetch novel zero-day adversarial attacks (e.g., prompt injections) and their mitigation strategies.

GET/threats/dark-webAuth: Clerk JWT

Monitor and retrieve organization-specific Dark Web mentions and data leaks.

AI Governance & Auditing

POST/governance/assetsAuth: Clerk JWT

{ "name": "Prod GPT-4", "asset_type": "LLM", "provider": "OpenAI" }

GET/governance/audit-trailAuth: Clerk JWT

Retrieve the immutable audit trail of all actions performed on AI assets.

Billing & Subscriptions

GET/users/meAuth: Clerk JWT

Retrieve current authenticated user profile, including their active subscription_tier (e.g., Starter, Pro, Enterprise).

POST/payments/payu/successAuth: Public (PayU Hash Required)

Webhook handler for PayU payment success. Securely verifies the transaction hash and automatically upgrades the user's subscription tier.

application/x-www-form-urlencoded

Need a custom integration?

Our engineering team can help you build custom security scanners for proprietary codebases or specific compliance requirements.

Contact Integration Team

Engine is waking up