Skip to main content

​
Introduction

The Sentinel AI API provides programmatic access to monitor and manage services, interact with the autonomous agent, and query the knowledge base. Built with FastAPI, the API follows REST principles and returns JSON responses.

​
Base URL

The default base URL for the API is: 
http://localhost:8000
The actual host and port may vary based on your deployment configuration.

​
API Version

Current API version: 2.0.0

​
Authentication

The current version of the Sentinel AI API does not require authentication. CORS is enabled for all origins to facilitate development and integration.
In production environments, it’s recommended to implement proper authentication and restrict CORS origins.

​
Common Patterns

​
Response Format

All endpoints return JSON responses. Successful responses typically include:
  • status: Operation status (e.g., “ok”, “started”, “stopping”)
  • message: Human-readable message describing the result
  • Additional fields specific to the endpoint

​
Error Handling

The API uses standard HTTP status codes:
  • 200: Successful operation
  • 400: Bad request (invalid parameters)
  • 404: Resource not found
  • 409: Conflict (e.g., agent already running)
  • 503: Service unavailable (e.g., knowledge base initializing)
Error responses include a detail field with information about the error: 
{
  "detail": "Agent is already running"
}

​
Health Check

A simple health check endpoint is available at the root: 
GET /
Response: 
{
  "status": "ok",
  "service": "Sentinel AI API",
  "mode": "on-demand",
  "agent_status": "idle"
}

​
Endpoint Categories

The API is organized into the following categories:

Agent Control

Start, stop, and manage the autonomous monitoring agent

Service Management

Monitor services and manage service configurations

Chat Interface

Query the knowledge base with streaming responses

WebSocket Logs

Real-time log streaming via WebSocket connection

​
Real-time Updates

Sentinel AI supports real-time event streaming through:
  1. WebSocket: Connect to /ws/logs for live log events
  2. Server-Sent Events (SSE): The /chat endpoint streams responses as SSE

​
Configuration Endpoint

Retrieve current system configuration: 
GET /config
Response: 
{
  "services": ["nginx", "postgresql", "redis"],
  "interval": 300,
  "max_retries": 3,
  "mode": "on-demand"
}
​
services
array
List of monitored service names
​
interval
integer
Monitoring interval in seconds
​
max_retries
integer
Maximum retry attempts for failed operations
​
mode
string
Agent operation mode (“on-demand” or “continuous”)

​
Next Steps

Explore the specific endpoint documentation:

Build docs developers (and LLMs) love

Get started for freeTalk to us