API Reference Index
This page is the single entry point for all Arbitex API documentation. Every documented endpoint is cataloged here, organized by service and functional domain, with links to the page where the full specification lives.
Gateway API
Section titled “Gateway API”The Gateway API is the data-plane interface for AI completions. It exposes an OpenAI-compatible endpoint that handles provider routing, DLP inspection, policy enforcement, and audit logging. The full consolidated reference lives in the Gateway API section.
| Page | Endpoints | Description |
|---|---|---|
| Gateway API Overview | — | Base URL, authentication, rate limiting, policy headers, error codes, OpenAI compatibility |
| Chat completions | 1 | POST /v1/chat/completions — streaming, DLP events, request/response fields |
| Embeddings | 1 | POST /v1/embeddings — OpenAI-compatible embedding generation |
| Models | 2 | GET /v1/models — model listing, provider/model-id format, routing |
| DLP results | 4 | Inline DLP behavior + DLP events read-back API |
| Policy decisions | — | Policy response headers, decision semantics, 403 policy_block |
| Audit events | 1 | GET /v1/audit/events — audit read-back with cursor pagination |
| Usage & cost | 3 | Usage records, stats, and cost attribution read-back |
Platform Admin API
Section titled “Platform Admin API”The Platform service (gateway.arbitex.ai) hosts the admin API for configuration, policy management, DLP rules, user management, audit, and provider operations. All admin endpoints require authentication via Bearer JWT with admin role unless noted otherwise.
Policy & Rules
Section titled “Policy & Rules”| Page | Endpoints | Description |
|---|---|---|
| Policy Engine API | ~12 | Policy packs, rules, chains CRUD; simulation; effective policy per user |
| DLP Rules API | ~8 | DLP rule CRUD, bulk import/export, pattern testing, version history |
| Smart Rule Builder API | ~10 | Org DLP rules: AI-assisted regex generation, custom patterns, AI detectors, rule testing, effective rules, scan level |
| Content Filters | ~4 | Keyword blocking, topic blocking, system prompt injection rules |
| Routing Rules API | ~6 | Routing strategies, fallback chains, cost caps, model filters |
| MCP Security API | 1 | Headless MCP payload evaluation against policy engine and DLP pipeline |
| Agent Session API | ~10 | Agent session lifecycle, session timeline, per-agent tool authorization policies |
| Image DLP API | 3 | OCR configuration, OCR scan statistics, file upload with automatic OCR |
| Shadow AI Discovery API | ~12 | Discovered services, user activity, data ingestion, alerts, data sources |
Provider Management
Section titled “Provider Management”| Page | Endpoints | Description |
|---|---|---|
| Provider Management API | ~5 | List, configure, update, remove AI provider integrations + BYOE |
| Model Catalog | ~5 | Model catalog CRUD, auto-discovery, provider sync |
| Model Registry | ~5 | Model inventory with SR 11-7 risk tiers, validation status, export |
| Kill Switch | ~4 | Emergency disable/re-enable providers or models |
| Emergency Controls | 1 | Redis-backed org isolation, feature kill switches, credential revocation, quarantine ingest |
| Cost Forecast | 1 | Burn rate, projected monthly total, budget exhaustion date |
| Cost Routing | ~4 | Provider preference, fallback chains, cost caps |
Users, Groups & Auth
Section titled “Users, Groups & Auth”| Page | Endpoints | Description |
|---|---|---|
| Groups & Model Access | ~8 | Group CRUD, membership, per-group DLP overrides, model access rules |
| Quotas | ~4 | Per-user and per-group daily/monthly token, request, and cost caps |
| SAML Admin | ~4 | SAML IdP CRUD, SP metadata, SSO login initiation |
| SCIM Provisioning | ~6 | SCIM 2.0 user/group provisioning, token management |
| OAuth Clients | ~4 | OAuth M2M client CRUD, secret rotation |
| Passkey / WebAuthn | ~6 | Hardware key registration, authentication, credential management |
| Credentials | 3 | Unified credential rotation, revocation, and listing across all secret types |
Compliance & Audit
Section titled “Compliance & Audit”| Page | Endpoints | Description |
|---|---|---|
| Compliance Export | ~3 | Compliance bundle export, bulk export, import with conflict resolution |
| Compliance Reporting | ~3 | Per-bundle detection stats, all-bundles overview, exportable reports |
| Conversation Export | ~3 | Single conversation, filtered list, async bulk export |
System
Section titled “System”| Page | Endpoints | Description |
|---|---|---|
| System Health | ~4 | Liveness, readiness, component status, version metadata |
| Alerts API | ~4 | Alert rules CRUD, trigger history, manual evaluation |
| Webhooks API | ~4 | Webhook CRUD, test delivery — DLP triggers, quota events |
| System Config Keys | 2 | All 62 admin-configurable runtime keys with types, defaults, constraints, and per-org overrides |
| Org Settings | 2 | Display name, allowed domains, session policies, MFA, feature flags |
| Config Backup | 2 | Full org config snapshot export/import (20-domain, schema v2.0) |
| Usage Analytics | 1 | Time-series request data, per-model breakdowns, top-user cost rankings |
| Output Quality API | 3 | Quality metrics aggregation, threshold alerts, model comparison by composite score |
| Observability API | 16 | Drift detection (latency/topic/behavior), bias & fairness (disparate treatment, sentiment), model evaluation (comparisons, golden sets, analytics) |
Cloud Portal API
Section titled “Cloud Portal API”The Cloud service (cloud.arbitex.io) powers the customer portal. Endpoints are org-scoped with Portal JWT authentication and IDOR prevention via org claim cross-checks.
| Page | Key Endpoints | Description |
|---|---|---|
| Cloud Outpost API | ~6 | Outpost registration, listing, deregistration from the portal |
| Portal Search | 1 | Global search across portal resources |
| Platform Admin (Portal) | — | Portal-side admin operations |
| Security Admin | — | Security configuration from the portal |
| Avatar & Analytics | ~3 | User avatar management and analytics dashboard |
Outpost Admin API
Section titled “Outpost Admin API”The Outpost service runs on-premises and exposes a local admin API on port 8301. All admin endpoints require the outpost admin API key via Authorization: Bearer or X-Admin-Key header.
| Page | Key Endpoints | Description |
|---|---|---|
| Outpost Admin API | ~20 | Full outpost admin surface — status, overrides, DLP, audit, certs |
| Outpost Admin CLI | 20 commands | CLI reference for all outpost management commands |
API Batch Reference
Section titled “API Batch Reference”Batches document endpoints in the order they were added to the platform. Each batch covers a group of related endpoints across one or more services. Use the domain-organized tables above to find endpoints by function; use the batch list below for chronological reference or to find recently added endpoints.
Batches 6–15 (Foundation)
Section titled “Batches 6–15 (Foundation)”| Batch | Endpoints | Domains Covered |
|---|---|---|
| Batch 6 | 3 | DLP events, DLP stats, session management |
| Batch 7 | ~10 | WebAuthn/FIDO2, conversation tags, IP allowlist, SCIM tokens, search |
| Batch 8 | ~8 | Cloud Portal org management, SSO, member management, outpost registration |
| Batch 9 | ~8 | Avatar, preferences, system config, model catalog |
| Batch 10 | ~12 | Policy Engine, compliance bundles, DLP rules, SIEM, kill switch |
| Batch 11 | ~10 | Model registry (SR 11-7), attachments, audit, custom endpoints, SOC 2 |
| Batch 12 | ~8 | Audit events, password reset, usage stats, MFA policy, folders, sessions |
| Batch 13 | ~10 | Effective policy, usage export, sessions, WebAuthn, SCIM 2.0 |
| Batch 14 | ~10 | SIEM config, policy simulation, compliance reporting, audit export, SOC 2, provider chains |
| Batch 15 | ~20 | Per-org SIEM/DLP/IP/compliance, policy templates, intent routing, rate limits, invites, projects, costs, passkeys |
Batches 24–34 (Portal & Fleet)
Section titled “Batches 24–34 (Portal & Fleet)”| Batch | Endpoints | Domains Covered |
|---|---|---|
| Batch 24 | ~4 | DLP accuracy metrics, portal notifications, admin data export |
| Batch 25 | ~5 | Billing portal, org settings, outpost config diff |
| Batch 26 | ~6 | Portal health monitoring, pagination, outpost TLS + metrics |
| Batch 27 | ~6 | Portal API key management, outpost rate limiting, circuit breakers |
| Batch 28 | ~5 | Portal global search, onboarding status, outpost admin audit |
| Batch 29 | ~6 | Audit viewer, webhook deliveries, health monitoring |
| Batch 30 | ~6 | Usage + billing APIs, outpost security headers, admin status |
| Batch 31 | ~8 | RBAC members, audit export, outpost actions, config hot-reload |
| Batch 32 | ~6 | Portal notifications, DLP alert thresholds, session management, OTel |
| Batch 33 | ~8 | Advanced org settings, DLP simulate, outpost IP allowlist, audit search |
| Batch 34 | ~6 | Billing usage, CSV export, plan details, outpost cert management, config backup |
Batches 35–57 (Deep Reference)
Section titled “Batches 35–57 (Deep Reference)”| Batch | Endpoints | Domains Covered |
|---|---|---|
| Batch 35 | ~8 | SSO config (SAML/OIDC), SCIM provisioning, MFA status, outpost cache |
| Batch 36 | ~8 | API key management, outpost JWT auth, replay protection, audit verification |
| Batch 37 | ~8 | Plugin registry, webhook emitter, custom patterns, outpost auth |
| Batch 38 | ~8 | Compliance reporting (async), multi-org APIs, outpost health summary |
| Batch 39 | ~5 | Entity types, secret detection packs, per-entity accuracy |
| Batch 40 | ~6 | Account recovery, tenant lifecycle, usage quota/summary |
| Batch 41 | ~6 | Tenant admin (suspend/activate/delete), usage quota, per-user/group quotas |
| Batch 42 | ~5 | Self-service recovery, passkey enforcement, webhook delivery management |
| Batch 43 | ~6 | Content categories, knowledge diff, group features, compliance bundles |
| Batch 44 | ~6 | Webhook delivery stats, system health alerts, alert rules, onboarding |
| Batch 45 | ~8 | Onboarding steps, portal invoices, daily usage, billing dashboard |
| Batch 46 | ~12 | Billing CRUD, org usage, health endpoints, admin org list |
| Batch 47 | ~10 | Health components, DLP pipeline stats, signed audit export, outpost health |
| Batch 48 | 21 | Emergency kill-switch, DLP alert thresholds, model governance, security events, compliance reports |
| Batch 50 | 27 | Notification center, outpost fleet management, provider health/circuit breakers |
| Batch 51 | 22 | SSO config, MFA flow, PKCE auth, portal activity, provisioning jobs |
| Batch 52 | 18 | Cloud DLP proxy, OAuth sub-resources, user management, passkey policy |
| Batch 53 | 0 | Correction batch — OAuth client CRUD fixes (PUT method, pagination format), Cloud proxy field mapping |
| Batch 54 | ~24 | Data retention policies, org recovery policy, usage CSV export, SCIM token rotation, outpost admin JWT auth |
| Batch 55 | ~12 | Connection health, bandwidth monitoring, circuit breakers, upgrade orchestrator, version compatibility |
| Batch 56 (Cloud) | ~7 | Email templates, notification type preferences, endpoint summary |
| Batch 57 | ~12 | Compliance reporting, data retention policies |
| Batch 58 | ~6 | Compliance bundle lifecycle (activate, deactivate, version history, seeded bundle upgrade) |
| Batch 59 | 7 | Conversation search, policy simulation, cost attribution, cost forecast, group features, attachment scanning |
| Batch 60 | 12 | DLP stats aggregate, DLP event lifecycle, effective policy resolution, chain template CRUD |
| Batch 61 | 8 | Retention policy management (CRUD, preview, manual run, run-all) |
| Batch 62 | 13 | Model guidance prompts, MCP server integration, conversation branching, conversation sharing links, project management |
| Batch 63 | 12 | Admin attachment quarantine management, admin usage statistics (summary/history/by-model/alerts), content category taxonomy admin |
| Batch 64 | 13 | Customer audit log API (org-scoped), org compliance bundle management, setup wizard, portal fallback chains, internal Platform–Cloud mTLS API |
Non-Batch Reference Pages
Section titled “Non-Batch Reference Pages”These standalone pages provide deep-dive documentation for specific subsystems that span multiple endpoints or require architectural context beyond individual endpoint specs.
| Page | Description |
|---|---|
| Outpost Admin API Reference | Complete reference for all ~102 outpost admin API endpoints on port 8301 |
| Configuration Reference | Every environment variable across Platform, Cloud, and Outpost |
| CLI Reference | All 20 Outpost CLI commands with flags, output formats, exit codes |
| Error Codes | All error codes across all services with resolution steps |
| DLP Architecture | 5-tier DLP pipeline internals, detection flow, accuracy metrics |
| Rate Limiting Architecture | Rate limit tiers, bucket design, header semantics |
| Industry Compliance | Regulatory framework mapping (PCI-DSS, HIPAA, SOX, etc.) |
Endpoint Count Summary
Section titled “Endpoint Count Summary”| Service | Documented Endpoints (approx.) |
|---|---|
| Platform (Gateway + Admin) | ~234 |
| Cloud (Portal API) | ~120 |
| Outpost (Admin API) | ~102 |
| Total | ~456 |