Skip to main content
GET
/
model
List Models
curl --request GET \
  --url https://api.fish.audio/model \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "items": [
    {
      "_id": "<string>",
      "type": "svc",
      "title": "<string>",
      "description": "<string>",
      "cover_image": "<string>",
      "state": "created",
      "tags": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "visibility": "public",
      "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,
      "dmca_taken_down": false,
      "default_text": "",
      "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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://hanabiaiinc-codex-concurrency-tier-update.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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

Required range: x >= 1
​
page_number
integer
default:1

Page number

Required range: x >= 1
​
title
string | null

Title to filter models

​
tag

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

Language to filter models

​
title_language

Title language to filter models

​
sort_by
enum<string>
default:score
Available options:
score,
task_count,
created_at

Response

Request fulfilled, document follows

​
total
integer
required
​
items
ModelEntity · object[]
required