スタジオプロジェクトを作成

新しいStudioプロジェクトを作成します。空白の状態、ドキュメント、またはURLから初期化できます。

ヘッダー

xi-api-keystringオプション

リクエスト

This endpoint expects a multipart form containing an optional file.
namestring必須

Studioプロジェクトの名前。識別目的でのみ使用します。

default_title_voice_idstring or nullオプション

新しいタイトルに使用するデフォルト音声に対応するvoice_idです。

default_paragraph_voice_idstring or nullオプション

新しい段落に使用するデフォルト音声に対応するvoice_idです。

default_model_idstring or nullオプション

このStudioプロジェクトで使用するモデルのID。GET /v1/modelsをクエリして、利用可能なすべてのモデルを一覧表示できます。

from_urlstring or nullオプション
コンテンツを抽出してStudioプロジェクトを初期化する元となる任意のURLです。これを設定する場合、'from_url'と'from_content'はnullでなければなりません。'from_url'、'from_document'、'from_content'のいずれも指定しない場合、Studioプロジェクトは空の状態で初期化されます。
from_documentfileオプション
任意で.epub、.pdf、.txtまたは類似のファイルを指定できます。指定した場合、その内容でStudioプロジェクトを初期化します。これを設定する場合、'from_url'と'from_content'はnullでなければなりません。'from_url'、'from_document'、'from_content'のいずれも指定しない場合、Studioプロジェクトは空の状態で初期化されます。
from_content_jsonstringオプション
Studioプロジェクトの初期化に使用する任意のコンテンツです。設定する場合、'from_url'と'from_document'はnullである必要があります。'from_url'、'from_document'、'from_content'のいずれも指定しない場合、Studioプロジェクトは空の状態で初期化されます。 例: [{"name": "チャプターA", "blocks": [{"sub_type": "p", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "A", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "B", "type": "tts_node"}]}, {"sub_type": "h1", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "C", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "D", "type": "tts_node"}]}]}, {"name": "チャプターB", "blocks": [{"sub_type": "p", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "E", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "F", "type": "tts_node"}]}, {"sub_type": "h2", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "G", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "H", "type": "tts_node"}]}]}]
quality_presetenum or nullオプション
生成されたオーディオの出力品質。次のいずれかを指定する必要があります。 'standard':標準出力形式。サンプルレート44.1kHz、128kbps。 'high':高品質出力形式。サンプルレート44.1kHz、192kbpsで、大幅な品質向上が適用されます。 'ultra':最高品質出力形式。サンプルレート44.1kHz、192kbpsで、最大限の品質向上が適用されます。 'ultra_lossless':完全なロスレス形式による最高品質出力形式。サンプルレート44.1kHz、705.6kbpsで、最大限の品質向上が適用されます。 指定しない場合、サブスクリプションのティアで利用可能な最高品質のプリセットがデフォルトになります。
許可された値:
titlestring or nullオプション

Studioプロジェクトの任意の著者名です。StudioプロジェクトまたはチャプターをMP3としてダウンロードする際、メタデータとして追加されます。

authorstring or nullオプション

Studioプロジェクトの任意の著者名です。StudioプロジェクトまたはチャプターをMP3としてダウンロードする際、メタデータとして追加されます。

descriptionstring or nullオプション

Studioプロジェクトの任意の説明。

genreslist of stringsオプション

Studioプロジェクトに関連付ける任意のジャンルリスト。

target_audienceenum or nullオプション

Studioプロジェクトの任意の対象読者。

許可された値:
languagestring or nullオプション=2 characters

Studioプロジェクトの任意の言語。2文字の言語コード(ISO 639-1)。

content_typestring or nullオプション

Studioプロジェクトの任意のコンテンツタイプ。

original_publication_datestring or nullオプション形式: "^\d{4}-\d{2}-\d{2}$|^\d{4}$"

Studioプロジェクトの任意の初回公開日。形式はYYYY-MM-DDまたはYYYYです。

mature_contentboolean or nullオプションデフォルト値 false

このStudioプロジェクトに成人向けコンテンツが含まれるかどうかを指定します。

isbn_numberstring or nullオプション

作成するStudioプロジェクトの任意のISBN番号です。StudioプロジェクトまたはチャプターをMP3としてダウンロードする際、メタデータとして追加されます。

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

[Deprecated] Studioプロジェクトのダウンロード時に、返されるオーディオへオーディオブックの正規化音量要件に準拠するための後処理を適用するかどうか。

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

Studioプロジェクトのダウンロード時に、返されるオーディオにオーディオブックの正規化音量要件を満たすための後処理を適用するかどうか。

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\"}"'。
callback_urlstring or nullオプション
Studioプロジェクトの変換時にサービスから呼び出されるURLです。リクエストには、変換ステータスを含むJSON blobが含まれます。 メッセージ: 1. プロジェクトの変換に成功した場合: { type: "project_conversion_status", event_timestamp: 1234567890, data: { request_id: "1234567890", project_id: "21m00Tcm4TlvDq8ikWAM", conversion_status: "success", project_snapshot_id: "22m00Tcm4TlvDq8ikMAT", error_details: None, } } 2. プロジェクトの変換に失敗した場合: { type: "project_conversion_status", event_timestamp: 1234567890, data: { request_id: "1234567890", project_id: "21m00Tcm4TlvDq8ikWAM", conversion_status: "error", project_snapshot_id: None, error_details: "変換に失敗した場合のエラー詳細" } } 3. チャプターの変換に成功した場合: { type: "chapter_conversion_status", event_timestamp: 1234567890, data: { request_id: "1234567890", project_id: "21m00Tcm4TlvDq8ikWAM", chapter_id: "22m00Tcm4TlvDq8ikMAT", conversion_status: "success", chapter_snapshot_id: "23m00Tcm4TlvDq8ikMAV", error_details: None, } } 4. チャプターの変換に失敗した場合: { type: "chapter_conversion_status", event_timestamp: 1234567890, data: { request_id: "1234567890", project_id: "21m00Tcm4TlvDq8ikWAM", chapter_id: "22m00Tcm4TlvDq8ikMAT", conversion_status: "error", chapter_snapshot_id: None, error_details: "変換に失敗した場合のエラー詳細" } }
fictionenum or nullオプション

このStudioプロジェクトのコンテンツがフィクションかどうかを指定します。

許可された値:
apply_text_normalizationenum or nullオプション
このパラメーターは、'auto'、'on'、'apply_english'、'off'の4つのモードでテキスト正規化を制御します。 'auto'に設定すると、システムがテキスト正規化を適用するかどうかを自動的に判断します (例:数字を読み上げ用の表記に変換)。'on'では常にテキスト正規化が適用され、 'off'ではスキップされます。'apply_english'は'on'と同じですが、テキストが英語であるとみなします。
許可された値:
auto_convertbooleanオプションデフォルト値 false

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

auto_assign_voicesboolean or nullオプションデフォルト値 false

[Alpha Feature] プロジェクト作成時にフレーズへ音声を自動的に割り当てるかどうか。

source_typeenum or nullオプション

作成するStudioプロジェクトのタイプです。

voice_settingslist of stringsオプション

プロジェクトの音声設定を上書きする任意の値です。JSON文字列のリストとしてエンコードします。

例: [”{“voice_id”: “21m00Tcm4TlvDq8ikWAM”, “stability”: 0.7, “similarity_boost”: 0.8, “style”: 0.5, “speed”: 1.0, “use_speaker_boost”: true}”]

create_publishing_readboolean or nullオプションデフォルト値 false

trueの場合、下書き状態で直接公開するための対応するreadを作成します

レスポンス

成功レスポンス。

projectobject

エラー

422
Unprocessable Entity Error