Implementation: DESIGN (server) · Exposure: PUBLIC PREVIEW (contract). The Agency API is not live yet. This page describes the published v0.3 contract so you can review and build against it; details may change before alpha.
The contract document itself is versioned v0.3 while it is a preview. The API it describes uses the scheme below.

​
Major version in the URL

The major version is part of the path: https://api.allternit.com/v1/.... A breaking change ships as a new major path. /v1 does not change incompatibly.

​
Dated minor versions

Compatible behavior changes are released as dated versions and selected with a request header:
  • If you omit the header, the version pinned to your API key applies.
  • Every response echoes the Allternit-Version that served it.
  • An unsupported value returns ERR_VERSION_UNSUPPORTED.
Pin a version in production and move forward deliberately.

​
Deprecation

When a behavior is scheduled for removal, responses that use it carry:

​
Unknown fields and values

These rules are what make additive change safe. They mirror the kernel contract evolution rules.

​
Extensions and metadata

  • Closed objects accept extension properties named x-<name> (pattern ^x-[a-z0-9-]+$). Extensions never change kernel semantics.
  • Your own annotations go in metadata, a string map of at most 50 keys with values up to 500 characters.