Skip to main content

API Reference

Complete API documentation for BrainPredict Operations. All endpoints require authentication via API key.

Authentication

Include your API key in the Authorization header:

Authorization: Bearer bp_operations_live_your_api_key_here

Base URL

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

Endpoints

POST/api/v1/operations/oee/analyze

Analyze OEE for a production line

{
  "line_id": "LINE-001",
  "period": "last_7_days",
  "include_recommendations": true
}
POST/api/v1/operations/maintenance/predict

Predict maintenance needs for equipment

{
  "equipment_id": "CNC-001",
  "prediction_horizon": "30_days",
  "include_cost_analysis": true
}
POST/api/v1/operations/quality/analyze

Analyze quality metrics and predict defects

{
  "product_id": "PROD-001",
  "batch_id": "BATCH-2025-001",
  "include_spc_analysis": true
}
POST/api/v1/operations/production/schedule

Generate optimized production schedule

{
  "planning_horizon": "7_days",
  "demand_forecast": [...],
  "constraints": {...}
}
GET/api/v1/operations/dashboard

Get real-time operations dashboard data

// Query parameters:
?lines=LINE-001,LINE-002
&metrics=oee,throughput,quality
&period=today

Rate Limits

  • Starter: 1,000 requests/hour
  • Professional: 5,000 requests/hour
  • Enterprise: 20,000 requests/hour
  • Custom: Unlimited (contact sales)

Error Codes

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