# mocoVoice API

<br /> <br /><strong>書き起こしAPI</strong>では、音声ファイルをアップロードし、書き起こしを開始し、その結果を取得することができます。 <br /> <br /><strong>辞書API</strong>では、書き起こし精度を高めるために、辞書を作成し、単語を登録することができます。


Version: 1.9.0

## Servers

mocoVoice APIサーバー
```
https://api.mocomoco.ai
```

## Security

### HTTPBearer

Type: http
Scheme: bearer

### APIKeyHeader

Type: apiKey
In: header
Name: X-API-KEY

## Download OpenAPI description

[mocoVoice API](https://docs.mocomoco.ai/_bundle/mocovoice/apis/index.yaml)

## 書き起こしAPI

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


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

 - [POST /api/v1/transcriptions/upload](https://docs.mocomoco.ai/mocovoice/apis/api/upload_request_api_v1_transcriptions_upload_post.md): 音声ファイルをアップロードするためのエンドポイントです。このエンドポイントを呼び出すと、音声ファイルをアップロードするための一時的なURLが発行されます。

### 書き起こし開始

 - [POST /api/v1/transcriptions/{transcription_id}/transcribe](https://docs.mocomoco.ai/mocovoice/apis/api/start_transcribe_api_v1_transcriptions__transcription_id__transcribe_post.md): 指定した書き起こしIDに対して、書き起こし処理を開始します。音声ファイルのアップロードが完了している必要があります。

### 書き起こし一覧取得

 - [GET /api/v1/transcriptions](https://docs.mocomoco.ai/mocovoice/apis/api/get_transcription_list_api_v1_transcriptions_get.md): ユーザーまたはチームがこれまでに行った書き起こしの一覧を取得します。ページネーションが可能です。

### 書き起こし取得

 - [GET /api/v1/transcriptions/{transcription_id}](https://docs.mocomoco.ai/mocovoice/apis/api/get_transcription_api_v1_transcriptions__transcription_id__get.md): 指定した書き起こしIDの詳細情報とステータスを取得します。書き起こしの進捗状況や結果を確認できます。

### 書き起こし削除

 - [DELETE /api/v1/transcriptions/{transcription_id}](https://docs.mocomoco.ai/mocovoice/apis/api/delete_transcription_api_v1_transcriptions__transcription_id__get.md): 指定した書き起こしIDの書き起こしを削除します。APIキーにDELETEロールを付与する必要があります。

### 書き起こし要約取得

 - [GET /api/v1/transcriptions/{transcription_id}/summary](https://docs.mocomoco.ai/mocovoice/apis/api/get_summary_api_v1_transcriptions__transcription_id__summary_get.md): 指定した書き起こしIDの書き起こし要約を取得します。

### 書き起こし要約作成

 - [POST /api/v1/transcriptions/{transcription_id}/summary](https://docs.mocomoco.ai/mocovoice/apis/api/summary_request_api_v1_transcriptions__transcription_id__summary_post.md): 指定した書き起こしIDの書き起こし要約を行います。

### 書き起こし感情分析取得

 - [GET /api/v1/transcriptions/{transcription_id}/emotion](https://docs.mocomoco.ai/mocovoice/apis/api/get_emotion_api_v1_transcriptions__transcription_id__emotion_get.md): 指定した書き起こしIDの書き起こしの感情分析を取得します。

### 書き起こし感情分析作成

 - [POST /api/v1/transcriptions/{transcription_id}/emotion](https://docs.mocomoco.ai/mocovoice/apis/api/emotion_request_api_v1_transcriptions__transcription_id__emotion_post.md): 指定した書き起こしIDの書き起こしの感情分析を行います。

### 書き起こし翻訳取得

 - [GET /api/v1/transcriptions/{transcription_id}/translate](https://docs.mocomoco.ai/mocovoice/apis/api/get_translate_api_v1_transcriptions__transcription_id__translate_get.md): 指定した書き起こしIDの書き起こしの翻訳結果を取得します。

### 書き起こし翻訳作成

 - [POST /api/v1/transcriptions/{transcription_id}/translate](https://docs.mocomoco.ai/mocovoice/apis/api/translate_request_api_v1_transcriptions__transcription_id__translate_post.md): 指定した書き起こしIDの書き起こしの翻訳を行います。

## 辞書API

辞書APIでは、書き起こし精度を高めるために、単語とその読みを登録した辞書を作成することができます。 <br /><br /> 主な機能
  <br />    • 辞書を作成する
  <br />    • 辞書に単語を登録する
  <br />    • 辞書を参照する


### 辞書リスト取得

 - [GET /api/v1/dictionaries](https://docs.mocomoco.ai/mocovoice/apis/api/get_dictionaries_api_v1_dictionaries_get.md): チームに関連付けられた辞書のリストを取得します。ページネーションが可能です。

### 辞書作成

 - [POST /api/v1/dictionaries](https://docs.mocomoco.ai/mocovoice/apis/api/create_dictionary_api_v1_dictionaries_post.md): 新しい辞書を作成します。辞書は書き起こし時に使用することができます。

### 辞書取得

 - [GET /api/v1/dictionaries/{dictionary_id}](https://docs.mocomoco.ai/mocovoice/apis/api/get_dictionary_api_v1_dictionaries__dictionary_id__get.md): 指定した辞書IDの詳細情報を取得します。辞書に含まれる単語の一覧も取得できます。

### 辞書アップデート

 - [PATCH /api/v1/dictionaries/{dictionary_id}](https://docs.mocomoco.ai/mocovoice/apis/api/update_dictionary_api_v1_dictionaries__dictionary_id__patch.md): 指定した辞書の情報を更新します。辞書名の変更などが可能です。

### 辞書削除

 - [DELETE /api/v1/dictionaries/{dictionary_id}](https://docs.mocomoco.ai/mocovoice/apis/api/delete_dictionary_api_v1_dictionaries__dictionary_id__delete.md): 指定した辞書を削除します。削除すると、その辞書に関連付けられた単語もすべて削除されます。

### 単語登録

 - [POST /api/v1/dictionaries/{dictionary_id}/words](https://docs.mocomoco.ai/mocovoice/apis/api/create_word_api_v1_dictionaries__dictionary_id__words_post.md): 指定した辞書に新しい単語を登録します。書き起こし時に正確な変換が可能になります。

### 複数の単語登録

 - [POST /api/v1/dictionaries/{dictionary_id}/words/bulk](https://docs.mocomoco.ai/mocovoice/apis/api/create_words_from_array_api_v1_dictionaries__dictionary_id__words_bulk_post.md): 指定した辞書に複数の単語を一括で登録します。大量の単語を効率的に追加できます。

### 単語取得

 - [GET /api/v1/dictionaries/{dictionary_id}/words/{word_id}](https://docs.mocomoco.ai/mocovoice/apis/api/get_word_api_v1_dictionaries__dictionary_id__words__word_id__get.md): 指定した単語IDの詳細情報を取得します。

### 単語削除

 - [DELETE /api/v1/dictionaries/{dictionary_id}/words/{word_id}](https://docs.mocomoco.ai/mocovoice/apis/api/delete_word_api_v1_dictionaries__dictionary_id__words__word_id__delete.md): 指定した単語を辞書から削除します。

### 強制置換単語登録

 - [POST /api/v1/dictionaries/{dictionary_id}/blacklist_words](https://docs.mocomoco.ai/mocovoice/apis/api/create_blacklist_word_api_v1_dictionaries__dictionary_id__blacklist_words_post.md): 指定した辞書に新しい強制置換単語を登録します。書き起こし時に正確な変換が可能になります。

### 複数の強制置換単語登録

 - [POST /api/v1/dictionaries/{dictionary_id}/blacklist_words/bulk](https://docs.mocomoco.ai/mocovoice/apis/api/create_blacklist_words_from_array_api_v1_dictionaries__dictionary_id__blacklist_words_bulk_post.md): 指定した辞書に複数の単語を一括で登録します。大量の単語を効率的に追加できます。

### 強制置換単語取得

 - [GET /api/v1/dictionaries/{dictionary_id}/blacklist_words/{blacklist_word_id}](https://docs.mocomoco.ai/mocovoice/apis/api/get_blacklist_word_api_v1_dictionaries__dictionary_id__blacklist_words__blacklist_word_id__get.md): 指定した強制置換単語IDの詳細情報を取得します。

### 強制置換単語削除

 - [DELETE /api/v1/dictionaries/{dictionary_id}/blacklist_words/{blacklist_word_id}](https://docs.mocomoco.ai/mocovoice/apis/api/delete_blacklist_word_api_v1_dictionaries__dictionary_id__blacklist_words__blacklist_word_id__delete.md): 指定した単語を辞書から削除します。