Vai al contenuto
Riferimento API
Riferimento API

Fish Audio Testo in voce

Usa l'endpoint da testo a voce per ricevere un risultato nella stessa risposta.

01

Panoramica

Usa l'endpoint da testo a voce e leggi il risultato dalla stessa risposta.

Avvio rapido

  1. Crea una Chiave API e impostala come RUNAPI_API_KEY.
  2. Invia una richiesta POST il cui corpo corrisponde allo schema della richiesta.
  3. Leggi il risultato dal corpo della risposta positiva.

Endpoint

POST /api/v1/fish_audio/text_to_speech
URL di base
https://runapi.ai
Versione API
v1
Autenticazione
Authorization: Bearer YOUR_API_TOKEN
02

Modelli supportati

Apri la pagina di un modello per i prezzi correnti, i limiti di frequenza e i dettagli sull'uso commerciale.

03

Schema della richiesta

Corpo JSON

Invia solo i campi dichiarati per questo endpoint.

s19 campi
bitrate_kbpsinteger
Opzionale

Bitrate MP3. Non accettato per l'output WAV.

Valori consentiti: 64, 128, 192 Predefinito: 128
modelstring
Obbligatorio

Slug del modello.

output_formatstring
Opzionale

Formato audio di output.

Valori consentiti: mp3, wav Predefinito: mp3
referencesarray
Opzionale

Campioni audio di riferimento inline per questa richiesta.

references[].audiostring
Obbligatorio

Byte audio grezzi codificati in Base64.

references[].textstring
Obbligatorio

Trascrizione esatta dell'audio di riferimento.

sample_rate_hzinteger
Opzionale

Frequenza di campionamento di output. MP3 supporta 32000 e 44100 Hz; WAV supporta tutti i valori elencati.

Valori consentiti: 8000, 16000, 24000, 32000, 44100 Predefinito: 44100
textstring
Obbligatorio
voice_idstring
Opzionale
s2-pro9 campi
bitrate_kbpsinteger
Opzionale

Bitrate MP3. Non accettato per l'output WAV.

Valori consentiti: 64, 128, 192 Predefinito: 128
modelstring
Obbligatorio

Slug del modello.

output_formatstring
Opzionale

Formato audio di output.

Valori consentiti: mp3, wav Predefinito: mp3
referencesarray
Opzionale

Campioni audio di riferimento inline per questa richiesta.

references[].audiostring
Obbligatorio

Byte audio grezzi codificati in Base64.

references[].textstring
Obbligatorio

Trascrizione esatta dell'audio di riferimento.

sample_rate_hzinteger
Opzionale

Frequenza di campionamento di output. MP3 supporta 32000 e 44100 Hz; WAV supporta tutti i valori elencati.

Valori consentiti: 8000, 16000, 24000, 32000, 44100 Predefinito: 44100
textstring
Obbligatorio
voice_idstring
Opzionale
s2.1-pro9 campi
bitrate_kbpsinteger
Opzionale

Bitrate MP3. Non accettato per l'output WAV.

Valori consentiti: 64, 128, 192 Predefinito: 128
modelstring
Obbligatorio

Slug del modello.

output_formatstring
Opzionale

Formato audio di output.

Valori consentiti: mp3, wav Predefinito: mp3
referencesarray
Opzionale

Campioni audio di riferimento inline per questa richiesta.

references[].audiostring
Obbligatorio

Byte audio grezzi codificati in Base64.

references[].textstring
Obbligatorio

Trascrizione esatta dell'audio di riferimento.

sample_rate_hzinteger
Opzionale

Frequenza di campionamento di output. MP3 supporta 32000 e 44100 Hz; WAV supporta tutti i valori elencati.

Valori consentiti: 8000, 16000, 24000, 32000, 44100 Predefinito: 44100
textstring
Obbligatorio
voice_idstring
Opzionale

Regole condizionali

Questi requisiti si applicano quando tutte le condizioni elencate corrispondono.

  1. Quando output_format = wav
    Obbligatorio
    Non accettato
    bitrate_kbps
  2. Quando output_format = mp3
    Obbligatorio
    Non accettato
  3. Quando output_format = {"present" => false}
    Obbligatorio
    Non accettato
04

Risposta di successo

HTTP 200

POST /api/v1/fish_audio/text_to_speech

Schema della risposta
JSON
{
  "properties": {
    "audios": {
      "items": {
        "properties": {
          "format": {
            "type": "string"
          },
          "mime_type": {
            "type": "string"
          },
          "size_bytes": {
            "type": "integer"
          },
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          }
        },
        "required": [
          "url",
          "format",
          "mime_type",
          "size_bytes"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    },
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "audios",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

JSON
{
  "audios": [
    {
      "format": "mp3",
      "mime_type": "audio/mpeg",
      "size_bytes": 128,
      "url": "https://file.runapi.ai/reference-audio.mp3"
    }
  ],
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "completed"
}
05

Errori

HTTP 401

POST /api/v1/fish_audio/text_to_speech

Schema della risposta
JSON
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

JSON
{
  "error": "Authentication required"
}
06

Errori

HTTP 400

POST /api/v1/fish_audio/text_to_speech

Schema della risposta
JSON
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Messaggio di errore leggibile.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Riepilogo di convalida leggibile dall'utente.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Messaggi di convalida con chiave per campo della richiesta pubblica, con un array di stringhe leggibili dall'utente per ogni campo.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Esempio di risposta

JSON
{
  "error": "model must be one of: s1, s2-pro, s2.1-pro"
}
07

Errori

HTTP 402

POST /api/v1/fish_audio/text_to_speech

Schema della risposta
JSON
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

JSON
{
  "error": "Insufficient balance"
}
08

Errori

HTTP 429

POST /api/v1/fish_audio/text_to_speech

Schema della risposta
JSON
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

JSON
{
  "error": "API key credit limit exceeded"
}
09

Errori

HTTP 409

POST /api/v1/fish_audio/text_to_speech

Schema della risposta
JSON
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

JSON
{
  "error": "The request uses features that are not supported for the selected model"
}
10

Errori

HTTP 429

POST /api/v1/fish_audio/text_to_speech

Schema della risposta
JSON
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

JSON
{
  "error": "Rate limit reached. Please retry later."
}
11

Errori

HTTP 503

POST /api/v1/fish_audio/text_to_speech

Schema della risposta
JSON
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

JSON
{
  "error": "Service under maintenance, please try again later"
}
12

Errori

HTTP 504

POST /api/v1/fish_audio/text_to_speech

Schema della risposta
JSON
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

JSON
{
  "error": "The request timed out"
}
13

Esempi di Codice Generati

Usa cURL direttamente, oppure installa un SDK per il tuo linguaggio. Ogni esempio invia la richiesta validata mostrata in questo riferimento.

Installa

Shell
pip install runapi-fish-audio
PYTHON
import os
from runapi.fish_audio import FishAudioClient

client = FishAudioClient(api_key=os.environ["RUNAPI_API_KEY"])
result = client.text_to_speech.run(
  model="s1",
  text="Welcome to RunAPI."
)