API マニュアル

エンドポイント

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。 必須。 Unicode で 200 文字以内。
speaker 話者名。後述の「話者一覧」の中のいずれかを指定します。 必須。
format 音声ファイルフォーマット。以下のいずれかを指定します。
  • wav(圧縮無し)
  • ogg(Ogg Vorbisフォーマットでの圧縮)
  • mp3(MP3フォーマットでの圧縮)
 wav
emotion 感情カテゴリの指定。 話者 haruka、hikari、takeru、santa、bear にのみ使用できます。 以下のいずれかを指定します。
  • happiness 喜
  • anger 怒
  • sadness 悲
emotion_level 感情レベルの指定。1〜4を指定できます。数値が大きいほど感情が強くなります。 2
pitch 音の高低を数値で指定します。値が小さいほど低い音になります。 50から200(%)まで。 100(%)
speed 話す速度を数値で指定します。値が小さいほど遅い話し方になります。 50から400(%)まで。 100(%)
volume 音量を数値で指定します。値が小さいほど小さい音になります。 50から200(%)まで。 100(%)

話者一覧:

言語 話者名
日本語 show(男性)
日本語 haruka(女性)
日本語 hikari(女性)
日本語 takeru(男性)
日本語 santa(サンタ)
日本語 bear(凶暴なクマ)

例:

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