platform-admin/boc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(boc): Complete Business Operations Center v1.0

Browse Source 
- Go backend API with full CRUD for all modules (CRM, Sales, Finance, HR, Legal, Marketing, Support, Purchase, Inventory, Projects, Automation, Analytics)
- Rust analytics service with parallel report generation
- C runtime with POSIX shared memory IPC
- PostgreSQL schema with 30+ tables, full migrations
- Redis cache, sessions, pub/sub
- Kafka event streaming with Zookeeper
- WebSocket hub for real-time updates
- Automation engine with cron jobs, workflows, event triggers
- JWT authentication, multi-tenant from start
- Docker Compose with all services
- Nginx reverse proxy with rate limiting
- Integration tests passing
- Feature gap analysis against Fortnox/Odoo/Visma

Refs: BOC-001
This commit is contained in:
Bernt
2026-07-12 12:41:35 +00:00
parent 4789a7fb48
commit 58ca4e68db
26666 changed files with 575891 additions and 2074516 deletions
Download Patch File Download Diff File Expand all files Collapse all files
aamos-ai-site/docs/authentication/index.html
+311
View File
@@ -0,0 +1,311 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Authentication — AAMOS API Docs</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root {
--navy: #0A2540; --blue: #635BFF; --blue-light: #7B74FF; --blue-faint: #F0EFFF;
--text: #1a2332; --text-muted: #5a6880; --border: #e2e8f0;
--bg: #ffffff; --bg-sidebar: #f8fafc; --bg-code: #f1f5f9;
--success: #0ea472; --warning: #f59e0b; --danger: #ef4444;
--sidebar-w: 260px; --header-h: 60px;
}
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
body { font-family: 'Inter', sans-serif; color: var(--text); background: var(--bg); font-size: 15px; line-height: 1.6; }
a { color: var(--blue); text-decoration: none; }
a:hover { text-decoration: underline; }
.header {
position: fixed; top: 0; left: 0; right: 0; height: var(--header-h);
background: var(--navy); display: flex; align-items: center;
padding: 0 24px; z-index: 100; gap: 16px;
}
.header-logo { display: flex; align-items: center; gap: 10px; color: #fff; font-weight: 700; font-size: 18px; text-decoration: none; }
.header-logo-mark { width: 32px; height: 32px; background: var(--blue); border-radius: 8px; display: flex; align-items: center; justify-content: center; font-size: 14px; font-weight: 800; color: #fff; }
.header-badge { background: rgba(99,91,255,0.25); color: #a5a0ff; font-size: 11px; font-weight: 600; padding: 2px 8px; border-radius: 20px; letter-spacing: 0.05em; }
.header-nav { margin-left: auto; display: flex; gap: 24px; align-items: center; }
.header-nav a { color: rgba(255,255,255,0.75); font-size: 14px; font-weight: 500; }
.header-nav a:hover { color: #fff; text-decoration: none; }
.btn-primary { background: var(--blue); color: #fff; padding: 8px 18px; border-radius: 8px; font-size: 13px; font-weight: 600; }
.hamburger { display: none; background: none; border: none; color: #fff; cursor: pointer; padding: 4px; }
.layout { display: flex; margin-top: var(--header-h); min-height: calc(100vh - var(--header-h)); }
.sidebar {
width: var(--sidebar-w); background: var(--bg-sidebar); border-right: 1px solid var(--border);
position: fixed; top: var(--header-h); bottom: 0; overflow-y: auto; padding: 24px 0;
transition: transform 0.25s ease;
}
.sidebar-section { margin-bottom: 8px; }
.sidebar-label { font-size: 11px; font-weight: 700; letter-spacing: 0.08em; color: var(--text-muted); padding: 8px 20px 4px; text-transform: uppercase; }
.sidebar-link { display: flex; align-items: center; gap: 8px; padding: 7px 20px; color: var(--text-muted); font-size: 13.5px; font-weight: 500; transition: all 0.15s; border-left: 3px solid transparent; }
.sidebar-link:hover { color: var(--navy); background: var(--blue-faint); text-decoration: none; }
.sidebar-link.active { color: var(--blue); background: var(--blue-faint); border-left-color: var(--blue); }
.sidebar-link .icon { width: 16px; height: 16px; flex-shrink: 0; opacity: 0.7; }
.main { margin-left: var(--sidebar-w); flex: 1; padding: 48px 56px; max-width: calc(860px + var(--sidebar-w)); }
.page-header { margin-bottom: 40px; }
.breadcrumb { font-size: 13px; color: var(--text-muted); margin-bottom: 12px; }
.breadcrumb a { color: var(--text-muted); }
.breadcrumb a:hover { color: var(--blue); }
h1 { font-size: 32px; font-weight: 800; color: var(--navy); margin-bottom: 12px; }
.page-desc { font-size: 16px; color: var(--text-muted); }
h2 { font-size: 20px; font-weight: 700; color: var(--navy); margin: 36px 0 12px; padding-bottom: 10px; border-bottom: 1px solid var(--border); }
h3 { font-size: 16px; font-weight: 600; color: var(--navy); margin: 20px 0 8px; }
p { color: var(--text-muted); margin-bottom: 12px; }
.code-wrap { position: relative; margin: 12px 0; }
.code-lang { position: absolute; top: 10px; right: 44px; font-size: 11px; font-weight: 600; color: rgba(255,255,255,0.4); text-transform: uppercase; letter-spacing: 0.05em; font-family: 'Inter', sans-serif; }
.copy-btn { position: absolute; top: 8px; right: 10px; background: rgba(255,255,255,0.1); border: 1px solid rgba(255,255,255,0.15); color: rgba(255,255,255,0.7); border-radius: 6px; padding: 4px 8px; font-size: 11px; cursor: pointer; font-family: 'Inter', sans-serif; font-weight: 500; transition: all 0.15s; }
.copy-btn:hover { background: rgba(255,255,255,0.2); color: #fff; }
.copy-btn.copied { color: #4ade80; border-color: #4ade80; }
pre { background: #0f1923; color: #e2e8f0; border-radius: 10px; padding: 18px 20px; overflow-x: auto; font-family: 'JetBrains Mono', monospace; font-size: 13px; line-height: 1.7; }
code { font-family: 'JetBrains Mono', monospace; }
.inline-code { background: var(--bg-code); color: #c2410c; padding: 2px 6px; border-radius: 4px; font-size: 13px; font-family: 'JetBrains Mono', monospace; }
.tok-kw { color: #c792ea; } .tok-str { color: #c3e88d; } .tok-num { color: #f78c6c; } .tok-cmt { color: #546e7a; }
.tok-url { color: #80cbc4; } .tok-key { color: #89ddff; } .tok-bool { color: #ff5572; }
.tok-method { color: #ffcb6b; font-weight: 600; } .tok-path { color: #80cbc4; }
.info-box { background: var(--blue-faint); border: 1px solid #d4d0ff; border-radius: 10px; padding: 16px 20px; display: flex; gap: 12px; margin: 20px 0; }
.info-box.warning { background: #fffbeb; border-color: #fde68a; }
.info-box.danger { background: #fff5f5; border-color: #fecaca; }
.info-box-icon { font-size: 18px; flex-shrink: 0; }
.info-box-body { font-size: 13.5px; color: var(--text); }
.info-box-body strong { color: var(--navy); }
.divider { border: none; border-top: 1px solid var(--border); margin: 40px 0; }
/* Tier table */
.tier-table { width: 100%; border-collapse: collapse; margin: 16px 0; font-size: 14px; }
.tier-table th { background: var(--navy); color: #fff; padding: 12px 16px; text-align: left; font-size: 12px; font-weight: 600; letter-spacing: 0.05em; }
.tier-table th:first-child { border-radius: 8px 0 0 0; } .tier-table th:last-child { border-radius: 0 8px 0 0; }
.tier-table td { padding: 12px 16px; border-bottom: 1px solid var(--border); color: var(--text-muted); }
.tier-table tr:hover td { background: var(--bg-sidebar); }
.tier-table tr:last-child td { border-bottom: none; }
.tier-badge { display: inline-block; padding: 2px 10px; border-radius: 20px; font-size: 11px; font-weight: 700; }
.tier-free { background: #dcfce7; color: #15803d; }
.tier-starter { background: #dbeafe; color: #1d4ed8; }
.tier-pro { background: var(--blue-faint); color: var(--blue); }
/* Error table */
.error-table { width: 100%; border-collapse: collapse; margin: 16px 0; font-size: 14px; }
.error-table th { padding: 10px 14px; text-align: left; font-size: 12px; font-weight: 600; color: var(--text-muted); border-bottom: 2px solid var(--border); }
.error-table td { padding: 12px 14px; border-bottom: 1px solid var(--border); color: var(--text-muted); vertical-align: top; }
.status-badge { display: inline-block; padding: 3px 10px; border-radius: 6px; font-family: 'JetBrains Mono', monospace; font-size: 12px; font-weight: 700; }
.s-401 { background: #fff5f5; color: #dc2626; }
.s-403 { background: #fff7ed; color: #d97706; }
.s-429 { background: #faf5ff; color: #7c3aed; }
.s-500 { background: #f1f5f9; color: #475569; }
@media (max-width: 768px) {
.sidebar { transform: translateX(-100%); z-index: 50; }
.sidebar.open { transform: translateX(0); }
.main { margin-left: 0; padding: 24px 20px; }
.hamburger { display: flex; }
.header-nav { display: none; }
.overlay { display: none; position: fixed; inset: 0; background: rgba(0,0,0,0.4); z-index: 40; }
.overlay.visible { display: block; }
}
</style>
</head>
<body>
<header class="header">
<button class="hamburger" id="hamburger" aria-label="Menu">
<svg width="22" height="22" viewBox="0 0 22 22" fill="none"><rect y="4" width="22" height="2" rx="1" fill="white"/><rect y="10" width="22" height="2" rx="1" fill="white"/><rect y="16" width="22" height="2" rx="1" fill="white"/></svg>
</button>
<a href="/docs/" class="header-logo"><div class="header-logo-mark">A</div>AAMOS</a>
<span class="header-badge">API DOCS</span>
<nav class="header-nav">
<a href="https://aamos.ai">Home</a>
<a href="/docs/">Docs</a>
<a href="https://aamos.ai/signup/" class="btn-primary">Get API Key</a>
</nav>
</header>
<div class="overlay" id="overlay"></div>
<div class="layout">
<nav class="sidebar" id="sidebar">
<div class="sidebar-section">
<div class="sidebar-label">Getting Started</div>
<a href="/docs/" class="sidebar-link">
<svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h12v2H2zm0 4h12v2H2zm0 4h8v2H2z"/></svg>Overview</a>
<a href="/docs/authentication/" class="sidebar-link active">
<svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>Authentication</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">APIs</div>
<a href="/docs/vims/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M1 3h14v2H1zm2 4h10v2H3zm2 4h6v2H5z"/></svg>VIMS</a>
<a href="/docs/reality-alerts/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1L1 14h14L8 1zm0 3l5 9H3l5-9zm-1 3v3h2V7H7zm0 4v2h2v-2H7z"/></svg>Reality Alerts</a>
<a href="/docs/kyz/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>KYZ</a>
<a href="/docs/modules/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h5v5H2zm7 0h5v5H9zm-7 7h5v5H2zm7 0h5v5H9z"/></svg>AAMOS Modules</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">Resources</div>
<a href="https://aamos.ai" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 0a8 8 0 100 16A8 8 0 008 0zm0 2a6 6 0 010 12A6 6 0 018 2zm0 2a4 4 0 100 8 4 4 0 000-8z"/></svg>Website</a>
<a href="https://aamos.ai/signup/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm5 11H3a1 1 0 00-1 1v2h14v-2a1 1 0 00-1-1z"/></svg>Sign Up</a>
</div>
</nav>
<main class="main">
<div class="page-header">
<div class="breadcrumb"><a href="/docs/">Docs</a> / Authentication</div>
<h1>Authentication</h1>
<p class="page-desc">How to authenticate requests to the AAMOS API using API keys.</p>
</div>
<h2>Getting an API Key</h2>
<p>To access the AAMOS API, you need an API key. Sign up for a free account at <a href="https://aamos.ai/signup/">aamos.ai/signup</a> and generate a key from your dashboard under <strong>Settings → API Keys</strong>.</p>
<div class="info-box">
<span class="info-box-icon">🔑</span>
<div class="info-box-body"><strong>Keep your key secret.</strong> Your API key grants full access to your account. Never include it in client-side JavaScript, public repositories, or log files.</div>
</div>
<h2>Request Format</h2>
<p>Include your API key in every request as a Bearer token in the <code class="inline-code">Authorization</code> header:</p>
<div class="code-wrap">
<span class="code-lang">http</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>Authorization: Bearer ak_live_xxxxxxxxxxxxxxxxxxxx</pre>
</div>
<p>Here's a complete example with curl:</p>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> <span class="tok-str">https://api.aamos.ai/v1/vims/objects</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-H <span class="tok-str">"Content-Type: application/json"</span></pre>
</div>
<h3>API Key format</h3>
<p>Live keys follow the format:</p>
<div class="code-wrap">
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>ak_live_[32-character alphanumeric string]</pre>
</div>
<p>Test keys (for sandbox) use:</p>
<div class="code-wrap">
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>ak_test_[32-character alphanumeric string]</pre>
</div>
<hr class="divider">
<h2>Rate Limits</h2>
<p>Rate limits are enforced per API key, per minute. Limits vary by plan:</p>
<table class="tier-table">
<thead>
<tr>
<th>Plan</th>
<th>Requests / minute</th>
<th>Requests / day</th>
<th>File uploads / day</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="tier-badge tier-free">Free</span></td>
<td>20</td>
<td>1,000</td>
<td>100</td>
</tr>
<tr>
<td><span class="tier-badge tier-starter">Starter</span></td>
<td>100</td>
<td>10,000</td>
<td>1,000</td>
</tr>
<tr>
<td><span class="tier-badge tier-pro">Pro</span></td>
<td>500</td>
<td>100,000</td>
<td>Unlimited</td>
</tr>
</tbody>
</table>
<p>Rate limit headers are included in every response:</p>
<div class="code-wrap">
<span class="code-lang">http</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>X-RateLimit-Limit: 100
X-RateLimit-Remaining: 87
X-RateLimit-Reset: 1705312800</pre>
</div>
<hr class="divider">
<h2>Error Responses</h2>
<p>Authentication and authorization errors return appropriate HTTP status codes with a JSON body:</p>
<table class="error-table">
<thead>
<tr>
<th>Status</th>
<th>Code</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="status-badge s-401">401</span></td>
<td><code class="inline-code">unauthorized</code></td>
<td>Missing or invalid API key. Check your Authorization header.</td>
</tr>
<tr>
<td><span class="status-badge s-403">403</span></td>
<td><code class="inline-code">forbidden</code></td>
<td>Your key doesn't have permission for this resource or endpoint.</td>
</tr>
<tr>
<td><span class="status-badge s-429">429</span></td>
<td><code class="inline-code">rate_limit_exceeded</code></td>
<td>You've exceeded your plan's rate limit. Wait and retry, or upgrade your plan.</td>
</tr>
<tr>
<td><span class="status-badge s-500">500</span></td>
<td><code class="inline-code">internal_error</code></td>
<td>Something went wrong on our side. Retry with exponential backoff.</td>
</tr>
</tbody>
</table>
<p>Error response body format:</p>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"error"</span>: {
<span class="tok-key">"code"</span>: <span class="tok-str">"unauthorized"</span>,
<span class="tok-key">"message"</span>: <span class="tok-str">"Invalid API key provided"</span>,
<span class="tok-key">"request_id"</span>: <span class="tok-str">"req_a1b2c3d4e5"</span>
}
}</pre>
</div>
<div class="info-box warning">
<span class="info-box-icon">⚠️</span>
<div class="info-box-body"><strong>Rate limit 429 handling:</strong> When you receive a 429, check the <code class="inline-code">Retry-After</code> header for the number of seconds to wait before retrying.</div>
</div>
<hr class="divider">
<h2>Complete Example</h2>
<p>A fully authenticated request to list VIMS objects:</p>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -s <span class="tok-str">https://api.aamos.ai/v1/vims/objects</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-H <span class="tok-str">"Accept: application/json"</span> | jq .</pre>
</div>
</main>
</div>
<script>
function copyCode(btn) {
const pre = btn.closest('.code-wrap').querySelector('pre');
navigator.clipboard.writeText(pre.innerText || pre.textContent).then(() => {
btn.textContent = 'Copied!'; btn.classList.add('copied');
setTimeout(() => { btn.textContent = 'Copy'; btn.classList.remove('copied'); }, 2000);
});
}
const hamburger = document.getElementById('hamburger');
const sidebar = document.getElementById('sidebar');
const overlay = document.getElementById('overlay');
hamburger.addEventListener('click', () => { sidebar.classList.toggle('open'); overlay.classList.toggle('visible'); });
overlay.addEventListener('click', () => { sidebar.classList.remove('open'); overlay.classList.remove('visible'); });
</script>
</body>
</html>
aamos-ai-site/docs/index.html
+411
View File
@@ -0,0 +1,411 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>AAMOS API Documentation</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root {
--navy: #0A2540;
--blue: #635BFF;
--blue-light: #7B74FF;
--blue-faint: #F0EFFF;
--text: #1a2332;
--text-muted: #5a6880;
--border: #e2e8f0;
--bg: #ffffff;
--bg-sidebar: #f8fafc;
--bg-code: #f1f5f9;
--success: #0ea472;
--warning: #f59e0b;
--danger: #ef4444;
--sidebar-w: 260px;
--header-h: 60px;
}
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
body { font-family: 'Inter', sans-serif; color: var(--text); background: var(--bg); font-size: 15px; line-height: 1.6; }
a { color: var(--blue); text-decoration: none; }
a:hover { text-decoration: underline; }
/* Header */
.header {
position: fixed; top: 0; left: 0; right: 0; height: var(--header-h);
background: var(--navy); display: flex; align-items: center;
padding: 0 24px; z-index: 100; gap: 16px;
}
.header-logo { display: flex; align-items: center; gap: 10px; color: #fff; font-weight: 700; font-size: 18px; }
.header-logo-mark {
width: 32px; height: 32px; background: var(--blue); border-radius: 8px;
display: flex; align-items: center; justify-content: center;
font-size: 14px; font-weight: 800; color: #fff;
}
.header-badge {
background: rgba(99,91,255,0.25); color: #a5a0ff;
font-size: 11px; font-weight: 600; padding: 2px 8px; border-radius: 20px; letter-spacing: 0.05em;
}
.header-nav { margin-left: auto; display: flex; gap: 24px; align-items: center; }
.header-nav a { color: rgba(255,255,255,0.75); font-size: 14px; font-weight: 500; }
.header-nav a:hover { color: #fff; text-decoration: none; }
.btn-primary {
background: var(--blue); color: #fff; padding: 8px 18px; border-radius: 8px;
font-size: 13px; font-weight: 600; border: none; cursor: pointer;
}
.hamburger { display: none; background: none; border: none; color: #fff; cursor: pointer; padding: 4px; }
/* Layout */
.layout { display: flex; margin-top: var(--header-h); min-height: calc(100vh - var(--header-h)); }
/* Sidebar */
.sidebar {
width: var(--sidebar-w); background: var(--bg-sidebar); border-right: 1px solid var(--border);
position: fixed; top: var(--header-h); bottom: 0; overflow-y: auto; padding: 24px 0;
transition: transform 0.25s ease;
}
.sidebar-section { margin-bottom: 8px; }
.sidebar-label {
font-size: 11px; font-weight: 700; letter-spacing: 0.08em; color: var(--text-muted);
padding: 8px 20px 4px; text-transform: uppercase;
}
.sidebar-link {
display: flex; align-items: center; gap: 8px; padding: 7px 20px;
color: var(--text-muted); font-size: 13.5px; font-weight: 500;
transition: all 0.15s; border-left: 3px solid transparent;
}
.sidebar-link:hover { color: var(--navy); background: var(--blue-faint); text-decoration: none; }
.sidebar-link.active { color: var(--blue); background: var(--blue-faint); border-left-color: var(--blue); }
.sidebar-link .icon { width: 16px; height: 16px; flex-shrink: 0; opacity: 0.7; }
/* Main */
.main { margin-left: var(--sidebar-w); flex: 1; padding: 48px 56px; max-width: calc(860px + var(--sidebar-w)); }
/* Hero */
.hero {
background: linear-gradient(135deg, var(--navy) 0%, #1a3a5c 100%);
border-radius: 16px; padding: 48px; margin-bottom: 48px; color: #fff;
}
.hero-eyebrow { font-size: 12px; font-weight: 700; letter-spacing: 0.1em; text-transform: uppercase; color: #a5a0ff; margin-bottom: 12px; }
.hero h1 { font-size: 36px; font-weight: 800; line-height: 1.2; margin-bottom: 16px; }
.hero p { font-size: 16px; color: rgba(255,255,255,0.75); max-width: 560px; }
.hero-base-url {
margin-top: 24px; background: rgba(0,0,0,0.3); border-radius: 10px;
padding: 14px 20px; display: inline-flex; align-items: center; gap: 12px;
font-family: 'JetBrains Mono', monospace; font-size: 14px;
}
.hero-base-url .label { font-family: 'Inter', sans-serif; color: rgba(255,255,255,0.5); font-size: 12px; }
/* Quick start */
.section-title { font-size: 22px; font-weight: 700; color: var(--navy); margin-bottom: 8px; }
.section-desc { color: var(--text-muted); margin-bottom: 28px; }
.steps { display: flex; flex-direction: column; gap: 0; }
.step {
display: flex; gap: 20px; position: relative;
padding-bottom: 32px;
}
.step:last-child { padding-bottom: 0; }
.step-num {
width: 36px; height: 36px; border-radius: 50%; background: var(--blue); color: #fff;
font-weight: 700; font-size: 14px; display: flex; align-items: center; justify-content: center;
flex-shrink: 0; position: relative; z-index: 1;
}
.step::before {
content: ''; position: absolute; left: 17px; top: 36px; bottom: 0;
width: 2px; background: var(--border);
}
.step:last-child::before { display: none; }
.step-body { flex: 1; padding-top: 6px; }
.step-body h3 { font-size: 16px; font-weight: 600; color: var(--navy); margin-bottom: 6px; }
.step-body p { color: var(--text-muted); font-size: 14px; margin-bottom: 12px; }
/* Code block */
.code-wrap { position: relative; margin: 12px 0; }
.code-lang {
position: absolute; top: 10px; right: 44px;
font-size: 11px; font-weight: 600; color: var(--text-muted); font-family: 'Inter', sans-serif;
text-transform: uppercase; letter-spacing: 0.05em;
}
.copy-btn {
position: absolute; top: 8px; right: 10px; background: rgba(255,255,255,0.1);
border: 1px solid rgba(255,255,255,0.15); color: rgba(255,255,255,0.7);
border-radius: 6px; padding: 4px 8px; font-size: 11px; cursor: pointer;
font-family: 'Inter', sans-serif; font-weight: 500; transition: all 0.15s;
}
.copy-btn:hover { background: rgba(255,255,255,0.2); color: #fff; }
.copy-btn.copied { color: #4ade80; border-color: #4ade80; }
pre {
background: #0f1923; color: #e2e8f0; border-radius: 10px;
padding: 18px 20px; overflow-x: auto; font-family: 'JetBrains Mono', monospace;
font-size: 13px; line-height: 1.7;
}
code { font-family: 'JetBrains Mono', monospace; }
.inline-code {
background: var(--bg-code); color: #c2410c; padding: 2px 6px;
border-radius: 4px; font-size: 13px; font-family: 'JetBrains Mono', monospace;
}
/* Token highlight */
.tok-kw { color: #c792ea; }
.tok-str { color: #c3e88d; }
.tok-num { color: #f78c6c; }
.tok-cmt { color: #546e7a; }
.tok-url { color: #80cbc4; }
.tok-key { color: #89ddff; }
.tok-bool { color: #ff5572; }
.tok-method { color: #ffcb6b; font-weight: 600; }
.tok-path { color: #80cbc4; }
/* API cards */
.api-grid { display: grid; grid-template-columns: repeat(auto-fill, minmax(260px, 1fr)); gap: 20px; margin-top: 8px; }
.api-card {
border: 1px solid var(--border); border-radius: 12px; padding: 24px;
transition: all 0.2s; display: block; color: inherit;
}
.api-card:hover { border-color: var(--blue); box-shadow: 0 4px 20px rgba(99,91,255,0.12); text-decoration: none; transform: translateY(-2px); }
.api-card-icon {
width: 44px; height: 44px; border-radius: 10px; background: var(--blue-faint);
display: flex; align-items: center; justify-content: center;
margin-bottom: 16px; font-size: 20px;
}
.api-card h3 { font-size: 16px; font-weight: 700; color: var(--navy); margin-bottom: 6px; }
.api-card p { font-size: 13px; color: var(--text-muted); line-height: 1.5; }
.api-card-arrow { margin-top: 16px; color: var(--blue); font-size: 13px; font-weight: 600; }
/* Divider */
.divider { border: none; border-top: 1px solid var(--border); margin: 40px 0; }
/* Auth box */
.info-box {
background: var(--blue-faint); border: 1px solid #d4d0ff; border-radius: 10px;
padding: 16px 20px; display: flex; gap: 12px; margin: 20px 0;
}
.info-box.warning { background: #fffbeb; border-color: #fde68a; }
.info-box-icon { font-size: 18px; flex-shrink: 0; }
.info-box-body { font-size: 13.5px; color: var(--text); }
.info-box-body strong { color: var(--navy); }
/* Responsive */
@media (max-width: 768px) {
.sidebar { transform: translateX(-100%); z-index: 50; }
.sidebar.open { transform: translateX(0); }
.main { margin-left: 0; padding: 24px 20px; }
.hero { padding: 28px; }
.hero h1 { font-size: 26px; }
.hamburger { display: flex; }
.api-grid { grid-template-columns: 1fr; }
.header-nav { display: none; }
.overlay { display: none; position: fixed; inset: 0; background: rgba(0,0,0,0.4); z-index: 40; }
.overlay.visible { display: block; }
}
</style>
</head>
<body>
<header class="header">
<button class="hamburger" id="hamburger" aria-label="Menu">
<svg width="22" height="22" viewBox="0 0 22 22" fill="none"><rect y="4" width="22" height="2" rx="1" fill="white"/><rect y="10" width="22" height="2" rx="1" fill="white"/><rect y="16" width="22" height="2" rx="1" fill="white"/></svg>
</button>
<a href="/docs/" class="header-logo" style="text-decoration:none">
<div class="header-logo-mark">A</div>
AAMOS
</a>
<span class="header-badge">API DOCS</span>
<nav class="header-nav">
<a href="https://aamos.ai">Home</a>
<a href="/docs/">Docs</a>
<a href="https://aamos.ai/signup/" class="btn-primary">Get API Key</a>
</nav>
</header>
<div class="overlay" id="overlay"></div>
<div class="layout">
<nav class="sidebar" id="sidebar">
<div class="sidebar-section">
<div class="sidebar-label">Getting Started</div>
<a href="/docs/" class="sidebar-link active">
<svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h12v2H2zm0 4h12v2H2zm0 4h8v2H2z"/></svg>
Overview
</a>
<a href="/docs/authentication/" class="sidebar-link">
<svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>
Authentication
</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">APIs</div>
<a href="/docs/vims/" class="sidebar-link">
<svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M1 3h14v2H1zm2 4h10v2H3zm2 4h6v2H5z"/></svg>
VIMS
</a>
<a href="/docs/reality-alerts/" class="sidebar-link">
<svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1L1 14h14L8 1zm0 3l5 9H3l5-9zm-1 3v3h2V7H7zm0 4v2h2v-2H7z"/></svg>
Reality Alerts
</a>
<a href="/docs/kyz/" class="sidebar-link">
<svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>
KYZ
</a>
<a href="/docs/modules/" class="sidebar-link">
<svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h5v5H2zm7 0h5v5H9zm-7 7h5v5H2zm7 0h5v5H9z"/></svg>
AAMOS Modules
</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">Resources</div>
<a href="https://aamos.ai" class="sidebar-link">
<svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 0a8 8 0 100 16A8 8 0 008 0zm0 2a6 6 0 010 12A6 6 0 018 2zm0 2a4 4 0 100 8 4 4 0 000-8z"/></svg>
Website
</a>
<a href="https://aamos.ai/signup/" class="sidebar-link">
<svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm5 11H3a1 1 0 00-1 1v2h14v-2a1 1 0 00-1-1z"/></svg>
Sign Up
</a>
</div>
</nav>
<main class="main">
<div class="hero">
<div class="hero-eyebrow">Developer Documentation</div>
<h1>AAMOS API Documentation</h1>
<p>Build powerful applications with real-time visual intelligence, identity verification, and situational awareness APIs.</p>
<div class="hero-base-url">
<span class="label">Base URL</span>
<span>https://api.aamos.ai/v1</span>
</div>
</div>
<section>
<h2 class="section-title">Quick Start</h2>
<p class="section-desc">Get up and running with the AAMOS API in three steps.</p>
<div class="steps">
<div class="step">
<div class="step-num">1</div>
<div class="step-body">
<h3>Get your API key</h3>
<p>Sign up at <a href="https://aamos.ai/signup/">aamos.ai/signup</a> and create an API key from your dashboard. Keys follow the format <code class="inline-code">ak_live_...</code></p>
</div>
</div>
<div class="step">
<div class="step-num">2</div>
<div class="step-body">
<h3>Make your first call</h3>
<p>Pass your key in the <code class="inline-code">Authorization</code> header on every request.</p>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> <span class="tok-str">https://api.aamos.ai/v1/vims/objects</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span></pre>
</div>
</div>
</div>
<div class="step">
<div class="step-num">3</div>
<div class="step-body">
<h3>Handle the response</h3>
<p>All endpoints return JSON. Check the <code class="inline-code">HTTP status code</code> — 2xx means success, 4xx/5xx means error.</p>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"objects"</span>: [
{
<span class="tok-key">"object_id"</span>: <span class="tok-str">"obj_abc123"</span>,
<span class="tok-key">"baseline_count"</span>: <span class="tok-num">3</span>,
<span class="tok-key">"last_analysis"</span>: <span class="tok-str">"2025-01-15T10:30:00Z"</span>
}
]
}</pre>
</div>
</div>
</div>
</div>
</section>
<hr class="divider">
<section>
<h2 class="section-title">Authentication</h2>
<p class="section-desc">All requests must include your API key in the Authorization header.</p>
<div class="info-box">
<span class="info-box-icon">🔑</span>
<div class="info-box-body"><strong>Authorization: Bearer ak_live_...</strong><br>Include this header in every API request. Keep your key secret — never expose it in client-side code.</div>
</div>
<a href="/docs/authentication/" style="font-weight:600;font-size:14px;">View full authentication docs →</a>
</section>
<hr class="divider">
<section>
<h2 class="section-title">API Reference</h2>
<p class="section-desc">Explore all available AAMOS APIs.</p>
<div class="api-grid">
<a href="/docs/vims/" class="api-card">
<div class="api-card-icon">🔍</div>
<h3>VIMS</h3>
<p>Visual Integrity Monitoring System. Detect changes, anomalies, and deviations in monitored objects using computer vision.</p>
<div class="api-card-arrow">Explore VIMS →</div>
</a>
<a href="/docs/reality-alerts/" class="api-card">
<div class="api-card-icon">🚨</div>
<h3>Reality Alerts</h3>
<p>Subscribe to real-world event streams and receive webhook notifications when conditions match your criteria.</p>
<div class="api-card-arrow">Explore Reality Alerts →</div>
</a>
<a href="/docs/kyz/" class="api-card">
<div class="api-card-icon">🪪</div>
<h3>KYZ</h3>
<p>Know Your Zone — identity verification with liveness detection, document scanning, and hosted or API flow options.</p>
<div class="api-card-arrow">Explore KYZ →</div>
</a>
<a href="/docs/modules/" class="api-card">
<div class="api-card-icon">🧩</div>
<h3>AAMOS Modules</h3>
<p>Incident management and deviation detection APIs for operational intelligence and asset monitoring workflows.</p>
<div class="api-card-arrow">Explore Modules →</div>
</a>
</div>
</section>
<hr class="divider">
<section>
<h2 class="section-title">Base URL &amp; Versioning</h2>
<p class="section-desc">The current API version is <strong>v1</strong>. All endpoints are prefixed with:</p>
<div class="code-wrap">
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>https://api.aamos.ai/v1</pre>
</div>
<div class="info-box warning" style="margin-top:20px">
<span class="info-box-icon">⚠️</span>
<div class="info-box-body"><strong>API Versioning:</strong> We will notify you before introducing breaking changes. Minor additions (new fields, new endpoints) may be added without a version bump.</div>
</div>
</section>
</main>
</div>
<script>
function copyCode(btn) {
const pre = btn.closest('.code-wrap').querySelector('pre');
const text = pre.innerText || pre.textContent;
navigator.clipboard.writeText(text).then(() => {
btn.textContent = 'Copied!';
btn.classList.add('copied');
setTimeout(() => { btn.textContent = 'Copy'; btn.classList.remove('copied'); }, 2000);
});
}
const hamburger = document.getElementById('hamburger');
const sidebar = document.getElementById('sidebar');
const overlay = document.getElementById('overlay');
hamburger.addEventListener('click', () => {
sidebar.classList.toggle('open');
overlay.classList.toggle('visible');
});
overlay.addEventListener('click', () => {
sidebar.classList.remove('open');
overlay.classList.remove('visible');
});
</script>
</body>
</html>
aamos-ai-site/docs/kyz/index.html
+318
View File
@@ -0,0 +1,318 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>KYZ API — AAMOS API Docs</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root {
--navy: #0A2540; --blue: #635BFF; --blue-faint: #F0EFFF;
--text: #1a2332; --text-muted: #5a6880; --border: #e2e8f0;
--bg: #ffffff; --bg-sidebar: #f8fafc; --bg-code: #f1f5f9;
--sidebar-w: 260px; --header-h: 60px;
}
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
body { font-family: 'Inter', sans-serif; color: var(--text); background: var(--bg); font-size: 15px; line-height: 1.6; }
a { color: var(--blue); text-decoration: none; } a:hover { text-decoration: underline; }
.header { position: fixed; top: 0; left: 0; right: 0; height: var(--header-h); background: var(--navy); display: flex; align-items: center; padding: 0 24px; z-index: 100; gap: 16px; }
.header-logo { display: flex; align-items: center; gap: 10px; color: #fff; font-weight: 700; font-size: 18px; text-decoration: none; }
.header-logo-mark { width: 32px; height: 32px; background: var(--blue); border-radius: 8px; display: flex; align-items: center; justify-content: center; font-size: 14px; font-weight: 800; color: #fff; }
.header-badge { background: rgba(99,91,255,0.25); color: #a5a0ff; font-size: 11px; font-weight: 600; padding: 2px 8px; border-radius: 20px; letter-spacing: 0.05em; }
.header-nav { margin-left: auto; display: flex; gap: 24px; align-items: center; }
.header-nav a { color: rgba(255,255,255,0.75); font-size: 14px; font-weight: 500; }
.header-nav a:hover { color: #fff; text-decoration: none; }
.btn-primary { background: var(--blue); color: #fff; padding: 8px 18px; border-radius: 8px; font-size: 13px; font-weight: 600; }
.hamburger { display: none; background: none; border: none; color: #fff; cursor: pointer; padding: 4px; }
.layout { display: flex; margin-top: var(--header-h); min-height: calc(100vh - var(--header-h)); }
.sidebar { width: var(--sidebar-w); background: var(--bg-sidebar); border-right: 1px solid var(--border); position: fixed; top: var(--header-h); bottom: 0; overflow-y: auto; padding: 24px 0; transition: transform 0.25s ease; }
.sidebar-section { margin-bottom: 8px; }
.sidebar-label { font-size: 11px; font-weight: 700; letter-spacing: 0.08em; color: var(--text-muted); padding: 8px 20px 4px; text-transform: uppercase; }
.sidebar-link { display: flex; align-items: center; gap: 8px; padding: 7px 20px; color: var(--text-muted); font-size: 13.5px; font-weight: 500; transition: all 0.15s; border-left: 3px solid transparent; }
.sidebar-link:hover { color: var(--navy); background: var(--blue-faint); text-decoration: none; }
.sidebar-link.active { color: var(--blue); background: var(--blue-faint); border-left-color: var(--blue); }
.sidebar-link .icon { width: 16px; height: 16px; flex-shrink: 0; opacity: 0.7; }
.main { margin-left: var(--sidebar-w); flex: 1; padding: 48px 56px; max-width: calc(900px + var(--sidebar-w)); }
.page-header { margin-bottom: 40px; }
.breadcrumb { font-size: 13px; color: var(--text-muted); margin-bottom: 12px; }
.breadcrumb a { color: var(--text-muted); } .breadcrumb a:hover { color: var(--blue); }
h1 { font-size: 32px; font-weight: 800; color: var(--navy); margin-bottom: 12px; }
.page-desc { font-size: 16px; color: var(--text-muted); }
h2 { font-size: 20px; font-weight: 700; color: var(--navy); margin: 40px 0 14px; padding-bottom: 10px; border-bottom: 1px solid var(--border); }
h3 { font-size: 12px; font-weight: 600; color: var(--text-muted); margin: 16px 0 8px; text-transform: uppercase; letter-spacing: 0.06em; }
p { color: var(--text-muted); margin-bottom: 12px; }
.endpoint-card { border: 1px solid var(--border); border-radius: 12px; margin: 24px 0; overflow: hidden; }
.endpoint-header { display: flex; align-items: center; gap: 12px; padding: 18px 24px; background: var(--bg-sidebar); border-bottom: 1px solid var(--border); }
.method-badge { font-family: 'JetBrains Mono', monospace; font-size: 12px; font-weight: 700; padding: 4px 12px; border-radius: 6px; }
.method-post { background: #dcfce7; color: #15803d; }
.method-get { background: #dbeafe; color: #1d4ed8; }
.endpoint-path { font-family: 'JetBrains Mono', monospace; font-size: 14px; color: var(--navy); font-weight: 500; }
.endpoint-body { padding: 24px; }
.endpoint-desc { color: var(--text-muted); font-size: 14px; margin-bottom: 20px; }
.params-table { width: 100%; border-collapse: collapse; font-size: 13.5px; margin: 8px 0 20px; }
.params-table th { text-align: left; padding: 8px 12px; font-size: 11px; font-weight: 700; letter-spacing: 0.06em; color: var(--text-muted); border-bottom: 2px solid var(--border); text-transform: uppercase; }
.params-table td { padding: 10px 12px; border-bottom: 1px solid var(--border); vertical-align: top; }
.params-table tr:last-child td { border-bottom: none; }
.param-name { font-family: 'JetBrains Mono', monospace; color: var(--navy); font-size: 13px; }
.param-type { font-family: 'JetBrains Mono', monospace; color: var(--blue); font-size: 12px; }
.param-req { display: inline-block; background: #fef3c7; color: #92400e; font-size: 10px; font-weight: 700; padding: 1px 6px; border-radius: 4px; text-transform: uppercase; }
.param-opt { display: inline-block; background: var(--bg-code); color: var(--text-muted); font-size: 10px; font-weight: 700; padding: 1px 6px; border-radius: 4px; text-transform: uppercase; }
.param-desc { color: var(--text-muted); }
.code-wrap { position: relative; margin: 12px 0; }
.code-lang { position: absolute; top: 10px; right: 44px; font-size: 11px; font-weight: 600; color: rgba(255,255,255,0.4); text-transform: uppercase; letter-spacing: 0.05em; font-family: 'Inter', sans-serif; }
.copy-btn { position: absolute; top: 8px; right: 10px; background: rgba(255,255,255,0.1); border: 1px solid rgba(255,255,255,0.15); color: rgba(255,255,255,0.7); border-radius: 6px; padding: 4px 8px; font-size: 11px; cursor: pointer; font-family: 'Inter', sans-serif; font-weight: 500; transition: all 0.15s; }
.copy-btn:hover { background: rgba(255,255,255,0.2); color: #fff; }
.copy-btn.copied { color: #4ade80; border-color: #4ade80; }
pre { background: #0f1923; color: #e2e8f0; border-radius: 10px; padding: 18px 20px; overflow-x: auto; font-family: 'JetBrains Mono', monospace; font-size: 13px; line-height: 1.7; }
code { font-family: 'JetBrains Mono', monospace; }
.inline-code { background: var(--bg-code); color: #c2410c; padding: 2px 6px; border-radius: 4px; font-size: 13px; font-family: 'JetBrains Mono', monospace; }
.tok-kw { color: #c792ea; } .tok-str { color: #c3e88d; } .tok-num { color: #f78c6c; } .tok-cmt { color: #546e7a; }
.tok-url { color: #80cbc4; } .tok-key { color: #89ddff; } .tok-bool { color: #ff5572; }
.info-box { background: var(--blue-faint); border: 1px solid #d4d0ff; border-radius: 10px; padding: 16px 20px; display: flex; gap: 12px; margin: 20px 0; }
.info-box.warning { background: #fffbeb; border-color: #fde68a; }
.info-box-icon { font-size: 18px; flex-shrink: 0; }
.info-box-body { font-size: 13.5px; color: var(--text); }
.info-box-body strong { color: var(--navy); }
/* Flow comparison */
.flow-grid { display: grid; grid-template-columns: 1fr 1fr; gap: 16px; margin: 20px 0; }
.flow-card { border: 1px solid var(--border); border-radius: 10px; padding: 20px; }
.flow-card h4 { font-size: 15px; font-weight: 700; color: var(--navy); margin-bottom: 8px; }
.flow-card p { font-size: 13px; }
.flow-tag { display: inline-block; padding: 2px 10px; border-radius: 20px; font-size: 11px; font-weight: 700; margin-bottom: 10px; }
.flow-hosted { background: var(--blue-faint); color: var(--blue); }
.flow-api { background: #dcfce7; color: #15803d; }
@media (max-width: 768px) {
.sidebar { transform: translateX(-100%); z-index: 50; }
.sidebar.open { transform: translateX(0); }
.main { margin-left: 0; padding: 24px 20px; }
.hamburger { display: flex; }
.header-nav { display: none; }
.overlay { display: none; position: fixed; inset: 0; background: rgba(0,0,0,0.4); z-index: 40; }
.overlay.visible { display: block; }
.flow-grid { grid-template-columns: 1fr; }
}
</style>
</head>
<body>
<header class="header">
<button class="hamburger" id="hamburger" aria-label="Menu">
<svg width="22" height="22" viewBox="0 0 22 22" fill="none"><rect y="4" width="22" height="2" rx="1" fill="white"/><rect y="10" width="22" height="2" rx="1" fill="white"/><rect y="16" width="22" height="2" rx="1" fill="white"/></svg>
</button>
<a href="/docs/" class="header-logo"><div class="header-logo-mark">A</div>AAMOS</a>
<span class="header-badge">API DOCS</span>
<nav class="header-nav">
<a href="https://aamos.ai">Home</a>
<a href="/docs/">Docs</a>
<a href="https://aamos.ai/signup/" class="btn-primary">Get API Key</a>
</nav>
</header>
<div class="overlay" id="overlay"></div>
<div class="layout">
<nav class="sidebar" id="sidebar">
<div class="sidebar-section">
<div class="sidebar-label">Getting Started</div>
<a href="/docs/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h12v2H2zm0 4h12v2H2zm0 4h8v2H2z"/></svg>Overview</a>
<a href="/docs/authentication/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>Authentication</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">APIs</div>
<a href="/docs/vims/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M1 3h14v2H1zm2 4h10v2H3zm2 4h6v2H5z"/></svg>VIMS</a>
<a href="/docs/reality-alerts/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1L1 14h14L8 1zm0 3l5 9H3l5-9zm-1 3v3h2V7H7zm0 4v2h2v-2H7z"/></svg>Reality Alerts</a>
<a href="/docs/kyz/" class="sidebar-link active"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>KYZ</a>
<a href="/docs/modules/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h5v5H2zm7 0h5v5H9zm-7 7h5v5H2zm7 0h5v5H9z"/></svg>AAMOS Modules</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">On this page</div>
<a href="#flows" class="sidebar-link" style="font-size:12.5px">Verification Flows</a>
<a href="#create-session" class="sidebar-link" style="font-size:12.5px">Create Session</a>
<a href="#get-session" class="sidebar-link" style="font-size:12.5px">Get Session</a>
<a href="#submit" class="sidebar-link" style="font-size:12.5px">Submit Documents</a>
</div>
</nav>
<main class="main">
<div class="page-header">
<div class="breadcrumb"><a href="/docs/">Docs</a> / KYZ API</div>
<h1>KYZ API Reference</h1>
<p class="page-desc">Know Your Zone — identity verification with liveness detection, document scanning, and flexible hosted or API-native flows.</p>
</div>
<div class="info-box">
<span class="info-box-icon">📍</span>
<div class="info-box-body"><strong>Base path:</strong> <code class="inline-code">https://api.aamos.ai/v1/kyz/</code></div>
</div>
<h2 id="flows">Verification Flows</h2>
<p>KYZ supports two verification flows. Choose based on your integration needs:</p>
<div class="flow-grid">
<div class="flow-card">
<span class="flow-tag flow-hosted">Hosted</span>
<h4>Hosted Flow</h4>
<p>Redirect your user to a AAMOS-hosted verification page. No frontend work required. Best for quick integration and compliance.</p>
</div>
<div class="flow-card">
<span class="flow-tag flow-api">API Flow</span>
<h4>API Flow</h4>
<p>Submit documents and selfies programmatically via multipart upload. Full control over UX. Best for custom verification experiences.</p>
</div>
</div>
<h2 id="create-session">POST /v1/kyz/sessions</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-post">POST</span>
<span class="endpoint-path">/v1/kyz/sessions</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Create a new verification session. Returns a session ID and, for hosted flow, a URL to redirect the user to.</p>
<h3>Request — application/json</h3>
<table class="params-table">
<thead><tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">user_ref</td><td class="param-type">string</td><td><span class="param-req">Required</span></td><td class="param-desc">Your internal user identifier. Used to correlate results back to your system.</td></tr>
<tr><td class="param-name">flow</td><td class="param-type">string</td><td><span class="param-req">Required</span></td><td class="param-desc">Verification flow: <code class="inline-code">hosted</code> or <code class="inline-code">api</code>.</td></tr>
<tr><td class="param-name">redirect_url</td><td class="param-type">string</td><td><span class="param-opt">Optional</span></td><td class="param-desc">Where to redirect after hosted flow completes. Required when flow=hosted.</td></tr>
<tr><td class="param-name">webhook_url</td><td class="param-type">string</td><td><span class="param-opt">Optional</span></td><td class="param-desc">Receive a POST notification when verification is complete.</td></tr>
</tbody>
</table>
<h3>Example — Hosted Flow</h3>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X POST <span class="tok-str">https://api.aamos.ai/v1/kyz/sessions</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-H <span class="tok-str">"Content-Type: application/json"</span> \
-d <span class="tok-str">'{
"user_ref": "user_123456",
"flow": "hosted",
"redirect_url": "https://your-app.example.com/verification-complete",
"webhook_url": "https://your-app.example.com/hooks/kyz"
}'</span></pre>
</div>
<h3>Response — 201 Created</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"session_id"</span>: <span class="tok-str">"kyz_5e2a8f1c7d"</span>,
<span class="tok-key">"hosted_url"</span>: <span class="tok-str">"https://verify.aamos.ai/kyz_5e2a8f1c7d"</span>,
<span class="tok-key">"expires_at"</span>: <span class="tok-str">"2025-01-15T11:00:00Z"</span>
}</pre>
</div>
<p>For hosted flow, redirect the user to <code class="inline-code">hosted_url</code>. The session expires after 30 minutes.</p>
</div>
</div>
<h2 id="get-session">GET /v1/kyz/sessions/:session_id</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-get">GET</span>
<span class="endpoint-path">/v1/kyz/sessions/:session_id</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Retrieve the current status and result of a verification session.</p>
<h3>Path Parameters</h3>
<table class="params-table">
<thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">session_id</td><td class="param-type">string</td><td class="param-desc">The session ID returned by POST /v1/kyz/sessions.</td></tr>
</tbody>
</table>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> <span class="tok-str">https://api.aamos.ai/v1/kyz/sessions/kyz_5e2a8f1c7d</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span></pre>
</div>
<h3>Response — 200 OK</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"session_id"</span>: <span class="tok-str">"kyz_5e2a8f1c7d"</span>,
<span class="tok-key">"status"</span>: <span class="tok-str">"approved"</span>,
<span class="tok-key">"decision"</span>: <span class="tok-str">"approved"</span>,
<span class="tok-key">"confidence"</span>: <span class="tok-num">0.97</span>,
<span class="tok-key">"liveness"</span>: <span class="tok-bool">true</span>,
<span class="tok-key">"document_country"</span>: <span class="tok-str">"SE"</span>,
<span class="tok-key">"document_type"</span>: <span class="tok-str">"passport"</span>,
<span class="tok-key">"completed_at"</span>: <span class="tok-str">"2025-01-15T10:45:00Z"</span>
}</pre>
</div>
<h3>Session Status Values</h3>
<table class="params-table">
<thead><tr><th>Status</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">pending</td><td class="param-desc">Session created, awaiting user action.</td></tr>
<tr><td class="param-name">in_progress</td><td class="param-desc">User has started verification.</td></tr>
<tr><td class="param-name">processing</td><td class="param-desc">Documents submitted, verification in progress.</td></tr>
<tr><td class="param-name">approved</td><td class="param-desc">Verification successful.</td></tr>
<tr><td class="param-name">rejected</td><td class="param-desc">Verification failed — document invalid, liveness failure, or fraud signal.</td></tr>
<tr><td class="param-name">expired</td><td class="param-desc">Session expired before completion.</td></tr>
</tbody>
</table>
</div>
</div>
<h2 id="submit">POST /v1/kyz/sessions/:session_id/submit</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-post">POST</span>
<span class="endpoint-path">/v1/kyz/sessions/:session_id/submit</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Submit identity documents and selfie for API-flow verification. Only available when the session was created with <code class="inline-code">flow: "api"</code>.</p>
<div class="info-box warning">
<span class="info-box-icon">⚠️</span>
<div class="info-box-body"><strong>API flow only.</strong> This endpoint returns <code class="inline-code">403 Forbidden</code> for sessions created with <code class="inline-code">flow: "hosted"</code>.</div>
</div>
<h3>Request — multipart/form-data</h3>
<table class="params-table">
<thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">id_front</td><td class="param-type">file</td><td><span class="param-req">Required</span></td><td class="param-desc">Front of the identity document. JPEG or PNG. Max 10 MB.</td></tr>
<tr><td class="param-name">id_back</td><td class="param-type">file</td><td><span class="param-opt">Optional</span></td><td class="param-desc">Back of the identity document. Required for most national ID cards.</td></tr>
<tr><td class="param-name">selfie</td><td class="param-type">file</td><td><span class="param-req">Required</span></td><td class="param-desc">Live selfie photo for liveness and biometric matching. JPEG or PNG.</td></tr>
</tbody>
</table>
<h3>Example Request</h3>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X POST <span class="tok-str">https://api.aamos.ai/v1/kyz/sessions/kyz_5e2a8f1c7d/submit</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-F <span class="tok-str">"id_front=@/path/to/passport_front.jpg"</span> \
-F <span class="tok-str">"id_back=@/path/to/passport_back.jpg"</span> \
-F <span class="tok-str">"selfie=@/path/to/selfie.jpg"</span></pre>
</div>
<h3>Response — 202 Accepted</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"session_id"</span>: <span class="tok-str">"kyz_5e2a8f1c7d"</span>,
<span class="tok-key">"status"</span>: <span class="tok-str">"processing"</span>,
<span class="tok-key">"message"</span>: <span class="tok-str">"Documents received. Verification will complete in 10-30 seconds."</span>
}</pre>
</div>
<p>Poll <code class="inline-code">GET /v1/kyz/sessions/:session_id</code> or wait for your webhook to receive the final result.</p>
</div>
</div>
</main>
</div>
<script>
function copyCode(btn) {
const pre = btn.closest('.code-wrap').querySelector('pre');
navigator.clipboard.writeText(pre.innerText || pre.textContent).then(() => {
btn.textContent = 'Copied!'; btn.classList.add('copied');
setTimeout(() => { btn.textContent = 'Copy'; btn.classList.remove('copied'); }, 2000);
});
}
const hamburger = document.getElementById('hamburger');
const sidebar = document.getElementById('sidebar');
const overlay = document.getElementById('overlay');
hamburger.addEventListener('click', () => { sidebar.classList.toggle('open'); overlay.classList.toggle('visible'); });
overlay.addEventListener('click', () => { sidebar.classList.remove('open'); overlay.classList.remove('visible'); });
</script>
</body>
</html>
aamos-ai-site/docs/modules/index.html
+428
View File
@@ -0,0 +1,428 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>AAMOS Modules — API Docs</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root {
--navy: #0A2540; --blue: #635BFF; --blue-faint: #F0EFFF;
--text: #1a2332; --text-muted: #5a6880; --border: #e2e8f0;
--bg: #ffffff; --bg-sidebar: #f8fafc; --bg-code: #f1f5f9;
--sidebar-w: 260px; --header-h: 60px;
}
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
body { font-family: 'Inter', sans-serif; color: var(--text); background: var(--bg); font-size: 15px; line-height: 1.6; }
a { color: var(--blue); text-decoration: none; } a:hover { text-decoration: underline; }
.header { position: fixed; top: 0; left: 0; right: 0; height: var(--header-h); background: var(--navy); display: flex; align-items: center; padding: 0 24px; z-index: 100; gap: 16px; }
.header-logo { display: flex; align-items: center; gap: 10px; color: #fff; font-weight: 700; font-size: 18px; text-decoration: none; }
.header-logo-mark { width: 32px; height: 32px; background: var(--blue); border-radius: 8px; display: flex; align-items: center; justify-content: center; font-size: 14px; font-weight: 800; color: #fff; }
.header-badge { background: rgba(99,91,255,0.25); color: #a5a0ff; font-size: 11px; font-weight: 600; padding: 2px 8px; border-radius: 20px; letter-spacing: 0.05em; }
.header-nav { margin-left: auto; display: flex; gap: 24px; align-items: center; }
.header-nav a { color: rgba(255,255,255,0.75); font-size: 14px; font-weight: 500; }
.header-nav a:hover { color: #fff; text-decoration: none; }
.btn-primary { background: var(--blue); color: #fff; padding: 8px 18px; border-radius: 8px; font-size: 13px; font-weight: 600; }
.hamburger { display: none; background: none; border: none; color: #fff; cursor: pointer; padding: 4px; }
.layout { display: flex; margin-top: var(--header-h); min-height: calc(100vh - var(--header-h)); }
.sidebar { width: var(--sidebar-w); background: var(--bg-sidebar); border-right: 1px solid var(--border); position: fixed; top: var(--header-h); bottom: 0; overflow-y: auto; padding: 24px 0; transition: transform 0.25s ease; }
.sidebar-section { margin-bottom: 8px; }
.sidebar-label { font-size: 11px; font-weight: 700; letter-spacing: 0.08em; color: var(--text-muted); padding: 8px 20px 4px; text-transform: uppercase; }
.sidebar-link { display: flex; align-items: center; gap: 8px; padding: 7px 20px; color: var(--text-muted); font-size: 13.5px; font-weight: 500; transition: all 0.15s; border-left: 3px solid transparent; }
.sidebar-link:hover { color: var(--navy); background: var(--blue-faint); text-decoration: none; }
.sidebar-link.active { color: var(--blue); background: var(--blue-faint); border-left-color: var(--blue); }
.sidebar-link .icon { width: 16px; height: 16px; flex-shrink: 0; opacity: 0.7; }
.sidebar-indent { padding-left: 36px !important; font-size: 12.5px !important; }
.main { margin-left: var(--sidebar-w); flex: 1; padding: 48px 56px; max-width: calc(900px + var(--sidebar-w)); }
.page-header { margin-bottom: 40px; }
.breadcrumb { font-size: 13px; color: var(--text-muted); margin-bottom: 12px; }
.breadcrumb a { color: var(--text-muted); } .breadcrumb a:hover { color: var(--blue); }
h1 { font-size: 32px; font-weight: 800; color: var(--navy); margin-bottom: 12px; }
.page-desc { font-size: 16px; color: var(--text-muted); }
h2 { font-size: 22px; font-weight: 800; color: var(--navy); margin: 48px 0 6px; }
.module-divider { border: none; height: 3px; background: linear-gradient(90deg, var(--blue), transparent); border-radius: 4px; margin: 0 0 24px; }
h3 { font-size: 12px; font-weight: 600; color: var(--text-muted); margin: 16px 0 8px; text-transform: uppercase; letter-spacing: 0.06em; }
p { color: var(--text-muted); margin-bottom: 12px; }
.endpoint-card { border: 1px solid var(--border); border-radius: 12px; margin: 20px 0; overflow: hidden; }
.endpoint-header { display: flex; align-items: center; gap: 12px; padding: 18px 24px; background: var(--bg-sidebar); border-bottom: 1px solid var(--border); }
.method-badge { font-family: 'JetBrains Mono', monospace; font-size: 12px; font-weight: 700; padding: 4px 12px; border-radius: 6px; }
.method-post { background: #dcfce7; color: #15803d; }
.method-get { background: #dbeafe; color: #1d4ed8; }
.method-put { background: #fff7ed; color: #d97706; }
.endpoint-path { font-family: 'JetBrains Mono', monospace; font-size: 14px; color: var(--navy); font-weight: 500; }
.endpoint-body { padding: 24px; }
.endpoint-desc { color: var(--text-muted); font-size: 14px; margin-bottom: 20px; }
.params-table { width: 100%; border-collapse: collapse; font-size: 13.5px; margin: 8px 0 20px; }
.params-table th { text-align: left; padding: 8px 12px; font-size: 11px; font-weight: 700; letter-spacing: 0.06em; color: var(--text-muted); border-bottom: 2px solid var(--border); text-transform: uppercase; }
.params-table td { padding: 10px 12px; border-bottom: 1px solid var(--border); vertical-align: top; }
.params-table tr:last-child td { border-bottom: none; }
.param-name { font-family: 'JetBrains Mono', monospace; color: var(--navy); font-size: 13px; }
.param-type { font-family: 'JetBrains Mono', monospace; color: var(--blue); font-size: 12px; }
.param-req { display: inline-block; background: #fef3c7; color: #92400e; font-size: 10px; font-weight: 700; padding: 1px 6px; border-radius: 4px; text-transform: uppercase; }
.param-opt { display: inline-block; background: var(--bg-code); color: var(--text-muted); font-size: 10px; font-weight: 700; padding: 1px 6px; border-radius: 4px; text-transform: uppercase; }
.param-desc { color: var(--text-muted); }
.code-wrap { position: relative; margin: 12px 0; }
.code-lang { position: absolute; top: 10px; right: 44px; font-size: 11px; font-weight: 600; color: rgba(255,255,255,0.4); text-transform: uppercase; letter-spacing: 0.05em; font-family: 'Inter', sans-serif; }
.copy-btn { position: absolute; top: 8px; right: 10px; background: rgba(255,255,255,0.1); border: 1px solid rgba(255,255,255,0.15); color: rgba(255,255,255,0.7); border-radius: 6px; padding: 4px 8px; font-size: 11px; cursor: pointer; font-family: 'Inter', sans-serif; font-weight: 500; transition: all 0.15s; }
.copy-btn:hover { background: rgba(255,255,255,0.2); color: #fff; }
.copy-btn.copied { color: #4ade80; border-color: #4ade80; }
pre { background: #0f1923; color: #e2e8f0; border-radius: 10px; padding: 18px 20px; overflow-x: auto; font-family: 'JetBrains Mono', monospace; font-size: 13px; line-height: 1.7; }
code { font-family: 'JetBrains Mono', monospace; }
.inline-code { background: var(--bg-code); color: #c2410c; padding: 2px 6px; border-radius: 4px; font-size: 13px; font-family: 'JetBrains Mono', monospace; }
.tok-kw { color: #c792ea; } .tok-str { color: #c3e88d; } .tok-num { color: #f78c6c; } .tok-cmt { color: #546e7a; }
.tok-url { color: #80cbc4; } .tok-key { color: #89ddff; } .tok-bool { color: #ff5572; }
.info-box { background: var(--blue-faint); border: 1px solid #d4d0ff; border-radius: 10px; padding: 16px 20px; display: flex; gap: 12px; margin: 20px 0; }
.info-box-icon { font-size: 18px; flex-shrink: 0; }
.info-box-body { font-size: 13.5px; color: var(--text); }
.info-box-body strong { color: var(--navy); }
@media (max-width: 768px) {
.sidebar { transform: translateX(-100%); z-index: 50; }
.sidebar.open { transform: translateX(0); }
.main { margin-left: 0; padding: 24px 20px; }
.hamburger { display: flex; }
.header-nav { display: none; }
.overlay { display: none; position: fixed; inset: 0; background: rgba(0,0,0,0.4); z-index: 40; }
.overlay.visible { display: block; }
}
</style>
</head>
<body>
<header class="header">
<button class="hamburger" id="hamburger" aria-label="Menu">
<svg width="22" height="22" viewBox="0 0 22 22" fill="none"><rect y="4" width="22" height="2" rx="1" fill="white"/><rect y="10" width="22" height="2" rx="1" fill="white"/><rect y="16" width="22" height="2" rx="1" fill="white"/></svg>
</button>
<a href="/docs/" class="header-logo"><div class="header-logo-mark">A</div>AAMOS</a>
<span class="header-badge">API DOCS</span>
<nav class="header-nav">
<a href="https://aamos.ai">Home</a>
<a href="/docs/">Docs</a>
<a href="https://aamos.ai/signup/" class="btn-primary">Get API Key</a>
</nav>
</header>
<div class="overlay" id="overlay"></div>
<div class="layout">
<nav class="sidebar" id="sidebar">
<div class="sidebar-section">
<div class="sidebar-label">Getting Started</div>
<a href="/docs/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h12v2H2zm0 4h12v2H2zm0 4h8v2H2z"/></svg>Overview</a>
<a href="/docs/authentication/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>Authentication</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">APIs</div>
<a href="/docs/vims/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M1 3h14v2H1zm2 4h10v2H3zm2 4h6v2H5z"/></svg>VIMS</a>
<a href="/docs/reality-alerts/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1L1 14h14L8 1zm0 3l5 9H3l5-9zm-1 3v3h2V7H7zm0 4v2h2v-2H7z"/></svg>Reality Alerts</a>
<a href="/docs/kyz/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>KYZ</a>
<a href="/docs/modules/" class="sidebar-link active"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h5v5H2zm7 0h5v5H9zm-7 7h5v5H2zm7 0h5v5H9z"/></svg>AAMOS Modules</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">On this page</div>
<a href="#incident" class="sidebar-link" style="font-size:12.5px">Incident API</a>
<a href="#incident-create" class="sidebar-link sidebar-indent">Create Incident</a>
<a href="#incident-list" class="sidebar-link sidebar-indent">List Incidents</a>
<a href="#incident-status" class="sidebar-link sidebar-indent">Update Status</a>
<a href="#incident-comment" class="sidebar-link sidebar-indent">Add Comment</a>
<a href="#deviation" class="sidebar-link" style="font-size:12.5px">Deviation API</a>
<a href="#deviation-compare" class="sidebar-link sidebar-indent">Compare</a>
<a href="#deviation-baseline" class="sidebar-link sidebar-indent">Set Baseline</a>
</div>
</nav>
<main class="main">
<div class="page-header">
<div class="breadcrumb"><a href="/docs/">Docs</a> / AAMOS Modules</div>
<h1>AAMOS Modules Reference</h1>
<p class="page-desc">Incident management and deviation detection APIs for operational intelligence and asset monitoring workflows.</p>
</div>
<!-- INCIDENT API -->
<h2 id="incident">Incident API</h2>
<div class="module-divider"></div>
<div class="info-box">
<span class="info-box-icon">🚨</span>
<div class="info-box-body"><strong>Base path:</strong> <code class="inline-code">https://api.aamos.ai/v1/incident/</code> — Manage operational incidents with full lifecycle tracking, SLA enforcement, and team workflows.</div>
</div>
<div class="endpoint-card" id="incident-create">
<div class="endpoint-header">
<span class="method-badge method-post">POST</span>
<span class="endpoint-path">/v1/incident/incidents</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Create a new incident. The system automatically assigns an SLA deadline based on priority level.</p>
<h3>Request — application/json</h3>
<table class="params-table">
<thead><tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">title</td><td class="param-type">string</td><td><span class="param-req">Required</span></td><td class="param-desc">Short, descriptive title for the incident.</td></tr>
<tr><td class="param-name">priority</td><td class="param-type">string</td><td><span class="param-req">Required</span></td><td class="param-desc">One of: <code class="inline-code">critical</code>, <code class="inline-code">high</code>, <code class="inline-code">medium</code>, <code class="inline-code">low</code>.</td></tr>
<tr><td class="param-name">source</td><td class="param-type">string</td><td><span class="param-req">Required</span></td><td class="param-desc">Origin system or sensor that triggered the incident (e.g. <code class="inline-code">vims</code>, <code class="inline-code">reality-alerts</code>, <code class="inline-code">manual</code>).</td></tr>
<tr><td class="param-name">assignee_group</td><td class="param-type">string</td><td><span class="param-opt">Optional</span></td><td class="param-desc">Team or group responsible for resolution.</td></tr>
<tr><td class="param-name">description</td><td class="param-type">string</td><td><span class="param-opt">Optional</span></td><td class="param-desc">Detailed description of the incident.</td></tr>
</tbody>
</table>
<h3>Example Request</h3>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X POST <span class="tok-str">https://api.aamos.ai/v1/incident/incidents</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-H <span class="tok-str">"Content-Type: application/json"</span> \
-d <span class="tok-str">'{
"title": "Unauthorized access detected at Site A",
"priority": "high",
"source": "vims",
"assignee_group": "security-ops",
"description": "VIMS analysis detected structural change at front gate. Change score: 0.74."
}'</span></pre>
</div>
<h3>Response — 201 Created</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"incident_id"</span>: <span class="tok-str">"inc_4b7e2f9a1c"</span>,
<span class="tok-key">"status"</span>: <span class="tok-str">"open"</span>,
<span class="tok-key">"priority"</span>: <span class="tok-str">"high"</span>,
<span class="tok-key">"sla_deadline"</span>: <span class="tok-str">"2025-01-15T14:30:00Z"</span>,
<span class="tok-key">"created_at"</span>: <span class="tok-str">"2025-01-15T10:30:00Z"</span>
}</pre>
</div>
</div>
</div>
<div class="endpoint-card" id="incident-list">
<div class="endpoint-header">
<span class="method-badge method-get">GET</span>
<span class="endpoint-path">/v1/incident/incidents</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">List incidents with optional filtering by status, priority, and pagination.</p>
<h3>Query Parameters</h3>
<table class="params-table">
<thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">status</td><td class="param-type">string</td><td class="param-desc">Filter: <code class="inline-code">open</code>, <code class="inline-code">investigating</code>, <code class="inline-code">resolved</code>, <code class="inline-code">closed</code>.</td></tr>
<tr><td class="param-name">priority</td><td class="param-type">string</td><td class="param-desc">Filter: <code class="inline-code">critical</code>, <code class="inline-code">high</code>, <code class="inline-code">medium</code>, <code class="inline-code">low</code>.</td></tr>
<tr><td class="param-name">page</td><td class="param-type">integer</td><td class="param-desc">Page number (default: 1). 50 results per page.</td></tr>
</tbody>
</table>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> <span class="tok-str">"https://api.aamos.ai/v1/incident/incidents?status=open&priority=high"</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span></pre>
</div>
<h3>Response — 200 OK</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"incidents"</span>: [
{
<span class="tok-key">"incident_id"</span>: <span class="tok-str">"inc_4b7e2f9a1c"</span>,
<span class="tok-key">"title"</span>: <span class="tok-str">"Unauthorized access detected at Site A"</span>,
<span class="tok-key">"status"</span>: <span class="tok-str">"open"</span>,
<span class="tok-key">"priority"</span>: <span class="tok-str">"high"</span>,
<span class="tok-key">"sla_deadline"</span>: <span class="tok-str">"2025-01-15T14:30:00Z"</span>,
<span class="tok-key">"created_at"</span>: <span class="tok-str">"2025-01-15T10:30:00Z"</span>
}
],
<span class="tok-key">"total"</span>: <span class="tok-num">1</span>,
<span class="tok-key">"page"</span>: <span class="tok-num">1</span>
}</pre>
</div>
</div>
</div>
<div class="endpoint-card" id="incident-status">
<div class="endpoint-header">
<span class="method-badge method-put">PUT</span>
<span class="endpoint-path">/v1/incident/incidents/:id/status</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Update the status of an incident through its lifecycle.</p>
<h3>Request — application/json</h3>
<table class="params-table">
<thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">status</td><td class="param-type">string</td><td class="param-desc">New status: <code class="inline-code">open</code> → <code class="inline-code">investigating</code> → <code class="inline-code">resolved</code> → <code class="inline-code">closed</code>.</td></tr>
</tbody>
</table>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X PUT <span class="tok-str">https://api.aamos.ai/v1/incident/incidents/inc_4b7e2f9a1c/status</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-H <span class="tok-str">"Content-Type: application/json"</span> \
-d <span class="tok-str">'{ "status": "investigating" }'</span></pre>
</div>
<h3>Response — 200 OK</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"incident_id"</span>: <span class="tok-str">"inc_4b7e2f9a1c"</span>,
<span class="tok-key">"status"</span>: <span class="tok-str">"investigating"</span>,
<span class="tok-key">"updated_at"</span>: <span class="tok-str">"2025-01-15T11:15:00Z"</span>
}</pre>
</div>
</div>
</div>
<div class="endpoint-card" id="incident-comment">
<div class="endpoint-header">
<span class="method-badge method-post">POST</span>
<span class="endpoint-path">/v1/incident/incidents/:id/comments</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Add a comment to an incident for audit trail and team communication.</p>
<h3>Request — application/json</h3>
<table class="params-table">
<thead><tr><th>Field</th><th>Type</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">text</td><td class="param-type">string</td><td class="param-desc">The comment text. Markdown supported.</td></tr>
</tbody>
</table>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X POST <span class="tok-str">https://api.aamos.ai/v1/incident/incidents/inc_4b7e2f9a1c/comments</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-H <span class="tok-str">"Content-Type: application/json"</span> \
-d <span class="tok-str">'{ "text": "On-site team dispatched. ETA 20 minutes." }'</span></pre>
</div>
<h3>Response — 201 Created</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"comment_id"</span>: <span class="tok-str">"cmt_2e8a5f1b3d"</span>,
<span class="tok-key">"incident_id"</span>: <span class="tok-str">"inc_4b7e2f9a1c"</span>,
<span class="tok-key">"text"</span>: <span class="tok-str">"On-site team dispatched. ETA 20 minutes."</span>,
<span class="tok-key">"created_at"</span>: <span class="tok-str">"2025-01-15T11:20:00Z"</span>
}</pre>
</div>
</div>
</div>
<!-- DEVIATION API -->
<h2 id="deviation" style="margin-top: 60px">Deviation API</h2>
<div class="module-divider"></div>
<div class="info-box">
<span class="info-box-icon">📐</span>
<div class="info-box-body"><strong>Base path:</strong> <code class="inline-code">https://api.aamos.ai/v1/deviation/</code> — Detect visual deviations in assets against registered baselines, with configurable thresholds and region-level analysis.</div>
</div>
<div class="endpoint-card" id="deviation-compare">
<div class="endpoint-header">
<span class="method-badge method-post">POST</span>
<span class="endpoint-path">/v1/deviation/compare</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Compare an image against the registered baseline for an asset. Returns a deviation score, change classification, and actionable recommendation.</p>
<h3>Request — multipart/form-data</h3>
<table class="params-table">
<thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">image</td><td class="param-type">file</td><td><span class="param-req">Required</span></td><td class="param-desc">Current image of the asset. JPEG, PNG, or WebP. Max 10 MB.</td></tr>
<tr><td class="param-name">asset_id</td><td class="param-type">string</td><td><span class="param-req">Required</span></td><td class="param-desc">Your unique identifier for the asset being compared.</td></tr>
<tr><td class="param-name">threshold</td><td class="param-type">float</td><td><span class="param-opt">Optional</span></td><td class="param-desc">Deviation threshold (0.0–1.0) above which changes are flagged. Default: <code class="inline-code">0.3</code>.</td></tr>
</tbody>
</table>
<h3>Example Request</h3>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X POST <span class="tok-str">https://api.aamos.ai/v1/deviation/compare</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-F <span class="tok-str">"image=@/path/to/asset_current.jpg"</span> \
-F <span class="tok-str">"asset_id=rack-server-b2"</span> \
-F <span class="tok-str">"threshold=0.25"</span></pre>
</div>
<h3>Response — 200 OK</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"asset_id"</span>: <span class="tok-str">"rack-server-b2"</span>,
<span class="tok-key">"deviation_score"</span>: <span class="tok-num">0.42</span>,
<span class="tok-key">"change_type"</span>: <span class="tok-str">"component_removal"</span>,
<span class="tok-key">"regions"</span>: [
{
<span class="tok-key">"bbox"</span>: [<span class="tok-num">200</span>, <span class="tok-num">150</span>, <span class="tok-num">450</span>, <span class="tok-num">320</span>],
<span class="tok-key">"deviation"</span>: <span class="tok-num">0.61</span>,
<span class="tok-key">"label"</span>: <span class="tok-str">"Missing hardware component (slot 4)"</span>
}
],
<span class="tok-key">"recommend_action"</span>: <span class="tok-str">"immediate_review"</span>,
<span class="tok-key">"analyzed_at"</span>: <span class="tok-str">"2025-01-15T10:30:00Z"</span>
}</pre>
</div>
<h3>Recommended Actions</h3>
<table class="params-table">
<thead><tr><th>Value</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">none</td><td class="param-desc">No action needed. Deviation within expected range.</td></tr>
<tr><td class="param-name">monitor</td><td class="param-desc">Minor deviation detected. Continue monitoring.</td></tr>
<tr><td class="param-name">review</td><td class="param-desc">Deviation above threshold. Schedule a review.</td></tr>
<tr><td class="param-name">immediate_review</td><td class="param-desc">Significant deviation. Requires immediate attention.</td></tr>
</tbody>
</table>
</div>
</div>
<div class="endpoint-card" id="deviation-baseline">
<div class="endpoint-header">
<span class="method-badge method-post">POST</span>
<span class="endpoint-path">/v1/deviation/baseline</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Register or update the baseline image for an asset. The baseline is the reference state used for all future comparisons.</p>
<h3>Request — multipart/form-data</h3>
<table class="params-table">
<thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">asset_id</td><td class="param-type">string</td><td><span class="param-req">Required</span></td><td class="param-desc">Your unique identifier for the asset. Created if new.</td></tr>
<tr><td class="param-name">image</td><td class="param-type">file</td><td><span class="param-req">Required</span></td><td class="param-desc">The reference (baseline) image. JPEG, PNG, or WebP.</td></tr>
</tbody>
</table>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X POST <span class="tok-str">https://api.aamos.ai/v1/deviation/baseline</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-F <span class="tok-str">"asset_id=rack-server-b2"</span> \
-F <span class="tok-str">"image=@/path/to/rack_baseline.jpg"</span></pre>
</div>
<h3>Response — 201 Created</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"baseline_id"</span>: <span class="tok-str">"dbl_6f3c8e2a9d"</span>,
<span class="tok-key">"asset_id"</span>: <span class="tok-str">"rack-server-b2"</span>,
<span class="tok-key">"created_at"</span>: <span class="tok-str">"2025-01-15T09:00:00Z"</span>
}</pre>
</div>
</div>
</div>
</main>
</div>
<script>
function copyCode(btn) {
const pre = btn.closest('.code-wrap').querySelector('pre');
navigator.clipboard.writeText(pre.innerText || pre.textContent).then(() => {
btn.textContent = 'Copied!'; btn.classList.add('copied');
setTimeout(() => { btn.textContent = 'Copy'; btn.classList.remove('copied'); }, 2000);
});
}
const hamburger = document.getElementById('hamburger');
const sidebar = document.getElementById('sidebar');
const overlay = document.getElementById('overlay');
hamburger.addEventListener('click', () => { sidebar.classList.toggle('open'); overlay.classList.toggle('visible'); });
overlay.addEventListener('click', () => { sidebar.classList.remove('open'); overlay.classList.remove('visible'); });
</script>
</body>
</html>
aamos-ai-site/docs/reality-alerts/index.html
+373
View File
@@ -0,0 +1,373 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Reality Alerts API — AAMOS API Docs</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root {
--navy: #0A2540; --blue: #635BFF; --blue-faint: #F0EFFF;
--text: #1a2332; --text-muted: #5a6880; --border: #e2e8f0;
--bg: #ffffff; --bg-sidebar: #f8fafc; --bg-code: #f1f5f9;
--sidebar-w: 260px; --header-h: 60px;
}
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
body { font-family: 'Inter', sans-serif; color: var(--text); background: var(--bg); font-size: 15px; line-height: 1.6; }
a { color: var(--blue); text-decoration: none; } a:hover { text-decoration: underline; }
.header { position: fixed; top: 0; left: 0; right: 0; height: var(--header-h); background: var(--navy); display: flex; align-items: center; padding: 0 24px; z-index: 100; gap: 16px; }
.header-logo { display: flex; align-items: center; gap: 10px; color: #fff; font-weight: 700; font-size: 18px; text-decoration: none; }
.header-logo-mark { width: 32px; height: 32px; background: var(--blue); border-radius: 8px; display: flex; align-items: center; justify-content: center; font-size: 14px; font-weight: 800; color: #fff; }
.header-badge { background: rgba(99,91,255,0.25); color: #a5a0ff; font-size: 11px; font-weight: 600; padding: 2px 8px; border-radius: 20px; letter-spacing: 0.05em; }
.header-nav { margin-left: auto; display: flex; gap: 24px; align-items: center; }
.header-nav a { color: rgba(255,255,255,0.75); font-size: 14px; font-weight: 500; }
.header-nav a:hover { color: #fff; text-decoration: none; }
.btn-primary { background: var(--blue); color: #fff; padding: 8px 18px; border-radius: 8px; font-size: 13px; font-weight: 600; }
.hamburger { display: none; background: none; border: none; color: #fff; cursor: pointer; padding: 4px; }
.layout { display: flex; margin-top: var(--header-h); min-height: calc(100vh - var(--header-h)); }
.sidebar { width: var(--sidebar-w); background: var(--bg-sidebar); border-right: 1px solid var(--border); position: fixed; top: var(--header-h); bottom: 0; overflow-y: auto; padding: 24px 0; transition: transform 0.25s ease; }
.sidebar-section { margin-bottom: 8px; }
.sidebar-label { font-size: 11px; font-weight: 700; letter-spacing: 0.08em; color: var(--text-muted); padding: 8px 20px 4px; text-transform: uppercase; }
.sidebar-link { display: flex; align-items: center; gap: 8px; padding: 7px 20px; color: var(--text-muted); font-size: 13.5px; font-weight: 500; transition: all 0.15s; border-left: 3px solid transparent; }
.sidebar-link:hover { color: var(--navy); background: var(--blue-faint); text-decoration: none; }
.sidebar-link.active { color: var(--blue); background: var(--blue-faint); border-left-color: var(--blue); }
.sidebar-link .icon { width: 16px; height: 16px; flex-shrink: 0; opacity: 0.7; }
.main { margin-left: var(--sidebar-w); flex: 1; padding: 48px 56px; max-width: calc(900px + var(--sidebar-w)); }
.page-header { margin-bottom: 40px; }
.breadcrumb { font-size: 13px; color: var(--text-muted); margin-bottom: 12px; }
.breadcrumb a { color: var(--text-muted); } .breadcrumb a:hover { color: var(--blue); }
h1 { font-size: 32px; font-weight: 800; color: var(--navy); margin-bottom: 12px; }
.page-desc { font-size: 16px; color: var(--text-muted); }
h2 { font-size: 20px; font-weight: 700; color: var(--navy); margin: 40px 0 14px; padding-bottom: 10px; border-bottom: 1px solid var(--border); }
h3 { font-size: 12px; font-weight: 600; color: var(--text-muted); margin: 16px 0 8px; text-transform: uppercase; letter-spacing: 0.06em; }
p { color: var(--text-muted); margin-bottom: 12px; }
.divider { border: none; border-top: 1px solid var(--border); margin: 40px 0; }
.endpoint-card { border: 1px solid var(--border); border-radius: 12px; margin: 24px 0; overflow: hidden; }
.endpoint-header { display: flex; align-items: center; gap: 12px; padding: 18px 24px; background: var(--bg-sidebar); border-bottom: 1px solid var(--border); }
.method-badge { font-family: 'JetBrains Mono', monospace; font-size: 12px; font-weight: 700; padding: 4px 12px; border-radius: 6px; }
.method-post { background: #dcfce7; color: #15803d; }
.method-get { background: #dbeafe; color: #1d4ed8; }
.method-delete { background: #fff5f5; color: #dc2626; }
.endpoint-path { font-family: 'JetBrains Mono', monospace; font-size: 14px; color: var(--navy); font-weight: 500; }
.endpoint-body { padding: 24px; }
.endpoint-desc { color: var(--text-muted); font-size: 14px; margin-bottom: 20px; }
.params-table { width: 100%; border-collapse: collapse; font-size: 13.5px; margin: 8px 0 20px; }
.params-table th { text-align: left; padding: 8px 12px; font-size: 11px; font-weight: 700; letter-spacing: 0.06em; color: var(--text-muted); border-bottom: 2px solid var(--border); text-transform: uppercase; }
.params-table td { padding: 10px 12px; border-bottom: 1px solid var(--border); vertical-align: top; }
.params-table tr:last-child td { border-bottom: none; }
.param-name { font-family: 'JetBrains Mono', monospace; color: var(--navy); font-size: 13px; }
.param-type { font-family: 'JetBrains Mono', monospace; color: var(--blue); font-size: 12px; }
.param-req { display: inline-block; background: #fef3c7; color: #92400e; font-size: 10px; font-weight: 700; padding: 1px 6px; border-radius: 4px; text-transform: uppercase; }
.param-opt { display: inline-block; background: var(--bg-code); color: var(--text-muted); font-size: 10px; font-weight: 700; padding: 1px 6px; border-radius: 4px; text-transform: uppercase; }
.param-desc { color: var(--text-muted); }
.code-wrap { position: relative; margin: 12px 0; }
.code-lang { position: absolute; top: 10px; right: 44px; font-size: 11px; font-weight: 600; color: rgba(255,255,255,0.4); text-transform: uppercase; letter-spacing: 0.05em; font-family: 'Inter', sans-serif; }
.copy-btn { position: absolute; top: 8px; right: 10px; background: rgba(255,255,255,0.1); border: 1px solid rgba(255,255,255,0.15); color: rgba(255,255,255,0.7); border-radius: 6px; padding: 4px 8px; font-size: 11px; cursor: pointer; font-family: 'Inter', sans-serif; font-weight: 500; transition: all 0.15s; }
.copy-btn:hover { background: rgba(255,255,255,0.2); color: #fff; }
.copy-btn.copied { color: #4ade80; border-color: #4ade80; }
pre { background: #0f1923; color: #e2e8f0; border-radius: 10px; padding: 18px 20px; overflow-x: auto; font-family: 'JetBrains Mono', monospace; font-size: 13px; line-height: 1.7; }
code { font-family: 'JetBrains Mono', monospace; }
.inline-code { background: var(--bg-code); color: #c2410c; padding: 2px 6px; border-radius: 4px; font-size: 13px; font-family: 'JetBrains Mono', monospace; }
.tok-kw { color: #c792ea; } .tok-str { color: #c3e88d; } .tok-num { color: #f78c6c; } .tok-cmt { color: #546e7a; }
.tok-url { color: #80cbc4; } .tok-key { color: #89ddff; } .tok-bool { color: #ff5572; }
.info-box { background: var(--blue-faint); border: 1px solid #d4d0ff; border-radius: 10px; padding: 16px 20px; display: flex; gap: 12px; margin: 20px 0; }
.info-box.warning { background: #fffbeb; border-color: #fde68a; }
.info-box-icon { font-size: 18px; flex-shrink: 0; }
.info-box-body { font-size: 13.5px; color: var(--text); }
.info-box-body strong { color: var(--navy); }
@media (max-width: 768px) {
.sidebar { transform: translateX(-100%); z-index: 50; }
.sidebar.open { transform: translateX(0); }
.main { margin-left: 0; padding: 24px 20px; }
.hamburger { display: flex; }
.header-nav { display: none; }
.overlay { display: none; position: fixed; inset: 0; background: rgba(0,0,0,0.4); z-index: 40; }
.overlay.visible { display: block; }
}
</style>
</head>
<body>
<header class="header">
<button class="hamburger" id="hamburger" aria-label="Menu">
<svg width="22" height="22" viewBox="0 0 22 22" fill="none"><rect y="4" width="22" height="2" rx="1" fill="white"/><rect y="10" width="22" height="2" rx="1" fill="white"/><rect y="16" width="22" height="2" rx="1" fill="white"/></svg>
</button>
<a href="/docs/" class="header-logo"><div class="header-logo-mark">A</div>AAMOS</a>
<span class="header-badge">API DOCS</span>
<nav class="header-nav">
<a href="https://aamos.ai">Home</a>
<a href="/docs/">Docs</a>
<a href="https://aamos.ai/signup/" class="btn-primary">Get API Key</a>
</nav>
</header>
<div class="overlay" id="overlay"></div>
<div class="layout">
<nav class="sidebar" id="sidebar">
<div class="sidebar-section">
<div class="sidebar-label">Getting Started</div>
<a href="/docs/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h12v2H2zm0 4h12v2H2zm0 4h8v2H2z"/></svg>Overview</a>
<a href="/docs/authentication/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>Authentication</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">APIs</div>
<a href="/docs/vims/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M1 3h14v2H1zm2 4h10v2H3zm2 4h6v2H5z"/></svg>VIMS</a>
<a href="/docs/reality-alerts/" class="sidebar-link active"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1L1 14h14L8 1zm0 3l5 9H3l5-9zm-1 3v3h2V7H7zm0 4v2h2v-2H7z"/></svg>Reality Alerts</a>
<a href="/docs/kyz/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>KYZ</a>
<a href="/docs/modules/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h5v5H2zm7 0h5v5H9zm-7 7h5v5H2zm7 0h5v5H9z"/></svg>AAMOS Modules</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">On this page</div>
<a href="#create-sub" class="sidebar-link" style="font-size:12.5px">Create Subscription</a>
<a href="#list-subs" class="sidebar-link" style="font-size:12.5px">List Subscriptions</a>
<a href="#delete-sub" class="sidebar-link" style="font-size:12.5px">Delete Subscription</a>
<a href="#list-alerts" class="sidebar-link" style="font-size:12.5px">List Alerts</a>
<a href="#get-alert" class="sidebar-link" style="font-size:12.5px">Get Alert</a>
</div>
</nav>
<main class="main">
<div class="page-header">
<div class="breadcrumb"><a href="/docs/">Docs</a> / Reality Alerts API</div>
<h1>Reality Alerts API Reference</h1>
<p class="page-desc">Subscribe to real-world event streams and receive webhook notifications when conditions match your geographic and severity criteria.</p>
</div>
<div class="info-box">
<span class="info-box-icon">📍</span>
<div class="info-box-body"><strong>Base path:</strong> <code class="inline-code">https://api.aamos.ai/v1/reality-alerts/</code></div>
</div>
<div class="info-box warning">
<span class="info-box-icon">🌍</span>
<div class="info-box-body"><strong>Webhook delivery:</strong> Your <code class="inline-code">webhook_url</code> must be publicly accessible and respond with <code class="inline-code">HTTP 200</code> within 5 seconds. Failed deliveries are retried up to 3 times with exponential backoff.</div>
</div>
<h2 id="create-sub">POST /v1/reality-alerts/subscriptions</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-post">POST</span>
<span class="endpoint-path">/v1/reality-alerts/subscriptions</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Create a new alert subscription. You will receive webhook notifications when real-world events matching your criteria are detected within the specified bounding box.</p>
<h3>Request — application/json</h3>
<table class="params-table">
<thead><tr><th>Field</th><th>Type</th><th>Required</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">webhook_url</td><td class="param-type">string</td><td><span class="param-req">Required</span></td><td class="param-desc">HTTPS URL to receive POST notifications when alerts trigger.</td></tr>
<tr><td class="param-name">categories</td><td class="param-type">string[]</td><td><span class="param-req">Required</span></td><td class="param-desc">Event categories to subscribe to. See category list below.</td></tr>
<tr><td class="param-name">bbox</td><td class="param-type">float[4]</td><td><span class="param-req">Required</span></td><td class="param-desc">Geographic bounding box: [west, south, east, north] in WGS84 decimal degrees.</td></tr>
<tr><td class="param-name">min_severity</td><td class="param-type">integer</td><td><span class="param-opt">Optional</span></td><td class="param-desc">Minimum severity level (1–5). Default: 1 (all severities).</td></tr>
</tbody>
</table>
<h3>Alert Categories</h3>
<table class="params-table">
<thead><tr><th>Category</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">fire</td><td class="param-desc">Fire and wildfire events</td></tr>
<tr><td class="param-name">flood</td><td class="param-desc">Flooding and water events</td></tr>
<tr><td class="param-name">infrastructure</td><td class="param-desc">Infrastructure failures (power, roads, utilities)</td></tr>
<tr><td class="param-name">security</td><td class="param-desc">Security incidents and public safety events</td></tr>
<tr><td class="param-name">weather</td><td class="param-desc">Severe weather conditions</td></tr>
<tr><td class="param-name">environmental</td><td class="param-desc">Environmental events and hazards</td></tr>
</tbody>
</table>
<h3>Example Request</h3>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X POST <span class="tok-str">https://api.aamos.ai/v1/reality-alerts/subscriptions</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-H <span class="tok-str">"Content-Type: application/json"</span> \
-d <span class="tok-str">'{
"webhook_url": "https://your-app.example.com/hooks/alerts",
"categories": ["fire", "flood", "infrastructure"],
"bbox": [17.8, 59.2, 18.2, 59.4],
"min_severity": 3
}'</span></pre>
</div>
<h3>Response — 201 Created</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"subscription_id"</span>: <span class="tok-str">"sub_8c2f1a3e5b"</span>,
<span class="tok-key">"status"</span>: <span class="tok-str">"active"</span>,
<span class="tok-key">"webhook_url"</span>: <span class="tok-str">"https://your-app.example.com/hooks/alerts"</span>,
<span class="tok-key">"categories"</span>: [<span class="tok-str">"fire"</span>, <span class="tok-str">"flood"</span>, <span class="tok-str">"infrastructure"</span>],
<span class="tok-key">"bbox"</span>: [<span class="tok-num">17.8</span>, <span class="tok-num">59.2</span>, <span class="tok-num">18.2</span>, <span class="tok-num">59.4</span>],
<span class="tok-key">"min_severity"</span>: <span class="tok-num">3</span>,
<span class="tok-key">"created_at"</span>: <span class="tok-str">"2025-01-15T09:00:00Z"</span>
}</pre>
</div>
<h3>Webhook Payload Example</h3>
<p>When an alert triggers, your webhook receives a POST with this body:</p>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"event"</span>: <span class="tok-str">"alert.triggered"</span>,
<span class="tok-key">"subscription_id"</span>: <span class="tok-str">"sub_8c2f1a3e5b"</span>,
<span class="tok-key">"alert"</span>: {
<span class="tok-key">"alert_id"</span>: <span class="tok-str">"alt_9d1e7b4f2c"</span>,
<span class="tok-key">"category"</span>: <span class="tok-str">"fire"</span>,
<span class="tok-key">"severity"</span>: <span class="tok-num">4</span>,
<span class="tok-key">"title"</span>: <span class="tok-str">"Wildfire reported near monitored area"</span>,
<span class="tok-key">"location"</span>: { <span class="tok-key">"lat"</span>: <span class="tok-num">59.31</span>, <span class="tok-key">"lng"</span>: <span class="tok-num">18.05</span> },
<span class="tok-key">"detected_at"</span>: <span class="tok-str">"2025-01-15T11:00:00Z"</span>
}
}</pre>
</div>
</div>
</div>
<h2 id="list-subs">GET /v1/reality-alerts/subscriptions</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-get">GET</span>
<span class="endpoint-path">/v1/reality-alerts/subscriptions</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">List all active subscriptions for your API key.</p>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> <span class="tok-str">https://api.aamos.ai/v1/reality-alerts/subscriptions</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span></pre>
</div>
<h3>Response — 200 OK</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"subscriptions"</span>: [
{
<span class="tok-key">"subscription_id"</span>: <span class="tok-str">"sub_8c2f1a3e5b"</span>,
<span class="tok-key">"status"</span>: <span class="tok-str">"active"</span>,
<span class="tok-key">"categories"</span>: [<span class="tok-str">"fire"</span>, <span class="tok-str">"flood"</span>],
<span class="tok-key">"created_at"</span>: <span class="tok-str">"2025-01-15T09:00:00Z"</span>
}
]
}</pre>
</div>
</div>
</div>
<h2 id="delete-sub">DELETE /v1/reality-alerts/subscriptions/:id</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-delete">DELETE</span>
<span class="endpoint-path">/v1/reality-alerts/subscriptions/:id</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Cancel and delete a subscription. You will stop receiving webhook notifications immediately.</p>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X DELETE <span class="tok-str">https://api.aamos.ai/v1/reality-alerts/subscriptions/sub_8c2f1a3e5b</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span></pre>
</div>
<h3>Response — 204 No Content</h3>
<p>An empty <code class="inline-code">204</code> response confirms deletion.</p>
</div>
</div>
<h2 id="list-alerts">GET /v1/reality-alerts/alerts</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-get">GET</span>
<span class="endpoint-path">/v1/reality-alerts/alerts</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Query historical alerts matching your filters. Useful for backfill, auditing, or building dashboards.</p>
<h3>Query Parameters</h3>
<table class="params-table">
<thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">from</td><td class="param-type">string</td><td><span class="param-opt">Optional</span></td><td class="param-desc">ISO 8601 timestamp. Filter alerts detected after this time.</td></tr>
<tr><td class="param-name">to</td><td class="param-type">string</td><td><span class="param-opt">Optional</span></td><td class="param-desc">ISO 8601 timestamp. Filter alerts detected before this time.</td></tr>
<tr><td class="param-name">category</td><td class="param-type">string</td><td><span class="param-opt">Optional</span></td><td class="param-desc">Filter by alert category (e.g. <code class="inline-code">fire</code>, <code class="inline-code">flood</code>).</td></tr>
<tr><td class="param-name">min_severity</td><td class="param-type">integer</td><td><span class="param-opt">Optional</span></td><td class="param-desc">Minimum severity level (1–5).</td></tr>
</tbody>
</table>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> <span class="tok-str">"https://api.aamos.ai/v1/reality-alerts/alerts?from=2025-01-01T00:00:00Z&category=fire&min_severity=3"</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span></pre>
</div>
<h3>Response — 200 OK</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"alerts"</span>: [
{
<span class="tok-key">"alert_id"</span>: <span class="tok-str">"alt_9d1e7b4f2c"</span>,
<span class="tok-key">"category"</span>: <span class="tok-str">"fire"</span>,
<span class="tok-key">"severity"</span>: <span class="tok-num">4</span>,
<span class="tok-key">"title"</span>: <span class="tok-str">"Wildfire reported near monitored area"</span>,
<span class="tok-key">"location"</span>: { <span class="tok-key">"lat"</span>: <span class="tok-num">59.31</span>, <span class="tok-key">"lng"</span>: <span class="tok-num">18.05</span> },
<span class="tok-key">"detected_at"</span>: <span class="tok-str">"2025-01-15T11:00:00Z"</span>
}
],
<span class="tok-key">"total"</span>: <span class="tok-num">1</span>
}</pre>
</div>
</div>
</div>
<h2 id="get-alert">GET /v1/reality-alerts/alerts/:alert_id</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-get">GET</span>
<span class="endpoint-path">/v1/reality-alerts/alerts/:alert_id</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Retrieve the full details of a specific alert by ID, including enriched metadata.</p>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> <span class="tok-str">https://api.aamos.ai/v1/reality-alerts/alerts/alt_9d1e7b4f2c</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span></pre>
</div>
<h3>Response — 200 OK</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"alert_id"</span>: <span class="tok-str">"alt_9d1e7b4f2c"</span>,
<span class="tok-key">"category"</span>: <span class="tok-str">"fire"</span>,
<span class="tok-key">"severity"</span>: <span class="tok-num">4</span>,
<span class="tok-key">"title"</span>: <span class="tok-str">"Wildfire reported near monitored area"</span>,
<span class="tok-key">"description"</span>: <span class="tok-str">"Active fire detected within your subscription area. Estimated spread: 2.3 km²."</span>,
<span class="tok-key">"location"</span>: {
<span class="tok-key">"lat"</span>: <span class="tok-num">59.31</span>,
<span class="tok-key">"lng"</span>: <span class="tok-num">18.05</span>,
<span class="tok-key">"radius_m"</span>: <span class="tok-num">800</span>
},
<span class="tok-key">"sources"</span>: [<span class="tok-str">"satellite"</span>, <span class="tok-str">"sensor_network"</span>],
<span class="tok-key">"detected_at"</span>: <span class="tok-str">"2025-01-15T11:00:00Z"</span>,
<span class="tok-key">"updated_at"</span>: <span class="tok-str">"2025-01-15T11:45:00Z"</span>,
<span class="tok-key">"status"</span>: <span class="tok-str">"active"</span>
}</pre>
</div>
</div>
</div>
</main>
</div>
<script>
function copyCode(btn) {
const pre = btn.closest('.code-wrap').querySelector('pre');
navigator.clipboard.writeText(pre.innerText || pre.textContent).then(() => {
btn.textContent = 'Copied!'; btn.classList.add('copied');
setTimeout(() => { btn.textContent = 'Copy'; btn.classList.remove('copied'); }, 2000);
});
}
const hamburger = document.getElementById('hamburger');
const sidebar = document.getElementById('sidebar');
const overlay = document.getElementById('overlay');
hamburger.addEventListener('click', () => { sidebar.classList.toggle('open'); overlay.classList.toggle('visible'); });
overlay.addEventListener('click', () => { sidebar.classList.remove('open'); overlay.classList.remove('visible'); });
</script>
</body>
</html>
aamos-ai-site/docs/vims/index.html
+348
View File
@@ -0,0 +1,348 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>VIMS API — AAMOS API Docs</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
<style>
:root {
--navy: #0A2540; --blue: #635BFF; --blue-faint: #F0EFFF;
--text: #1a2332; --text-muted: #5a6880; --border: #e2e8f0;
--bg: #ffffff; --bg-sidebar: #f8fafc; --bg-code: #f1f5f9;
--sidebar-w: 260px; --header-h: 60px;
}
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
body { font-family: 'Inter', sans-serif; color: var(--text); background: var(--bg); font-size: 15px; line-height: 1.6; }
a { color: var(--blue); text-decoration: none; } a:hover { text-decoration: underline; }
.header { position: fixed; top: 0; left: 0; right: 0; height: var(--header-h); background: var(--navy); display: flex; align-items: center; padding: 0 24px; z-index: 100; gap: 16px; }
.header-logo { display: flex; align-items: center; gap: 10px; color: #fff; font-weight: 700; font-size: 18px; text-decoration: none; }
.header-logo-mark { width: 32px; height: 32px; background: var(--blue); border-radius: 8px; display: flex; align-items: center; justify-content: center; font-size: 14px; font-weight: 800; color: #fff; }
.header-badge { background: rgba(99,91,255,0.25); color: #a5a0ff; font-size: 11px; font-weight: 600; padding: 2px 8px; border-radius: 20px; letter-spacing: 0.05em; }
.header-nav { margin-left: auto; display: flex; gap: 24px; align-items: center; }
.header-nav a { color: rgba(255,255,255,0.75); font-size: 14px; font-weight: 500; }
.header-nav a:hover { color: #fff; text-decoration: none; }
.btn-primary { background: var(--blue); color: #fff; padding: 8px 18px; border-radius: 8px; font-size: 13px; font-weight: 600; }
.hamburger { display: none; background: none; border: none; color: #fff; cursor: pointer; padding: 4px; }
.layout { display: flex; margin-top: var(--header-h); min-height: calc(100vh - var(--header-h)); }
.sidebar { width: var(--sidebar-w); background: var(--bg-sidebar); border-right: 1px solid var(--border); position: fixed; top: var(--header-h); bottom: 0; overflow-y: auto; padding: 24px 0; transition: transform 0.25s ease; }
.sidebar-section { margin-bottom: 8px; }
.sidebar-label { font-size: 11px; font-weight: 700; letter-spacing: 0.08em; color: var(--text-muted); padding: 8px 20px 4px; text-transform: uppercase; }
.sidebar-link { display: flex; align-items: center; gap: 8px; padding: 7px 20px; color: var(--text-muted); font-size: 13.5px; font-weight: 500; transition: all 0.15s; border-left: 3px solid transparent; }
.sidebar-link:hover { color: var(--navy); background: var(--blue-faint); text-decoration: none; }
.sidebar-link.active { color: var(--blue); background: var(--blue-faint); border-left-color: var(--blue); }
.sidebar-link .icon { width: 16px; height: 16px; flex-shrink: 0; opacity: 0.7; }
.main { margin-left: var(--sidebar-w); flex: 1; padding: 48px 56px; max-width: calc(900px + var(--sidebar-w)); }
.page-header { margin-bottom: 40px; }
.breadcrumb { font-size: 13px; color: var(--text-muted); margin-bottom: 12px; }
.breadcrumb a { color: var(--text-muted); } .breadcrumb a:hover { color: var(--blue); }
h1 { font-size: 32px; font-weight: 800; color: var(--navy); margin-bottom: 12px; }
.page-desc { font-size: 16px; color: var(--text-muted); }
h2 { font-size: 20px; font-weight: 700; color: var(--navy); margin: 40px 0 14px; padding-bottom: 10px; border-bottom: 1px solid var(--border); }
h3 { font-size: 15px; font-weight: 600; color: var(--text-muted); margin: 16px 0 8px; text-transform: uppercase; letter-spacing: 0.06em; font-size: 12px; }
p { color: var(--text-muted); margin-bottom: 12px; }
.divider { border: none; border-top: 1px solid var(--border); margin: 40px 0; }
/* Endpoint card */
.endpoint-card { border: 1px solid var(--border); border-radius: 12px; margin: 24px 0; overflow: hidden; }
.endpoint-header { display: flex; align-items: center; gap: 12px; padding: 18px 24px; background: var(--bg-sidebar); border-bottom: 1px solid var(--border); }
.method-badge { font-family: 'JetBrains Mono', monospace; font-size: 12px; font-weight: 700; padding: 4px 12px; border-radius: 6px; }
.method-post { background: #dcfce7; color: #15803d; }
.method-get { background: #dbeafe; color: #1d4ed8; }
.method-delete { background: #fff5f5; color: #dc2626; }
.method-put { background: #fff7ed; color: #d97706; }
.endpoint-path { font-family: 'JetBrains Mono', monospace; font-size: 14px; color: var(--navy); font-weight: 500; }
.endpoint-body { padding: 24px; }
.endpoint-desc { color: var(--text-muted); font-size: 14px; margin-bottom: 20px; }
/* Params table */
.params-table { width: 100%; border-collapse: collapse; font-size: 13.5px; margin: 8px 0 20px; }
.params-table th { text-align: left; padding: 8px 12px; font-size: 11px; font-weight: 700; letter-spacing: 0.06em; color: var(--text-muted); border-bottom: 2px solid var(--border); text-transform: uppercase; }
.params-table td { padding: 10px 12px; border-bottom: 1px solid var(--border); vertical-align: top; }
.params-table tr:last-child td { border-bottom: none; }
.param-name { font-family: 'JetBrains Mono', monospace; color: var(--navy); font-size: 13px; }
.param-type { font-family: 'JetBrains Mono', monospace; color: var(--blue); font-size: 12px; }
.param-req { display: inline-block; background: #fef3c7; color: #92400e; font-size: 10px; font-weight: 700; padding: 1px 6px; border-radius: 4px; text-transform: uppercase; }
.param-opt { display: inline-block; background: var(--bg-code); color: var(--text-muted); font-size: 10px; font-weight: 700; padding: 1px 6px; border-radius: 4px; text-transform: uppercase; }
.param-desc { color: var(--text-muted); }
/* Code */
.code-wrap { position: relative; margin: 12px 0; }
.code-lang { position: absolute; top: 10px; right: 44px; font-size: 11px; font-weight: 600; color: rgba(255,255,255,0.4); text-transform: uppercase; letter-spacing: 0.05em; font-family: 'Inter', sans-serif; }
.copy-btn { position: absolute; top: 8px; right: 10px; background: rgba(255,255,255,0.1); border: 1px solid rgba(255,255,255,0.15); color: rgba(255,255,255,0.7); border-radius: 6px; padding: 4px 8px; font-size: 11px; cursor: pointer; font-family: 'Inter', sans-serif; font-weight: 500; transition: all 0.15s; }
.copy-btn:hover { background: rgba(255,255,255,0.2); color: #fff; }
.copy-btn.copied { color: #4ade80; border-color: #4ade80; }
pre { background: #0f1923; color: #e2e8f0; border-radius: 10px; padding: 18px 20px; overflow-x: auto; font-family: 'JetBrains Mono', monospace; font-size: 13px; line-height: 1.7; }
code { font-family: 'JetBrains Mono', monospace; }
.inline-code { background: var(--bg-code); color: #c2410c; padding: 2px 6px; border-radius: 4px; font-size: 13px; font-family: 'JetBrains Mono', monospace; }
.tok-kw { color: #c792ea; } .tok-str { color: #c3e88d; } .tok-num { color: #f78c6c; } .tok-cmt { color: #546e7a; }
.tok-url { color: #80cbc4; } .tok-key { color: #89ddff; } .tok-bool { color: #ff5572; }
.tok-method { color: #ffcb6b; font-weight: 600; } .tok-path { color: #80cbc4; }
.info-box { background: var(--blue-faint); border: 1px solid #d4d0ff; border-radius: 10px; padding: 16px 20px; display: flex; gap: 12px; margin: 20px 0; }
.info-box-icon { font-size: 18px; flex-shrink: 0; }
.info-box-body { font-size: 13.5px; color: var(--text); }
.info-box-body strong { color: var(--navy); }
@media (max-width: 768px) {
.sidebar { transform: translateX(-100%); z-index: 50; }
.sidebar.open { transform: translateX(0); }
.main { margin-left: 0; padding: 24px 20px; }
.hamburger { display: flex; }
.header-nav { display: none; }
.overlay { display: none; position: fixed; inset: 0; background: rgba(0,0,0,0.4); z-index: 40; }
.overlay.visible { display: block; }
.endpoint-header { flex-wrap: wrap; }
}
</style>
</head>
<body>
<header class="header">
<button class="hamburger" id="hamburger" aria-label="Menu">
<svg width="22" height="22" viewBox="0 0 22 22" fill="none"><rect y="4" width="22" height="2" rx="1" fill="white"/><rect y="10" width="22" height="2" rx="1" fill="white"/><rect y="16" width="22" height="2" rx="1" fill="white"/></svg>
</button>
<a href="/docs/" class="header-logo"><div class="header-logo-mark">A</div>AAMOS</a>
<span class="header-badge">API DOCS</span>
<nav class="header-nav">
<a href="https://aamos.ai">Home</a>
<a href="/docs/">Docs</a>
<a href="https://aamos.ai/signup/" class="btn-primary">Get API Key</a>
</nav>
</header>
<div class="overlay" id="overlay"></div>
<div class="layout">
<nav class="sidebar" id="sidebar">
<div class="sidebar-section">
<div class="sidebar-label">Getting Started</div>
<a href="/docs/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h12v2H2zm0 4h12v2H2zm0 4h8v2H2z"/></svg>Overview</a>
<a href="/docs/authentication/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>Authentication</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">APIs</div>
<a href="/docs/vims/" class="sidebar-link active"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M1 3h14v2H1zm2 4h10v2H3zm2 4h6v2H5z"/></svg>VIMS</a>
<a href="/docs/reality-alerts/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1L1 14h14L8 1zm0 3l5 9H3l5-9zm-1 3v3h2V7H7zm0 4v2h2v-2H7z"/></svg>Reality Alerts</a>
<a href="/docs/kyz/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M8 1a4 4 0 110 8A4 4 0 018 1zm0 10c-4 0-7 2-7 3v1h14v-1c0-1-3-3-7-3z"/></svg>KYZ</a>
<a href="/docs/modules/" class="sidebar-link"><svg class="icon" viewBox="0 0 16 16" fill="currentColor"><path d="M2 2h5v5H2zm7 0h5v5H9zm-7 7h5v5H2zm7 0h5v5H9z"/></svg>AAMOS Modules</a>
</div>
<div class="sidebar-section">
<div class="sidebar-label">On this page</div>
<a href="#analyze" class="sidebar-link" style="font-size:12.5px">Analyze Image</a>
<a href="#baseline" class="sidebar-link" style="font-size:12.5px">Set Baseline</a>
<a href="#list-objects" class="sidebar-link" style="font-size:12.5px">List Objects</a>
<a href="#get-analysis" class="sidebar-link" style="font-size:12.5px">Get Analysis</a>
</div>
</nav>
<main class="main">
<div class="page-header">
<div class="breadcrumb"><a href="/docs/">Docs</a> / VIMS API</div>
<h1>VIMS API Reference</h1>
<p class="page-desc">Visual Integrity Monitoring System — detect changes, anomalies, and deviations in monitored objects using computer vision.</p>
</div>
<div class="info-box">
<span class="info-box-icon">📍</span>
<div class="info-box-body"><strong>Base path:</strong> All VIMS endpoints are under <code class="inline-code">https://api.aamos.ai/v1/vims/</code></div>
</div>
<h2 id="analyze">POST /v1/vims/analyze</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-post">POST</span>
<span class="endpoint-path">/v1/vims/analyze</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Analyze an image for changes against the registered baseline for a given object. Returns a change score, risk level, and detected anomalies. The baseline is automatically updated if drift is within acceptable thresholds.</p>
<h3>Request — multipart/form-data</h3>
<table class="params-table">
<thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">image</td><td class="param-type">file</td><td><span class="param-req">Required</span></td><td class="param-desc">The image to analyze. Accepted formats: JPEG, PNG, WebP. Max 10 MB.</td></tr>
<tr><td class="param-name">object_id</td><td class="param-type">string</td><td><span class="param-req">Required</span></td><td class="param-desc">Your unique identifier for the monitored object. Must have an existing baseline.</td></tr>
<tr><td class="param-name">lat</td><td class="param-type">float</td><td><span class="param-opt">Optional</span></td><td class="param-desc">GPS latitude of the image capture location.</td></tr>
<tr><td class="param-name">lng</td><td class="param-type">float</td><td><span class="param-opt">Optional</span></td><td class="param-desc">GPS longitude of the image capture location.</td></tr>
</tbody>
</table>
<h3>Example Request</h3>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X POST <span class="tok-str">https://api.aamos.ai/v1/vims/analyze</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-F <span class="tok-str">"image=@/path/to/photo.jpg"</span> \
-F <span class="tok-str">"object_id=site-front-gate"</span> \
-F <span class="tok-str">"lat=59.3293"</span> \
-F <span class="tok-str">"lng=18.0686"</span></pre>
</div>
<h3>Response — 200 OK</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"analysis_id"</span>: <span class="tok-str">"an_7f3a9b2c1d"</span>,
<span class="tok-key">"object_id"</span>: <span class="tok-str">"site-front-gate"</span>,
<span class="tok-key">"change_detected"</span>: <span class="tok-bool">true</span>,
<span class="tok-key">"change_score"</span>: <span class="tok-num">0.74</span>,
<span class="tok-key">"risk_level"</span>: <span class="tok-str">"high"</span>,
<span class="tok-key">"detections"</span>: [
{
<span class="tok-key">"type"</span>: <span class="tok-str">"structural_change"</span>,
<span class="tok-key">"confidence"</span>: <span class="tok-num">0.91</span>,
<span class="tok-key">"bbox"</span>: [<span class="tok-num">120</span>, <span class="tok-num">45</span>, <span class="tok-num">380</span>, <span class="tok-num">290</span>],
<span class="tok-key">"label"</span>: <span class="tok-str">"Gate damage detected"</span>
}
],
<span class="tok-key">"baseline_updated"</span>: <span class="tok-bool">false</span>,
<span class="tok-key">"analyzed_at"</span>: <span class="tok-str">"2025-01-15T10:30:00Z"</span>
}</pre>
</div>
<h3>Risk Levels</h3>
<p>The <code class="inline-code">risk_level</code> field reflects the severity of detected change:</p>
<table class="params-table">
<thead><tr><th>Value</th><th>change_score range</th><th>Meaning</th></tr></thead>
<tbody>
<tr><td class="param-name">none</td><td class="param-type">0.0 – 0.1</td><td class="param-desc">No meaningful change detected.</td></tr>
<tr><td class="param-name">low</td><td class="param-type">0.1 – 0.3</td><td class="param-desc">Minor variation, within expected range.</td></tr>
<tr><td class="param-name">medium</td><td class="param-type">0.3 – 0.6</td><td class="param-desc">Notable change, review recommended.</td></tr>
<tr><td class="param-name">high</td><td class="param-type">0.6 – 1.0</td><td class="param-desc">Significant change, immediate review required.</td></tr>
</tbody>
</table>
</div>
</div>
<h2 id="baseline">POST /v1/vims/baseline</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-post">POST</span>
<span class="endpoint-path">/v1/vims/baseline</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Register a new baseline image for an object. The baseline is the reference state used for all subsequent analyze calls. You can update baselines as needed.</p>
<h3>Request — multipart/form-data</h3>
<table class="params-table">
<thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">object_id</td><td class="param-type">string</td><td><span class="param-req">Required</span></td><td class="param-desc">Your unique identifier for this object. Will be created if it doesn't exist.</td></tr>
<tr><td class="param-name">image</td><td class="param-type">file</td><td><span class="param-req">Required</span></td><td class="param-desc">The baseline image. JPEG, PNG, or WebP. Max 10 MB.</td></tr>
</tbody>
</table>
<h3>Example Request</h3>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> -X POST <span class="tok-str">https://api.aamos.ai/v1/vims/baseline</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span> \
-F <span class="tok-str">"object_id=site-front-gate"</span> \
-F <span class="tok-str">"image=@/path/to/baseline.jpg"</span></pre>
</div>
<h3>Response — 201 Created</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"baseline_id"</span>: <span class="tok-str">"bl_3d8e1f7a9b"</span>,
<span class="tok-key">"object_id"</span>: <span class="tok-str">"site-front-gate"</span>,
<span class="tok-key">"created_at"</span>: <span class="tok-str">"2025-01-15T09:00:00Z"</span>
}</pre>
</div>
</div>
</div>
<h2 id="list-objects">GET /v1/vims/objects</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-get">GET</span>
<span class="endpoint-path">/v1/vims/objects</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">List all monitored objects registered under your API key, with their baseline count and last analysis timestamp.</p>
<h3>Example Request</h3>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> <span class="tok-str">https://api.aamos.ai/v1/vims/objects</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span></pre>
</div>
<h3>Response — 200 OK</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"objects"</span>: [
{
<span class="tok-key">"object_id"</span>: <span class="tok-str">"site-front-gate"</span>,
<span class="tok-key">"baseline_count"</span>: <span class="tok-num">3</span>,
<span class="tok-key">"last_analysis"</span>: <span class="tok-str">"2025-01-15T10:30:00Z"</span>
},
{
<span class="tok-key">"object_id"</span>: <span class="tok-str">"server-rack-a1"</span>,
<span class="tok-key">"baseline_count"</span>: <span class="tok-num">1</span>,
<span class="tok-key">"last_analysis"</span>: <span class="tok-str">"2025-01-14T14:15:00Z"</span>
}
]
}</pre>
</div>
</div>
</div>
<h2 id="get-analysis">GET /v1/vims/analysis/:analysis_id</h2>
<div class="endpoint-card">
<div class="endpoint-header">
<span class="method-badge method-get">GET</span>
<span class="endpoint-path">/v1/vims/analysis/:analysis_id</span>
</div>
<div class="endpoint-body">
<p class="endpoint-desc">Retrieve the full details of a previously completed analysis by its ID.</p>
<h3>Path Parameters</h3>
<table class="params-table">
<thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
<tbody>
<tr><td class="param-name">analysis_id</td><td class="param-type">string</td><td class="param-desc">The analysis ID returned by <code class="inline-code">POST /v1/vims/analyze</code>.</td></tr>
</tbody>
</table>
<h3>Example Request</h3>
<div class="code-wrap">
<span class="code-lang">bash</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre><span class="tok-kw">curl</span> <span class="tok-str">https://api.aamos.ai/v1/vims/analysis/an_7f3a9b2c1d</span> \
-H <span class="tok-str">"Authorization: Bearer ak_live_YOUR_KEY"</span></pre>
</div>
<h3>Response — 200 OK</h3>
<div class="code-wrap">
<span class="code-lang">json</span>
<button class="copy-btn" onclick="copyCode(this)">Copy</button>
<pre>{
<span class="tok-key">"analysis_id"</span>: <span class="tok-str">"an_7f3a9b2c1d"</span>,
<span class="tok-key">"object_id"</span>: <span class="tok-str">"site-front-gate"</span>,
<span class="tok-key">"change_detected"</span>: <span class="tok-bool">true</span>,
<span class="tok-key">"change_score"</span>: <span class="tok-num">0.74</span>,
<span class="tok-key">"risk_level"</span>: <span class="tok-str">"high"</span>,
<span class="tok-key">"detections"</span>: [
{
<span class="tok-key">"type"</span>: <span class="tok-str">"structural_change"</span>,
<span class="tok-key">"confidence"</span>: <span class="tok-num">0.91</span>,
<span class="tok-key">"bbox"</span>: [<span class="tok-num">120</span>, <span class="tok-num">45</span>, <span class="tok-num">380</span>, <span class="tok-num">290</span>],
<span class="tok-key">"label"</span>: <span class="tok-str">"Gate damage detected"</span>
}
],
<span class="tok-key">"baseline_updated"</span>: <span class="tok-bool">false</span>,
<span class="tok-key">"baseline_id"</span>: <span class="tok-str">"bl_3d8e1f7a9b"</span>,
<span class="tok-key">"image_url"</span>: <span class="tok-str">"https://storage.aamos.ai/analyses/an_7f3a9b2c1d.jpg"</span>,
<span class="tok-key">"analyzed_at"</span>: <span class="tok-str">"2025-01-15T10:30:00Z"</span>
}</pre>
</div>
</div>
</div>
</main>
</div>
<script>
function copyCode(btn) {
const pre = btn.closest('.code-wrap').querySelector('pre');
navigator.clipboard.writeText(pre.innerText || pre.textContent).then(() => {
btn.textContent = 'Copied!'; btn.classList.add('copied');
setTimeout(() => { btn.textContent = 'Copy'; btn.classList.remove('copied'); }, 2000);
});
}
const hamburger = document.getElementById('hamburger');
const sidebar = document.getElementById('sidebar');
const overlay = document.getElementById('overlay');
hamburger.addEventListener('click', () => { sidebar.classList.toggle('open'); overlay.classList.toggle('visible'); });
overlay.addEventListener('click', () => { sidebar.classList.remove('open'); overlay.classList.remove('visible'); });
</script>
</body>
</html>