API contract

Versioning and deprecation.

A short policy agents can rely on when integrating with PremiumPin.

Versioning

The current REST API uses the /v1/ path. Additive fields, new endpoints, and compatible corrections may ship within v1. A breaking request or response change requires a new major path.

Deprecation and sunset

PremiumPin will publish the replacement and provide at least 90 days notice before removing a deprecated endpoint. During that period, deprecated responses will include Deprecation: true, an RFC 8594 Sunset date, and a Link to this policy with rel="deprecation". No v1 endpoint is currently deprecated.

Machine contracts

Use the current OpenAPI 3.1 specification for routes and request shapes. Use the API catalog and llms.txt for discovery and agent-routing guidance.