API-Referenz

Fish Audio Text zu Sprache

Erzeuge Sprache mit den S2 Pro-Modellen, sofortigem Stimmenklonen und mp3- oder wav-Ausgabe.

Markdown anzeigen

Übersicht

Verwenden Sie den Endpunkt „Text zu Sprache" und lesen Sie das Ergebnis aus derselben Antwort aus.

Schnellstart

Erstellen Sie einen API-Schlüssel und setzen Sie ihn als RUNAPI_API_KEY.
Eine POST-Anfrage senden, deren Körper dem Anfrage-Schema entspricht.
Das Ergebnis aus dem erfolgreichen Antwortkörper lesen.

POST /api/v1/fish_audio/text_to_speech

Basis-URL: https://runapi.ai
API-Version: v1
Authentifizierung: Authorization: Bearer YOUR_API_TOKEN

Unterstützte Modelle

Öffnen Sie eine Modellseite für aktuelle Preise, Ratenlimits und Details zur kommerziellen Nutzung.

Anfrage-Schema

JSON-Body

Nur die für diesen Endpunkt deklarierten Felder senden.

s19 Felder

bitrate_kbpsinteger

Optional

MP3-Bitrate. Wird für WAV-Ausgabe nicht akzeptiert.

Zulässige Werte: 64, 128, 192 Standard: 128

modelstring

Erforderlich

Modell-Slug.

output_formatstring

Optional

Ausgabe-Audioformat.

Zulässige Werte: mp3, wav Standard: mp3

referencesarray

Optional

Eine Probe zur temporären Stimmklonung. Nicht mit voice_id kombinierbar. Für keine Probe weglassen oder null bzw. [] verwenden.

Elementlimit: 1

references[].audiostring

Erforderlich

Öffentlich zugängliche HTTPS-Audio-URL. Muss während der Wartezeit und beim Abruf durch den Anbieter gültig bleiben.

references[].textstring

Erforderlich

Exaktes Transkript, das Wort für Wort mit dem Referenzaudio übereinstimmt.

sample_rate_hzinteger

Optional

Ausgabe-Abtastrate. MP3 unterstützt 32000 und 44100 Hz; WAV unterstützt jeden aufgeführten Wert.

Zulässige Werte: 8000, 16000, 24000, 32000, 44100 Standard: 44100

textstring

Erforderlich

voice_idstring

Optional

s2-pro9 Felder

bitrate_kbpsinteger

Optional

MP3-Bitrate. Wird für WAV-Ausgabe nicht akzeptiert.

Zulässige Werte: 64, 128, 192 Standard: 128

modelstring

Erforderlich

Modell-Slug.

output_formatstring

Optional

Ausgabe-Audioformat.

Zulässige Werte: mp3, wav Standard: mp3

referencesarray

Optional

Eine Probe zur temporären Stimmklonung. Nicht mit voice_id kombinierbar. Für keine Probe weglassen oder null bzw. [] verwenden.

Elementlimit: 1

references[].audiostring

Erforderlich

Öffentlich zugängliche HTTPS-Audio-URL. Muss während der Wartezeit und beim Abruf durch den Anbieter gültig bleiben.

references[].textstring

Erforderlich

Exaktes Transkript, das Wort für Wort mit dem Referenzaudio übereinstimmt.

sample_rate_hzinteger

Optional

Ausgabe-Abtastrate. MP3 unterstützt 32000 und 44100 Hz; WAV unterstützt jeden aufgeführten Wert.

Zulässige Werte: 8000, 16000, 24000, 32000, 44100 Standard: 44100

textstring

Erforderlich

voice_idstring

Optional

s2.1-pro9 Felder

bitrate_kbpsinteger

Optional

MP3-Bitrate. Wird für WAV-Ausgabe nicht akzeptiert.

Zulässige Werte: 64, 128, 192 Standard: 128

modelstring

Erforderlich

Modell-Slug.

output_formatstring

Optional

Ausgabe-Audioformat.

Zulässige Werte: mp3, wav Standard: mp3

referencesarray

Optional

Eine Probe zur temporären Stimmklonung. Nicht mit voice_id kombinierbar. Für keine Probe weglassen oder null bzw. [] verwenden.

Elementlimit: 1

references[].audiostring

Erforderlich

Öffentlich zugängliche HTTPS-Audio-URL. Muss während der Wartezeit und beim Abruf durch den Anbieter gültig bleiben.

references[].textstring

Erforderlich

Exaktes Transkript, das Wort für Wort mit dem Referenzaudio übereinstimmt.

sample_rate_hzinteger

Optional

Ausgabe-Abtastrate. MP3 unterstützt 32000 und 44100 Hz; WAV unterstützt jeden aufgeführten Wert.

Zulässige Werte: 8000, 16000, 24000, 32000, 44100 Standard: 44100

textstring

Erforderlich

voice_idstring

Optional

Bedingte Regeln

Diese Anforderungen gelten, wenn alle aufgeführten Bedingungen zutreffen.

Wenn references present

Erforderlich

Nicht akzeptiert

voice_id
Wenn output_format = wav

Erforderlich

Nicht akzeptiert

bitrate_kbps
Wenn output_format = mp3

Erforderlich

Nicht akzeptiert
Wenn output_format absent

Erforderlich

Nicht akzeptiert

Erfolgsantwort

HTTP 200

POST /api/v1/fish_audio/text_to_speech

Antwort-Schema

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
}

Antwortbeispiel

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

Fehler

HTTP 401

POST /api/v1/fish_audio/text_to_speech

Antwort-Schema

JSON

{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON

{
  "error": "Authentication required"
}

Fehler

HTTP 400

POST /api/v1/fish_audio/text_to_speech

Antwort-Schema

JSON

{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "Für Menschen lesbare Fehlermeldung.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "Menschenlesbare Validierungszusammenfassung.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Validierungsmeldungen nach öffentlichem Anforderungsfeld gegliedert, mit einem Array menschenlesbarer Zeichenketten für jedes Feld.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Antwortbeispiel

JSON

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

Fehler

HTTP 402

POST /api/v1/fish_audio/text_to_speech

Antwort-Schema

JSON

{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON

{
  "error": "Insufficient balance"
}

Fehler

HTTP 429

POST /api/v1/fish_audio/text_to_speech

Antwort-Schema

JSON

{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON

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

Fehler

HTTP 409

POST /api/v1/fish_audio/text_to_speech

Antwort-Schema

JSON

{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON

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

Fehler

HTTP 429

POST /api/v1/fish_audio/text_to_speech

Antwort-Schema

JSON

{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON

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

Fehler

HTTP 503

POST /api/v1/fish_audio/text_to_speech

Antwort-Schema

JSON

{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON

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

Fehler

HTTP 504

POST /api/v1/fish_audio/text_to_speech

Antwort-Schema

JSON

{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON

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

Generierte Code-Beispiele

Verwende cURL direkt oder installiere ein SDK für deine Programmiersprache. Jedes Beispiel übermittelt die in dieser Referenz gezeigte validierte Anfrage.

Installieren

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

Installieren

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

Installieren

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 Text zu Sprache

Übersicht

Schnellstart

Endpunkt

Unterstützte Modelle

Anfrage-Schema

Bedingte Regeln

Erfolgsantwort

Antwortbeispiel

Fehler

Antwortbeispiel

Fehler

Antwortbeispiel

Fehler

Antwortbeispiel

Fehler

Antwortbeispiel

Fehler

Antwortbeispiel

Fehler

Antwortbeispiel

Fehler

Antwortbeispiel

Fehler

Antwortbeispiel

Generierte Code-Beispiele

Installieren

Verwandte Anleitungen