Public docs
Quickstart
Get your first response in under 5 minutes.
Phase 1 shell: this docs surface is wired to the existing backend and repo documentation, and will be expanded as the private dashboard comes online.
Step 1 — Get your API key
Sign in to the opSentry dashboard and go to Settings → Credentials. Create an app to get your API key, then send it in the X-API-Key header on every request.
Your access tier follows your plan:
- Free / Individual — deterministic
basicmode - Pro — full access, includes AI mode
Step 2 — Test the connection
curl https://api.opsentry.ai/health \
-H "X-API-Key: YOUR_API_KEY"Expected response:
{ "status": "ok" }Step 3 — Send your first changelog
curl -X POST https://api.opsentry.ai/v1/translate \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"raw_text": "Deprecated scope auth:legacy. Introduced auth:token.rotate. Breaking change.",
"audience": ["cs", "support"],
"mode": "basic"
}'You'll get back structured summaries, risk flags, extracted changes, and an impact level.
Step 4 — Use AI mode (pro only)
Switch mode to "ai" (requires a Pro plan). AI mode adds:
- Executive summary
- Partner-specific impact reasoning
- Impacted scopes detection
- Partner email draft
Base URL
All examples use the production API base: https://api.opsentry.ai.
Health check
curl https://api.opsentry.ai/health \ -H "X-API-Key: YOUR_API_KEY"