DocsAPI ReferenceContact Us

API Versioning

CAPTUR3D’s API uses a rolling date-based versioning scheme to ensure smooth updates while maintaining support for previous versions.

Versioning Strategy

  • As the API evolves, new versions are introduced when breaking changes are made.

  • Each version is identified by its release date as yyyy-mm-dd (e.g. 2025-01-01).

  • Older versions remain supported for backward compatibility, but we recommend upgrading to the latest version when possible to take advantage of new features and improvements.

Selecting an API Version

You can specify the desired API version by including the x-api-version header in your requests:

e.g.

x-api-version: '2025-01-01'

Default API Version

  • If you do not include the x-api-version header, CAPTUR3D will automatically use the latest available API version.

  • To prevent unexpected changes, we strongly recommend specifying a version in all requests.

Deprecation and Support

  • Older API versions will continue to be supported for a period of time, but deprecated versions may eventually be retired.

  • We will provide advance notice before any version is discontinued.

  • To stay up to date, check the Changelog for announcements on new releases and deprecations.

Changelog