API Reference 📖

CommitVigil provides a clean RESTful interface for all operations.

📥 Commitment Ingestion

src.api.v1.ingestion.ingest_raw_commitment(user_id, raw_text) async

Elite Feature: Extract structured commitment record from raw Slack/Discord text.

src.api.v1.ingestion.ingest_git_commitment(commit_data) async

Advanced GitOps Feature: Extract commitments directly from Git Commit Messages.

🚦 Accountability Evaluation

src.api.v1.evaluation.evaluate_commitment(update, sync=False, redis=Depends(get_redis)) async

Main ingestion gateway for commitment evaluations. - Production (Default): Enqueues job in Redis for background processing. - Sync Mode (sync=true): Executes pipeline immediately (useful for demos and low-latency chatbots).

⚙️ User Configuration

src.api.v1.config_routes.map_slack_user(user_id, slack_id) async

Elite Config Feature: Map an internal user reference to a Slack Member ID. Example: user_id='john_dev' -> slack_id='U12345678'

src.api.v1.config_routes.map_git_user(user_id, email) async

Elite Config Feature: Map an internal user reference to a Git Email.

📊 Performance Audits

src.api.v1.reports.get_performance_audit(user_id, report_format='json') async

CASH-GENERATION ENDPOINT: Generates a professional Performance Integrity Audit. Supports report_format='json', report_format='markdown', or report_format='html'.

🏢 Enterprise Departmental Audits

src.api.v1.reports.get_departmental_audit(department, report_format='json') async

ENTERPRISE GATEWAY: Generates an aggregate performance report for a department. Ideal for 100+ member engineering/HR/research teams.

src.api.v1.reports.get_organizational_audit(report_format='json') async

CEO/CTO MODE: The Holy Grail of Monitoring. Aggregates all departments into a single 'God-View' of the entire company.

💰 Sales Intelligence & GTM

src.api.v1.sales.generate_sales_prospect(company_name, target_role, team_size, industry='generic') async

SALES AGENT: Automates the creation of a 'Perfect Prospect' profile. Generates industry-specific drift scenarios to wow the customer during demos.

src.api.v1.sales.calculate_roi(team_size, avg_salary=150000.0, currency='USD') async

SALES INTELLIGENCE: Interactive ROI Calculator. Now supports basic currency formatting (USD/EUR/GBP).

src.api.v1.sales.generate_executive_brief(company_name, target_role, team_size, industry, currency='USD') async

SALES ENABLEMENT: Generates a premium HTML one-pager for C-Level meetings. Combines Prospecting Scenarios + ROI Analysis.

🔄 Continuous Learning

src.api.v1.feedback.log_manager_feedback(feedback) async

Human-in-the-Loop: Managers providing feedback on interventions. This feedback tunes the model's future safety decisions.

---

Built for High-Performance Teams and Elite Portfolios. 🛡️🚀