v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

studio

Update Studio Project

Updates the specified Studio project by setting the values of the parameters passed.

post/v1/studio/projects/{project_id}

Path parameters

project_idstring required

The ID of the Studio project.

Example:21m00Tcm4TlvDq8ikWAM

The ID of the Studio project.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

namestring required

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

default_title_voice_idstring required

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

default_paragraph_voice_idstring required

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

titlestring nullable

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.

authorstring nullable

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.

isbn_numberstring nullable

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.

volume_normalizationboolean

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

Example request

{
  "name": "Project 1",
  "default_title_voice_id": "21m00Tcm4TlvDq8ikWAM",
  "default_paragraph_voice_id": "21m00Tcm4TlvDq8ikWAM",
  "title": "Romeo and Juliet",
  "author": "William Shakespeare",
  "isbn_number": "0-306-40615-2"
}

Response

Successful Response

Example response

{
  "project": {
    "access_level": "viewer",
    "author": "John Doe",
    "can_be_downloaded": true,
    "content_type": "Novel",
    "cover_image_url": "https://example.com/cover.jpg",
    "create_date_unix": 1714204800,
    "created_by_user_id": "Vbtgl3bRdj6lk79rYAgx",
    "creation_meta": {
      "creation_progress": 0.5,
      "status": "pending",
      "type": "blank"
    },
    "default_model_id": "eleven_multilingual_v2",
    "default_paragraph_voice_id": "JBFqnCBsd6RMkjVDRZzb",
    "default_paragraph_voice_ref_id": "JBFqnCBsd6RMkjVDRZzb",
    "default_title_voice_id": "JBFqnCBsd6RMkjVDRZzb",
    "default_title_voice_ref_id": "JBFqnCBsd6RMkjVDRZzb",
    "description": "This is a description of my project.",
    "fiction": "fiction",
    "genres": [
      "Novel",
      "Short Story"
    ],
    "isbn_number": "978-90-274-3964-2",
    "language": "en",
    "last_conversion_date_unix": 1714204800,
    "mature_content": false,
    "name": "My Project",
    "original_publication_date": "2025-01-01",
    "project_id": "aw1NgEzBg83R7vgmiJt6",
    "public_share_id": "abc123def456789",
    "quality_check_on": false,
    "quality_check_on_when_bulk_convert": false,
    "state": "default",
    "target_audience": "young adult",
    "title": "My Project",
    "volume_normalization": true
  }
}