List Models

Get a list of all models

GET /model

List Models

cURL

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

200

{
  "total": 123,
  "items": [
    {
      "_id": "<string>",
      "title": "<string>",
      "description": "<string>",
      "cover_image": "<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>"
      },
      "train_mode": "full",
      "samples": [],
      "languages": [],
      "lock_visibility": false,
      "unliked": false,
      "liked": false,
      "marked": false
    }
  ]
}

[
  {
    "loc": [
      "<string>"
    ],
    "type": "<string>",
    "msg": "<string>",
    "ctx": "<string>"
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page_size · integer · default: 10

Page size

page_number · integer · default: 1

Page number

title · string | null

Title to filter models

tag · string[] string

Tag to filter models

self · boolean · default: false

If True, only models created by the user will be returned

author_id · string | null

Author ID to filter models, this will be ignored if self is True

language · string[] string

Language to filter models

title_language · string[] string

Title language to filter models

sort_by · enum<string> · default: score

Available options: score, task_count, created_at

Response

200

application/json

Request fulfilled, document follows

total · integer · required

items · ModelEntity · object[] · required

Show child attributes