API Changelog
Track all changes, updates, and improvements to the HireCharacter API.
Version 1.2.0
Released January 15, 2025Added
- Bulk Assessment API: New
POST /assessments/bulkendpoint for processing multiple candidates simultaneously - Webhook Retry Logic: Automatic retry mechanism for failed webhook deliveries with exponential backoff
- Assessment Templates: Pre-configured assessment templates for common job roles
- Enhanced Filtering: Advanced filtering options for signals search with date ranges and confidence levels
- Report Customization: New parameters for customizing generated reports (branding, sections, format)
Improved
- Performance: 40% faster response times for assessment processing
- Rate Limiting: More granular rate limits per endpoint with burst allowances
- Error Messages: More descriptive error messages with actionable guidance
- Documentation: Complete OpenAPI 3.0.3 specification with examples
Changed
- Authentication: API keys now require the
Bearerprefix in Authorization header - Pagination: Default page size increased from 10 to 20 items
- Response Format: Standardized error response structure across all endpoints
Breaking Changes: API keys without Bearer prefix will be deprecated on March 1, 2025. Update your authentication headers.
Version 1.1.3
Released December 20, 2024Added
- Signal Verification: Community-driven verification system for signal accuracy
- Export Formats: Support for CSV and Excel exports in assessment reports
- API Health Check: New
GET /healthendpoint for service monitoring
Improved
- AI Analysis: Enhanced sentiment analysis with context awareness
- Search Performance: 60% improvement in signal search response times
- Data Quality: Improved duplicate detection and filtering
Fixed
- Fixed pagination issues in large result sets
- Resolved timeout errors in bulk operations
- Fixed character encoding issues in international names
Version 1.1.2
Released November 28, 2024Added
- Matching Algorithm v2: Improved candidate matching with personality compatibility scores
- Real-time Notifications: WebSocket support for real-time assessment status updates
- Signal Categories: New categorization system for different types of public signals
Improved
- Security: Enhanced API key management with scoped permissions
- Reliability: Improved error handling and retry mechanisms
- Documentation: Added more code examples and use cases
Version 1.1.1
Released October 15, 2024Improved
- Performance: Optimized database queries for faster response times
- Accuracy: Enhanced AI models for better character trait detection
- Scalability: Improved infrastructure to handle increased load
Fixed
- Fixed memory leaks in long-running assessment processes
- Resolved issues with special characters in candidate names
- Fixed webhook delivery failures for certain payload sizes
Version 1.1.0
Released September 30, 2024Added
- Candidate Profiles: Comprehensive candidate profile management system
- Assessment History: Track assessment history and progress over time
- Team Management: Multi-user support with role-based access control
- Custom Scoring: Configurable scoring models for different industries
Changed
- API Structure: Reorganized endpoints for better logical grouping
- Rate Limits: Adjusted rate limits based on subscription tier
Version 1.0.0
Released August 15, 2024Initial Release
- Core API: Complete REST API for character assessment and matching
- Authentication: API key-based authentication system
- User Management: Basic user and organization management
- Assessments: Character assessment creation and result retrieval
- Signal Processing: Public signal collection and analysis
- Report Generation: PDF and JSON report generation
- Webhooks: Real-time notification system
- Documentation: Complete API reference and examples
🎉 Initial Launch: HireCharacter API v1.0.0 officially launched with full feature set!
Quick Navigation
Release Schedule
We follow semantic versioning (SemVer) for all releases:
- Major (x.0.0): Breaking changes
- Minor (x.y.0): New features
- Patch (x.y.z): Bug fixes
Release Frequency:
• Minor releases: Monthly
• Patch releases: As needed
• Major releases: Quarterly
Deprecation Policy
We maintain backwards compatibility and provide advance notice for any breaking changes:
- 90 days notice for breaking changes
- 6 months support for deprecated features
- Migration guides for major version updates
Stay Updated
Get notified about API updates: