Fish Model Get API
GEThttps://api.acedata.cloud/fish/model/{id}
Request Paths
idstring
The unique identifier of the sound model to be obtained.
Request Headers
acceptstring
Specify the response format returned by the server.
Please select
authorizationstring
Bearer token
Response
Success200
Request successful, returning sound model details.
Response Body
_idstring
The unique identifier of the sound model.
tagsarray
A list of free format labels attached to the model.
Array of
String
typestring
Types of voice models (such as `tts`, `svc`).
statestring
The current state of the model (such as `trained`, `training`).
titlestring
Display name of the voice model.
authorobject
Public information about the model author.
samplesarray
The list of preview audio samples for this sound model.
Array of
languagesarray
List of languages supported by this voice model.
Array of
String
created_atstring
The creation time of the model.
train_modestring
The training mode used to build this model.
updated_atstring
The last update time of the model.
visibilitystring
The visibility of the model: `public` or `private`.
cover_imagestring
The URL address of the model cover image.
descriptionstring
Detailed description information of the voice model.
Example
{
"_id": "d7900c21663f485ab63ebdb7e5905036",
"tags": [
"historical"
],
"type": "tts",
"liked": false,
"state": "trained",
"title": "Marcus Aurelius",
"author": {
"_id": "8e0b7add9a474db4b46abe51ef64b3c0",
"nickname": "AceDataCloud"
},
"marked": false,
"samples": [
{
"text": "Hello, this is a sample.",
"audio": "https://api.fish.audio/v1/file/sample-1.mp3",
"title": "sample 1",
"task_id": "ad1c50e6f1a4474d96a17a91da93dac2"
}
],
"unliked": false,
"languages": [
"en"
],
"created_at": "2024-09-01T07:53:39.476000Z",
"like_count": 12,
"mark_count": 3,
"task_count": 5,
"train_mode": "fast",
"updated_at": "2024-09-01T07:53:39.476000Z",
"visibility": "public",
"cover_image": "https://api.fish.audio/v1/file/voice-cover.jpg",
"description": "A historical sound model based on classical recording training.",
"shared_count": 0,
"lock_visibility": false
}Failure400token_mismatched
Request error, possibly due to missing or invalid parameters.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "token_mismatched",
"message": "The specified token is not matched with API."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure400api_not_implemented
Request error, possibly due to missing or invalid parameters.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "api_not_implemented",
"message": "The API is not implemented."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure400disabled
Request error, possibly due to missing or invalid parameters.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "disabled",
"message": "Your application has been disabled by Ace Data Cloud due to abnormal usage behavior, please contact our support to get more information."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure400bad_request
Request error, possibly due to missing or invalid parameters.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "bad_request",
"message": "model is invalid."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure400no_token
Request error, possibly due to missing or invalid parameters.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "no_token",
"message": "No token specified for the request."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure401invalid_token
Unauthorized, authorization token is invalid or missing.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "invalid_token",
"message": "The specified token is invalid or wrong."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure401token_expired
Unauthorized, authorization token is invalid or missing.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "token_expired",
"message": "token expired."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure401token_mismatched
Unauthorized, authorization token is invalid or missing.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "token_mismatched",
"message": "token and api does not match."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure403used_up
Unauthorized, authorization token is invalid or missing.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "used_up",
"message": "Your balance is not sufficient for current request, please buy more in Ace Data Cloud."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure404no_api
Unauthorized, authorization token is invalid or missing.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "no_api",
"message": "API does not exist, please make sure url is correct."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure429too_many_requests
Too many requests, rate limit exceeded.
Response Body
errorobject
codestring
Response error code.
messagestring
Error message of the response.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "too_many_requests",
"message": "You have exceeded the rate limit."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Failure500api_error
Internal server error, an exception occurred on the server side.
Response Body
errorobject
codestring
Response error code.
messagestring
Response error message.
trace_idstring
The tracking ID for this request.
Example
{
"error": {
"code": "api_error",
"message": "Internal server error."
},
"trace_id": "2efa9340-b21b-4e26-9e14-4aac95f343ab"
}Fish voice generation
Allow Use General Balance
When 'Allow General Balance' is enabled, the general balance is used automatically if an app's balance is insufficient.
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.