petter2025 commited on
Commit
4f87d5a
·
verified ·
1 Parent(s): 9c0d2fa

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +23 -4
README.md CHANGED
@@ -1,11 +1,30 @@
1
  ---
2
  title: ARF Sandbox API
3
- emoji: 🏆
4
- colorFrom: green
5
- colorTo: gray
6
  sdk: docker
7
  pinned: false
8
  license: apache-2.0
9
  ---
10
 
11
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: ARF Sandbox API
3
+ emoji: 🧪
4
+ colorFrom: blue
5
+ colorTo: indigo
6
  sdk: docker
7
  pinned: false
8
  license: apache-2.0
9
  ---
10
 
11
+ # ARF Sandbox API Mock Endpoint
12
+
13
+ > 🧪 **This is a fully simulated, mock API.**
14
+ > It does **not** use the protected Bayesian engine.
15
+ > No real data is processed – all responses are deterministic examples.
16
+
17
+ Use this endpoint to test integrations and see the expected request/response format.
18
+
19
+ ## 🔗 Endpoints
20
+
21
+ - `POST /v1/evaluate` – Simulate an incident evaluation.
22
+ - `GET /health` – Health check.
23
+ - `GET /docs` – Interactive Swagger UI.
24
+
25
+ ## 📦 Example Request
26
+
27
+ ```bash
28
+ curl -X POST https://A-R-F-ARF-Sandbox-API.hf.space/v1/evaluate \
29
+ -H "Content-Type: application/json" \
30
+ -d '{"service_name":"api","event_type":"latency","severity":"high","metrics":{"latency_ms":450}}'