This guide provides comprehensive documentation for integrating the Releases API into your application, including authentication, data models, endpoints, and workflow management.
Overview
The Releases API enables developers to create and manage music releases through a complete workflow system. The API supports release creation, track management, media uploads, review workflows, feedback systems, and automatic catalog integration.Key Features
Release Management
Create, update, and manage music releases with multiple tracks and comprehensive metadata
Media Management
Upload files or submit external links for tracks and release artwork
Workflow System
Complete approval workflow from draft to automatic catalog integration
Feedback System
User and admin feedback with internal notes and review communication
Authentication
All API endpoints require Bearer token authentication. Include your JWT token in the Authorization header.
Data Models
Release Model
Release Schema
Release Schema
Release Asset (Track) Model
Track Schema
Track Schema
Media Model
Media Schema
Media Schema
Release Feedback Model
Feedback Schema
Feedback Schema
Release Workflow
1
Draft Creation
User creates a release in draft status with basic information and tracks. Multiple drafts can be saved and edited.
2
Media Upload
User uploads audio files, artwork, and other media or submits external links (WeTransfer, Google Drive, etc.)
3
Submission
User submits the completed release for admin review. Release must have complete metadata and at least one track.
4
Admin Review
Admin reviews the submission and can approve, reject, or request changes with detailed feedback.
5
Auto-Creation
Upon approval, the system automatically creates catalog products and assets with proper metadata and file associations.
6
Completion
Release is marked as completed and all content is available in the main catalog system.
API Endpoints
Create Release
Request Body Schema
Request Body Schema
Upload Media Files
Submit Media Links
Upload Track Media
Get Releases with Filtering
Submit Release for Review
Only releases in ‘draft’ or ‘rejected’ status can be submitted for review. Release must have at least one track with complete metadata.
Review Release (Admin Only)
This endpoint requires admin privileges. Only releases in ‘submitted’ status can be reviewed.
Add Feedback
Link Existing Asset to Release
Reorder Tracks
Error Handling
Common Error Codes
400 - Bad Request
400 - Bad Request
401 - Unauthorized
401 - Unauthorized
403 - Forbidden
403 - Forbidden
404 - Not Found
404 - Not Found
Status Workflow & Permissions
Understanding the release status workflow and permission system is crucial for proper integration.
Status Transitions
Current Status | Available Actions | Next Status | Who Can Perform |
---|---|---|---|
draft | Edit, Delete, Submit | submitted | Owner, Admin |
submitted | Review, Add Feedback | under_review , approved , rejected | Admin |
under_review | Review, Add Feedback | approved , rejected | Admin |
approved | Revert Status | submitted , completed | Admin |
rejected | Edit, Submit | submitted | Owner, Admin |
completed | View Only | - | All |
Permission Matrix
Regular Users
- Create own releases
- Edit own draft/rejected releases
- Submit releases for review
- Add public feedback
- Delete own draft releases
- View own releases
Admin Users
- All regular user permissions
- View all releases
- Review any submission
- Approve/reject releases
- Add internal feedback
- Delete any release
- Revert release status
- Create releases for other users
Auto-Creation Process
When a release is approved, the system automatically:- Creates Products: Main release product in catalog
- Creates Assets: Individual track assets with metadata
- Transfers Media: Moves files from temporary to permanent storage
- Links Relationships: Establishes proper product-asset associations
- Updates Status: Marks release as completed
- Sends Notifications: Notifies relevant users
Monitoring Auto-Creation
Handling Auto-Creation Failures
If auto-creation fails (autoCreationStatus: 'failed'
), admins can:
- Review Error Details: Check
autoCreationError
field - Revert Status: Use revert endpoint to send back for corrections
- Manual Processing: Create catalog items manually if needed
Best Practices
Release Creation
Release Creation
- Always validate required fields before submission
- Ensure at least one primary artist is specified
- Include comprehensive track information and metadata
- Use proper ISRC/ISWC codes when available
- Set appropriate explicit content flags
- Upload high-quality media files or valid external links
- Test audio files before submission
Media Management
Media Management
- Use lossless audio formats (WAV/FLAC) when possible
- Minimum 320kbps MP3 for compressed audio
- Upload artwork at minimum 3000x3000px resolution
- Use descriptive file names
- Validate external links before submission
- Consider file size limits for uploads
Error Handling
Error Handling
- Implement retry logic for network failures
- Handle validation errors gracefully with specific user feedback
- Show meaningful error messages based on API response details
- Log errors with sufficient context for debugging
- Handle auto-creation failures with appropriate user messaging
Performance
Performance
- Use pagination for release lists with appropriate page sizes
- Implement caching for frequently accessed release data
- Debounce search inputs to reduce API calls
- Lazy load track details and media when needed
- Use background processing for large file uploads
Security
Security
- Always validate JWT tokens and handle expired tokens
- Never expose sensitive information in client-side code
- Implement proper permission checks before API calls
- Sanitize all user inputs before sending to API
- Use HTTPS for all API communications
- Validate file types and sizes before upload
Complete Integration Example
Webhooks & Notifications
The API includes a comprehensive notification system that sends real-time updates for release events.
Webhook Events
Event | Description | Payload |
---|---|---|
release.created | Release created | Release object |
release.submitted | Release submitted for review | Release object |
release.approved | Release approved by admin | Release object + reviewer info |
release.rejected | Release rejected by admin | Release object + feedback |
release.completed | Auto-creation completed successfully | Release object + created assets |
release.auto_creation_failed | Auto-creation process failed | Release object + error details |
release.feedback_added | New feedback added | Feedback object + release info |
Setting Up Webhooks
Testing & Validation
Test Environment Setup
Conclusion
The Releases API provides a comprehensive solution for managing music submissions and catalog creation. By following this guide, you can integrate a complete release workflow into your application, from initial submission through approval and automatic catalog creation.Key Takeaways
- Workflow-Centric Design: The API is built around a clear submission-to-publication workflow
- Comprehensive Media Support: Handle both file uploads and external links seamlessly
- Robust Error Handling: Implement proper error handling for all API interactions
- Performance Considerations: Use pagination, filtering, and caching appropriately
- Security Best Practices: Always validate permissions and sanitize inputs
Next Steps
- Implement webhook handling for real-time updates
- Set up monitoring and analytics for release workflows
- Customize the UI/UX to match your application’s design
- Consider implementing additional features like bulk operations or advanced analytics