Fish Audio Texto a voz

01

Descripción general

Usa el endpoint de texto a voz y lee el resultado de la misma respuesta.

Inicio rápido

Cree una Clave de API y establézcala como RUNAPI_API_KEY.
Envíe una solicitud POST cuyo cuerpo coincida con el esquema de la solicitud.
Lea el resultado en el cuerpo de la respuesta exitosa.

POST /api/v1/fish_audio/text_to_speech

URL base: https://runapi.ai
Versión de la API: v1
Autenticación: Authorization: Bearer YOUR_API_TOKEN

02

Modelos compatibles

Abra una página de modelo para conocer los precios actuales, los límites de velocidad y los detalles de uso comercial.

03

Esquema de solicitud

Cuerpo JSON

Envíe únicamente los campos declarados para este endpoint.

s19 campos

bitrate_kbpsinteger

Opcional

Tasa de bits MP3. No se acepta para salida WAV.

Valores permitidos: 64, 128, 192 Valor predeterminado: 128

modelstring

Obligatorio

Identificador del modelo.

output_formatstring

Opcional

Formato de audio de salida.

Valores permitidos: mp3, wav Valor predeterminado: mp3

referencesarray

Opcional

Muestras de audio de referencia en línea para esta solicitud.

references[].audiostring

Obligatorio

Bytes de audio sin procesar codificados en Base64.

references[].textstring

Obligatorio

Transcripción exacta del audio de referencia.

sample_rate_hzinteger

Opcional

Frecuencia de muestreo de salida. MP3 admite 32000 y 44100 Hz; WAV admite todos los valores indicados.

Valores permitidos: 8000, 16000, 24000, 32000, 44100 Valor predeterminado: 44100

textstring

Obligatorio

voice_idstring

Opcional

s2-pro9 campos

bitrate_kbpsinteger

Opcional

Tasa de bits MP3. No se acepta para salida WAV.

Valores permitidos: 64, 128, 192 Valor predeterminado: 128

modelstring

Obligatorio

Identificador del modelo.

output_formatstring

Opcional

Formato de audio de salida.

Valores permitidos: mp3, wav Valor predeterminado: mp3

referencesarray

Opcional

Muestras de audio de referencia en línea para esta solicitud.

references[].audiostring

Obligatorio

Bytes de audio sin procesar codificados en Base64.

references[].textstring

Obligatorio

Transcripción exacta del audio de referencia.

sample_rate_hzinteger

Opcional

Frecuencia de muestreo de salida. MP3 admite 32000 y 44100 Hz; WAV admite todos los valores indicados.

Valores permitidos: 8000, 16000, 24000, 32000, 44100 Valor predeterminado: 44100

textstring

Obligatorio

voice_idstring

Opcional

s2.1-pro9 campos

bitrate_kbpsinteger

Opcional

Tasa de bits MP3. No se acepta para salida WAV.

Valores permitidos: 64, 128, 192 Valor predeterminado: 128

modelstring

Obligatorio

Identificador del modelo.

output_formatstring

Opcional

Formato de audio de salida.

Valores permitidos: mp3, wav Valor predeterminado: mp3

referencesarray

Opcional

Muestras de audio de referencia en línea para esta solicitud.

references[].audiostring

Obligatorio

Bytes de audio sin procesar codificados en Base64.

references[].textstring

Obligatorio

Transcripción exacta del audio de referencia.

sample_rate_hzinteger

Opcional

Frecuencia de muestreo de salida. MP3 admite 32000 y 44100 Hz; WAV admite todos los valores indicados.

Valores permitidos: 8000, 16000, 24000, 32000, 44100 Valor predeterminado: 44100

textstring

Obligatorio

voice_idstring

Opcional

Reglas condicionales

Estos requisitos se aplican cuando todas las condiciones enumeradas coinciden.

Cuando output_format = wav

Obligatorio

No aceptado

bitrate_kbps
Cuando output_format = mp3

Obligatorio

No aceptado
Cuando output_format = {"present" => false}

Obligatorio

No aceptado

04

Respuesta de éxito

HTTP 200

POST /api/v1/fish_audio/text_to_speech

Esquema de respuesta

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
}

Ejemplo de respuesta

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

Errores

HTTP 401

POST /api/v1/fish_audio/text_to_speech

Esquema de respuesta

JSON

{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

JSON

{
  "error": "Authentication required"
}

06

Errores

HTTP 400

POST /api/v1/fish_audio/text_to_speech

Esquema de respuesta

JSON

{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Mensaje de error legible por personas.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Resumen de validación legible por personas.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Mensajes de validación con clave por campo de solicitud público, con un array de cadenas legibles por personas para cada campo.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Ejemplo de respuesta

JSON

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

07

Errores

HTTP 402

POST /api/v1/fish_audio/text_to_speech

Esquema de respuesta

JSON

{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

JSON

{
  "error": "Insufficient balance"
}

08

Errores

HTTP 429

POST /api/v1/fish_audio/text_to_speech

Esquema de respuesta

JSON

{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

JSON

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

09

Errores

HTTP 409

POST /api/v1/fish_audio/text_to_speech

Esquema de respuesta

JSON

{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

JSON

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

10

Errores

HTTP 429

POST /api/v1/fish_audio/text_to_speech

Esquema de respuesta

JSON

{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

JSON

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

11

Errores

HTTP 503

POST /api/v1/fish_audio/text_to_speech

Esquema de respuesta

JSON

{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

JSON

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

12

Errores

HTTP 504

POST /api/v1/fish_audio/text_to_speech

Esquema de respuesta

JSON

{
  "properties": {
    "error": {
      "description": "Mensaje de error legible por personas.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Ejemplo de respuesta

JSON

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

13

Ejemplos de código generados

Usa cURL directamente o instala un SDK para tu lenguaje. Cada muestra envía la solicitud validada que se muestra en esta referencia.

Instalar

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."
)

Instalar

Shell

npm install @runapi.ai/fish-audio

JAVASCRIPT

import { FishAudioClient } from "@runapi.ai/fish-audio";

const client = new FishAudioClient({ apiKey: process.env.RUNAPI_API_KEY });
const result = await client.textToSpeech.run({
  "model": "s1",
  "text": "Welcome to RunAPI."
});

CURL

curl -X POST https://runapi.ai/api/v1/fish_audio/text_to_speech \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"model":"s1","text":"Welcome to RunAPI."}'

Instalar

Shell

go get github.com/runapi-ai/fish-audio-sdk/go@latest

GO

package main

import (
  "context"
  "log"
  "os"

  "github.com/runapi-ai/core-sdk/go/option"
  fishaudio "github.com/runapi-ai/fish-audio-sdk/go/fishaudio"
)

func main() {
  client, err := fishaudio.NewClient(option.WithAPIKey(os.Getenv("RUNAPI_API_KEY")))
  if err != nil {
    log.Fatal(err)
  }

  result, err := client.TextToSpeech.Run(context.Background(), fishaudio.TextToSpeechParams{
    Model: "s1",
    Text: "Welcome to RunAPI.",
  })
  if err != nil {
    log.Fatal(err)
  }
  _ = result
}

14

Fish Audio Texto a voz

Descripción general

Inicio rápido

Endpoint

Modelos compatibles

Esquema de solicitud

Reglas condicionales

Respuesta de éxito

Ejemplo de respuesta

Errores

Ejemplo de respuesta

Errores

Ejemplo de respuesta

Errores

Ejemplo de respuesta

Errores

Ejemplo de respuesta

Errores

Ejemplo de respuesta

Errores

Ejemplo de respuesta

Errores

Ejemplo de respuesta

Errores

Ejemplo de respuesta

Ejemplos de código generados

Instalar

Guías relacionadas