Start
First developer journey
Authenticate
Use the issued alpha realm and grant type. No self-service credentials are published.
02Select Tenant Context
Discover admitted tenants and mint the server-owned context token for tenant-scoped calls.
03Build A Read Journey
Follow a complete policy lookup recipe from access pack to rendered application data.
04Run An SDK Example
Use the Five Acts example to exercise generated SDK calls against a public-safe scenario.
05Browse The Contract
Use the generated 0.2.83 reference for endpoint, schema, and response detail.
06Request Preview Access
Send the structured intake fields so credentials can be approved, issued, and smoke-tested through the private access path.
Build Path
Move from contract to application code
Start with the generated reference, use the quickstart to prove access, then run the Five Acts SDK example before adding screen behaviour. Keep unavailable behaviour visible as an application gap until the API or issued access pack commits the shape.
OpenAPI 0.2.83
Five Acts
X-Correlation-ID
Reference
Generated from OpenAPI
The browsable API Reference is generated from the same OpenAPI source used for SDK generation and contract checks. Endpoint truth belongs in the contract, not in hand-written page copies.
curl -fsS https://api.afr-dev.axiom.express/v1/health \
-H "X-Correlation-ID: dev-preview-check"Recipes
One useful application path first
The first public recipe shows how a backend obtains a bearer token, mints tenant context, reads party and policy information, and keeps unavailable data as explicit application gaps.
OIDC discovery
X-Tenant-Context
read-oriented
Guide
How to consume the reference
Use the API Guide for the public auth model, tenant-context sequence, generated reference posture, alpha rate-limit posture, and upload-constraint posture before wiring client code.
Authorization: Bearer <jwt>
X-Tenant-Context: <server-minted context>
X-Correlation-ID: <support trace>Operating Model
Public contract rules
Tenant Data Is Tenant-Owned
Axiom provides the engine and API surface. Business data belongs to the admitted tenant.
Rules Are Data
Insurance variation belongs in governed product grammar and rules, not client forks.
Explainability Is Required
Material decisions must preserve the evidence needed to explain outcomes to affected parties.
Alpha Is Admitted
Request developer-preview access through help@axiom.express. Access is approved and issued before credentials are usable.
Versioning
0.x.y until the stable external commitment
API families live in the URL path. The current family is
/v1, and the current developer-preview contract is
0.2.83. Axiom uses SemVer 0.x.y through
alpha and beta; 1.0.0 is reserved for the first stable
external-client API commitment.
X-API-Version
info.version
/v1
SDKs
Generated SDK lanes
TypeScript
Generated wire types and client surfaces are maintained from OpenAPI. Public package docs are still under preview review.
Python
Use the Five Acts example as the first reviewed backend-owned Python SDK consumption path.
Examples
Executable examples are synchronized with the canonical Five Acts demo and checked for public safety and freshness.
Agent Consumption
llms.txt lists the safe entry points for AI agents, generated contracts, and executable examples.
Support
Escalate with correlation evidence
For failed calls, include correlation ID, endpoint, HTTP status, timestamp, and the admitted API environment. Browser clients may not read every diagnostic response header until all expose-header work has landed.