Get Started

API Reference

Every v2 endpoint has a live, interactive reference rendered straight from the OpenAPI schema. You can read the spec, try requests against the production API, and copy working curl snippets — no extra setup.

Interactive reference

The interactive reference is generated by Scalar from the canonical OpenAPI document. It is served directly by the FastAPI application, so it is always in lockstep with the running version of the API:

bash
https://api.alloovium.com/api/v2/docs

Open it in a browser and you get per-endpoint request builders, schema explorers, and one-click curl / Python / JavaScript / Go snippets for every capability.

OpenAPI document

The raw OpenAPI 3.1 JSON is available at:

bash
https://api.alloovium.com/api/v2/openapi.json

Use it to generate SDKs (gen, ts, go), seed Postman / Insomnia collections, or drive contract tests. The spec covers the full surface — every REST route under prefix, the error envelope, scope requirements, and per-endpoint rate limits.

Quickly regenerate a TypeScript client

bash
npx openapi-typescript https://api.alloovium.com/api/v2/openapi.json \
  --output ./alloovium.d.ts

Or a Python client

bash
openapi-python-client generate \
  --url https://api.alloovium.com/api/v2/openapi.json

What lives where

The interactive reference is the source of truth for request/response shapes. The pages under Capabilities in this documentation site are the opinionated guide — they explain why an endpoint exists and when you should call it, with worked examples and design notes you will not find in raw schema.

Use both together

Read the capability guide to understand a feature, then open the Scalar reference to drill into the exact field types, enum values, and error codes.

API base URLs

bash
# Production
https://api.alloovium.com/api/v2

Every REST path in this documentation is relative to that production 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. Test keys (prefix test) are intended for non-production environments; live keys (live) are for production traffic.