コンテンツへスキップ
/書き起こしAPI

mocoVoice API (1.8.0)



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

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

言語
サーバー
mocoVoice APIサーバー

https://api.mocomoco.ai/

書き起こしAPI

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

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

操作

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

リクエスト

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

セキュリティ
APIKeyHeader
ボディapplication/json必須
filenamestring必須

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

dictionary_idstring

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

languageany

音声ファイルの言語コードを指定する。（例: 'ja'）
複数の言語コードは配列で指定できる。（例: ['en', 'ja']）
詳細の言語コードは、FAQの対応言語を参照。

transcription_modelstring

書き起こしモデル（任意、未指定時は、default） 話者分離強化モデルの場合は、diarization-highを入力

デフォルト "default"
num_speakersstring

指定する話者数（指定なし：自動推定）

max_speakersstring

指定する最大話者数（指定なし：自動推定）

min_speakersstring

指定する最小話者数（指定なし：自動推定）

wordsArray of objects(WordCreateRequest)

適用する単語リスト（任意、dictionary_idを指定している場合は、こちらが優先される）

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,
    "transcription_model": "default",
    "num_speakers": "string",
    "max_speakers": "string",
    "min_speakers": "string",
    "words": [
      {
        "word": "string",
        "reading": "string"
      }
    ]
  }'

レスポンス

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

ボディapplication/json
transcription_idstring

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

dictionary_idstring
team_idstring

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

audio_upload_urlstring

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

transcription_modelstring

書き起こしモデル

レスポンス
application/json
{
  "transcription_id": "string",
  "dictionary_id": "string",
  "team_id": "string",
  "audio_upload_url": "string",
  "transcription_model": "string"
}

書き起こし開始

リクエスト

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

セキュリティ
APIKeyHeader
パス
transcription_idstring必須

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

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

レスポンス

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

ボディapplication/json
transcription_idstring

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

dictionary_idstring

使用された辞書のID

team_idstring

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

namestring

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

userobject

書き起こしたユーザ（API経由の場合はnull）

transcription_pathstring

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

audio_pathstring

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

transcription_modelstring

書き起こしモデル

statusstring

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

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

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

created_atstring(date-time)

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

updated_atstring(date-time)

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

レスポンス
application/json
{
  "transcription_id": "string",
  "dictionary_id": "string",
  "team_id": "string",
  "name": "string",
  "user": {
    "user_id": "string",
    "name": "string"
  },
  "transcription_path": "string",
  "audio_path": "string",
  "transcription_model": "string",
  "status": "string",
  "speaking_duration": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

書き起こし一覧取得

リクエスト

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

セキュリティ
APIKeyHeader
クエリ
pageinteger

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

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

レスポンス

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

ボディapplication/jsonArray [
transcription_idstring

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

dictionary_idstring

使用された辞書のID

team_idstring

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

namestring

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

userobject

書き起こしたユーザ（API経由の場合はnull）

transcription_pathstring

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

audio_pathstring

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

transcription_modelstring

書き起こしモデル

statusstring

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

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

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

created_atstring(date-time)

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

updated_atstring(date-time)

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

]
レスポンス
application/json
[
  {
    "transcription_id": "string",
    "dictionary_id": "string",
    "team_id": "string",
    "name": "string",
    "user": { … },
    "transcription_path": "string",
    "audio_path": "string",
    "transcription_model": "string",
    "status": "string",
    "speaking_duration": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

書き起こし取得

リクエスト

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

セキュリティ
APIKeyHeader
パス
transcription_idstring必須

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

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

レスポンス

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

ボディapplication/json
transcription_idstring

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

dictionary_idstring

使用された辞書のID

team_idstring

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

namestring

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

userobject

書き起こしたユーザ（API経由の場合はnull）

transcription_pathstring

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

audio_pathstring

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

transcription_modelstring

書き起こしモデル

statusstring

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

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

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

created_atstring(date-time)

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

updated_atstring(date-time)

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

レスポンス
application/json
{
  "transcription_id": "string",
  "dictionary_id": "string",
  "team_id": "string",
  "name": "string",
  "user": {
    "user_id": "string",
    "name": "string"
  },
  "transcription_path": "string",
  "audio_path": "string",
  "transcription_model": "string",
  "status": "string",
  "speaking_duration": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

書き起こし削除

リクエスト

指定した書き起こしIDの書き起こしを削除します。APIキーにDELETEロールを付与する必要があります。

セキュリティ
APIKeyHeader
パス
transcription_idstring必須

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

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

レスポンス

書き起こしの詳細情報を削除しました。

レスポンス
コンテンツなし

書き起こし要約取得

リクエスト

指定した書き起こしIDの書き起こし要約を取得します。

セキュリティ
APIKeyHeader
パス
transcription_idstring必須

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

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

レスポンス

書き起こしの要約を取得しました。

ボディapplication/json
transcription_idstring

書き起こしのID

summarized_textstring

書き起こし要約

statusstring

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

  • IN_PROGRESS: 現在、処理が進行中である状態
  • COMPLETED: 処理が正常に完了した状態
  • FAILED: 処理が失敗した状態
  • CANCELLED: リクエストがキャンセルされた状態
レスポンス
application/json
{
  "transcription_id": "string",
  "summarized_text": "string",
  "status": "string"
}

書き起こし要約作成

リクエスト

指定した書き起こしIDの書き起こし要約を行います。

セキュリティ
APIKeyHeader
パス
transcription_idstring必須

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

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

レスポンス

書き起こしの要約を取得しました。

ボディapplication/json
transcription_idstring

書き起こしID

is_asyncboolean

処理方式（基本的に非同期でtrueとなります）

status_urlstring

GETメソッドで状態を閲覧できるリンク

レスポンス
application/json
{
  "transcription_id": "string",
  "is_async": true,
  "status_url": "string"
}

書き起こし感情分析取得

リクエスト

指定した書き起こしIDの書き起こしの感情分析を取得します。

セキュリティ
APIKeyHeader
パス
transcription_idstring必須

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

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

レスポンス

書き起こしの感情分析結果を取得しました。

ボディapplication/json
transcription_idstring

書き起こしのID

emotionsArray of arrays

感情分析結果

statusstring

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

  • IN_PROGRESS: 現在、処理が進行中である状態
  • COMPLETED: 処理が正常に完了した状態
  • FAILED: 処理が失敗した状態
  • CANCELLED: リクエストがキャンセルされた状態
レスポンス
application/json
{
  "transcription_id": "string",
  "emotions": [],
  "status": "string"
}

書き起こし感情分析作成

リクエスト

指定した書き起こしIDの書き起こしの感情分析を行います。

セキュリティ
APIKeyHeader
パス
transcription_idstring必須

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

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

レスポンス

書き起こしの感情分析結果を取得しました。

ボディapplication/json
transcription_idstring

書き起こしID

is_asyncboolean

処理方式（基本的に非同期でtrueとなります）

status_urlstring

GETメソッドで状態を閲覧できるリンク

レスポンス
application/json
{
  "transcription_id": "string",
  "is_async": true,
  "status_url": "string"
}

書き起こし翻訳取得

リクエスト

指定した書き起こしIDの書き起こしの翻訳結果を取得します。

セキュリティ
APIKeyHeader
パス
transcription_idstring必須

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

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

レスポンス

書き起こしの翻訳結果を取得しました。

ボディapplication/json
transcription_idstring

書き起こしのID

translated_textstring

翻訳結果

statusstring

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

  • IN_PROGRESS: 現在、処理が進行中である状態
  • COMPLETED: 処理が正常に完了した状態
  • FAILED: 処理が失敗した状態
  • CANCELLED: リクエストがキャンセルされた状態
レスポンス
application/json
{
  "transcription_id": "string",
  "translated_text": "string",
  "status": "string"
}

書き起こし翻訳作成

リクエスト

指定した書き起こしIDの書き起こしの翻訳を行います。

セキュリティ
APIKeyHeader
パス
transcription_idstring必須

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

ボディapplication/json必須
languagestring

翻訳する言語の言語コードを指定する。（例: 'ja'） 詳細の言語コードは、FAQの対応言語を参照

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

レスポンス

書き起こしの翻訳結果を取得しました。

ボディapplication/json
transcription_idstring

書き起こしID

is_asyncboolean

処理方式（基本的に非同期でtrueとなります）

status_urlstring

GETメソッドで状態を閲覧できるリンク

レスポンス
application/json
{
  "transcription_id": "string",
  "is_async": true,
  "status_url": "string"
}

辞書API

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

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

操作

辞書リスト取得

リクエスト

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

セキュリティ
APIKeyHeader
クエリ
pageinteger

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

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

レスポンス

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

ボディapplication/jsonArray [
dictionary_idstring

辞書の一意な識別子

team_idstring

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

namestring

辞書の名前

created_atstring(date-time)

辞書が作成された日時

updated_atstring(date-time)

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

]
レスポンス
application/json
[
  {
    "dictionary_id": "string",
    "team_id": "string",
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

辞書作成

リクエスト

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

セキュリティ
APIKeyHeader
ボディapplication/json必須
namestring必須

作成する辞書の名前

wordsArray of objects(WordCreateRequest)

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

is_temporaryboolean

POST /api/v1/transcriptions/uploadで単語を指定した場合に臨時的に生成される辞書。trueの場合、書き起こし終了後に削除される。

デフォルト false
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",
    "words": [
      {
        "word": "string",
        "reading": "string"
      }
    ],
    "is_temporary": false
  }'

レスポンス

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

ボディapplication/json
dictionary_idstring

辞書の一意な識別子

team_idstring

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

namestring

辞書の名前

wordsArray of objects(Word)

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

is_temporaryboolean

POST /api/v1/transcriptions/uploadで単語を指定した場合に臨時的に生成される辞書。trueの場合、書き起こし終了後に削除される。

created_atstring(date-time)

辞書が作成された日時

updated_atstring(date-time)

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

レスポンス
application/json
{
  "dictionary_id": "string",
  "team_id": "string",
  "name": "string",
  "words": [
    { … }
  ],
  "is_temporary": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

辞書取得

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

取得したい辞書のID

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

レスポンス

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

ボディapplication/json
dictionary_idstring

辞書の一意な識別子

team_idstring

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

namestring

辞書の名前

wordsArray of objects(Word)

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

is_temporaryboolean

POST /api/v1/transcriptions/uploadで単語を指定した場合に臨時的に生成される辞書。trueの場合、書き起こし終了後に削除される。

created_atstring(date-time)

辞書が作成された日時

updated_atstring(date-time)

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

レスポンス
application/json
{
  "dictionary_id": "string",
  "team_id": "string",
  "name": "string",
  "words": [
    { … }
  ],
  "is_temporary": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

辞書アップデート

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

更新したい辞書のID

ボディapplication/json必須
namestring

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

is_temporaryboolean

POST /api/v1/transcriptions/uploadで単語を指定した場合に臨時的に生成される辞書。trueの場合、書き起こし終了後に削除される。

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",
    "is_temporary": true
  }'

レスポンス

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

ボディapplication/json
dictionary_idstring

辞書の一意な識別子

team_idstring

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

namestring

辞書の名前

wordsArray of objects(Word)

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

is_temporaryboolean

POST /api/v1/transcriptions/uploadで単語を指定した場合に臨時的に生成される辞書。trueの場合、書き起こし終了後に削除される。

created_atstring(date-time)

辞書が作成された日時

updated_atstring(date-time)

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

レスポンス
application/json
{
  "dictionary_id": "string",
  "team_id": "string",
  "name": "string",
  "words": [
    { … }
  ],
  "is_temporary": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

辞書削除

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

削除したい辞書のID

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

レスポンス

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

レスポンス
コンテンツなし

単語登録

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

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

ボディapplication/json必須
wordstring必須

登録する単語

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

レスポンス

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

ボディapplication/json
word_idstring

単語の一意な識別子

dictionary_idstring

単語が所属する辞書のID

wordstring

辞書に登録する単語

readingstring

単語の読み仮名（任意）

created_atstring(date-time)

単語が作成された日時

updated_atstring(date-time)

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

レスポンス
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"
}

複数の単語登録

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

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

ボディapplication/json必須Array [
wordstring必須

登録する単語

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

レスポンス

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

ボディapplication/jsonArray [
word_idstring

単語の一意な識別子

dictionary_idstring

単語が所属する辞書のID

wordstring

辞書に登録する単語

readingstring

単語の読み仮名（任意）

created_atstring(date-time)

単語が作成された日時

updated_atstring(date-time)

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

]
レスポンス
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"
  }
]

単語取得

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

単語が含まれる辞書のID

word_idstring必須

取得したい単語の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'

レスポンス

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

ボディapplication/json
word_idstring

単語の一意な識別子

dictionary_idstring

単語が所属する辞書のID

wordstring

辞書に登録する単語

readingstring

単語の読み仮名（任意）

created_atstring(date-time)

単語が作成された日時

updated_atstring(date-time)

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

レスポンス
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"
}

単語削除

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

単語が含まれる辞書のID

word_idstring必須

削除したい単語の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'

レスポンス

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

レスポンス
コンテンツなし

強制置換単語登録

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

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

ボディapplication/json必須
patternstring

書き換え対象の単語

replacementstring

書き換え後の単語

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

レスポンス

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

ボディapplication/json
blacklist_word_idstring

強制置換単語ID

dictionary_idstring

辞書ID

patternstring

書き換え対象の単語

replacementstring

書き換え後の単語

created_atstring(date-time)

作成日時

updated_atstring(date-time)

更新日時

レスポンス
application/json
{
  "blacklist_word_id": "string",
  "dictionary_id": "string",
  "pattern": "string",
  "replacement": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

複数の強制置換単語登録

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

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

ボディapplication/json必須Array [
patternstring

書き換え対象の単語

replacementstring

書き換え後の単語

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

レスポンス

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

ボディapplication/jsonArray [
blacklist_word_idstring

強制置換単語ID

dictionary_idstring

辞書ID

patternstring

書き換え対象の単語

replacementstring

書き換え後の単語

created_atstring(date-time)

作成日時

updated_atstring(date-time)

更新日時

]
レスポンス
application/json
[
  {
    "blacklist_word_id": "string",
    "dictionary_id": "string",
    "pattern": "string",
    "replacement": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

強制置換単語取得

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

単語が含まれる辞書のID

blacklist_word_idstring必須

取得したい強制置換単語のID

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

レスポンス

強制置換単語の詳細情報を取得しました。

ボディapplication/json
blacklist_word_idstring

強制置換単語ID

dictionary_idstring

辞書ID

patternstring

書き換え対象の単語

replacementstring

書き換え後の単語

created_atstring(date-time)

作成日時

updated_atstring(date-time)

更新日時

レスポンス
application/json
{
  "blacklist_word_id": "string",
  "dictionary_id": "string",
  "pattern": "string",
  "replacement": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

強制置換単語削除

リクエスト

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

セキュリティ
APIKeyHeader
パス
dictionary_idstring必須

強制置換単語が含まれる辞書のID

blacklist_word_idstring必須

削除したい強制置換単語のID

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

レスポンス

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

レスポンス
コンテンツなし