Create Studio Project

The name of the Studio project, used for identification only.

The voice_id that corresponds to the default voice used for new titles.

The voice_id that corresponds to the default voice used for new paragraphs.

The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models.

An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank.

An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the Studio project with its content. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank.

An optional content to initialize the Studio project with. If this is set, 'from_url' and 'from_document' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank.

Example:
[{"name": "Chapter 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": "Chapter 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"}]}]}]

An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.

An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download.

An optional description of the Studio project.

An optional target audience of the Studio project.

An optional language of the Studio project. Two-letter language code (ISO 639-1).

An optional content type of the Studio project.

An optional original publication date of the Studio project, in the format YYYY-MM-DD or YYYY.

An optional specification of whether this Studio project contains mature content.

An optional ISBN number of the Studio project you want to create, this will be added as metadata to the mp3 file on Studio project or chapter download.

[Deprecated] When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements

When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements

A url that will be called by our service when the Studio project is converted. Request will contain a json blob containing the status of the conversion
Messages:
1. When project was converted successfully:
{
  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. When project conversion failed:
{
  type: "project_conversion_status",
  event_timestamp: 1234567890,
  data: {
    request_id: "1234567890",
    project_id: "21m00Tcm4TlvDq8ikWAM",
    conversion_status: "error",
    project_snapshot_id: None,
    error_details: "Error details if conversion failed"
  }
}

3. When chapter was converted successfully:
{
  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. When chapter conversion failed:
{
  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: "Error details if conversion failed"
  }
}

An optional specification of whether the content of this Studio project is fiction.

This parameter controls text normalization with four modes: 'auto', 'on', 'apply_english' and 'off'.
When set to 'auto', the system will automatically decide whether to apply text normalization
(e.g., spelling out numbers). With 'on', text normalization will always be applied, while
with 'off', it will be skipped. 'apply_english' is the same as 'on' but will assume that text is in English.

Whether to auto convert the Studio project to audio or not.

[Alpha Feature] Whether automatically assign voices to phrases in the create Project.

The type of Studio project to create.

If true, creates a corresponding read for direct publishing in draft state