Parameter Selection Logic
- audioId parameter:
- The audioId parameter is required to identify the exact track
- Provides a unique identifier for the audio track within the generation task
Developer Notes
- Timestamp values are in seconds
- Returned waveform data can be used for audio visualization
- For instrumental tracks (generated with instrumental=true), no lyrics data will be available
- Typical use case: Karaoke-style lyrics display in music player interfaces
Authorizations
🔑 API Authentication
All endpoints require authentication using Bearer Token.
Get API Key
- Visit the API Key Management Page to obtain your API Key
Usage
Add to request headers:
Authorization: Bearer YOUR_API_KEY⚠️ Note:
- Keep your API Key secure and do not share it with others
- If you suspect your API Key has been compromised, reset it immediately from the management page
Body
application/json
Response
Request successful
Status Codes
- ✅ 200 - Request successful
- ⚠️ 400 - Invalid parameters
- ⚠️ 401 - Unauthorized access
- ⚠️ 404 - Invalid request method or path
- ⚠️ 405 - Rate limit exceeded
- ⚠️ 413 - Theme or prompt too long
- ⚠️ 429 - Insufficient credits
- ⚠️ 430 - Your call frequency is too high. Please try again later.
- ⚠️ 455 - System maintenance
- ❌ 500 - Server error
Available options:
200, 400, 401, 404, 405, 413, 429, 430, 455, 500 Example:
200
Error message when code != 200
Example:
"success"
