List Models
curl --request GET \
--url https://api.fish.audio/model \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fish.audio/model"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fish.audio/model', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fish.audio/model",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fish.audio/model"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fish.audio/model")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fish.audio/model")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"total": 123,
"items": [
{
"_id": "<string>",
"title": "<string>",
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"like_count": 123,
"mark_count": 123,
"shared_count": 123,
"task_count": 123,
"author": {
"_id": "<string>",
"nickname": "<string>",
"avatar": "<string>"
},
"description": "",
"cover_image": "",
"train_mode": "full",
"samples": [],
"languages": [],
"lock_visibility": false,
"dmca_taken_down": false,
"default_text": "",
"source": "<string>",
"pvc_notice_period_months": 123,
"pvc_released_at": "2023-11-07T05:31:56Z",
"pvc_retire_requested_at": "2023-11-07T05:31:56Z",
"pvc_retire_effective_at": "2023-11-07T05:31:56Z",
"quality": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"audios": [
{
"filename": "<string>",
"duration_ms": 123,
"language": "unknown",
"quality": {},
"quality_passed": false,
"quality_reason": ""
}
]
},
"unliked": false,
"liked": false,
"marked": false
}
],
"max_offset": 123,
"accessible_upper_bound": 123,
"window_limited": false,
"total_is_exact": true,
"has_more": true
}Voice Models
List Models
Get a list of all models
GET
/
model
List Models
curl --request GET \
--url https://api.fish.audio/model \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.fish.audio/model"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.fish.audio/model', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fish.audio/model",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.fish.audio/model"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fish.audio/model")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fish.audio/model")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"total": 123,
"items": [
{
"_id": "<string>",
"title": "<string>",
"tags": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"like_count": 123,
"mark_count": 123,
"shared_count": 123,
"task_count": 123,
"author": {
"_id": "<string>",
"nickname": "<string>",
"avatar": "<string>"
},
"description": "",
"cover_image": "",
"train_mode": "full",
"samples": [],
"languages": [],
"lock_visibility": false,
"dmca_taken_down": false,
"default_text": "",
"source": "<string>",
"pvc_notice_period_months": 123,
"pvc_released_at": "2023-11-07T05:31:56Z",
"pvc_retire_requested_at": "2023-11-07T05:31:56Z",
"pvc_retire_effective_at": "2023-11-07T05:31:56Z",
"quality": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"audios": [
{
"filename": "<string>",
"duration_ms": 123,
"language": "unknown",
"quality": {},
"quality_passed": false,
"quality_reason": ""
}
]
},
"unliked": false,
"liked": false,
"marked": false
}
],
"max_offset": 123,
"accessible_upper_bound": 123,
"window_limited": false,
"total_is_exact": true,
"has_more": true
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Page size
Required range:
1 <= x <= 100Page number
Required range:
x >= 1Title to filter models
Tag to filter models
If True, return models owned by the active workspace
Author ID to filter public models; ignored if self is True
Language to filter models
Title language to filter models
Available options:
score, task_count, created_at Was this page helpful?
⌘I

