Model
get/model

Request

  • Base URL
    https://api.fish.audio
  • URL
    https://api.fish.audio/model
  • Auth
    HTTP bearer

Query parameters

page_sizeinteger

Page size

page_numberinteger

Page number

titlestring nullable

Title to filter models

string[]
OR
string

Tag to filter models

selfboolean

If True, return models owned by the active workspace

author_idstring nullable

Author ID to filter public models; ignored if self is True

string[]
OR
string

Language to filter models

string[]
OR
string

Title language to filter models

visibility'public' | 'unlist' | 'private' nullable

Visibility to filter workspace models; ignored unless self is True

licensedboolean

If True, only voices licensed by Fish Audio (rights secured from the voice owner) are returned; ignored if self is True

sort_by'score' | 'task_count' | 'created_at'

Response

Request fulfilled, document follows

max_offsetinteger nullable
accessible_upper_boundinteger nullable
window_limitedboolean
total_is_exactboolean
totalinteger required
has_moreboolean nullable

Changes

    • warning

      for the query request parameter page_size, the max was set to 100.00

    • info

      added the new optional query request parameter licensed

    • info

      added the new optional query request parameter visibility

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status