Create Model

Create a new voice model

POST /model

Create Model

cURL

curl --request POST \
  --url https://api.fish.audio/model \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form type=tts \
  --form 'title=<string>' \
  --form train_mode=fast \
  --form 'voices=<string>' \
  --form visibility=public \
  --form 'description=<string>' \
  --form 'cover_image=<string>' \
  --form 'texts=<string>' \
  --form 'tags=<string>' \
  --form enhance_audio_quality=false \
  --form voices.0.items='@example-file' \
  --form voices.1='@example-file' \
  --form cover_image.0='@example-file'

import requests

url = "https://api.fish.audio/model"

files = {
    "voices.0.items": ("example-file", open("example-file", "rb")),
    "voices.1": ("example-file", open("example-file", "rb")),
    "cover_image.0": ("example-file", open("example-file", "rb"))
}
payload = {
    "type": "tts",
    "title": "<string>",
    "train_mode": "fast",
    "voices": "<string>",
    "visibility": "public",
    "description": "<string>",
    "cover_image": "<string>",
    "texts": "<string>",
    "tags": "<string>",
    "enhance_audio_quality": "false"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('type', 'tts');
form.append('title', '<string>');
form.append('train_mode', 'fast');
form.append('voices', '<string>');
form.append('visibility', 'public');
form.append('description', '<string>');
form.append('cover_image', '<string>');
form.append('texts', '<string>');
form.append('tags', '<string>');
form.append('enhance_audio_quality', 'false');
form.append('voices.0.items', '{
  "fileName": "example-file"
}');
form.append('voices.1', '{
  "fileName": "example-file"
}');
form.append('cover_image.0', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

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 => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ntts\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"train_mode\"\r\n\r\nfast\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"visibility\"\r\n\r\npublic\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cover_image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"texts\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhance_audio_quality\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cover_image.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fish.audio/model"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ntts\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"train_mode\"\r\n\r\nfast\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"visibility\"\r\n\r\npublic\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cover_image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"texts\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhance_audio_quality\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cover_image.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	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.post("https://api.fish.audio/model")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ntts\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"train_mode\"\r\n\r\nfast\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"visibility\"\r\n\r\npublic\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cover_image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"texts\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhance_audio_quality\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cover_image.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\ntts\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"title\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"train_mode\"\r\n\r\nfast\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"visibility\"\r\n\r\npublic\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"description\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cover_image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"texts\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tags\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"enhance_audio_quality\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"voices.1\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cover_image.0\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

201

{
  "_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
}

{
  "status": 123,
  "message": "<string>"
}

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

Since this endpoint requires uploading file, it only accepts multipart/form-data and application/msgpack.

Authorizations

Authorization · string · header · required

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

Body

multipart/form-dataapplication/msgpack

type · enum<string> · required

Model type, tts is for text to speech

Available options: tts

Allowed value: "tts"

title · string · required

Model title or name

train_mode · enum<string> · required

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

Available options: fast

Allowed value: "fast"

voices · file[] file · required

Upload voices files that will be used to tune the model

visibility · enum<string> · default: public

Model visibility, public will be shown in the discovery page, unlist allows anyone with the link to access, private only be visible to the creator

Available options: public, unlist, private

description · string | null

Model description

cover_image · file | null

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

texts · string[] string

Texts corresponding to the voices, if unspecified, ASR will be performed on the voices

tags · string[] string

Model tags

enhance_audio_quality · boolean · default: false

Enhance audio quality

Response

201

application/json

Document created, URL follows

_id · string · required

type · enum<string> · required

Available options: svc, tts

title · string · required

description · string · required

cover_image · string · required

state · enum<string> · required

Available options: created, training, trained, failed

tags · string[] · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

visibility · enum<string> · required

Available options: public, unlist, private

like_count · integer · required

mark_count · integer · required

shared_count · integer · required

task_count · integer · required

author · AuthorEntity · object · required

Show child attributes

train_mode · enum<string> · default: full

Available options: fast, full

samples · SampleEntity · object[]

Show child attributes

languages · string[]

lock_visibility · boolean · default: false

unliked · boolean · default: false

liked · boolean · default: false

marked · boolean · default: false