Suno Custom Models API
POSThttps://hsyunapi.hszl-bd.cn/suno/custom-models
Create and manage custom music models from 6 to 24 authorized audio files.
Request Headers
acceptstring
Response format, currently only supports JSON.
Please select
authorizationstring
Bearer token
Request Body
actionstringRequired parameter
Please select
Response
Success200
The operation has been accepted or completed. The creation operation will immediately return queued, and the final result can be obtained through a query or callback.
Response Body
idstring
statusstring
successboolean
task_idstring
idempotent_replayboolean
Is it an idempotent replay; when true, it returns the existing model created by the first request and will not charge again.
Success200
The operation has been accepted or completed. The creation operation will immediately return queued, and the final result can be obtained through a query or callback.
Response Body
dataobject
idstring
Exclusive music model platform ID.
namestring
Model name, up to 100 characters long.
statusstring
Model status. Only the `ready` state can be used for song generation.
task_idstring
The platform ID for creating tasks, which can be used to associate callbacks and troubleshoot issues.
progressobject
Model creation progress.
stagestring
totalinteger
uploadedinteger
created_atnumber
Creation time, Unix second timestamp.
updated_atnumber
Latest update time, Unix timestamp in seconds.
archived_atnumber
Archive time, Unix second timestamp.
source_countinteger
The number of authorized audio files used to create the model.
elapsednumber
successboolean
started_atnumber
finished_atnumber
Success200
The operation has been accepted or completed. The creation operation will immediately return queued, and the final result can be obtained through a query or callback.
Response Body
dataobject
countinteger
itemsarray
Array of
idstring
Exclusive music model platform ID.
namestring
Model name, up to 100 characters long.
statusstring
Model status. Only the `ready` state can be used for song generation.
task_idstring
The platform ID for creating tasks, which can be used to associate callbacks and troubleshoot issues.
progressobject
Model creation progress.
stagestring
totalinteger
uploadedinteger
created_atnumber
Creation time, Unix second timestamp.
updated_atnumber
Latest update time, Unix timestamp in seconds.
archived_atnumber
Archive time, Unix second timestamp.
source_countinteger
The number of authorized audio files used to create the model.
elapsednumber
successboolean
started_atnumber
finished_atnumber
Success200
The operation has been accepted or completed. The creation operation will immediately return queued, and the final result can be obtained through a query or callback.
Response Body
dataobject
idstring
statusstring
capacity_releasedboolean
elapsednumber
successboolean
started_atnumber
finished_atnumber
Success200
The operation has been accepted or completed. The creation operation will immediately return queued, and the final result can be obtained through a query or callback.
Response Body
task_idstring
trace_idstring
Success200
The operation has been accepted or completed. The creation operation will immediately return queued, and the final result can be obtained through a query or callback.
Response Body
costobject
object <string, unknown>
dataarray
Array of
idstring
lyricstring
modelstring
statestring
stylestring
titlestring
promptstring
durationnumber
audio_urlstring
image_urlstring
video_urlstring
created_atstring
elapsednumber
successboolean
task_idstring
started_atnumber
finished_atnumber
Failure400
The request parameters or action are invalid.
Response Body
errorobject
codestring
messagestring
successboolean
task_idstring
trace_idstring
started_atnumber
Failure401
The authentication information is invalid.
Response Body
errorobject
codestring
messagestring
successboolean
task_idstring
trace_idstring
started_atnumber
Failure403
Insufficient balance or unauthorized to perform this operation.
Response Body
errorobject
codestring
messagestring
successboolean
task_idstring
trace_idstring
started_atnumber
Failure404
The specified model cannot be found in the current application.
Response Body
errorobject
codestring
messagestring
successboolean
task_idstring
trace_idstring
started_atnumber
Failure409
The model is not yet ready, or the current application has reached the model quantity limit.
Response Body
errorobject
codestring
messagestring
successboolean
task_idstring
trace_idstring
started_atnumber
Failure429
Too many requests, please try again later.
Response Body
errorobject
codestring
messagestring
successboolean
task_idstring
trace_idstring
started_atnumber
Failure500
The service is temporarily unavailable.
Response Body
errorobject
codestring
messagestring
successboolean
task_idstring
trace_idstring
started_atnumber
Failure504
Model creation timed out, you can continue to check the model status.
Response Body
errorobject
codestring
messagestring
successboolean
task_idstring
trace_idstring
started_atnumber
Integration guide
Shell
Python
JavaScript
Java
Go
PHP
Kind reminder: For streaming requests, the above code may not be fully applicable. Please refer to the integration documentation for changes.
Suno Music Generation
Allow Use General Balance
When 'Allow General Balance' is enabled, the general balance is used automatically if an app's balance is insufficient.