Skip to content

API Documentation

API reference for the meghIQ platform, including the newest evidence, privacy, GDPR, AI agent, and resource-mutation governance surfaces.

Interactive API Explorer

Explore and test our API endpoints directly in your browser with our interactive documentation.

View OpenAPI Specification

Authentication

Secure your API requests with JWT tokens. All endpoints require authentication.

Authorization: Bearer <your_jwt_token>

API Endpoints Overview

Authentication

User authentication, token management, and session handling.

POST/auth/login
GET/auth/me

Automation Discovery

Discover and catalog automations across your enterprise platforms.

GET/automations
POST/discovery/scan

Compliance

Monitor compliance across GDPR, HIPAA, SOX and custom rules.

GET/compliance/checks
GET/compliance/violations

AI Insights

AI-powered automation analysis, DNA profiling, and predictions.

GET/ai/dna-profile
GET/ai/health-score

Analytics

Comprehensive analytics, metrics, and reporting for automations.

GET/analytics/overview
GET/analytics/metrics

Alerts & Notifications

Real-time alerts, notifications, and monitoring configuration.

GET/alerts
POST/notifications/send

Newly Implemented API Surfaces

/api/v1/gdpr/export

GDPR subject export

/api/v1/gdpr/erase

GDPR erasure workflow

/api/v1/ai-agents

AI Agent Registry

/api/v1/audit/verify

Tamper-evident audit verification

/api/v1/automations/{id}/disable

Automation state mutation evidence

/api/v1/workflows/workflows/{id}/execute

Workflow execution evidence

/api/v1/scheduled-reports/{id}/run

Scheduled-report execution evidence

/api/v1/compliance/violations/{id}/remediate

Compliance remediation evidence

Getting Started

Base URL

https://api.meghiq.com/v2

Quick Example

curl -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     https://api.meghiq.com/v2/automations

Response Format

{
  "success": true,
  "data": {...},
  "pagination": {...},
  "meta": {...}
}

Need Help?