RQE API Documentation | Binary³ Risk Quantification Engine

Base URL

/v1/rqe

All API requests are made to this base URL. Sandbox requests use the same URL with sandbox API keys.

Authentication

All API requests require authentication using an API key. Include your key in the X-API-Key header:

curl /v1/rqe/overview \
  -H "X-API-Key: rqek_live_your_api_key_here"

API Key Security

Keep your API keys secure. Never expose them in client-side code or public repositories.

Key Types

Live rqek_live_...

Production keys. Requests count against your quota.

Sandbox rqek_test_...

Test keys. Use demo data, don't count against quota.

Rate Limits

Rate limits vary by plan tier. Exceeding a limit returns 429 Too Many Requests.

Plan	Per Minute	Per Hour	Per Day
Free	10	100	500
Starter	30	500	5,000
Pro	60	1,500	15,000
Business	120	5,000	50,000
Enterprise	300	15,000	150,000

Error Handling

The API returns consistent error responses:

{
  "success": false,
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Hourly rate limit exceeded",
    "retry_after": 1234
  },
  "meta": { "request_id": "req_abc123", "timestamp": "..." }
}

Error Codes

401

missing_api_key / invalid_api_key

Authentication failed

402

quota_exceeded

Monthly credit quota exceeded

429

rate_limit_exceeded

Rate limit exceeded

500

internal_error

Server error

GET

/health

Check API health status. No authentication required.

Response

{ "success": true, "data": { "status": "healthy", "version": "1.0.0" } }

GET

/overview

0 credits

Get the latest risk score and findings summary for your tenant.

POST

/risk/score

1 credit

Trigger a risk score recalculation. Supports dry-run mode.

Request Body

{ "dry_run": false }

POST

/findings/ingest

1 credit

Ingest a new security finding into the RQE system.

Request Body

{
  "product": "custom",
  "category": "vulnerability",
  "title": "SQL Injection",
  "severity": "high",
  "asset_identifier": "app.example.com",
  "likelihood": 0.8,
  "impact": 0.9
}

GET

/findings

0 credits

Get a paginated list of findings.

Query Parameters

`product`	Filter by product
`severity`	Filter by severity
`status`	Filter by status
`page`	Page number (default: 1)
`per_page`	Items per page (max: 100)

GET

/timeline

0 credits

Get a combined timeline of ForensIQ and LogSentinel events.

Query Parameters

`days`	Days to look back (default: 30)
`limit`	Max events (default: 50, max: 200)

GET

/assets

0 credits

Get your asset inventory with pagination and filtering.

GET

/usage

0 credits

Get your API usage statistics for the current billing period.