API Reference
Build with SplintAI API
RESTful APIs to integrate AI margin 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 sites list.
import requests
# Set up authentication
headers = {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
# Get all sites
response = requests.get(
'https://api.splintai.com/v1/sites',
headers=headers
)
sites = response.json()
print(f"Found {len(sites['data'])} sites")
# Get AI margin insights for a specific site
site_id = sites['data'][0]['id']
insights = requests.get(
f'https://api.splintai.com/v1/insights/{site_id}',
headers=headers
).json()
print(f"Top margin opportunity: ${insights['top_opportunity']['estimated_recovery']}")API Endpoints
Sites & Data Sources
GET
/api/v1/sitesList all sitesAuth Required
GET
/api/v1/sites/{id}Get site details and configurationAuth Required
GET
/api/v1/integrationsList configured ERP, HRIS, and MES integrationsAuth Required
POST
/api/v1/integrationsRegister a new data sourceAuth Required
AI Insights & Margin Discovery
GET
/api/v1/insightsGet all AI-discovered margin opportunitiesAuth Required
GET
/api/v1/insights/{site_id}Get insights for a specific siteAuth Required
POST
/api/v1/insights/analyzeTrigger new AI margin analysisAuth Required
GET
/api/v1/executive-briefGet the latest weekly AI executive briefAuth Required
Margin Metrics
GET
/api/v1/metrics/marginGet cross-site margin comparisonAuth Required
GET
/api/v1/metrics/labor-costGet direct labor cost per pound by siteAuth Required
GET
/api/v1/metrics/yieldGet yield by commodity, drilled to the siteAuth Required
GET
/api/v1/ci-initiativesGet CI initiative portfolio with trajectoryAuth Required
Official SDKs
Get started faster with our official client libraries
🐍
📦
🔷
☕
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
Intelligence Starter
1,000/hour•Burst: 100/minute
Intelligence Growth
10,000/hour•Burst: 500/minute
Intelligence Enterprise
Unlimited*•Burst: Custom
* Enterprise plans have custom limits based on requirements
Webhooks Available
Receive real-time notifications when the AI engine surfaces new opportunities or detects anomalies in your operations.
- New margin opportunity discovered
- AI anomaly threshold alerts
- CI initiative trajectory changes
- Weekly executive brief published
Start Building with SplintAI
Get your API key and start integrating AI margin intelligence into your applications