Skip to main content
AutosnapAI uses URL-based versioning — every endpoint is prefixed with a version (e.g. /v1/). New versions are introduced for breaking changes. Additive changes (new fields, new endpoints, new optional parameters) happen within an existing version without a bump.

​
Current version

​
What counts as a breaking change

These are breaking and trigger a new version:
  • Removing an endpoint
  • Removing a field from a response
  • Changing the type of an existing field
  • Renaming a field
  • Changing an enum value’s meaning
  • Making an optional request parameter required
  • Changing a required parameter’s type
These are non-breaking and happen without a version bump:
  • Adding a new endpoint
  • Adding a new optional request parameter
  • Adding a new field to a response
  • Adding a new enum value (consumers must tolerate unknown values)
  • Improving error messages
  • Fixing a bug in existing behavior
Your client must tolerate new fields in responses. We add fields to responses without bumping the version. If your parser fails on unknown fields, fix that first.

​
Deprecation policy

When we deprecate an endpoint or a field, our goal is to provide:
  1. At least 6 months of overlap between the old and new version.
  2. Advance notice via changelog and direct communication before the sunset date.
  3. Direct outreach to accounts with recent traffic on the deprecated endpoint.
AutosnapAI is currently on v1 with no deprecated endpoints. This policy will take effect when a v2 is introduced.

​
Staying informed

Contact support

Questions about upcoming changes? Reach out anytime.