FIfish
Model

Create Model for Users via API

Changed on
post/model

Request

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

Request body

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

Model visibility. Public requests are downgraded to private; use the web publish flow to publish publicly. Unlist allows anyone with the link to access, while private is visible only to the creator.

type'tts' required

Model type, tts is for text to speech

titlestring required

Model title or name

descriptionstring nullable

Model description

cover_imagestring binary nullable

Model cover image, this is required if the model is public

train_mode'fast' required

Model train mode, for TTS model, fast means model instantly available after creation

enhance_audio_qualityboolean

Enhance audio quality

generate_sampleboolean

Generate default text

Response

Document created, URL follows

_idstring required
type'svc' | 'tts' required
titlestring required
descriptionstring
cover_imagestring
train_mode'fast' | 'full'
state'created' | 'training' | 'trained' | 'failed' required
tagsstring[] required
created_atstring date-time required
updated_atstring date-time required
languagesstring[]
visibility'public' | 'unlist' | 'private' required
lock_visibilityboolean
dmca_taken_downboolean nullable
takedown_category'dmca' | 'policy' nullable
default_textstring
sourcestring nullable
licensedboolean
pvc_release_state'released' | 'retiring' nullable
pvc_notice_period_monthsinteger nullable
pvc_released_atstring date-time nullable
pvc_retire_requested_atstring date-time nullable
pvc_retire_effective_atstring date-time nullable
like_countinteger required
mark_countinteger required
shared_countinteger required
task_countinteger required
unlikedboolean
likedboolean
markedboolean

Changes

  • 42ac421f7a12Revision changes
    • breaking

      the / request property's minItems was increased to 1 (media type: application/json)

    • breaking

      the / request property's minItems was increased to 1 (media type: application/x-www-form-urlencoded)

    • breaking

      the / request property's minItems was increased to 1 (media type: multipart/form-data)

    • breaking

      the / request property's minItems was increased to 1 (media type: application/msgpack)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/msgpack)

    • info

      the request property default value changed from public to private (media type: application/json)

    • info

      the request property default value changed from public to private (media type: application/x-www-form-urlencoded)

    • info

      the request property default value changed from public to private (media type: multipart/form-data)

    • info

      the request property default value changed from public to private (media type: application/msgpack)

    • info

      added the non-success response with the status

    • 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