Versioning

The Clipform API is versioned so you can build against a stable surface.

Version in the URL

The version is the first path segment, so every request names the version it targets:

https://api.clipform.io/v1

Pin your integration to /v1. We will not remove or change the behaviour of an existing /v1 endpoint in a breaking way.

What can change without a new version

These are backward-compatible and can ship inside /v1 at any time, so write your client to tolerate them:

• New endpoints.
• New optional request parameters.
• New fields on a response object.

Breaking changes

A change that removes an endpoint or field, renames one, or changes its meaning is a breaking change. Breaking changes ship under a new version prefix (/v2); the previous version keeps working through its deprecation window.

Deprecation and sunset

When an endpoint is deprecated:

• It is marked deprecated in the OpenAPI specification.
• Its responses carry a Deprecation header and a Sunset header (RFC 8594) giving the date after which it may stop responding.
• The sunset date is at least 90 days out, so you have time to migrate.

Watch for a Sunset response header in your integration and treat it as a signal to move to the replacement documented alongside the deprecated endpoint.