Skip to main content

BrainPredict Sales API Reference

Complete API documentation for all 27 endpoints across Sales AI models and strategic intelligence. All endpoints use REST architecture with JSON payloads.

Authentication

All API requests require authentication using your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
X-Tenant-ID: your-tenant-id

Get your API key from Portal → Settings → API Keys

API Endpoints

GET/api/salesforce/ai-models/models

Get list of all 26 Sales AI models with their specifications and accuracy rates

Parameters:

Response: {"total":26,"models":[{"name":"DealPredictor","accuracy":94}],"average_accuracy":90.6}

POST/api/salesforce/ai-models/predict-deal/{opportunity_id}

Predict deal close probability, amount, and date (DealPredictor - 94.0% accuracy)

Parameters: opportunity_id, tenant_id

Response: {"opportunity_id":1,"close_probability":0.87,"predicted_close_date":"2025-12-15","predicted_amount":50000}

POST/api/salesforce/ai-models/score-lead/{contact_id}

Score and prioritize leads for conversion (LeadScorer - 92.0% accuracy)

Parameters: contact_id, tenant_id

Response: {"contact_id":1,"lead_score":92,"grade":"A","conversion_probability":0.78}

POST/api/salesforce/ai-models/forecast-pipeline

Forecast revenue with scenario modeling (PipelineForecaster - 95.0% accuracy)

Parameters: tenant_id, time_horizon_days

Response: {"forecasted_revenue":5400000,"confidence":0.95,"monthly_breakdown":[]}

POST/api/salesforce/ai-models/predict-churn/{account_id}

Predict customer churn risk (ChurnPredictor - 91.0% accuracy)

Parameters: account_id, tenant_id

Response: {"account_id":1,"churn_probability":0.35,"risk_level":"medium","retention_recommendations":[]}

POST/api/salesforce/ai-models/predict-clv/{account_id}

Predict customer lifetime value (CLVPredictor - 93.0% accuracy)

Parameters: account_id, tenant_id

Response: {"account_id":1,"predicted_clv":250000,"confidence":0.93,"time_horizon_months":36}

POST/api/salesforce/ai-models/analyze-win-loss

Analyze win/loss patterns (WinLossAnalyzer - 88.0% accuracy)

Parameters: tenant_id, time_period_days

Response: {"win_rate":0.65,"loss_reasons":[],"win_factors":[],"recommendations":[]}

POST/api/salesforce/ai-models/recommend-content

Recommend sales content for deals (ContentRecommender - 89.0% accuracy)

Parameters: opportunity_id, tenant_id

Response: {"opportunity_id":1,"recommended_content":[],"relevance_scores":[]}

POST/api/salesforce/ai-models/detect-buying-signal

Detect buying signals from social media (SocialBuyingSignalDetector - 87.0% accuracy)

Parameters: account_id, tenant_id

Response: {"account_id":1,"buying_signals":[],"signal_strength":0.75,"recommended_actions":[]}

POST/api/salesforce/ai-models/analyze-contract-risk

Analyze contract risk factors (ContractRiskAnalyzer - 90.0% accuracy)

Parameters: contract_id, tenant_id

Response: {"contract_id":1,"risk_score":0.25,"risk_factors":[],"mitigation_strategies":[]}

POST/api/salesforce/ai-models/analyze-customer-feedback

Analyze customer feedback sentiment (CustomerFeedbackAnalyzer - 86.0% accuracy)

Parameters: account_id, tenant_id

Response: {"account_id":1,"sentiment_score":0.82,"themes":[],"action_items":[]}

POST/api/salesforce/ai-models/analyze-partner-performance

Analyze partner performance metrics (PartnerPerformanceAnalyzer - 88.0% accuracy)

Parameters: partner_id, tenant_id

Response: {"partner_id":1,"performance_score":0.85,"strengths":[],"improvement_areas":[]}

POST/api/salesforce/ai-models/score-account-health

Score account health and engagement (AccountHealthScorer - 91.0% accuracy)

Parameters: account_id, tenant_id

Response: {"account_id":1,"health_score":0.88,"risk_level":"low","engagement_metrics":{}}

POST/api/salesforce/ai-models/score-email-engagement

Score email engagement likelihood (EmailEngagementScorer - 89.0% accuracy)

Parameters: email_id, tenant_id

Response: {"email_id":1,"engagement_score":0.75,"open_probability":0.65,"click_probability":0.45}

POST/api/salesforce/ai-models/analyze-meeting

Analyze meeting transcripts for insights (MeetingIntelligence - 92.0% accuracy)

Parameters: meeting_id, tenant_id

Response: {"meeting_id":1,"key_topics":[],"action_items":[],"sentiment":"positive","next_steps":[]}

POST/api/salesforce/ai-models/analyze-pipeline-velocity

Analyze pipeline velocity and bottlenecks (PipelineVelocityAnalyzer - 90.0% accuracy)

Parameters: tenant_id, time_period_days

Response: {"average_velocity_days":45,"bottlenecks":[],"acceleration_opportunities":[]}

POST/api/salesforce/ai-models/optimize-pricing-strategy

Optimize pricing strategies (PricingOptimizer - 93.0% accuracy)

Parameters: opportunity_id, tenant_id

Response: {"opportunity_id":1,"optimal_price":50000,"discount_recommendation":0.1,"win_probability":0.85}

POST/api/salesforce/ai-models/plan-quota-strategy

Plan quota allocation strategies (QuotaPlanner - 88.0% accuracy)

Parameters: tenant_id, time_period_days

Response: {"recommended_quotas":[],"territory_allocations":[],"expected_attainment":0.92}

POST/api/salesforce/ai-models/optimize-sales-activity

Optimize sales activity recommendations (SalesActivityOptimizer - 89.0% accuracy)

Parameters: rep_id, tenant_id

Response: {"rep_id":1,"recommended_activities":[],"priority_accounts":[],"time_allocation":{}}

POST/api/salesforce/ai-models/coach-sales-rep

Provide AI-powered sales coaching (SalesCoach - 87.0% accuracy)

Parameters: rep_id, tenant_id

Response: {"rep_id":1,"coaching_insights":[],"skill_gaps":[],"training_recommendations":[]}

POST/api/salesforce/ai-models/optimize-territory-assignment

Optimize territory assignments (TerritoryOptimizer - 91.0% accuracy)

Parameters: tenant_id

Response: {"optimized_territories":[],"expected_revenue_lift":0.15,"coverage_improvements":[]}

POST/api/salesforce/ai-models/identify-upsell-opportunity

Identify upsell and cross-sell opportunities (UpsellIdentifier - 90.0% accuracy)

Parameters: account_id, tenant_id

Response: {"account_id":1,"upsell_opportunities":[],"cross_sell_products":[],"expected_value":25000}

POST/api/salesforce/ai-models/analyze-revenue-intelligence

Analyze revenue intelligence and trends (RevenueIntelligence - 94.0% accuracy)

Parameters: tenant_id, time_period_days

Response: {"revenue_trends":[],"growth_drivers":[],"risk_factors":[],"strategic_recommendations":[]}

POST/api/v1/sales/strategic/benchmarking/performance

Benchmark sales performance against industry standards

Parameters: organization_data, industry, time_period_days

Response: {"benchmarking_results":{},"performance_gaps":[],"recommendations":[]}

POST/api/v1/sales/strategic/intelligence/aggregate

Aggregate sales intelligence for strategic decision-making

Parameters: time_period_days, include_predictions, aggregation_level

Response: {"aggregated_intelligence":{},"key_insights":[],"strategic_recommendations":[]}

GET/api/v1/sales/strategic/benchmarking/industry-standards

Get industry benchmark standards for sales metrics

Parameters: industry

Response: {"industry":"technology","industry_average":{},"top_performer":{},"available_industries":[]}

GET/api/v1/sales/strategic/intelligence/portfolio-summary

Get summary of sales portfolio health

Parameters:

Response: {"total_accounts":0,"total_opportunities":0,"pipeline_value":0,"win_rate":0}

Rate Limits

PlanRequests/HourBurst Limit
Starter10,000100/min
Professional50,000500/min
Enterprise200,0002,000/min

Error Codes

400 Bad Request: Invalid request parameters

401 Unauthorized: Invalid or missing API key

403 Forbidden: Insufficient permissions

404 Not Found: Resource not found

429 Too Many Requests: Rate limit exceeded

500 Internal Server Error: Server error