---
title: "List Models"
method: GET
path: "/model"
tags: ["Model"]
---

# List Models

`GET /model`

## Query parameters

- `page_size` integer
- `page_number` integer
- `title` string, nullable
- `tag` union
  - string[]
  - string
- `self` boolean
- `author_id` string, nullable
- `language` union
  - string[]
  - string
- `title_language` union
  - string[]
  - string
- `sort_by` 'score' | 'task_count' | 'created_at'

## Response `200`

Request fulfilled, document follows

- object
  - `total` integer, required
  - `items` ModelEntity[], required
    - `_id` string, required
    - `type` 'svc' | 'tts', required
    - `title` string, required
    - `description` string
    - `cover_image` string
    - `train_mode` 'fast' | 'full'
    - `state` 'created' | 'training' | 'trained' | 'failed', required
    - `tags` string[], required
    - `samples` SampleEntity[]
      - `title` string, required
      - `text` string, required
      - `task_id` string, required
      - `audio` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `languages` string[]
    - `visibility` 'public' | 'unlist' | 'private', required
    - `lock_visibility` boolean
    - `dmca_taken_down` boolean, nullable
    - `default_text` string
    - `source` string, nullable
    - `quality` ModelQualityEntity
      - `audios` ModelAudioQualityEntity[]
        - `filename` string, required
        - `duration_ms` number, required
        - `language` string
        - `quality` object
        - `quality_passed` boolean
        - `quality_reason` string
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
    - `like_count` integer, required
    - `mark_count` integer, required
    - `shared_count` integer, required
    - `task_count` integer, required
    - `unliked` boolean
    - `liked` boolean
    - `marked` boolean
    - `author` AuthorEntity, required
      - `_id` string, required
      - `nickname` string, required
      - `avatar` string, required
  - `has_more` boolean, nullable

## Other responses

- `422`

---

[API](https://skmtc.dev/fish/apis/fishaudio-openapi.md) · [All operations](https://skmtc.dev/fish/apis/fishaudio-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fish/fishaudio-openapi/revisions/bca9c1115c42/schema)