Documentation

Technical reference for MIOS deployments.

Full technical documentation — API reference, integration guides, deployment architecture, and configuration specifications — is available to credentialed institutional clients and authorized integration partners.

Documentation Modules

What the documentation covers.

01

Getting Started

Platform overview, authentication setup, environment provisioning, and first-run configuration. Available immediately upon deployment access.

02

MIOS API Reference

Full REST API documentation for signal ingestion, intelligence query, alert configuration, and briefing export endpoints with request/response schemas.

03

OSIRIS Integration

Technical reference for the OSIRIS AI reasoning layer — model configuration, confidence threshold tuning, custom classifier setup, and output schema.

04

Deployment Architecture

Infrastructure requirements, sovereign cloud deployment guides, air-gapped installation procedures, and networking specifications for each deployment configuration.

05

Access Control

Role definition, permission configuration, SSO integration, audit log management, and multi-tenant setup for large institutional deployments.

06

Alert & Briefing Configuration

Escalation threshold configuration, alert routing, briefing template customization, and scheduled intelligence package delivery setup.

07

Data & Retention

Data classification, retention policy configuration, encryption key management, and cross-jurisdictional compliance configuration.

08

Changelog & Versioning

Release notes, API versioning policy, deprecation timelines, and migration guides for platform updates across deployment environments.

Access Requirements

Documentation access tiers.

Documentation Section Public Credentialed Client Integration Partner
Platform Overview✓ Available✓ Available✓ Available
Getting Started Guide✓ Full Access✓ Full Access
API Reference✓ Full Access✓ Full Access
OSIRIS Integration Guide✓ Full Access✓ Full Access
Deployment ArchitectureOn Request✓ Full Access
Security SpecificationUnder NDAUnder NDA
API Overview

MIOS API at a glance.

The MIOS API provides programmatic access to intelligence data, alert streams, and briefing generation. Designed for integration with command center infrastructure, SIEM systems, and enterprise intelligence workflows.

  • REST API with JSON responses
  • Bearer token authentication with key rotation support
  • Webhook support for real-time alert delivery
  • Rate limiting configurable per deployment
  • Full TLS 1.3 enforcement
  • Client SDK available for Python and Node.js
mios-api-example.sh
# Query active narrative threats
curl -X GET \
  https://api.mios.merdot.com/v1/threats \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "severity": ["high","critical"],
    "languages": ["hi","en","ur"],
    "limit": 10
  }'

# Response
{
  "threats": [...],
  "total": 23,
  "escalating": 4,
  "generated_at": "2025-01-15T09:42:00Z"
}

Access MIOS documentation.

Documentation access is provisioned as part of the institutional onboarding process. If you are an existing client and need documentation credentials, contact your MERDOT account manager or reach us directly.