Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/LENINMORENO13/OpsMind/llms.txt

Use this file to discover all available pages before exploring further.

OpsMind gives you real-time visibility into your distributed services. Register any HTTP endpoint as a monitor, and OpsMind continuously checks its availability — flagging degradations, detecting drops, and calling on Google Gemini to generate a root-cause analysis and remediation suggestion the moment something goes wrong.

Quickstart

Deploy OpsMind with Docker and create your first monitor in under 5 minutes.

Configuration

Learn every environment variable OpsMind requires to run.

API Reference

Full reference for all REST endpoints — auth, monitors, and observability.

Core Concepts

Understand the architecture, status system, and how AI analysis works.

What OpsMind Does

1

Register a monitor

POST an endpoint name and URL to /api/v1/monitors. OpsMind stores it and immediately begins tracking it.
2

Automatic health checks

A background cron worker runs every 5 minutes, firing an HTTP GET to every registered URL and recording the response code, response time, and any errors.
3

Trend analysis

Each check is compared against the previous result. OpsMind derives a trend — STABLE, RECOVERED, DROP_DETECTED, or OFFLINE — and a service state: UP, DEGRADED, or DOWN.
4

AI-powered incident diagnosis

When a DROP_DETECTED trend is recorded, OpsMind calls Google Gemini with the incident details. Gemini returns a probable root cause and a concrete recommended action, both stored as an AIInsight record.

Key Features

Real-Time Checks

HTTP health checks with response time measurement and automatic status classification.

Trend Detection

Stateful trend engine comparing every check against the previous result.

AI Diagnosis

Gemini AI generates root-cause analysis and remediation steps on every incident.

JWT Security

All monitor endpoints are protected with Bearer JWT authentication.

History & Logs

Persistent log table retains the last 10 check results per monitor.

Docker Ready

Single docker compose up --build starts the API and PostgreSQL together.
OpsMind exposes a live Swagger UI at /api-docs. Once the server is running you can explore and test every endpoint directly in the browser.

Build docs developers (and LLMs) love