API Versioning
The Galen API follows a versioned URL scheme to ensure stability for production integrations.
Current version
The current API version is v1. All endpoints are prefixed with /api/v1/.
Base URL
https://research.usegalen.com/api/v1Stability guarantee
Endpoints under v1 will not have breaking changes without a version bump. You can depend on the current response shapes and field names.
What counts as a breaking change
The following changes will always require a new API version:
- ×Removing an endpoint
- ×Removing or renaming a response field
- ×Changing a field's type
- ×Changing the meaning of existing error codes
- ×Requiring a previously optional parameter
What's not a breaking change
Additive changes are shipped without a version bump:
- ✓Adding new endpoints
- ✓Adding new optional fields to responses
- ✓Adding new optional query parameters
- ✓Adding new error codes
- ✓Increasing rate limits
Change communication
All changes are documented in the changelog. Breaking changes are announced at least 30 days in advance via the changelog and API response headers.
Deprecated endpoints include a Deprecation response header with the sunset date, giving you time to migrate before the change takes effect.