v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

studio

Get Studio Project

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

get/v1/studio/projects/{project_id}

Path parameters

project_idstring required

The ID of the Studio project.

Example:21m00Tcm4TlvDq8ikWAM

The ID of the Studio project.

Query parameters

share_idstring nullable

The share ID of the 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.

Response

Successful Response

project_idstring required

The ID of the project.

namestring required

The name of the project.

create_date_unixinteger required

The creation date of the project.

created_by_user_idstring nullable required

The user ID who created the project.

default_title_voice_ref_idstring required

The default title project voice reference ID.

default_paragraph_voice_ref_idstring required

The default paragraph project voice reference ID.

default_model_idstring required

The default model ID.

last_conversion_date_unixinteger nullable

The last conversion date of the project.

can_be_downloadedboolean required

Whether the project can be downloaded.

titlestring nullable

The title of the project.

authorstring nullable

The author of the project.

descriptionstring nullable

The description of the project.

genresstring[] nullable

List of genres of the project.

cover_image_urlstring nullable

The cover image URL of the project.

target_audience'children' | 'young adult' | 'adult' | 'all ages' nullable

The target audience of the project.

languagestring nullable

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

content_typestring nullable

The content type of the project, e.g. 'Novel' or 'Short Story'

original_publication_datestring nullable

The original publication date of the project.

mature_contentboolean nullable

Whether the project contains mature content.

isbn_numberstring nullable

The ISBN number of the project.

volume_normalizationboolean required

Whether the project uses volume normalization.

state'creating' | 'default' | 'converting' | 'in_queue' required

The state of the project.

access_level'admin' | 'editor' | 'commenter' | 'viewer' required

The access level of the project.

fiction'fiction' | 'non-fiction' nullable

Whether the project is fiction.

quality_check_onboolean required

Whether quality check is enabled for this project.

quality_check_on_when_bulk_convertboolean required

Whether quality check is enabled on the project when bulk converting.

The source type of the project.

chapters_enabledboolean nullable

Whether chapters are enabled for the project.

captions_enabledboolean nullable

Whether captions are enabled for the project.

caption_style_template_overridesobject nullable

Styling changes that have been made to the provided templates

public_share_idstring nullable

The public share ID of the project.

aspect_ratio'16:9' | '9:16' | '4:5' | '1:1' nullable

The aspect ratio of the project.

quality_preset'standard' | 'high' | 'ultra' | 'ultra_lossless' required

apply_text_normalization'auto' | 'on' | 'off' | 'apply_english' required

Whether text normalization is applied to the project.

experimentalobject

Experimental features for the project.

default_title_voice_idstring required

The default title voice ID.

default_paragraph_voice_idstring required

The default paragraph voice ID.

Example response

{
  "access_level": "viewer",
  "apply_text_normalization": "auto",
  "assets": [],
  "author": "John Doe",
  "base_voices": [],
  "can_be_downloaded": true,
  "chapters": [
    {
      "can_be_downloaded": true,
      "chapter_id": "aw1NgEzBg83R7vgmiJt6",
      "conversion_progress": 0.5,
      "last_conversion_date_unix": 1714204800,
      "last_conversion_error": "Error message",
      "name": "Chapter 1",
      "state": "converting",
      "statistics": {
        "characters_converted": 500,
        "characters_unconverted": 1000,
        "credits_needed_to_convert": 1000,
        "paragraphs_converted": 20,
        "paragraphs_unconverted": 10,
        "voice_statistics": [
          {
            "characters_converted": 300,
            "characters_unconverted": 600,
            "project_voice_ref_id": "voice123",
            "voice_id": "voice123"
          },
          {
            "characters_converted": 200,
            "characters_unconverted": 400,
            "project_voice_ref_id": "voice456",
            "voice_id": "voice456"
          }
        ]
      }
    }
  ],
  "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.",
  "experimental": {},
  "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",
  "pronunciation_dictionary_locators": [],
  "pronunciation_dictionary_versions": [],
  "public_share_id": "abc123def456789",
  "quality_check_on": false,
  "quality_check_on_when_bulk_convert": false,
  "quality_preset": "standard",
  "state": "default",
  "target_audience": "young adult",
  "title": "My Project",
  "voices": [],
  "volume_normalization": true
}