API Versions

API Versions

Overview

API Versions allow developers to target specific releases of the Syntroper API to ensure stability, backward compatibility, and predictable behavior over time. You can pin your integration to a fixed version or migrate gradually to newer releases.

Why API Versions Matter

Using versioned APIs prevents unexpected breaking changes and ensures long term reliability in production systems.

Supported Version Types

Stable versions: Recommended for production use


Preview versions: Early access to upcoming features


Deprecated versions: Older releases scheduled for sunset

How to Specify an API Version

You can define the API version using request headers or query parameters.

Example Header Usage:

curl https://api.syntroper.com/v1/diagrams \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Syntroper-API-Version: 2025-01-01"

Example Query Parameter:

https://api.syntroper.com/v1/diagrams?version=2025-01-01