Documentation
API & Integration Guide
Complete documentation and guides for integrating Supply Chain AI into your systems.
Getting Started
Quick setup guide to get you up and running in minutes.
API Reference
Complete API endpoints documentation with examples.
Authentication
Learn about API key authentication and security best practices.
Webhook Integration
Setup webhooks to receive real-time prediction results.
Error Handling
Understanding and handling API errors gracefully.
API Request Example
Here's how to make a prediction request using cURL:
curl -X POST https://api.supplychainai.com/predict \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"Shipping_days": 5,
"Product_weight_g": 1500,
"Product_price": 250.00,
"Days_for_shipment": 3,
"Reached_on_time": 1,
"Sales_per_month": 50,
"Days_for_shipping_real": 4
}'
# Response:
{
"prediction": 0,
"confidence": 0.98,
"status": "on_time",
"risk_bucket": "low"
}Frequently Asked Questions
What is the API rate limit?
Starter: 100/min, Professional: 1000/min, Enterprise: Unlimited. Contact support for custom limits.
How long do predictions take?
Predictions are generated in <500ms on average. 99.9% of requests complete within 1 second.
Can I batch multiple predictions?
Yes! Use our /batch endpoint to submit up to 100 predictions in a single request.
What data do you store?
We store prediction requests, results, and aggregated metrics for analytics. Raw input data can be deleted on request.
How accurate is the model?
98% accuracy on our test set. Accuracy varies based on data quality and market conditions.
Is the API always available?
Yes, we guarantee 99.9% uptime with SLA compliance. Status page: status.supplychainai.com
Need Help?
Our support team is available 24/7 to help you integrate and succeed.