API Referansı

Fish Audio Metinden Konuşmaya

S2 Pro modelleri, anında ses klonlama ve mp3 veya wav çıktısıyla konuşma oluşturun.

Markdown'ı görüntüle

Genel Bakış

Metinden konuşmaya uç noktasını kullanın ve sonucu aynı yanıttan okuyun.

Hızlı başlangıç

Bir API anahtarı oluşturun ve RUNAPI_API_KEY olarak ayarlayın.
Gövdesi istek şemasıyla eşleşen bir POST isteği gönderin.
Sonucu başarılı yanıt gövdesinden okuyun.

POST /api/v1/fish_audio/text_to_speech

Temel URL: https://runapi.ai
API sürümü: v1
Kimlik doğrulama: Authorization: Bearer YOUR_API_TOKEN

Desteklenen modeller

Güncel fiyatlandırma, hız sınırları ve ticari kullanım ayrıntıları için bir model sayfası açın.

İstek şeması

JSON gövdesi

Yalnızca bu uç nokta için bildirilen alanları gönderin.

s19 alan

bitrate_kbpsinteger

İsteğe bağlı

MP3 bit hızı. WAV çıktısı için kabul edilmez.

İzin verilen değerler: 64, 128, 192 Varsayılan: 128

modelstring

Zorunlu

Model tanımlayıcısı.

output_formatstring

İsteğe bağlı

Çıktı ses biçimi.

İzin verilen değerler: mp3, wav Varsayılan: mp3

referencesarray

İsteğe bağlı

Geçici ses klonlama için tek örnek. voice_id ile birlikte kullanılamaz. Örnek yoksa alanı atlayın veya null ya da [] kullanın.

Öğe sınırı: 1

references[].audiostring

Zorunlu

Herkese açık HTTPS ses URL’si. Kuyrukta beklerken ve sağlayıcı tarafından okunurken geçerli kalmalıdır.

references[].textstring

Zorunlu

Referans sesle kelimesi kelimesine eşleşen tam transkript.

sample_rate_hzinteger

İsteğe bağlı

Çıktı örnek hızı. MP3, 32000 ve 44100 Hz'i destekler; WAV listelenen tüm değerleri destekler.

İzin verilen değerler: 8000, 16000, 24000, 32000, 44100 Varsayılan: 44100

textstring

Zorunlu

voice_idstring

İsteğe bağlı

s2-pro9 alan

bitrate_kbpsinteger

İsteğe bağlı

MP3 bit hızı. WAV çıktısı için kabul edilmez.

İzin verilen değerler: 64, 128, 192 Varsayılan: 128

modelstring

Zorunlu

Model tanımlayıcısı.

output_formatstring

İsteğe bağlı

Çıktı ses biçimi.

İzin verilen değerler: mp3, wav Varsayılan: mp3

referencesarray

İsteğe bağlı

Geçici ses klonlama için tek örnek. voice_id ile birlikte kullanılamaz. Örnek yoksa alanı atlayın veya null ya da [] kullanın.

Öğe sınırı: 1

references[].audiostring

Zorunlu

Herkese açık HTTPS ses URL’si. Kuyrukta beklerken ve sağlayıcı tarafından okunurken geçerli kalmalıdır.

references[].textstring

Zorunlu

Referans sesle kelimesi kelimesine eşleşen tam transkript.

sample_rate_hzinteger

İsteğe bağlı

Çıktı örnek hızı. MP3, 32000 ve 44100 Hz'i destekler; WAV listelenen tüm değerleri destekler.

İzin verilen değerler: 8000, 16000, 24000, 32000, 44100 Varsayılan: 44100

textstring

Zorunlu

voice_idstring

İsteğe bağlı

s2.1-pro9 alan

bitrate_kbpsinteger

İsteğe bağlı

MP3 bit hızı. WAV çıktısı için kabul edilmez.

İzin verilen değerler: 64, 128, 192 Varsayılan: 128

modelstring

Zorunlu

Model tanımlayıcısı.

output_formatstring

İsteğe bağlı

Çıktı ses biçimi.

İzin verilen değerler: mp3, wav Varsayılan: mp3

referencesarray

İsteğe bağlı

Geçici ses klonlama için tek örnek. voice_id ile birlikte kullanılamaz. Örnek yoksa alanı atlayın veya null ya da [] kullanın.

Öğe sınırı: 1

references[].audiostring

Zorunlu

Herkese açık HTTPS ses URL’si. Kuyrukta beklerken ve sağlayıcı tarafından okunurken geçerli kalmalıdır.

references[].textstring

Zorunlu

Referans sesle kelimesi kelimesine eşleşen tam transkript.

sample_rate_hzinteger

İsteğe bağlı

Çıktı örnek hızı. MP3, 32000 ve 44100 Hz'i destekler; WAV listelenen tüm değerleri destekler.

İzin verilen değerler: 8000, 16000, 24000, 32000, 44100 Varsayılan: 44100

textstring

Zorunlu

voice_idstring

İsteğe bağlı

Koşullu kurallar

Bu gereksinimler, listelenen tüm koşulların eşleştiği durumlarda uygulanır.

Şu durumlarda references present

Gerekli

Kabul edilmez

voice_id
Şu durumlarda output_format = wav

Gerekli

Kabul edilmez

bitrate_kbps
Şu durumlarda output_format = mp3

Gerekli

Kabul edilmez
Şu durumlarda output_format absent

Gerekli

Kabul edilmez

Başarılı yanıt

HTTP 200

POST /api/v1/fish_audio/text_to_speech

Yanıt şeması

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
}

Yanıt örneği

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

Hatalar

HTTP 401

POST /api/v1/fish_audio/text_to_speech

Yanıt şeması

JSON

{
  "properties": {
    "error": {
      "description": "İnsan tarafından okunabilir hata mesajı.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Yanıt örneği

JSON

{
  "error": "Authentication required"
}

Hatalar

HTTP 400

POST /api/v1/fish_audio/text_to_speech

Yanıt şeması

JSON

{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "İnsan tarafından okunabilir hata mesajı.",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "İnsan tarafından okunabilir doğrulama özeti.",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "Herkese açık istek alanına göre anahtarlanan doğrulama mesajları; her alan için insan tarafından okunabilir dizelerden oluşan bir dizi içerir.",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

Yanıt örneği

JSON

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

Hatalar

HTTP 402

POST /api/v1/fish_audio/text_to_speech

Yanıt şeması

JSON

{
  "properties": {
    "error": {
      "description": "İnsan tarafından okunabilir hata mesajı.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Yanıt örneği

JSON

{
  "error": "Insufficient balance"
}

Hatalar

HTTP 429

POST /api/v1/fish_audio/text_to_speech

Yanıt şeması

JSON

{
  "properties": {
    "error": {
      "description": "İnsan tarafından okunabilir hata mesajı.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Yanıt örneği

JSON

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

Hatalar

HTTP 409

POST /api/v1/fish_audio/text_to_speech

Yanıt şeması

JSON

{
  "properties": {
    "error": {
      "description": "İnsan tarafından okunabilir hata mesajı.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Yanıt örneği

JSON

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

Hatalar

HTTP 429

POST /api/v1/fish_audio/text_to_speech

Yanıt şeması

JSON

{
  "properties": {
    "error": {
      "description": "İnsan tarafından okunabilir hata mesajı.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Yanıt örneği

JSON

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

Hatalar

HTTP 503

POST /api/v1/fish_audio/text_to_speech

Yanıt şeması

JSON

{
  "properties": {
    "error": {
      "description": "İnsan tarafından okunabilir hata mesajı.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Yanıt örneği

JSON

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

Hatalar

HTTP 504

POST /api/v1/fish_audio/text_to_speech

Yanıt şeması

JSON

{
  "properties": {
    "error": {
      "description": "İnsan tarafından okunabilir hata mesajı.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Yanıt örneği

JSON

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

Oluşturulan Kod Örnekleri

Doğrudan cURL kullanın veya diliniz için bir SDK yükleyin. Her örnek, bu başvuruda gösterilen doğrulanmış isteği gönderir.

Yükle

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

Yükle

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

Yükle

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 Metinden Konuşmaya

Genel Bakış

Hızlı başlangıç

Uç Nokta

Desteklenen modeller

İstek şeması

Koşullu kurallar

Başarılı yanıt

Yanıt örneği

Hatalar

Yanıt örneği

Hatalar

Yanıt örneği

Hatalar

Yanıt örneği

Hatalar

Yanıt örneği

Hatalar

Yanıt örneği

Hatalar

Yanıt örneği

Hatalar

Yanıt örneği

Hatalar

Yanıt örneği

Oluşturulan Kod Örnekleri

Yükle

İlgili Kılavuzlar