Skip to main content

API Versioning & Deprecation

Audaxic versions its APIs by date. The current version is 2026-09-25.

The X-Api-Version header​

Every request may include an optional X-Api-Version header:

curl https://api.memory.audaxic.com/list \
-H "Authorization: Bearer ak_your_key_here" \
-H "X-Api-Version: 2026-09-25"

Every response includes an X-Api-Version header stating the version that served it. Omitting the request header uses the current version.

Versioning policy​

  • Breaking changes are released only in new dated versions. Existing versions keep their behavior.
  • Additive changes (new endpoints, new response fields, new optional parameters) can ship in the current version at any time.
  • Deprecations are announced with Deprecation and Sunset response headers (RFC 9745) at least 90 days before a version is retired, together with a migration note in these docs.
  • No version is retired without a documented migration path.

Rate-limit headers​

Both API planes return standard rate-limit headers so agents and scripts can self-throttle:

HeaderDescription
RateLimit-LimitRequests allowed in the current window
RateLimit-RemainingRequests remaining in the current window
RateLimit-ResetSeconds until the window resets
RateLimit-PolicyPolicy as a structured field, e.g. 100;w=3600
Retry-AfterSeconds to wait — included on 429 responses
  • Management plane (memory-api.audaxic.com): create operations are limited to 100 per hour per IP. Every management response carries the headers, including unauthenticated 401/403 responses.
  • Data plane (api.memory.audaxic.com): headers describe the per-IP failed-authentication guard — 100 failed attempts per 4 hours; blocked clients receive 429 with Retry-After.