API-referentie

Fish Audio tekst naar spraak

Genereer spraak met S2 Pro-modellen, directe stemkloning en mp3- of wav-uitvoer.

Markdown bekijken

Overzicht

Gebruik het eindpunt voor tekst naar spraak en lees het resultaat uit dezelfde respons.

Snelstart

Maak een API-sleutel aan en stel deze in als RUNAPI_API_KEY.
Stuur een POST-verzoek waarvan de body overeenkomt met het verzoekschema.
Lees het resultaat uit de body van de geslaagde respons.

POST /api/v1/fish_audio/text_to_speech

Basis-URL: https://runapi.ai
API-versie: v1
Authenticatie: Authorization: Bearer YOUR_API_TOKEN

Ondersteunde modellen

Open een modelpagina voor actuele prijzen, snelheidslimieten en details over commercieel gebruik.

Verzoekschema

JSON-body

Stuur alleen de velden die voor dit eindpunt zijn gedeclareerd.

s19 velden

bitrate_kbpsinteger

Optioneel

MP3-bitrate. Niet geaccepteerd voor WAV-uitvoer.

Toegestane waarden: 64, 128, 192 Standaard: 128

modelstring

Verplicht

Model-slug.

output_formatstring

Optioneel

Uitvoer-audioformaat.

Toegestane waarden: mp3, wav Standaard: mp3

referencesarray

Optioneel

Eén sample voor tijdelijke stemkloning. Kan niet worden gecombineerd met voice_id. Laat weg of gebruik null of [] voor geen sample.

Itemlimiet: 1

references[].audiostring

Verplicht

Openbaar toegankelijke HTTPS-audio-URL. Moet geldig blijven tijdens het wachten in de wachtrij en het lezen door de aanbieder.

references[].textstring

Verplicht

Exact transcript dat woord voor woord overeenkomt met de referentieaudio.

sample_rate_hzinteger

Optioneel

Uitvoer samplefrequentie. MP3 ondersteunt 32000 en 44100 Hz; WAV ondersteunt alle vermelde waarden.

Toegestane waarden: 8000, 16000, 24000, 32000, 44100 Standaard: 44100

textstring

Verplicht

voice_idstring

Optioneel

s2-pro9 velden

bitrate_kbpsinteger

Optioneel

MP3-bitrate. Niet geaccepteerd voor WAV-uitvoer.

Toegestane waarden: 64, 128, 192 Standaard: 128

modelstring

Verplicht

Model-slug.

output_formatstring

Optioneel

Uitvoer-audioformaat.

Toegestane waarden: mp3, wav Standaard: mp3

referencesarray

Optioneel

Eén sample voor tijdelijke stemkloning. Kan niet worden gecombineerd met voice_id. Laat weg of gebruik null of [] voor geen sample.

Itemlimiet: 1

references[].audiostring

Verplicht

Openbaar toegankelijke HTTPS-audio-URL. Moet geldig blijven tijdens het wachten in de wachtrij en het lezen door de aanbieder.

references[].textstring

Verplicht

Exact transcript dat woord voor woord overeenkomt met de referentieaudio.

sample_rate_hzinteger

Optioneel

Uitvoer samplefrequentie. MP3 ondersteunt 32000 en 44100 Hz; WAV ondersteunt alle vermelde waarden.

Toegestane waarden: 8000, 16000, 24000, 32000, 44100 Standaard: 44100

textstring

Verplicht

voice_idstring

Optioneel

s2.1-pro9 velden

bitrate_kbpsinteger

Optioneel

MP3-bitrate. Niet geaccepteerd voor WAV-uitvoer.

Toegestane waarden: 64, 128, 192 Standaard: 128

modelstring

Verplicht

Model-slug.

output_formatstring

Optioneel

Uitvoer-audioformaat.

Toegestane waarden: mp3, wav Standaard: mp3

referencesarray

Optioneel

Eén sample voor tijdelijke stemkloning. Kan niet worden gecombineerd met voice_id. Laat weg of gebruik null of [] voor geen sample.

Itemlimiet: 1

references[].audiostring

Verplicht

Openbaar toegankelijke HTTPS-audio-URL. Moet geldig blijven tijdens het wachten in de wachtrij en het lezen door de aanbieder.

references[].textstring

Verplicht

Exact transcript dat woord voor woord overeenkomt met de referentieaudio.

sample_rate_hzinteger

Optioneel

Uitvoer samplefrequentie. MP3 ondersteunt 32000 en 44100 Hz; WAV ondersteunt alle vermelde waarden.

Toegestane waarden: 8000, 16000, 24000, 32000, 44100 Standaard: 44100

textstring

Verplicht

voice_idstring

Optioneel

Voorwaardelijke regels

Deze vereisten zijn van toepassing wanneer alle vermelde voorwaarden overeenkomen.

Wanneer references present

Vereist

Niet geaccepteerd

voice_id
Wanneer output_format = wav

Vereist

Niet geaccepteerd

bitrate_kbps
Wanneer output_format = mp3

Vereist

Niet geaccepteerd
Wanneer output_format absent

Vereist

Niet geaccepteerd

Succesvol antwoord

HTTP 200

POST /api/v1/fish_audio/text_to_speech

Responsschema

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"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "audios"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON

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

Fouten

HTTP 401

POST /api/v1/fish_audio/text_to_speech

Responsschema

JSON

{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON

{
  "error": "Authentication required"
}

Fouten

HTTP 400

POST /api/v1/fish_audio/text_to_speech

Responsschema

JSON

{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Leesbare foutmelding.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Leesbare validatiesamenvatting.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validatieberichten gekoppeld aan het openbare aanvraagveld, met een reeks leesbare tekenreeksen per veld.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Responsvoorbeeld

JSON

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

Fouten

HTTP 402

POST /api/v1/fish_audio/text_to_speech

Responsschema

JSON

{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON

{
  "error": "Insufficient balance"
}

Fouten

HTTP 429

POST /api/v1/fish_audio/text_to_speech

Responsschema

JSON

{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON

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

Fouten

HTTP 409

POST /api/v1/fish_audio/text_to_speech

Responsschema

JSON

{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON

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

Fouten

HTTP 429

POST /api/v1/fish_audio/text_to_speech

Responsschema

JSON

{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON

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

Fouten

HTTP 503

POST /api/v1/fish_audio/text_to_speech

Responsschema

JSON

{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON

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

Fouten

HTTP 504

POST /api/v1/fish_audio/text_to_speech

Responsschema

JSON

{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

JSON

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

Gegenereerde codevoorbeelden

Gebruik cURL rechtstreeks, of installeer een SDK voor uw taal. Elk voorbeeld dient het gevalideerde verzoek in dat in deze referentie wordt getoond.

Installeren

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

Installeren

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."}'

Installeren

Shell

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

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
}

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 }

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

Fish Audio tekst naar spraak

Overzicht

Snelstart

Eindpunt

Ondersteunde modellen

Verzoekschema

Voorwaardelijke regels

Succesvol antwoord

Responsvoorbeeld

Fouten

Responsvoorbeeld

Fouten

Responsvoorbeeld

Fouten

Responsvoorbeeld

Fouten

Responsvoorbeeld

Fouten

Responsvoorbeeld

Fouten

Responsvoorbeeld

Fouten

Responsvoorbeeld

Fouten

Responsvoorbeeld

Gegenereerde codevoorbeelden

Installeren

Gerelateerde handleidingen