API Reference
Reference guide for the RaksHex REST API to ingest telemetry and query findings.
If you are not using our SDKs, you can interact with the RaksHex portal directly via our REST API. All requests must be authenticated using the Authorization: Bearer <API_KEY> header.
1. Ingest Telemetry
Record a completed model request and token metrics.
Endpoint: POST /v1/telemetry
Payload Example:
{
"model": "gpt-4o",
"prompt_tokens": 128,
"completion_tokens": 256,
"reasoning_tokens": 64,
"latency_ms": 420,
"user_id": "usr_93812",
"status": "success",
"endpoint": "/api/chat"
}
2. Retrieve Security Findings
Fetch the list of unresolved vulnerabilities or shadow API alerts.
Endpoint: GET /v1/findings
Query Parameters:
severity: Filter byCritical,High,Medium, orLow.resolved: Filter bytrueorfalse.
