API changelog

This page is the slice of /changelog that affects callers of the AACSearch REST API, oRPC procedures and webhook payloads. Format follows Changelog format.

Versioning

REST API versions are URL-pinned (/api/v1/...). See Versioning and deprecation policy for the rules on when a new major appears and how long the previous major stays callable.

v1 — Stable

2026-05-05

• Added — Request ID (X-Request-Id) on every response. Accepts inbound UUID v4 or generates one. Logs include requestId, orgId, indexId, authType, route. (AAC-024)

2026-05-03

• Added — include_fields JOIN parameter in search procedures. SearchDocumentsInput.includeFields accepts AACSearch JOIN syntax like $Category(id, name). (AAC-569)
• Added — diversify_based_on parameter wired through searchDocuments() and multiSearchDocuments() for MMR diversification. (AAC-574)

Webhook payloads

Webhook payloads are versioned by event name (document.upserted.v1, sync.completed.v2). A new version is published instead of mutating an existing payload — receivers subscribe to a specific version in the webhook config.

Webhook payload changes ship here under the API scope tag with the event name in the entry, e.g.:

### Added

- **API · Webhook**: `document.upserted.v2` payload now includes
  `previousIndexedAt`. Receivers on `v1` are unaffected. (AAC-XXX)

How to subscribe

For automated tracking of API changes:

• RSS feed at https://docs.aacsearch.com/changelog/api.rss (Roadmap — see /reference/claim-status).
• GitHub releases on the aacsearch/api tag.
• The X-Deprecated response header during the 12-month deprecation window, machine-readable for monitoring.