コンソール

単一話者の音声生成

POST/v1/audio/speech

テキストを音声に変換するAPIです。voice_idでボイスを指定し、非ストリーミング、生のPCM、SSEストリーミング出力に対応します。

リクエストパラメータ

フィールド型必須説明
model: string必須

モデルID。安定版モデルIDの使用を推奨します。固定バージョンを再現する必要がある場合は、スナップショットモデルIDを指定できます。

input: string必須

合成するテキスト。[pause 0.1s]~[pause 10.0s]によるポーズの挿入にはmoss-tts-1.5-flashのみが対応しています。moss-tts-1.0-proはこの構文に対応していません。

voice_id: string必須

ボイスID。ボイス一覧の取得で取得できます。また、Mosslandボイスライブラリでボイスカードのコピーアイコンをクリックして取得することもできます。TTSはボイスIDのみを受け付け、voice_url / voice_dataには対応していません。インライン音声や参照音声も受け付けません。

language: string任意

moss-tts-1.5-flashのみ対応。対象テキストの発音言語を指定します。テキストは翻訳されません。言語をまたぐボイスクローンでも、対象テキストに合わせて選択してください。対応言語の英語の正式名称(Chinese、Englishなど)を指定する必要があり、zh、enなどの言語コードには対応していません。省略した場合はモデルが自動で判定します。

expected_duration_sec: number任意

希望する音声の長さ(秒)。指定する場合は0より大きい値にする必要があります。

stream: boolean任意

trueに設定するとストリーミング出力を有効にします。async=trueまたは空でないwebhook_urlと同時に使用することはできません。

response_format: string任意

出力音声のフォーマット。ストリーミングリクエストではpcmを使用する必要があり、非ストリーミングリクエストではその他のフォーマットも選択できます。非同期タスクの実際のフォーマットは、タスク照会で返される内容に準じます。

delivery_method: string任意

非ストリーミング結果の返却方法。デフォルトでは音声バイナリを直接返します。ストリーミングリクエストでは指定しないでください。

stream_format: string任意

stream=trueの場合のみ有効で、デフォルトはaudioです。展開すると2種類のストリーミング返却プロトコルを確認できます。

async: boolean任意

trueに設定すると非同期タスクを作成し、タスクオブジェクトを即座に返します。タスクの結果はタスクの照会で取得し、webhook_urlは終了状態の通知の受信にのみ使用します。

webhook_url: string任意

非同期タスクの完了後にコールバックするHTTPS URL。

aigc_metadata: object任意

生成される音声ファイルにAIGCの暗黙的な識別子を書き込むかどうかを制御します。デフォルトでは書き込みません。このフィールドは最終的な音声ファイルのメタデータにのみ影響し、音声合成の内容には影響しません。

aigc_metadata.enabled: boolean任意

AIGCの暗黙的な識別子を書き込むかどうか。デフォルトはfalseです。

aigc_metadata.content_propagator: string任意

コンテンツ配信サービス提供者の名称またはコード。

aigc_metadata.propagate_id: string任意

コンテンツ配信番号。今回のコンテンツ配信を識別するために使用します。

戻り値

呼び出し方法に応じて、APIは音声コンテンツ、音声URLを含むJSON、または非同期タスクオブジェクトを返します。ストリーミング出力を有効にした場合は、音声データストリームまたはSSEイベントストリームを返します。

エラーコード

HTTPerror.code発生条件と対処方法
404: voice_not_found

指定したvoice_idが存在しないか、利用できません。voice_idがボイス一覧の取得、ボイス作成API、またはMosslandボイスライブラリから取得したものであることを確認してください。

400: 4件のerror.code

ストリーミング呼び出しと他のパラメータの組み合わせに対応していません。