Alloovium

Developer Documentation

Build on Alloovium

Public REST API v2 and Model Context Protocol server for document intelligence. Everything you need to integrate Alloovium's vault, chat, workflows, and template filler into your own product or LLM agent.

Base URL

All production API v2 endpoints are served under Base URL. A separate staging environment is available for pre-production validation; use the staging base URL listed in the live OpenAPI servers block or provided with your staging credentials. Every request must be HTTPS.

Developer Console

Create test and live API keys, register OAuth clients, and monitor your monthly developer-credit allowance from path. Free and trial workspaces start with sandbox credits so you can validate integrations before moving into paid traffic.

Get started

Quickstart

Create your first API key and make a call in under five minutes.

Authentication

API keys, OAuth 2.1 with PKCE, Dynamic Client Registration, scopes.

API Reference

Interactive Scalar reference generated from the hand-built OpenAPI 3.1 spec.

Developer Console

Create API keys, manage OAuth clients, and track your $100 in free starting credits.

Core concepts

Every capability — vault CRUD, chat, workflows, templates, meta — speaks the same conventions. Learn them once and you can call anything.

Rate Limits

Token buckets, burst capacity, four tiers, X-RateLimit headers, retry guidance.

Errors

RFC 7807 problem-detail envelope, stable error codes, request IDs.

Idempotency

Safely retry mutations with Idempotency-Key. 24-hour replay window.

Pagination

Cursor-based paging envelope shared by every list endpoint.

Capabilities

Seventeen capabilities grouped across five domains. Each one is exposed both as a REST endpoint and as an MCP tool, from a single registry entry — so the two surfaces never drift.

Projects

Projects, documents, uploads, and hybrid semantic + keyword search.

Chat

Ask questions grounded in your vault. Streaming and non-streaming.

Workflows

List workflows, start runs, and poll run status for outputs.

Templates

Fill DOCX templates from project evidence. Upload + poll pattern.

Meta

Whoami, scope discovery, and credential introspection.

MCP Server

Expose every capability as a Model Context Protocol tool for LLM agents.

Use cases

End-to-end integration guides for real construction workflows — with working Python code, realistic API calls, and deployment advice. Start here if you are building a new integration.

Use Cases Overview

Browse all six integration patterns with difficulty ratings and build-time estimates.

Contract Intelligence Pipeline

Extract obligations, payment terms, and milestones — push structured data to Procore or Jira.

Subcontractor Compliance Checker

Verify insurance certificates and licences against project requirements before mobilisation.

Automated Project Reports

Schedule weekly reports from your document vault, delivered to Slack or email.

How it fits together

Alloovium's public surface is built on a capability registry. Every operation is declared once and automatically mounted as:

  • A REST endpoint with OpenAPI 3.1 schema, rate limiting, and scope enforcement.
  • An MCP tool with the same input/output schema for LLM agents.
  • An audit log entry tagged with the capability name for every call.

The OpenAPI spec at path is the canonical machine-readable reference. The Scalar-powered browser at /developers/api-reference lets you try every endpoint interactively.

Versioning and stability

The public API is v2. We commit to the following stability contract:

  • Error code fields are stable — we will never silently rename one.
  • Breaking changes ship behind a new version prefix, never inside v2.
  • Additive changes (new optional fields, new capabilities) may land at any time.
  • Deprecated endpoints run for at least 90 days with a header header.

Watch the changelog for additions and deprecations.

Get help

Contact email with your field (returned in every error response) and we can trace any call end-to-end. For security reports, email security.