API Reference

RESTful APIs for data ingestion, entity management, workflow triggers, and real-time intelligence queries. Authenticated via OAuth 2.0 with RBAC enforcement.

Core API surface

GET

/v1/entities

Query operational entities sites, assets, contractors, deliveries with full-text search, relationship traversal, and field-level projection.

POST

/v1/ingest

Streaming and batch data ingestion. Accepts JSON, CSV, and Parquet. Automatic schema detection, deduplication, and conflict resolution.

POST

/v1/workflows/trigger

Programmatically trigger automation workflows. Supports conditional logic, chained actions, and webhook callbacks for async operations.

GET

/v1/intelligence/query

Real-time intelligence queries against the operational model. Supports KPI aggregation, anomaly detection, and time-series analysis.

GET

/v1/audit

Immutable audit log access. Every read, write, and administrative action with timestamp, actor, and diff. SIEM export available.

WSS

/v1/stream

WebSocket stream for real-time event subscriptions. Subscribe to entity changes, threshold breaches, and workflow state transitions.

🔑

Authentication

OAuth 2.0 with client credentials or authorization code flow. All tokens scoped to tenant + role. MFA required for token generation.

Rate Limits

10,000 requests/min per tenant (standard). Burst-capable with back-pressure headers. Enterprise tiers negotiable.

📦

SDKs

Official client libraries for Python, Node.js, Go, and .NET. OpenAPI 3.1 spec available for code generation in any language.

Full API documentation with interactive examples, SDKs, and sandbox access is provisioned during enterprise onboarding.

Request API Access