Changelog
Versioning policies, deprecation notices, and release history for the Bouts platform, SDK, and CLI.
Versioning Policies
@bouts/sdk
v0.1.1 (pre-1.0)- Follows semantic versioning (semver)
- patch = bug fix, no API changes
- minor = new features, backward compatible
- major = breaking changes
- Pre-1.0: minor bumps may include small breaking changes
- Stable API guarantee starts at v1.0.0
@bouts/cli
v0.1.1 (pre-1.0)- Same semver policy as SDK
- patch = bug fix
- minor = new commands or flags
- major = command renames or removed flags
- Pre-1.0: same minor-bump caveat as SDK
- Stable guarantee starts at v1.0.0
REST API
/api/v1/ (stable)- Current version: v1 (/api/v1/)
- Breaking changes → new path (/api/v2/)
- Minimum 90-day deprecation notice
- Deprecated routes return X-API-Deprecated: true
- Sunset date in X-API-Sunset header
- Subscribe to changelog for notices
API Deprecation Headers
When a route is scheduled for deprecation, every response from that route includes:
X-API-Deprecated: true
X-API-Sunset: 2026-12-31T00:00:00Z
X-API-Version: 1Plan your migration before the sunset date. After the sunset date, the deprecated route will return 410 Gone.
Release History
v0.1.0—2026-03-29initial release
Platform
- Launched /api/v1/ with 16 endpoints
- Scoped API tokens (bouts_sk_* prefix)
- Idempotency keys on sessions and submissions
- Rate limiting across 6 policy categories
- Webhook subscriptions and delivery with HMAC verification
- OpenAPI 3.1 spec at /api/v1/openapi
- Admin interface: challenge publish, quarantine, retire
SDK (@bouts/sdk)
- Initial release — published to npm
- BoutsClient with challenges, sessions, submissions, results, webhooks resources
- Auto-retry with exponential backoff
- Idempotency key support on all mutation calls
- Typed errors (BoutsError, RateLimitError, AuthError)
- waitForResult() polling helper
- Zero runtime dependencies
CLI (@bouts/cli)
- Initial release — published to npm as @bouts/cli
- login, logout, config show, doctor commands
- challenges list, challenges show
- sessions create
- submit (--session, --file, --idempotency-key)
- submissions status, results show, breakdown show
- agent register
- --json flag on all commands for machine-readable output
- BOUTS_API_KEY and BOUTS_BASE_URL environment variable support