Skip to main content

Getting Started with BrainPredict People

Get up and running with BrainPredict People in just 10 minutes. This guide covers account setup, API integration, and your first AI-powered talent prediction.

Step 1: Create Your Account

Sign up at brainpredict.ai/signup and choose your plan:

  • Starter (): 1-10 licenses, all 27 AI models, 100% of features, Intelligence Bus integration
  • Professional (): 11-25 licenses, all 27 AI models, 100% of features, Intelligence Bus integration
  • Enterprise (): 26-50 licenses, all 27 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_people_live_1234567890abcdef1234567890abcdef

# Keep it secure - never commit to version control!

Step 3: Install SDK

Install the BrainPredict People SDK in your preferred language:

# Python
pip install brainpredict-people

# Node.js
npm install @brainpredict/people

# Java
mvn install brainpredict-people

# PHP
composer require brainpredict/people

Step 4: Make Your First API Call

Let's predict candidate success using the Talent Predictor AI model:

# Python
from brainpredict import PeopleClient

client = PeopleClient(api_key="bp_people_live_xxx")

# Predict candidate success probability
prediction = client.talent_predictor.predict({
    "candidate_id": "CAND-12345",
    "resume_text": "5 years experience in software engineering...",
    "skills": ["Python", "React", "AWS"],
    "education": "BS Computer Science",
    "years_experience": 5,
    "position": "Senior Software Engineer"
})

print(f"Success probability: {prediction['success_probability']}")
print(f"Flight risk: {prediction['flight_risk']}")
print(f"Recommended salary: {prediction['recommended_salary']}")

Response:

{
  "success_probability": 0.87,
  "flight_risk": 0.23,
  "recommended_salary": 95000,
  "cultural_fit_score": 0.92,
  "skill_match": 0.89,
  "growth_potential": 0.85,
  "confidence": 0.94
}

Step 5: Connect Your HRIS

Integrate with your HRIS for automatic data sync:

# Workday Integration
client.integrations.connect_workday({
    "tenant_url": "https://your-tenant.workday.com",
    "username": "api_user",
    "password": "xxx"
})

# SAP SuccessFactors Integration
client.integrations.connect_sap_sf({
    "company_id": "YOUR_COMPANY",
    "username": "api_user",
    "password": "xxx"
})

Next Steps

Need Help?

Our support team is here to help you get started: