書き起こし開始

mocoVoice API リファレンス (1.2.0)

mocoVoice APIでは、音声ファイルの書き起こしが行えます。

書き起こしAPIでは、音声ファイルをアップロードし、書き起こしを開始し、その結果を取得することができます。

辞書APIでは、書き起こし精度を高めるために、辞書を作成し、単語を登録することができます。

Servers

mocoVoice APIサーバー

https://api.mocomoco.ai/

書き起こしAPI

書き起こしAPIでは、音声ファイルをアップロードし、書き起こしを開始し、その結果を取得することができます。
書き起こしの際には、辞書を指定することもできます。

主な機能
• 音声のファイルアップロードする
• 書き起こしを開始する
• 書き起こし結果を取得する

Operations

音声ファイルアップロード

Request

音声ファイルをアップロードするためのエンドポイントです。このエンドポイントを呼び出すと、音声ファイルをアップロードするための一時的なURLが発行されます。

Bodyapplication/jsonrequired

filenamestringrequired

アップロードする音声ファイルの名前

dictionary_idstring

書き起こし時に使用する辞書ID（任意）

languageany

音声ファイルの言語コードを指定する。（例: 'ja'）
複数の言語コードは配列で指定できる。（例: ['en', 'ja']）
言語コードは、対応言語のISO 639-1コードに対応。

curl -i -X POST \
  https://api.mocomoco.ai/api/v1/transcriptions/upload \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "filename": "string",
    "dictionary_id": "string",
    "language": null
  }'

Responses

アップロードリクエストが成功し、アップロードURLが発行されました。

Bodyapplication/json

transcription_idstring

新しく作成された書き起こしのID

dictionary_idstring

team_idstring

ユーザーが所属するチームのID

audio_upload_urlstring

音声ファイルをアップロードするための一時的なURL

Response

application/json

{
  "transcription_id": "string",
  "dictionary_id": "string",
  "team_id": "string",
  "audio_upload_url": "string"
}

書き起こし開始

Request

指定した書き起こしIDに対して、書き起こし処理を開始します。音声ファイルのアップロードが完了している必要があります。

Path

transcription_idstringrequired

書き起こし対象の音声ファイルを識別するためのID

curl -i -X POST \
  'https://api.mocomoco.ai/api/v1/transcriptions/{transcription_id}/transcribe' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

書き起こしが正常に開始されました。

Bodyapplication/json

transcription_idstring

書き起こしの一意な識別子

dictionary_idstring

使用された辞書のID

team_idstring

ユーザーが所属するチームのID

namestring

書き起こし対象の音声ファイルの名前

transcription_pathstring

書き起こし結果のダウンロードURL

audio_pathstring

アップロードされた音声ファイルのダウンロードURL

statusstring

書き起こしの現在のステータス

IN_PROGRESS: 現在、書き起こしの処理が進行中である状態
CONVERTING: 書き起こしのための音声の変換処理を行っている状態
COMPLETED: 書き起こし処理が正常に完了した状態
FAILED: 書き起こし処理が失敗した状態
CANCELLED: 書き起こしリクエストがキャンセルされた状態

speaking_durationnumber

音声ファイルの発話時間（秒）

created_atstring(date-time)

書き起こしが作成された日時

updated_atstring(date-time)

書き起こしが最後に更新された日時

Response

application/json

{
  "transcription_id": "string",
  "dictionary_id": "string",
  "team_id": "string",
  "name": "string",
  "transcription_path": "string",
  "audio_path": "string",
  "status": "string",
  "speaking_duration": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

書き起こし取得

Request

指定した書き起こしIDの詳細情報とステータスを取得します。書き起こしの進捗状況や結果を確認できます。

Path

transcription_idstringrequired

取得したい書き起こしのID

curl -i -X GET \
  'https://api.mocomoco.ai/api/v1/transcriptions/{transcription_id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

書き起こしの詳細情報を取得しました。

Bodyapplication/json

transcription_idstring

書き起こしの一意な識別子

dictionary_idstring

使用された辞書のID

team_idstring

ユーザーが所属するチームのID

namestring

書き起こし対象の音声ファイルの名前

transcription_pathstring

書き起こし結果のダウンロードURL

audio_pathstring

アップロードされた音声ファイルのダウンロードURL

statusstring

書き起こしの現在のステータス

IN_PROGRESS: 現在、書き起こしの処理が進行中である状態
CONVERTING: 書き起こしのための音声の変換処理を行っている状態
COMPLETED: 書き起こし処理が正常に完了した状態
FAILED: 書き起こし処理が失敗した状態
CANCELLED: 書き起こしリクエストがキャンセルされた状態

speaking_durationnumber

音声ファイルの発話時間（秒）

created_atstring(date-time)

書き起こしが作成された日時

updated_atstring(date-time)

書き起こしが最後に更新された日時

Response

application/json

{
  "transcription_id": "string",
  "dictionary_id": "string",
  "team_id": "string",
  "name": "string",
  "transcription_path": "string",
  "audio_path": "string",
  "status": "string",
  "speaking_duration": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

書き起こし一覧取得

Request

ユーザーまたはチームがこれまでに行った書き起こしの一覧を取得します。ページネーションが可能です。

Query

pageinteger

取得するページ番号（デフォルトは1）

Default 1

curl -i -X GET \
  'https://api.mocomoco.ai/api/v1/transcriptions?page=1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

書き起こしの一覧を取得しました。

Bodyapplication/jsonArray [

transcription_idstring

書き起こしの一意な識別子

dictionary_idstring

使用された辞書のID

team_idstring

ユーザーが所属するチームのID

namestring

書き起こし対象の音声ファイルの名前

transcription_pathstring

書き起こし結果のダウンロードURL

audio_pathstring

アップロードされた音声ファイルのダウンロードURL

statusstring

書き起こしの現在のステータス

IN_PROGRESS: 現在、書き起こしの処理が進行中である状態
CONVERTING: 書き起こしのための音声の変換処理を行っている状態
COMPLETED: 書き起こし処理が正常に完了した状態
FAILED: 書き起こし処理が失敗した状態
CANCELLED: 書き起こしリクエストがキャンセルされた状態

speaking_durationnumber

音声ファイルの発話時間（秒）

created_atstring(date-time)

書き起こしが作成された日時

updated_atstring(date-time)

書き起こしが最後に更新された日時

]

Response

application/json

[
  {
    "transcription_id": "string",
    "dictionary_id": "string",
    "team_id": "string",
    "name": "string",
    "transcription_path": "string",
    "audio_path": "string",
    "status": "string",
    "speaking_duration": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

辞書API

辞書APIでは、書き起こし精度を高めるために、単語とその読みを登録した辞書を作成することができます。

主な機能
• 辞書を作成する
• 辞書に単語を登録する
• 辞書を参照する

Operations