オーディオネイティブプロジェクトを作成

POST

/v1/audio-native

オーディオネイティブ対応プロジェクトを作成し、必要に応じて変換を開始して、プロジェクトIDと埋め込み可能なHTMLスニペットを返します。

リクエスト

This endpoint expects a multipart form containing an optional file.

namestring必須

プロジェクト名。

imagestring or nullオプションDeprecated

（非推奨）プレイヤーで使用する画像URLです。指定しない場合は、プレイヤー設定で設定されたデフォルト画像が使用されます。

authorstring or nullオプション

プレーヤーで使用され、アップロードされた記事の先頭に挿入される著者です。指定しない場合は、プレーヤー設定で指定されたデフォルトの著者が使用されます。

titlestring or nullオプション

プレーヤーで使用され、アップロードした記事の先頭に挿入されるタイトル。指定しない場合は、プレーヤー設定で指定されたデフォルトタイトルが使用されます。

smallbooleanオプションデフォルト値 falseDeprecated

（非推奨）小型プレイヤーを使用するかどうか。指定しない場合は、プレイヤー設定で設定されたデフォルト値が使用されます。

text_colorstring or nullオプション

プレーヤーで使用するテキストカラー。指定しない場合は、プレーヤー設定で設定されたデフォルトのテキストカラーが使用されます。

background_colorstring or nullオプション

プレーヤーで使用する背景色です。指定しない場合は、プレーヤー設定で指定されたデフォルトの背景色が使用されます。

sessionizationintegerオプションデフォルト値 0Deprecated

（非推奨）ページの再読み込み後もセッションを維持する時間（分）を指定します。指定しない場合は、プレイヤー設定で設定されたデフォルトのセッション化が使用されます。

voice_idstring or nullオプション

コンテンツの音声化に使用する音声ID。指定しない場合は、プレーヤー設定で設定されたデフォルトの音声IDが使用されます。

model_idstring or nullオプション

プレーヤーで使用するTTSモデルID。指定しない場合は、プレーヤー設定で設定されたデフォルトモデルIDが使用されます。

filefileオプション

記事コンテンツを含むtxtまたはHTMLの入力ファイル。HTMLは次の形式にしてください：‘<html><body><div><p>Your content</p><h3>More of your content</h3><p>Some more of your content</p></div></body></html>’

auto_convertbooleanオプションデフォルト値 false

プロジェクトをオーディオに自動変換するかどうか。

apply_text_normalizationenum or nullオプション

このパラメーターは、‘auto’、‘on’、‘apply_english’、‘off’の4つのモードでテキスト正規化を制御します。 ‘auto’に設定すると、システムがテキスト正規化を適用するかどうかを自動的に判断します（例：数字を読み上げ用の表記に変換）。‘on’では常にテキスト正規化が適用され、 ‘off’ではスキップされます。‘apply_english’は’on’と同じですが、テキストが英語であるとみなします。

このパラメーターは、'auto'、'on'、'apply_english'、'off'の4つのモードでテキスト正規化を制御します。 'auto'に設定すると、システムがテキスト正規化を適用するかどうかを自動的に判断します（例：数字を読み上げ用の表記に変換）。'on'では常にテキスト正規化が適用され、 'off'ではスキップされます。'apply_english'は'on'と同じですが、テキストが英語であるとみなします。

許可された値:

pronunciation_dictionary_locatorslist of stringsオプション

テキストに適用する発音辞書用の、JSON文字列のリストとしてエンコードされた発音辞書ロケーター（pronunciation_dictionary_id、version_id）の一覧です。プロジェクトの追加はjsonBodyではなくformDataを介して行われる場合があるため、JSONエンコード文字列のリストが必要です。複数の辞書を指定するには、curlで複数の—form行を使用します。例：—form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“Vmd4Zor6fplcA7WrINey”,“version_id”:“hRPaxjlTdR7wFMhV4w0b”}”’ —form ‘pronunciation_dictionary_locators=”{“pronunciation_dictionary_id”:“JzWtcGQMJ6bnlWwyMo7e”,“version_id”:“lbmwxiLu4q6txYxgdZqn”}”’。

テキストに適用する発音辞書用の、JSON文字列のリストとしてエンコードされた発音辞書ロケーター（pronunciation_dictionary_id、version_id）の一覧です。プロジェクトの追加はjsonBodyではなくformDataを介して行われる場合があるため、JSONエンコード文字列のリストが必要です。複数の辞書を指定するには、curlで複数の--form行を使用します。例：--form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'。

レスポンス

成功レスポンス。

project_idstring

作成されたオーディオネイティブプロジェクトのID。

convertingboolean

プロジェクトが現在変換中かどうか。

html_snippetstring

オーディオネイティブプレーヤーを埋め込むためのHTMLスニペット。

エラー

422

Unprocessable Entity Error

ヘッダー

リクエスト

レスポンス

エラー