ARF-Sandbox-API / README.md
petter2025's picture
Update README.md
bc06d10 verified
---
title: ARF Sandbox API
emoji: 🧪
colorFrom: blue
colorTo: indigo
sdk: docker
pinned: false
license: apache-2.0
---
# ARF Sandbox API – Mock Endpoint
> 🧪 **This is a fully simulated, mock API.**
> It does **not** use the protected Bayesian engine.
> No real data is processed – all responses are deterministic examples.
Use this endpoint to test integrations and see the expected request/response format.
## 🔗 Endpoints
- `POST /v1/evaluate` – Simulate an incident evaluation.
- `GET /health` – Health check.
- `GET /docs` – Interactive Swagger UI.
## 📦 Example Request
```bash
curl -X POST https://A-R-F-ARF-Sandbox-API.hf.space/v1/evaluate \
-H "Content-Type: application/json" \
-d '{"service_name":"api","event_type":"latency","severity":"high","metrics":{"latency_ms":450}}'
```
📤 Example Response
-------------------
```json
{
"status": "success",
"recommendation": "ESCALATE",
"risk_score": 0.68,
"confidence": 0.72,
"justification": "High latency (450ms) exceeds threshold; simulated response.",
"policy_violations": []
}
```
🔒 Real Engine
--------------
The actual ARF core engine is **access‑controlled** and available under outcome‑based pricing.Request pilot access at [arf-frontend-sandy.vercel.app/signup](https://arf-frontend-sandy.vercel.app/signup).
📚 See Also
-----------
* [Official Specification](https://arf-foundation.github.io/arf-spec/)
* [Public Demo UI](https://arf-frontend-sandy.vercel.app/)