Update project

POST
/v1/projects/:project_id

Edits basic project info.

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.

Request

This endpoint expects an object.
namestringRequired

The name of the project, used for identification only.

default_title_voice_idstringRequired

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

default_paragraph_voice_idstringRequired

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

titlestringOptional

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

authorstringOptional

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

isbn_numberstringOptional

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

volume_normalizationbooleanOptionalDefaults to false

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

quality_check_onbooleanOptional

[Depracated] Whether to run quality check on the generated audio and regenerate if needed. Applies to individual block conversion.

Response

Successful Response

projectobject

Errors

Built with