BrainPredict Risk: Getting Started Guide
Get up and running with BrainPredict Risk in 5 minutes. This guide covers installation, setup, and your first AI-powered risk assessment.
Prerequisites
- Active BrainPredict Risk subscription (Starter for 1-10 licenses, Professional for 11-25 licenses, Enterprise for 26-50 licenses, or Custom for 51+ licenses)
- API key from your BrainPredict Risk portal
- GRC system (ServiceNow GRC, RSA Archer, MetricStream, LogicManager, Resolver, SAP GRC, Oracle GRC, IBM OpenPages, Riskonnect, or Fusion)
- Basic knowledge of REST APIs
Step 1: Create Your Account
Sign up at brainpredict.ai/signup and choose your plan:
- Starter (): 1-10 licenses, all 25 AI models, 100% of features, Intelligence Bus integration
- Professional (): 11-25 licenses, all 25 AI models, 100% of features, Intelligence Bus integration
- Enterprise (): 26-50 licenses, all 25 AI models, 100% of features, Intelligence Bus integration
- Custom (51+ licenses): Contact sales for custom pricing, volume discounts, dedicated account manager
All plans include a Custom quote for your specific needs. Payment method required (credit card, SEPA, or bank transfer).
Step 2: Get Your API Key
Navigate to Portal → Settings → API Keys and generate a new key:
# Your API key will look like this: bp_risk_live_1234567890abcdef1234567890abcdef # Keep this secure - never commit to version control!
Security Best Practice: Store your API key in environment variables, not in your code.
Step 3: Install the SDK
Install the BrainPredict Risk SDK for your preferred language:
# Python pip install brainpredict-risk # Node.js npm install brainpredict-risk # Java mvn install brainpredict-risk-java-sdk # .NET dotnet add package BrainPredict.Risk.SDK
Step 4: Connect Your GRC System
Connect BrainPredict Risk to your GRC platform:
from brainpredict_risk import BrainPredictRisk
client = BrainPredictRisk(
api_key='YOUR_API_KEY',
tenant_id='your-tenant-id'
)
# Connect to ServiceNow GRC
client.connect_grc(
grc_type='servicenow',
credentials={
'instance_url': 'https://your-instance.service-now.com',
'username': 'your-username',
'password': 'your-password'
}
)
print("<svg className="w-4 h-4 inline-block align-text-bottom flex-shrink-0" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2.5" strokeLinecap="round" strokeLinejoin="round"><polyline points="20 6 9 17 4 12"/></svg> Connected to ServiceNow GRC successfully!")Step 5: Run Your First Risk Assessment
Get AI-powered risk assessments:
# Assess cybersecurity risk
result = client.assess_risk(
risk_type='cybersecurity',
data={
'asset_id': 'SERVER-001',
'asset_type': 'production_server',
'vulnerabilities': ['CVE-2024-1234', 'CVE-2024-5678'],
'patch_status': 'outdated',
'network_exposure': 'internet-facing'
}
)
print(f"Risk Score: {result['risk_score']}")
print(f"Risk Level: {result['risk_level']}")
print(f"Recommendations: {result['recommendations']}")
# Output:
# Risk Score: 85
# Risk Level: Critical
# Recommendations: ['Immediate patching required', 'Isolate from internet', 'Enable WAF']Step 6: Monitor Real-Time Risks
Set up real-time risk monitoring with webhooks:
# Configure webhook for critical risk alerts
client.configure_webhook(
event_type='critical_risk_detected',
webhook_url='https://your-app.com/webhooks/risk-alerts',
filters={
'risk_level': ['critical', 'high'],
'categories': ['cybersecurity', 'compliance', 'third-party']
}
)
print("<svg className="w-4 h-4 inline-block align-text-bottom flex-shrink-0" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2.5" strokeLinecap="round" strokeLinejoin="round"><polyline points="20 6 9 17 4 12"/></svg> Real-time risk monitoring enabled!")Next Steps
- →Explore all 25 AI Models - Learn about each specialized risk model
- →Set up GRC Integrations - Connect with 10 GRC platforms
- →API Reference - Complete documentation for all 60+ endpoints
- →Use Cases & Examples - Real-world risk management scenarios
- →Best Practices - Optimization tips and troubleshooting