Implementation-Focused Documentation

Developer Quickstart

Integrate Aegis Core API quickly with a single endpoint and predictable response schema designed for moderation workflows.

Endpoint: POST /v1/moderate

Get an API key Upgrade plan

Example Request

bash

curl -X POST https://api.aegiscoreapi.com/v1/moderate \
  -H "Authorization: Bearer test_free_key_123" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "you are an idiot",
    "lang": "en",
    "context": { "is_reply": true, "mentions": ["@someone"] }
  }'

Example Response

json

{
  "score": 61,
  "action": "review",
  "flags": ["insult", "directed"],
  "explanations": [
    "Strong insult term detected",
    "Second-person targeting detected",
    "ML toxicity probability: 0.78"
  ],
  "matches": [
    {
      "term": "idiot",
      "weight": 15,
      "multiplied": true,
      "window": "you are an idiot"
    }
  ]
}

Response Fields

score: Severity from 0 to 100
action: allow, warn, review, block
flags: Category labels (insult, threat, directed)
explanations: Human-readable moderation reasons
matches: Terms and context windows that triggered score

Integration Notes

Set API key via X-API-Key or Bearer auth header
Start with warn/review actions and tune thresholds with logs
Use explanations and matches to improve moderator tooling
Implement retries with short timeout budgets in clients

Developer Workflow

Ship with rules-first scoring
Tune policy thresholds per product surface
Use dashboard usage data for quota and cost controls

Enterprise Readiness

API behavior remains deterministic and explainable
Billing and entitlement controls are externally auditable
Architecture supports staged rollout of advanced controls