Skip to main content

API Reference

Complete API documentation for BrainPredict People with endpoints, parameters, and response examples.

Authentication

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

Authorization: Bearer bp_people_live_your_api_key_here

Base URL

https://api.brainpredict.ai/v1/people

Endpoints

GET/api/cubai/ai-models/predictions

Get all AI predictions with filtering by employee, model name, or prediction type

Endpoints

Parameters:

employee_idmodel_nameprediction_typeskiplimit

Example Response:

{
  "total": 0,
  "predictions": []
}
GET/api/cubai/ai-models/turnover-predictions

Get turnover predictions with 91.2% accuracy (TurnoverPredictor AI model)

Endpoints

Parameters:

employee_idmin_risk_scoreskiplimit

Example Response:

{
  "total": 0,
  "predictions": [
    {
      "employee_id": 1,
      "turnover_probability": 0.35,
      "risk_level": "medium"
    }
  ]
}
GET/api/cubai/ai-models/performance-predictions

Get performance predictions with 88.7% accuracy (PerformanceForecaster AI model)

Endpoints

Parameters:

employee_idskiplimit

Example Response:

{
  "total": 0,
  "predictions": [
    {
      "employee_id": 1,
      "predicted_rating": 4.2,
      "confidence": 0.87
    }
  ]
}
GET/api/cubai/ai-models/hiring-success-predictions

Get hiring success predictions with 86.5% accuracy (TalentPredictor AI model)

Endpoints

Parameters:

candidate_idmin_success_probabilityskiplimit

Example Response:

{
  "total": 0,
  "predictions": [
    {
      "candidate_id": 1,
      "success_probability": 0.87,
      "cultural_fit": 0.92
    }
  ]
}
GET/api/cubai/ai-models/learning-effectiveness-predictions

Get learning effectiveness predictions with 84.3% accuracy (LearningEffectivenessPredictor)

Endpoints

Parameters:

employee_idcourse_idskiplimit

Example Response:

{
  "total": 0,
  "predictions": [
    {
      "employee_id": 1,
      "course_id": 1,
      "effectiveness_score": 0.78
    }
  ]
}
GET/api/cubai/ai-models/succession-readiness-predictions

Get succession readiness predictions with 89.4% accuracy (SuccessionPlanner AI model)

Endpoints

Parameters:

employee_idtarget_position_idskiplimit

Example Response:

{
  "total": 0,
  "predictions": [
    {
      "employee_id": 1,
      "readiness_score": 0.85,
      "time_to_ready_months": 6
    }
  ]
}
GET/api/cubai/ai-models/model-performance

Get AI model performance metrics and accuracy tracking

Endpoints

Parameters:

model_nameskiplimit

Example Response:

{
  "total": 0,
  "metrics": [
    {
      "model_name": "TurnoverPredictor",
      "accuracy": 0.912,
      "predictions_count": 1500
    }
  ]
}
GET/api/cubai/ai-models/stats/overview

Get overview statistics for all 27 People AI models

Endpoints

Parameters:

Example Response:

{
  "total_models": 27,
  "total_predictions": 0,
  "average_accuracy": 0.887
}
POST/api/cubai/ai-models/recommend-internal-mobility

Recommend internal mobility opportunities for employees (InternalMobilityAdvisor - 87.9% accuracy)

Endpoints

Parameters:

employee_id

Example Response:

{
  "employee_id": 1,
  "opportunities": [],
  "recommendations": []
}
POST/api/cubai/ai-models/analyze-productivity

Analyze productivity for individual, team, or department (ProductivityAnalyzer - 85.6% accuracy)

Endpoints

Parameters:

analysis_typeentity_id

Example Response:

{
  "productivity_score": 0.82,
  "insights": [],
  "recommendations": []
}
POST/api/cubai/ai-models/predict-absenteeism

Predict absenteeism risk for employees (AbsenteeismPredictor - 83.2% accuracy)

Endpoints

Parameters:

employee_idprediction_timeframe_days

Example Response:

{
  "employee_id": 1,
  "absenteeism_probability": 0.15,
  "risk_level": "low"
}
POST/api/cubai/ai-models/predict-onboarding-success

Predict onboarding success for new hires (OnboardingSuccessPredictor - 88.1% accuracy)

Endpoints

Parameters:

employee_idhire_dateposition

Example Response:

{
  "employee_id": 1,
  "success_probability": 0.87,
  "success_level": "high"
}
POST/api/cubai/ai-models/detect-burnout

Detect burnout risk for employees (BurnoutDetector - 90.3% accuracy)

Endpoints

Parameters:

employee_id

Example Response:

{
  "employee_id": 1,
  "burnout_risk_score": 0.25,
  "risk_level": "low",
  "burnout_stage": "none"
}
POST/api/cubai/ai-models/predict-engagement

Predict employee engagement levels (EngagementPredictor - 86.8% accuracy)

Endpoints

Parameters:

employee_id

Example Response:

{
  "employee_id": 1,
  "engagement_score": 0.78,
  "engagement_level": "high"
}
POST/api/cubai/ai-models/analyze-skills-gap

Analyze skills gaps for individual, team, department, or company (SkillsGapAnalyzer - 84.7% accuracy)

Endpoints

Parameters:

analysis_typeentity_id

Example Response:

{
  "gaps": [],
  "training_recommendations": [],
  "priority_skills": []
}
POST/api/cubai/ai-models/analyze-dei

Analyze diversity, equity, and inclusion metrics (DEIAnalyzer - 82.5% accuracy)

Endpoints

Parameters:

analysis_typeentity_id

Example Response:

{
  "dei_score": 0.75,
  "diversity_metrics": {},
  "equity_metrics": {},
  "inclusion_metrics": {}
}
POST/api/cubai/ai-models/assess-mental-health

Assess employee mental health and wellbeing (MentalHealthAssessor - 89.6% accuracy)

Endpoints

Parameters:

employee_id

Example Response:

{
  "employee_id": 1,
  "mental_health_score": 0.82,
  "risk_level": "low",
  "recommendations": []
}
POST/api/cubai/ai-models/optimize-remote-work

Optimize remote work arrangements (RemoteWorkOptimizer - 85.3% accuracy)

Endpoints

Parameters:

employee_id

Example Response:

{
  "employee_id": 1,
  "optimal_schedule": {},
  "productivity_impact": 0.15,
  "recommendations": []
}
POST/api/cubai/ai-models/match-gig-worker

Match gig workers to projects (GigWorkerMatcher - 87.4% accuracy)

Endpoints

Parameters:

project_idrequired_skills

Example Response:

{
  "project_id": 1,
  "matched_workers": [],
  "match_scores": []
}
POST/api/cubai/ai-models/match-internal-opportunity

Match employees to internal opportunities (InternalOpportunityMatcher - 88.9% accuracy)

Endpoints

Parameters:

opportunity_id

Example Response:

{
  "opportunity_id": 1,
  "matched_employees": [],
  "match_scores": []
}
POST/api/v1/people/strategic/benchmarking/performance

Benchmark HR performance against industry standards

Endpoints

Parameters:

organization_dataindustrytime_period_days

Example Response:

{
  "benchmarking_results": {},
  "performance_gaps": [],
  "recommendations": []
}
POST/api/v1/people/strategic/intelligence/aggregate

Aggregate people intelligence for strategic decision-making

Endpoints

Parameters:

people_datatime_period_days

Example Response:

{
  "aggregated_intelligence": {},
  "key_insights": [],
  "strategic_recommendations": []
}
GET/api/v1/people/strategic/benchmarking/industry-standards

Get industry benchmark standards for HR metrics

Endpoints

Parameters:

industry

Example Response:

{
  "industry": "technology",
  "industry_average": {},
  "top_performer": {},
  "available_industries": []
}
GET/api/v1/people/strategic/intelligence/portfolio-summary

Get summary of HR portfolio health

Endpoints

Parameters:

Example Response:

{
  "total_employees": 0,
  "total_departments": 0,
  "average_engagement": 0,
  "turnover_rate": 0
}

Rate Limits

API rate limits vary by plan:

  • Starter: 500 requests/hour
  • Professional: 5,000 requests/hour
  • Enterprise: Unlimited

Error Codes

CodeDescription
400Bad Request - Invalid parameters
401Unauthorized - Invalid API key
429Too Many Requests - Rate limit exceeded
500Internal Server Error

SDKs & Libraries

We provide official SDKs for popular programming languages:

Python

pip install brainpredict-people

Node.js

npm install @brainpredict/people

Java

mvn install brainpredict-people

PHP

composer require brainpredict/people