ElevenCreativeStudio

Get Studio Project

Returns information about a specific Studio project. This endpoint returns more detailed information about a project than GET /v1/studio.

Path parameters

project_idstringRequired

The ID of the project to be used. You can use the List projects endpoint to list all the available projects.

Headers

xi-api-keystringOptional

Query parameters

share_idstringOptional
The share ID of the project

Response

Successful Response
project_idstring
The ID of the project.
namestring
The name of the project.
create_date_unixinteger
The creation date of the project.
default_title_voice_idstring
The default title voice ID.
default_paragraph_voice_idstring
The default paragraph voice ID.
default_model_idstring
The default model ID.
can_be_downloadedboolean
Whether the project can be downloaded.
volume_normalizationboolean
Whether the project uses volume normalization.
stateenum
The state of the project.
Allowed values:
access_levelenum
The access level of the project.
Allowed values:
quality_presetenum
The quality preset level of the project.
Allowed values:
chapterslist of objects
List of chapters of the project and their metadata.
pronunciation_dictionary_versionslist of objects
List of pronunciation dictionary versions of the project and their metadata.
pronunciation_dictionary_locatorslist of objects
List of pronunciation dictionary locators.
apply_text_normalizationenum
Whether text normalization is applied to the project.
Allowed values:
assetslist of objects
List of uploaded assets e.g. videos, audios.
voiceslist of objects
List of configured project voices.
quality_check_onbooleanDeprecated
Whether quality check is enabled for this project.
quality_check_on_when_bulk_convertbooleanDeprecated
Whether quality check is enabled on the project when bulk converting.
created_by_user_idstring
The user ID who created the project.
last_conversion_date_unixinteger
The last conversion date of the project.
titlestring
The title of the project.
authorstring
The author of the project.
descriptionstring
The description of the project.
genreslist of strings
List of genres of the project.
cover_image_urlstring
The cover image URL of the project.
target_audienceenum
The target audience of the project.
Allowed values:
languagestring

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

content_typestring
The content type of the project, e.g. 'Novel' or 'Short Story'
original_publication_datestring
The original publication date of the project.
mature_contentboolean
Whether the project contains mature content.
isbn_numberstring
The ISBN number of the project.
fictionenum
Whether the project is fiction.
Allowed values:
creation_metaobject
The creation meta of the project.
source_typeenum
The source type of the project.
chapters_enabledboolean
Whether chapters are enabled for the project.
captions_enabledboolean
Whether captions are enabled for the project.
caption_styleobject
Global styling to be applied to all captions
caption_style_template_overridesmap from strings to optional objects
Styling changes that have been made to the provided templates
public_share_idstring
The public share ID of the project.
aspect_ratioenum
The aspect ratio of the project.
Allowed values:
agent_settingsobject

Agent-related settings for the project

experimentalmap from strings to any
Experimental features for the project.
base_voiceslist of objects
List of voices used by the project.
publishing_readobject
The ElevenReader data if the book was published.

Errors

422
Projects Get Request Unprocessable Entity Error