Skip to main content

API Reference

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

Authentication

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

Authorization: Bearer bp_supply_live_your_api_key_here

Base URL

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

Endpoints

GET/api/brainpredict_supply/ai/models

List all 22 available Supply AI models with their capabilities and accuracy rates

Endpoints

Parameters:

Example Response:

{
  "total": 22,
  "models": [
    {
      "id": "supply_chain_brain",
      "name": "SupplyChainBrain",
      "accuracy": 0.942
    }
  ]
}
POST/api/brainpredict_supply/ai/supply-chain-health

Analyze overall supply chain health across facilities, suppliers, and SKUs

Endpoints

Parameters:

facilitiessuppliersskus

Example Response:

{
  "health_score": 0.87,
  "risk_level": "low",
  "recommendations": [
    "Increase safety stock for SKU-123"
  ]
}
POST/api/brainpredict_supply/ai/predict-disruptions

Predict supply chain disruptions 24-72 hours in advance

Endpoints

Parameters:

time_horizon_hours

Example Response:

{
  "disruptions": [
    {
      "type": "supplier_delay",
      "probability": 0.65,
      "impact": "medium",
      "eta_hours": 48
    }
  ]
}
POST/api/brainpredict_supply/ai/forecast-demand/{sku_id}

Forecast demand for specific SKU with 95%+ accuracy

Endpoints

Parameters:

sku_idtime_horizon_days

Example Response:

{
  "sku_id": "SKU-123",
  "forecast": [
    {
      "date": "2025-11-01",
      "demand": 450
    }
  ],
  "accuracy": 0.961
}
POST/api/brainpredict_supply/ai/optimize-inventory/{sku_id}

Calculate optimal inventory levels and reorder points

Endpoints

Parameters:

sku_idcurrent_stock

Example Response:

{
  "optimal_stock": 2500,
  "reorder_point": 800,
  "safety_stock": 300,
  "cost_savings": 15000
}
POST/api/brainpredict_supply/ai/predict-quality-issues

Predict quality issues before they occur

Endpoints

Parameters:

facility_id

Example Response:

{
  "quality_score": 0.92,
  "predicted_issues": [],
  "recommendations": [
    "Increase inspection frequency"
  ]
}
POST/api/brainpredict_supply/ai/optimize-logistics

Optimize logistics operations including routing, scheduling, and load planning

Endpoints

Parameters:

optimization_type

Example Response:

{
  "optimized_routes": [],
  "cost_savings": 25000,
  "efficiency_gain": 0.18
}
POST/api/brainpredict_supply/ai/assess-supplier-risk/{supplier_id}

Assess supplier risk across financial, operational, and geopolitical dimensions

Endpoints

Parameters:

supplier_id

Example Response:

{
  "risk_score": 0.35,
  "risk_level": "medium",
  "factors": [
    "financial_stability"
  ],
  "recommendations": [
    "Diversify suppliers"
  ]
}
POST/api/brainpredict_supply/ai/predict-safety-incidents

Predict workplace safety incidents 24-48 hours in advance

Endpoints

Parameters:

facility_idtime_horizon_hours

Example Response:

{
  "incidents": [],
  "safety_score": 0.94,
  "recommendations": [
    "Review safety protocols"
  ]
}
POST/api/brainpredict_supply/ai/optimize-transportation

Optimize transportation routes and modes for cost and efficiency

Endpoints

Parameters:

origindestinationshipment_details

Example Response:

{
  "optimal_route": [],
  "estimated_cost": 1250,
  "estimated_time_hours": 24,
  "carbon_emissions_kg": 125
}
POST/api/brainpredict_supply/ai/plan-production

Generate optimal production plans based on demand forecasts and capacity constraints

Endpoints

Parameters:

facility_iddemand_forecastcapacity_constraints

Example Response:

{
  "production_plan": [],
  "utilization_rate": 0.85,
  "cost_optimization": 0.12
}
POST/api/brainpredict_supply/ai/collaborate-supplier/{supplier_id}

Enable AI-powered supplier collaboration and data sharing

Endpoints

Parameters:

supplier_idcollaboration_typedata

Example Response:

{
  "collaboration_score": 0.88,
  "insights": [],
  "recommendations": []
}
POST/api/brainpredict_supply/ai/optimize-network

Optimize entire supply chain network configuration

Endpoints

Parameters:

network_dataoptimization_goals

Example Response:

{
  "optimized_network": {},
  "cost_savings": 500000,
  "efficiency_gain": 0.22
}
POST/api/brainpredict_supply/ai/circular-economy-opportunities

Identify circular economy opportunities for products and materials

Endpoints

Parameters:

product_id

Example Response:

{
  "opportunities": [],
  "potential_savings": 75000,
  "environmental_impact": "high"
}
POST/api/brainpredict_supply/ai/verify-blockchain-provenance/{product_id}

Verify product provenance using blockchain technology

Endpoints

Parameters:

product_idbatch_id

Example Response:

{
  "verified": true,
  "provenance_chain": [],
  "authenticity_score": 1
}
POST/api/brainpredict_supply/ai/route-autonomous-vehicle

Route autonomous vehicles for optimal delivery

Endpoints

Parameters:

vehicle_idorigindestinationwaypoints

Example Response:

{
  "optimal_route": [],
  "estimated_time_minutes": 45,
  "safety_score": 0.98
}
POST/api/brainpredict_supply/ai/analyze-3d-printing-opportunity/{part_id}

Analyze 3D printing opportunities for parts and components

Endpoints

Parameters:

part_idcurrent_manufacturing_methodannual_volume

Example Response:

{
  "feasibility_score": 0.75,
  "cost_savings": 25000,
  "lead_time_reduction_days": 14
}
POST/api/brainpredict_supply/ai/optimize-warehouse/{warehouse_id}

Optimize warehouse layout, picking routes, and operations

Endpoints

Parameters:

warehouse_idoptimization_type

Example Response:

{
  "optimized_layout": {},
  "efficiency_gain": 0.15,
  "cost_savings": 50000
}
POST/api/brainpredict_supply/ai/optimize-procurement/{material_id}

Optimize procurement strategies and supplier selection

Endpoints

Parameters:

material_idcurrent_supplierannual_spend

Example Response:

{
  "recommended_suppliers": [],
  "cost_savings": 35000,
  "risk_reduction": 0.2
}
POST/api/brainpredict_supply/ai/track-carbon-footprint

Track and analyze carbon footprint across supply chain

Endpoints

Parameters:

scopeentity_idperiod_startperiod_end

Example Response:

{
  "total_emissions_kg": 125000,
  "scope_breakdown": {},
  "reduction_opportunities": []
}
POST/api/brainpredict_supply/ai/predict-maintenance/{asset_id}

Predict equipment maintenance needs before failures occur

Endpoints

Parameters:

asset_idsensor_data

Example Response:

{
  "failure_probability": 0.15,
  "days_until_failure": 45,
  "recommended_action": "schedule_maintenance"
}
POST/api/v1/supply/strategic/benchmarking/performance

Benchmark supply chain performance against industry standards

Endpoints

Parameters:

organization_dataindustrytime_period_days

Example Response:

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

Aggregate supply chain intelligence for strategic decision-making

Endpoints

Parameters:

time_period_daysinclude_predictionsaggregation_level

Example Response:

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

Get industry benchmark standards for supply chain metrics

Endpoints

Parameters:

industry

Example Response:

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

Get summary of supply chain portfolio health

Endpoints

Parameters:

Example Response:

{
  "total_facilities": 0,
  "total_suppliers": 0,
  "total_skus": 0,
  "health_score": 0.85
}

Rate Limits

API rate limits vary by plan:

  • Starter: 1,000 requests/hour
  • Professional: 10,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-supply

Node.js

npm install @brainpredict/supply

Java

mvn install brainpredict-supply

PHP

composer require brainpredict/supply