ADMINISTRATIONStudio

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-keystringRequired

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:
experimentalobject
Experimental features of the project.
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.
last_conversion_date_unixinteger or null
The last conversion date of the project.
titlestring or null
The title of the project.
authorstring or null
The author of the project.
descriptionstring or null
The description of the project.
genreslist of strings or null
List of genres of the project.
cover_image_urlstring or null
The cover image URL of the project.
target_audienceenum or null
The target audience of the project.
Allowed values:
languagestring or null

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

content_typestring or null
The content type of the project, e.g. 'Novel' or 'Short Story'
original_publication_datestring or null
The original publication date of the project.
mature_contentboolean or null
Whether the project contains mature content.
isbn_numberstring or null
The ISBN number of the project.
fictionenum or null
Whether the project is fiction.
Allowed values:
creation_metaobject or null
The creation meta of the project.
source_typeenum or null
The source type of the project.
Allowed values:
chapters_enabledboolean or nullDefaults to true
Whether chapters are enabled for the project.

Errors