https://api.voicetext.jp
API への認証はベーシック認証で行ないます。 無料利用登録(終了しました)後に発行された API キーをベーシック認証のユーザー名とし、パスワードは空とすることで認証が行なえます。
全てのリクエストは HTTPS 経由で行なってください。
この API では HTTP レスポンスのステータスコードとレスポンスボディのJSON によって「成功」「失敗」を通知します。
この API が返すレスポンスコードを以下に示します。
ステータスコード | 意味 |
---|---|
200 | 成功。 |
400 | リクエストが不正。必須パラメータがない、パラメータの形式が不正、パラメータの値が範囲外など。 |
401 | 認証エラー。ベーシック認証に API キーが指定されていない、API キーが不正など。 |
403 | 指定されたAPIキーでは許可されていないリクエスト。テキストが長過ぎる、 指定したパラメータが利用中のプランでは許可されていないなど。 |
404 | 存在しない URL。 |
405 | 許可されていない HTTP メソッド。POST メソッドでリクエストされていないなど。 |
500 | サーバー内部エラー。 |
503 | サービス利用不可。 |
レスポンスボディの JSON では以下の形式でエラーメッセージを返します。 このエラーメッセージの内容は予告無く変更する可能性があるため、 プログラムから利用する用途には適しません。
{"error": {"message": "invalid speed is specified"}}
POST /v1/tts
パラメータ | 説明 | 制限 | 初期値 |
---|---|---|---|
text |
合成するテキスト。エンコーディングは UTF-8。 | 必須。 上限文字数はプランによって異なります。 | |
speaker |
話者名。後述の「話者一覧」の中のいずれかを指定します。 | 必須。 | |
engine |
エンジンの種類。以下のいずれかを指定します。
|
speaker ごとに利用できるエンジンが異なります。後述の「話者一覧」の「natural」「emotional」列をご参照ください。
|
speaker ごとに異なります。後述の「話者一覧」の「デフォルトエンジン」列をご参照ください。
|
format |
音声ファイルフォーマット。以下のいずれかを指定します。
|
wav |
|
emotion |
感情カテゴリの指定。
後述の「話者一覧」の「emotional」にチェックがついている話者にのみ使用できます。
以下のいずれかを指定します。
|
||
emotion_level |
感情レベルの指定。1 〜4 を指定できます。数値が大きいほど感情が強くなります。
|
2 |
|
pitch |
音の高低を数値で指定します。値が小さいほど低い音になります。 | 50 から200 (%)まで。 |
100 (%) |
speed |
話す速度を数値で指定します。値が小さいほど遅い話し方になります。 | 50 から400 (%)まで。 |
100 (%) |
volume |
音量を数値で指定します。値が小さいほど小さい音になります。 | 50 から200 (%)まで。 |
100 (%) |
言語 | 話者名 | natural | emotional | デフォルトエンジン |
---|---|---|---|---|
日本語 | show (男性) |
natural |
||
日本語 | haruka (女性) |
emotional |
||
日本語 | hikari (女性) |
emotional |
||
日本語 | takeru (男性) |
emotional |
||
日本語 | ryo (男性) |
natural |
||
日本語 | akira (男性) |
natural |
||
日本語 | misaki (女性) |
natural |
||
日本語 | sayaka (女性) |
natural |
||
日本語 | risa (女性) |
natural |
||
日本語 | erica (女性) |
natural |
||
日本語 | nao (女性) |
emotional |
||
日本語 | boy (男の子) |
emotional |
||
日本語 | girl (女の子) |
emotional |
||
日本語 | santa (サンタ) |
emotional |
||
日本語 | bear (凶暴なクマ) |
emotional |
||
英語 | james (男性) |
natural |
||
英語 | paul (男性) |
natural |
||
英語 | ashley (女性) |
natural |
||
英語 | julie (女性) |
natural |
||
英語 | kate (女性) |
natural |
||
英語 | eng_girl (女の子) |
emotional |
||
中国語 | qiang (男性) |
natural |
||
中国語 | hong (女性) |
natural |
||
中国語(台湾) | yafang (女性) |
natural |
||
韓国語 | jihun (男性) |
natural |
||
韓国語 | hyeryun (女性) |
natural |
||
タイ語 | sarawut (男性) |
natural |
||
タイ語 | somsi (女性) |
natural |
curl コマンドではベーシック認証のユーザー名とパスワードを ユーザー名:パスワード
の形式で指定するため、-u
オプションの最後に :
が必要なことに注意してください。
$ curl "https://api.voicetext.jp/v1/tts" \
-o "test.wav" \
-u "YOUR_API_KEY:" \
-d "text=おはようございます" \
-d "speaker=show"
$ curl "https://api.voicetext.jp/v1/tts" \
-o "test.wav" \
-u "YOUR_API_KEY:" \
-d "text=おはようございます" \
-d "speaker=hikari" \
-d "emotion=happiness" \
-d "emotion_level=2" \
-d "pitch=105" \
-d "speed=105"
レスポンスコード 200
と共にwav形式の音声ファイルを返します。
HTTP/1.1 200 OK
Accept-Ranges: bytes
Content-Length: 95566
Content-Type: audio/wave
Last-Modified: Sun, 29 Jun 2014 19:30:01 GMT
X-Revision: 1ce21c1603b4c28475063d5725591cb1d3d69134
Date: Sun, 29 Jun 2014 19:30:01 GMT
Connection: close
(以下、音声バイナリデータ)
エラーに応じたレスポンスコードと共にエラーメッセージをJSONで返します。
HTTP/1.1 400 Bad Request
Content-Type: application/json
X-Revision: 1ce21c1603b4c28475063d5725591cb1d3d69134
Date: Sun, 29 Jun 2014 19:33:27 GMT
Content-Length: 50
Connection: close
{"error":{"message":"invalid speed is specified"}}
GET /v1/usage
なし
$ curl -u "YOUR_API_KEY:" "https://api.voicetext.jp/v1/usage"
レスポンスコード 200
と共に JSON 形式で使用回数の情報を返します。
HTTP/1.1 200 OK
X-Revision: 06844d5bdbb0330571098d8fc8da165c6e0a93af
Date: Fri, 16 Jan 2015 07:15:59 GMT
Content-Length: 12
Content-Type: text/plain; charset=utf-8
{"count":100}
エラーに応じたレスポンスコードを返します。