API Reference

Build with SplintAI API

RESTful APIs to integrate manufacturing intelligence into your applications

Quick Start

1. Get Your API Key

Generate an API key from your dashboard settings. Keep it secure!

2. Install SDK

Use our official SDKs or make direct HTTP requests to our endpoints.

3. Make Your First Call

Start with a simple GET request to retrieve your equipment list.

import requests

# Set up authentication
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}

# Get all equipment
response = requests.get(
    'https://api.splintai.com/v2/equipment',
    headers=headers
)

equipment = response.json()
print(f"Found {len(equipment['data'])} equipment")

# Get predictions for specific equipment
equipment_id = equipment['data'][0]['id']
predictions = requests.get(
    f'https://api.splintai.com/v2/predictions/{equipment_id}',
    headers=headers
).json()

print(f"Next predicted failure: {predictions['next_failure']}")

API Endpoints

Equipment

GET
/api/v2/equipmentList all equipment
Auth Required
POST
/api/v2/equipmentCreate new equipment
Auth Required
GET
/api/v2/equipment/{id}Get equipment details
Auth Required
PUT
/api/v2/equipment/{id}Update equipment
Auth Required

Predictions

GET
/api/v2/predictionsGet all predictions
Auth Required
GET
/api/v2/predictions/{equipment_id}Get predictions for equipment
Auth Required
POST
/api/v2/predictions/analyzeTrigger new analysis
Auth Required

Metrics

GET
/api/v2/metrics/oeeGet OEE metrics
Auth Required
GET
/api/v2/metrics/downtimeGet downtime analytics
Auth Required
GET
/api/v2/metrics/qualityGet quality metrics
Auth Required

Official SDKs

Get started faster with our official client libraries

🐍

Python

Official Python SDK with async support

pip install splintaiView on GitHub
📦

JavaScript/Node

TypeScript-first SDK for Node.js

npm install @splintai/sdkView on GitHub
🔷

Go

High-performance Go client

go get github.com/splintai/go-sdkView on GitHub

Java

Java SDK with Spring Boot integration

Maven: com.splintai:sdk:2.0.0View on GitHub

Rate Limits

API rate limits vary by plan. All responses include rate limit headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1614556800
Starter
1,000/hourBurst: 100/minute
Professional
10,000/hourBurst: 500/minute
Enterprise
Unlimited*Burst: Custom

* Enterprise plans have custom limits based on requirements

Webhooks Available

Receive real-time notifications when important events occur in your manufacturing operations.

  • Equipment status changes
  • Prediction threshold alerts
  • Maintenance completion

Start Building with SplintAI

Get your API key and start integrating manufacturing intelligence into your applications