Skip to content

Versioning & stability

Two things are versioned independently:

  • The URL path (/v1/) versions the API contract — request/response shapes. Breaking shape changes will ship under a new path version.
  • versions.taxonomy and versions.patterns version the classification behaviour. A patterns bump means the same title may classify differently than before; re-run any cached classifications if you depend on consistency.

New function-area and standard-role values may be added without an API version bump; treat the function and standard_roles lists as open-ended.

Results are deterministic per pattern version, so they are safe to cache. Pin the versions object returned with every response alongside your cached results, and invalidate when either version string changes.