コンテンツへスキップ
APIリファレンス
APIリファレンス

Fish Audio テキスト読み上げ

テキストから音声へのエンドポイントを使用して、同じレスポンスで結果を受け取ります。

Markdownを表示
01

概要

テキストから音声へのエンドポイントを使用し、同じレスポンスから結果を読み取ります。

クイックスタート

  1. APIキーを作成し、RUNAPI_API_KEYとして設定します。
  2. 本文がリクエストスキーマと一致するPOSTリクエストを送信します。
  3. 成功レスポンスのボディから結果を読み取る。

エンドポイント

POST /api/v1/fish_audio/text_to_speech
ベースURL
https://runapi.ai
API バージョン
v1
認証
Authorization: Bearer YOUR_API_TOKEN
02

サポートされているモデル

現在の料金、レート制限、商用利用の詳細については、モデルページを開いてください。

03

リクエストスキーマ

JSONボディ

このエンドポイントで宣言されたフィールドのみを送信してください。

s1フィールド9件
bitrate_kbpsinteger
任意

MP3ビットレート。WAV出力では使用できません。

許可される値: 64, 128, 192 デフォルト: 128
modelstring
必須

モデルスラッグ。

output_formatstring
任意

出力オーディオフォーマット。

許可される値: mp3, wav デフォルト: mp3
referencesarray
任意

このリクエスト用のインライン参照音声サンプル。

references[].audiostring
必須

Base64エンコードされた生のオーディオバイト。

references[].textstring
必須

参照オーディオの正確なトランスクリプト。

sample_rate_hzinteger
任意

出力サンプルレート。MP3 は 32000 Hz および 44100 Hz をサポート。WAV はリストされた全値をサポート。

許可される値: 8000, 16000, 24000, 32000, 44100 デフォルト: 44100
textstring
必須
voice_idstring
任意
s2-proフィールド9件
bitrate_kbpsinteger
任意

MP3ビットレート。WAV出力では使用できません。

許可される値: 64, 128, 192 デフォルト: 128
modelstring
必須

モデルスラッグ。

output_formatstring
任意

出力オーディオフォーマット。

許可される値: mp3, wav デフォルト: mp3
referencesarray
任意

このリクエスト用のインライン参照音声サンプル。

references[].audiostring
必須

Base64エンコードされた生のオーディオバイト。

references[].textstring
必須

参照オーディオの正確なトランスクリプト。

sample_rate_hzinteger
任意

出力サンプルレート。MP3 は 32000 Hz および 44100 Hz をサポート。WAV はリストされた全値をサポート。

許可される値: 8000, 16000, 24000, 32000, 44100 デフォルト: 44100
textstring
必須
voice_idstring
任意
s2.1-proフィールド9件
bitrate_kbpsinteger
任意

MP3ビットレート。WAV出力では使用できません。

許可される値: 64, 128, 192 デフォルト: 128
modelstring
必須

モデルスラッグ。

output_formatstring
任意

出力オーディオフォーマット。

許可される値: mp3, wav デフォルト: mp3
referencesarray
任意

このリクエスト用のインライン参照音声サンプル。

references[].audiostring
必須

Base64エンコードされた生のオーディオバイト。

references[].textstring
必須

参照オーディオの正確なトランスクリプト。

sample_rate_hzinteger
任意

出力サンプルレート。MP3 は 32000 Hz および 44100 Hz をサポート。WAV はリストされた全値をサポート。

許可される値: 8000, 16000, 24000, 32000, 44100 デフォルト: 44100
textstring
必須
voice_idstring
任意

条件付きルール

これらの要件は、列挙されたすべての条件が一致する場合に適用されます。

  1. 条件 output_format = wav
    必須
    使用不可
    bitrate_kbps
  2. 条件 output_format = mp3
    必須
    使用不可
  3. 条件 output_format = {"present" => false}
    必須
    使用不可
04

成功レスポンス

HTTP 200

POST /api/v1/fish_audio/text_to_speech

レスポンススキーマ
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
}

レスポンス例

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

エラー

HTTP 401

POST /api/v1/fish_audio/text_to_speech

レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

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

エラー

HTTP 400

POST /api/v1/fish_audio/text_to_speech

レスポンススキーマ
JSON 
{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "人が読めるエラーメッセージ。",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "人間が読める形式のバリデーションサマリー。",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "公開リクエストフィールドをキーとするバリデーションメッセージ。各フィールドに対して人間が読める文字列の配列が含まれます。",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

レスポンス例

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

エラー

HTTP 402

POST /api/v1/fish_audio/text_to_speech

レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

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

エラー

HTTP 429

POST /api/v1/fish_audio/text_to_speech

レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

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

エラー

HTTP 409

POST /api/v1/fish_audio/text_to_speech

レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

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

エラー

HTTP 429

POST /api/v1/fish_audio/text_to_speech

レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

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

エラー

HTTP 503

POST /api/v1/fish_audio/text_to_speech

レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

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

エラー

HTTP 504

POST /api/v1/fish_audio/text_to_speech

レスポンススキーマ
JSON 
{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

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

生成されたコードサンプル

cURLを直接使用するか、お使いの言語向けのSDKをインストールしてください。各サンプルは、このリファレンスに示されたバリデーション済みリクエストを送信します。

インストール

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