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

辞書リスト取得

Request

チームに関連付けられた辞書のリストを取得します。ページネーションが可能です。

Query

pageinteger

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

Default 1

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

Responses

辞書のリストを取得しました。

Bodyapplication/jsonArray [

dictionary_idstring

辞書の一意な識別子

team_idstring

辞書が所属するチームのID

namestring

辞書の名前

created_atstring(date-time)

辞書が作成された日時

updated_atstring(date-time)

辞書が最後に更新された日時

]

Response

application/json

[
  {
    "dictionary_id": "string",
    "team_id": "string",
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

辞書作成

Request

新しい辞書を作成します。辞書は書き起こし時に使用することができます。

Bodyapplication/jsonrequired

namestringrequired

作成する辞書の名前

curl -i -X POST \
  https://api.mocomoco.ai/api/v1/dictionaries \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string"
  }'

Responses

辞書が正常に作成されました。

Bodyapplication/json

dictionary_idstring

辞書の一意な識別子

team_idstring

辞書が所属するチームのID

namestring

辞書の名前

wordsArray of arrays

辞書に含まれる単語の配列

created_atstring(date-time)

辞書が作成された日時

updated_atstring(date-time)

辞書が最後に更新された日時

Response

application/json

{
  "dictionary_id": "string",
  "team_id": "string",
  "name": "string",
  "words": [],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

辞書取得

Request

指定した辞書IDの詳細情報を取得します。辞書に含まれる単語の一覧も取得できます。

Path

dictionary_idstringrequired

取得したい辞書のID

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

Responses

辞書の詳細情報を取得しました。

Bodyapplication/json

dictionary_idstring

辞書の一意な識別子

team_idstring

辞書が所属するチームのID

namestring

辞書の名前

wordsArray of arrays

辞書に含まれる単語の配列

created_atstring(date-time)

辞書が作成された日時

updated_atstring(date-time)

辞書が最後に更新された日時

Response

application/json

{
  "dictionary_id": "string",
  "team_id": "string",
  "name": "string",
  "words": [],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

辞書アップデート

Request

指定した辞書の情報を更新します。辞書名の変更などが可能です。

Path

dictionary_idstringrequired

更新したい辞書のID

Bodyapplication/jsonrequired

namestring

更新する辞書の新しい名前

curl -i -X PATCH \
  'https://api.mocomoco.ai/api/v1/dictionaries/{dictionary_id}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string"
  }'

Responses

辞書が正常に更新されました。

Bodyapplication/json

dictionary_idstring

辞書の一意な識別子

team_idstring

辞書が所属するチームのID

namestring

辞書の名前

wordsArray of arrays

辞書に含まれる単語の配列

created_atstring(date-time)

辞書が作成された日時

updated_atstring(date-time)

辞書が最後に更新された日時

Response

application/json

{
  "dictionary_id": "string",
  "team_id": "string",
  "name": "string",
  "words": [],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

辞書削除

Request

指定した辞書を削除します。削除すると、その辞書に関連付けられた単語もすべて削除されます。

Path

dictionary_idstringrequired

削除したい辞書のID

curl -i -X DELETE \
  'https://api.mocomoco.ai/api/v1/dictionaries/{dictionary_id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

辞書が正常に削除されました。

Bodyapplication/json

any

Response

application/json

null

単語登録

Request

指定した辞書に新しい単語を登録します。書き起こし時に正確な変換が可能になります。

Path

dictionary_idstringrequired

単語を追加したい辞書のID

Bodyapplication/jsonrequired

wordstringrequired

登録する単語

readingstring

単語の読み仮名（任意）

curl -i -X POST \
  'https://api.mocomoco.ai/api/v1/dictionaries/{dictionary_id}/words' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "word": "string",
    "reading": "string"
  }'

Responses

単語が正常に登録されました。

Bodyapplication/json

word_idstring

単語の一意な識別子

dictionary_idstring

単語が所属する辞書のID

wordstring

辞書に登録する単語

readingstring

単語の読み仮名（任意）

created_atstring(date-time)

単語が作成された日時

updated_atstring(date-time)

単語が最後に更新された日時

Response

application/json

{
  "word_id": "string",
  "dictionary_id": "string",
  "word": "string",
  "reading": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

複数の単語登録

Request

指定した辞書に複数の単語を一括で登録します。大量の単語を効率的に追加できます。

Path

dictionary_idstringrequired

単語を追加したい辞書のID

Bodyapplication/jsonrequiredArray [

wordstringrequired

登録する単語

readingstring

単語の読み仮名（任意）

]

curl -i -X POST \
  'https://api.mocomoco.ai/api/v1/dictionaries/{dictionary_id}/words/bulk' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[
    {
      "word": "string",
      "reading": "string"
    }
  ]'

Responses

単語が正常に登録されました。

Bodyapplication/jsonArray [

word_idstring

単語の一意な識別子

dictionary_idstring

単語が所属する辞書のID

wordstring

辞書に登録する単語

readingstring

単語の読み仮名（任意）

created_atstring(date-time)

単語が作成された日時

updated_atstring(date-time)

単語が最後に更新された日時

]

Response

application/json

[
  {
    "word_id": "string",
    "dictionary_id": "string",
    "word": "string",
    "reading": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

単語取得

Request

指定した単語IDの詳細情報を取得します。

Path

dictionary_idstringrequired

単語が含まれる辞書のID

word_idstringrequired

取得したい単語のID

curl -i -X GET \
  'https://api.mocomoco.ai/api/v1/dictionaries/{dictionary_id}/words/{word_id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

単語の詳細情報を取得しました。

Bodyapplication/json

word_idstring

単語の一意な識別子

dictionary_idstring

単語が所属する辞書のID

wordstring

辞書に登録する単語

readingstring

単語の読み仮名（任意）

created_atstring(date-time)

単語が作成された日時

updated_atstring(date-time)

単語が最後に更新された日時

Response

application/json

{
  "word_id": "string",
  "dictionary_id": "string",
  "word": "string",
  "reading": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

単語削除

Request

指定した単語を辞書から削除します。

Path

dictionary_idstringrequired

単語が含まれる辞書のID

word_idstringrequired

削除したい単語のID

curl -i -X DELETE \
  'https://api.mocomoco.ai/api/v1/dictionaries/{dictionary_id}/words/{word_id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

単語が正常に削除されました。

Bodyapplication/json

any

Response

application/json

null