API Reference¶

NextSight AI exposes a comprehensive REST API for programmatic access to all features.

Base URL¶

http://localhost:8000/api/v1

Authentication¶

All API endpoints require authentication using JWT tokens:

curl -H "Authorization: Bearer <token>" \
     http://localhost:8000/api/v1/kubernetes/pods

API Categories¶

Quick Reference¶

Common Endpoints¶

Response Format¶

All responses follow a consistent JSON structure:

{
  "success": true,
  "data": { ... },
  "message": "Operation completed successfully",
  "timestamp": "2024-12-05T10:30:00Z"
}

Error Handling¶

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Resource not found",
    "details": { ... }
  },
  "timestamp": "2024-12-05T10:30:00Z"
}

HTTP Status Codes¶

Rate Limiting¶

API requests are rate-limited to prevent abuse:

• Standard tier: 100 requests/minute
• Authenticated: 1000 requests/minute

WebSocket Endpoints¶

For real-time features, NextSight AI provides WebSocket endpoints:

SDK & Libraries¶