---
title: "Get Studio Project"
method: GET
path: "/v1/studio/projects/{project_id}"
tags: ["studio"]
---

# Get Studio Project

`GET /v1/studio/projects/{project_id}`

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

## Path parameters

- `project_id` string, required — The ID of the Studio project.

## Query parameters

- `share_id` string, nullable — The share ID of the project

## Headers

- `xi-api-key` string, 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 `200`

Successful Response

- ProjectExtendedResponseModel
  - `project_id` string, required — The ID of the project.
  - `name` string, required — The name of the project.
  - `create_date_unix` integer, required — The creation date of the project.
  - `created_by_user_id` string, nullable, required — The user ID who created the project.
  - `default_title_voice_ref_id` string, required — The default title project voice reference ID.
  - `default_paragraph_voice_ref_id` string, required — The default paragraph project voice reference ID.
  - `default_model_id` string, required — The default model ID.
  - `last_conversion_date_unix` integer, nullable — The last conversion date of the project.
  - `can_be_downloaded` boolean, required — Whether the project can be downloaded.
  - `title` string, nullable — The title of the project.
  - `author` string, nullable — The author of the project.
  - `description` string, nullable — The description of the project.
  - `genres` string[], nullable — List of genres of the project.
  - `cover_image_url` string, nullable — The cover image URL of the project.
  - `target_audience` 'children' | 'young adult' | 'adult' | 'all ages', nullable — The target audience of the project.
  - `language` string, nullable — Two-letter language code (ISO 639-1) of the language of the project.
  - `content_type` string, nullable — The content type of the project, e.g. 'Novel' or 'Short Story'
  - `original_publication_date` string, nullable — The original publication date of the project.
  - `mature_content` boolean, nullable — Whether the project contains mature content.
  - `isbn_number` string, nullable — The ISBN number of the project.
  - `volume_normalization` boolean, 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_on` boolean, required — Whether quality check is enabled for this project.
  - `quality_check_on_when_bulk_convert` boolean, required — Whether quality check is enabled on the project when bulk converting.
  - `creation_meta` ProjectCreationMetaResponseModel
    - `creation_progress` number, required — The progress of the project creation.
    - `status` 'draft' | 'pending' | 'creating' | 'finished' | 'failed', required — The status of the project creation action.
    - `type` 'blank' | 'generate_podcast' | 'auto_assign_voices' | 'dub_video' | 'import_speech', required
  - `source_type` 'blank' | 'book' | 'article' | 'genfm' | 'video' | 'screenplay', nullable — The source type of the project.
  - `chapters_enabled` boolean, nullable — Whether chapters are enabled for the project.
  - `captions_enabled` boolean, nullable — Whether captions are enabled for the project.
  - `caption_style` CaptionStyleModel
    - `template` CaptionStyleTemplateModel
      - `key` string, required
      - `label` string, required
      - `requires_high_fps` boolean
    - `text_font` string, nullable
    - `text_scale` number, nullable
    - `text_color` string, nullable
    - `text_align` 'start' | 'center' | 'end', nullable
    - `text_style` 'normal' | 'italic', nullable
    - `text_weight` 'normal' | 'bold' | '900', nullable
    - `text_transform` 'none' | 'uppercase', nullable
    - `text_blend_mode` 'normal' | 'difference' | 'multiply', nullable
    - `text_shadow` StudioTextStyleShadowModel
      - `enabled` boolean, required
      - `color` string, required
      - `opacity` number, required
      - `blur` number, required
      - `offset_x` number, required
      - `offset_y` number, required
    - `text_outline` StudioTextStyleOutlineModel
      - `enabled` boolean, required
      - `color` string, required
      - `opacity` number, required
      - `width` number, required
    - `background_enabled` boolean, nullable
    - `background_color` string, nullable
    - `background_opacity` number, nullable
    - `background_blur` number, nullable
    - `background_border_radius` number, nullable
    - `word_highlights_enabled` boolean, nullable
    - `word_highlights_color` string, nullable
    - `word_highlights_background_color` string, nullable
    - `word_highlights_opacity` number, nullable
    - `word_highlights_border_radius` number, nullable
    - `word_highlights_blur` number, nullable
    - `section_animation` CaptionStyleSectionAnimationModel
      - `enter_type` 'none' | 'fade' | 'scale' | 'pop' | 'slide_up' | 'slide_down' | 'slam' | 'scale_down' | 'slide_in', required
      - `exit_type` 'none' | 'fade' | 'scale' | 'pop' | 'slide_up' | 'slide_down' | 'slam' | 'scale_down' | 'slide_in', required
    - `word_animation` CaptionStyleWordAnimationModel
      - `enter_type` 'none' | 'fade' | 'scale' | 'pop' | 'slide_up' | 'slide_down' | 'slam' | 'scale_down' | 'slide_in', required
      - `exit_type` 'none' | 'fade' | 'scale' | 'pop' | 'slide_up' | 'slide_down' | 'slam' | 'scale_down' | 'slide_in', required
    - `character_animation` CaptionStyleCharacterAnimationModel
      - `enter_type` 'none' | 'fade' | 'typewriter', required
      - `exit_type` 'none' | 'fade', required
    - `cursor_enabled` boolean, nullable
    - `width_pct` number, nullable
    - `horizontal_placement` CaptionStyleHorizontalPlacementModel
      - `align` 'left' | 'center' | 'right', required
      - `translate_pct` number, required
    - `vertical_placement` CaptionStyleVerticalPlacementModel
      - `align` 'top' | 'center' | 'bottom', required
      - `translate_pct` number, required
    - `auto_break_enabled` boolean, nullable
    - `max_lines_per_section` integer, nullable
    - `max_words_per_line` integer, nullable
  - `caption_style_template_overrides` object, nullable — Styling changes that have been made to the provided templates
  - `public_share_id` string, 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.
  - `agent_settings` StudioAgentSettingsModel
    - `tool_settings` object
  - `quality_preset` 'standard' | 'high' | 'ultra' | 'ultra_lossless', required
  - `chapters` ChapterResponseModel[], required — List of chapters of the project and their metadata.
    - `chapter_id` string, required — The ID of the chapter.
    - `name` string, required — The name of the chapter.
    - `last_conversion_date_unix` integer, nullable — The last conversion date of the chapter.
    - `conversion_progress` number, nullable — The conversion progress of the chapter.
    - `can_be_downloaded` boolean, required — Whether the chapter can be downloaded.
    - `state` 'default' | 'converting', required — The state of the chapter.
    - `has_video` boolean, nullable — Whether the chapter has a video.
    - `has_visual_content` boolean, nullable — Whether the chapter has any visual content (video, image, or text clips).
    - `voice_ids` string[], nullable — List of voice ids used by the chapter
    - `statistics` ChapterStatisticsResponseModel
      - `characters_unconverted` integer, required — The number of unconverted characters.
      - `characters_converted` integer, required — The number of converted characters.
      - `paragraphs_converted` integer, required — The number of converted paragraphs.
      - `paragraphs_unconverted` integer, required — The number of unconverted paragraphs.
      - `credits_needed_to_convert` integer, nullable — The number of credits needed to convert the remaining paragraphs.
      - `voice_statistics` VoiceStatisticsResponseModel[], nullable — Per-voice breakdown of character counts.
        - `project_voice_ref_id` string, required — The project voice reference ID.
        - `characters_unconverted` integer, required — The number of unconverted characters for this voice.
        - `characters_converted` integer, required — The number of converted characters for this voice.
        - `credits_needed_to_convert` integer, nullable — The number of credits needed to convert the remaining audio for this voice.
        - `voice_id` string, required — The voice ID.
    - `last_conversion_error` string, nullable — The last conversion error of the chapter.
  - `pronunciation_dictionary_versions` PronunciationDictionaryVersionResponseModel[], required — List of pronunciation dictionary versions of the project and their metadata.
    - `version_id` string, required
    - `version_rules_num` integer, required
    - `pronunciation_dictionary_id` string, required
    - `dictionary_name` string, required
    - `version_name` string, required
    - `permission_on_resource` 'admin' | 'editor' | 'commenter' | 'viewer', nullable, required
    - `created_by` string, required
    - `creation_time_unix` integer, required
    - `archived_time_unix` integer, nullable
  - `pronunciation_dictionary_locators` PronunciationDictionaryLocatorResponseModel[], required — List of pronunciation dictionary locators.
    - `pronunciation_dictionary_id` string, required
    - `version_id` string, nullable, required
  - `apply_text_normalization` 'auto' | 'on' | 'off' | 'apply_english', required — Whether text normalization is applied to the project.
  - `experimental` object — Experimental features for the project.
  - `assets` union[], required — List of uploaded assets e.g. videos, audios.
    - union
      - ProjectVideoResponseModel
        - `video_id` string, required
        - `filename` string, required
        - `signed_url` string, nullable, required
        - `signed_preview_url` string, nullable, required
        - `offset_ms` integer, required
        - `duration_ms` integer, required
        - `volume_gain_db` number, required
        - `muted` boolean, required
        - `fade_in_ms` integer
        - `fade_out_ms` integer
        - `width` integer, required
        - `height` integer, required
        - `codec` string, required
        - `order` string, required
        - `created_at_ms` integer, required
        - `updated_at_ms` integer, required
        - `error` string, nullable
        - `thumbnail_interval_seconds` number, required
        - `thumbnail_size` integer[], required
        - `thumbnail_sheets` ProjectVideoThumbnailSheetResponseModel[], required
          - `start_thumbnail_index` integer, required
          - `thumbnail_count` integer, required
          - `signed_cloud_url` string, required
        - `start_time_ms` integer, required
        - `end_time_ms` integer, nullable, required
        - `asset_preview_signed_url` string, nullable
        - `source_video_id` string, nullable
        - `source_asset_id` string, nullable
        - `source_platform_asset_id` string, nullable
        - `pending_blocks_metadata` PendingBlocksMetadataModel
          - `target_global_offset_ms` integer, nullable, required
          - `block_ids` string[], required
        - `pending_external_audios_metadata` PendingExternalAudiosMetadataModel
          - `target_global_offset_ms` integer, nullable, required
          - `external_audio_ids` string[], required
        - `speech_imported` boolean
        - `pending_task` PendingClipTask
          - `type` 'preprocessing' | 'speech_import' | 'dubbing' | 'video_to_music' | 'media_generation', required
          - `progress` number
          - `started_at_ms` integer
          - `updated_at_ms` integer
          - `metadata` object
        - `audio_track_ready` boolean
        - `export_format_ready` boolean
        - `current_snapshot_id` string, nullable
        - `source_context` GenerationSourceContext
          - `source_type` 'generation'
          - `generation_id` string, required
          - `prompt` string, nullable
          - `model_id` string, required
          - `model_provider` string, nullable
          - `generation_session_id` string, nullable
          - `session_iteration_id` string, nullable
          - `model_parameters` object, nullable
          - `extend_video` ReferenceVideo
            - `generation_id` string, nullable
            - `content_asset_id` string, nullable
            - `template_node_id` string, nullable
            - `studio_clip` StudioClipReference
              - …
        - `analysis` VideoAnalysis
          - `status` 'processing' | 'completed' | 'failed', required
          - `data` VideoAnalysisResult, required
            - `title` string, required
            - `description` string, required
            - `content_type` string, nullable
            - `overall_pacing` string, nullable
            - `subjects` VideoSubject[]
              - …
            - `segments` VideoSegment[]
              - …
            - `key_moments` VideoKeyMoment[]
              - …
          - `updated_at_ms` integer
        - `transcription` AssetTranscription
          - `status` 'processing' | 'completed' | 'failed', required
          - `data` AssetTranscriptionData, required
            - `language_code` string, required
            - `text` string, required
            - `words` string[], required
            - `word_start_times_ms` integer[], required
            - `word_end_times_ms` integer[], required
            - `word_speaker_ids` string[], required
          - `updated_at_ms` integer
        - `type` 'video'
        - `canvas_placement` CanvasPlacement — Defines asset positioning and transformation on canvas.
          - `x_relative` number
          - `y_relative` number
          - `scale_x` number
          - `scale_y` number
          - `pivot_x` number
          - `pivot_y` number
          - `skew_x` number
          - `skew_y` number
          - `crop_top` number
          - `crop_right` number
          - `crop_bottom` number
          - `crop_left` number
          - `flip_x` boolean
          - `flip_y` boolean
        - `animation` ClipAnimation
          - `enter_effect` 'none' | 'fade' | 'float' | 'gentle_float' | 'zoom_in' | 'drop' | 'slide_left' | 'slide_right' | 'slide_up' | 'slide_down' | 'pop' | 'bounce' | 'spin' | 'slide_bounce'
          - `enter_duration_ms` integer
          - `exit_effect` 'none' | 'fade' | 'float' | 'gentle_float' | 'zoom_in' | 'drop' | 'slide_left' | 'slide_right' | 'slide_up' | 'slide_down' | 'pop' | 'bounce' | 'spin' | 'slide_bounce'
          - `exit_duration_ms` integer
        - `playback_speed` number
        - `opacity` number
        - `track_id` string
        - `preview_job_progress` number, required
        - `import_speech_progress` number, nullable, required
      - ProjectExternalAudioResponseModel
        - `external_audio_id` string, required
        - `filename` string, required
        - `signed_url` string, nullable, required
        - `offset_ms` integer, required
        - `duration_ms` integer, required
        - `start_time_ms` integer, required
        - `end_time_ms` integer, nullable, required
        - `order` string, required
        - `track_id` string, required
        - `created_at_ms` integer, required
        - `updated_at_ms` integer, required
        - `volume_gain_db` number
        - `muted` boolean
        - `fade_in_ms` integer
        - `fade_out_ms` integer
        - `source_external_audio_id` string, nullable
        - `source_asset_id` string, nullable
        - `source_platform_asset_id` string, nullable
        - `pending_blocks_metadata` PendingBlocksMetadataModel
          - `target_global_offset_ms` integer, nullable, required
          - `block_ids` string[], required
        - `pending_external_audios_metadata` PendingExternalAudiosMetadataModel
          - `target_global_offset_ms` integer, nullable, required
          - `external_audio_ids` string[], required
        - `speech_imported` boolean
        - `pending_task` PendingClipTask
          - `type` 'preprocessing' | 'speech_import' | 'dubbing' | 'video_to_music' | 'media_generation', required
          - `progress` number
          - `started_at_ms` integer
          - `updated_at_ms` integer
          - `metadata` object
        - `error` string, nullable
        - `current_snapshot_id` string, nullable
        - `source_context` union
          - SongSourceContext
            - `source_type` 'song'
            - `song_id` string, required
            - `chat_id` string, nullable
            - `title` string, nullable
            - `description` string, nullable
            - `genres` string[]
            - `languages` string[]
            - `is_explicit` boolean, nullable
            - `bpm` integer, nullable
            - `generation_settings` object, nullable
          - MusicExploreSongSourceContext
            - `source_type` 'music_explore_song'
            - `music_explore_song_id` string, required
            - `title` string, nullable
            - `description` string, nullable
            - `bpm` integer, nullable
            - `vocals` string, nullable
            - `lyrics` string, nullable
          - SfxSourceContext — Context for sound effect clips.
            - `source_type` 'sfx'
            - `sound_generation_history_item_id` string, nullable
            - `text` string, nullable
            - `generation_config` object, nullable
        - `analysis` AudioAnalysis
          - `status` 'processing' | 'completed' | 'failed', required
          - `data` AudioAnalysisResult, required
            - `title` string, required
            - `description` string, required
            - `content_type` string, nullable
            - `overall_pacing` string, nullable
            - `segments` AudioSegment[]
              - …
            - `key_moments` AudioKeyMoment[]
              - …
          - `updated_at_ms` integer
        - `transcription` AssetTranscription
          - `status` 'processing' | 'completed' | 'failed', required
          - `data` AssetTranscriptionData, required
            - `language_code` string, required
            - `text` string, required
            - `words` string[], required
            - `word_start_times_ms` integer[], required
            - `word_end_times_ms` integer[], required
            - `word_speaker_ids` string[], required
          - `updated_at_ms` integer
        - `type` 'audio'
        - `import_speech_progress` number, nullable, required
      - ProjectImageResponseModel
        - `image_id` string, required
        - `filename` string, required
        - `signed_url` string, nullable
        - `thumbnail_signed_url` string, nullable
        - `type` 'image'
        - `source` 'upload'
        - `file_size_bytes` integer, required
        - `width` integer, required
        - `height` integer, required
        - `track_id` string
        - `offset_ms` integer, required
        - `duration_ms` integer, required
        - `order` string, required
        - `canvas_placement` CanvasPlacement, required — Defines asset positioning and transformation on canvas.
          - `x_relative` number
          - `y_relative` number
          - `scale_x` number
          - `scale_y` number
          - `pivot_x` number
          - `pivot_y` number
          - `skew_x` number
          - `skew_y` number
          - `crop_top` number
          - `crop_right` number
          - `crop_bottom` number
          - `crop_left` number
          - `flip_x` boolean
          - `flip_y` boolean
        - `animation` ClipAnimation
          - `enter_effect` 'none' | 'fade' | 'float' | 'gentle_float' | 'zoom_in' | 'drop' | 'slide_left' | 'slide_right' | 'slide_up' | 'slide_down' | 'pop' | 'bounce' | 'spin' | 'slide_bounce'
          - `enter_duration_ms` integer
          - `exit_effect` 'none' | 'fade' | 'float' | 'gentle_float' | 'zoom_in' | 'drop' | 'slide_left' | 'slide_right' | 'slide_up' | 'slide_down' | 'pop' | 'bounce' | 'spin' | 'slide_bounce'
          - `exit_duration_ms` integer
        - `opacity` number
        - `created_at_ms` integer, required
        - `updated_at_ms` integer, required
        - `current_snapshot_id` string, nullable
        - `source_asset_id` string, nullable
        - `source_platform_asset_id` string, nullable
        - `error` string, nullable
        - `pending_task` PendingClipTask
          - `type` 'preprocessing' | 'speech_import' | 'dubbing' | 'video_to_music' | 'media_generation', required
          - `progress` number
          - `started_at_ms` integer
          - `updated_at_ms` integer
          - `metadata` object
        - `analysis` ImageAnalysis
          - `status` 'processing' | 'completed' | 'failed', required
          - `data` ImageAnalysisResult, required
            - `title` string, required
            - `description` string, required
            - `content_type` string, nullable
            - `mood_and_style` string, nullable
            - `composition_notes` string, nullable
            - `visible_text` string, nullable — Readable text overlaid or shown in the image, if any.
            - `subjects` ImageSubject[]
              - …
          - `updated_at_ms` integer
  - `voices` ProjectVoiceResponseModel[], required — List of configured project voices.
    - `project_voice_ref_id` string, required
    - `voice_id` string, required
    - `alias` string, required
    - `stability` number, required
    - `similarity_boost` number, required
    - `style` number, required
    - `is_pinned` boolean, required
    - `use_speaker_boost` boolean, required
    - `volume_gain` number, required
    - `speed` number, required
  - `base_voices` VoiceResponseModel[], nullable — List of voices used by the project.
    - `voice_id` string, required — The ID of the voice.
    - `name` string, required — The name of the voice.
    - `samples` SampleResponseModel[], nullable — List of samples associated with the voice.
      - `sample_id` string, required — The ID of the sample.
      - `file_name` string, required — The name of the sample file.
      - `mime_type` string, required — The MIME type of the sample file.
      - `size_bytes` integer, required — The size of the sample file in bytes.
      - `hash` string, required — The hash of the sample file.
      - `duration_secs` number, nullable
      - `remove_background_noise` boolean, nullable
      - `has_isolated_audio` boolean, nullable
      - `has_isolated_audio_preview` boolean, nullable
      - `speaker_separation` SpeakerSeparationResponseModel
        - `voice_id` string, required — The ID of the voice.
        - `sample_id` string, required — The ID of the sample.
        - `status` 'not_started' | 'pending' | 'completed' | 'failed', required — The status of the speaker separation.
        - `speakers` object, nullable — The speakers of the sample.
        - `selected_speaker_ids` string[], nullable — The IDs of the selected speakers.
      - `trim_start` integer, nullable
      - `trim_end` integer, nullable
    - `category` 'generated' | 'cloned' | 'premade' | 'professional' | 'famous' | 'high_quality', required — The category of the voice.
    - `fine_tuning` FineTuningResponseModel
      - `is_allowed_to_fine_tune` boolean, required — Whether the user is allowed to fine-tune the voice.
      - `state` object, required — The state of the fine-tuning process for each model.
      - `verification_failures` string[], required — List of verification failures in the fine-tuning process.
      - `verification_attempts_count` integer, required — The number of verification attempts in the fine-tuning process.
      - `manual_verification_requested` boolean, required — Whether a manual verification was requested for the fine-tuning process.
      - `language` string, nullable — The language of the fine-tuning process.
      - `progress` object, nullable — The progress of the fine-tuning process.
      - `message` object, nullable — The message of the fine-tuning process.
      - `dataset_duration_seconds` number, nullable — The duration of the dataset in seconds.
      - `verification_attempts` VerificationAttemptResponseModel[], nullable — The number of verification attempts.
        - `text` string, required — The text of the verification attempt.
        - `date_unix` integer, required — The date of the verification attempt in Unix time.
        - `accepted` boolean, required — Whether the verification attempt was accepted.
        - `similarity` number, required — The similarity of the verification attempt.
        - `levenshtein_distance` number, required — The Levenshtein distance of the verification attempt.
        - `recording` RecordingResponseModel
          - `recording_id` string, required — The ID of the recording.
          - `mime_type` string, required — The MIME type of the recording.
          - `size_bytes` integer, required — The size of the recording in bytes.
          - `upload_date_unix` integer, required — The date of the recording in Unix time.
          - `transcription` string, required — The transcription of the recording.
      - `slice_ids` string[], nullable — List of slice IDs.
      - `manual_verification` ManualVerificationResponseModel
        - `extra_text` string, required — The extra text of the manual verification.
        - `request_time_unix` integer, required — The date of the manual verification in Unix time.
        - `files` ManualVerificationFileResponseModel[], required — The files of the manual verification.
          - `file_id` string, required — The ID of the file.
          - `file_name` string, required — The name of the file.
          - `mime_type` string, required — The MIME type of the file.
          - `size_bytes` integer, required — The size of the file in bytes.
          - `upload_date_unix` integer, required — The date of the file in Unix time.
      - `max_verification_attempts` integer, nullable — The maximum number of verification attempts.
      - `next_max_verification_attempts_reset_unix_ms` integer, nullable — The next maximum verification attempts reset time in Unix milliseconds.
    - `labels` object, required — Labels associated with the voice.
    - `description` string, nullable — The description of the voice.
    - `preview_url` string, nullable — The preview URL of the voice.
    - `available_for_tiers` string[], required — The tiers the voice is available for.
    - `settings` VoiceSettingsResponseModel
      - `stability` number, nullable — Determines how stable the voice is and the randomness between each generation. Lower values introduce broader emotional range for the voice. Higher values can result in a monotonous voice with limited emotion.
      - `use_speaker_boost` boolean, nullable — This setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency.
      - `similarity_boost` number, nullable — Determines how closely the AI should adhere to the original voice when attempting to replicate it.
      - `style` number, nullable — Determines the style exaggeration of the voice. This setting attempts to amplify the style of the original speaker. It does consume additional computational resources and might increase latency if set to anything other than 0.
      - `speed` number, nullable — Adjusts the speed of the voice. A value of 1.0 is the default speed, while values less than 1.0 slow down the speech, and values greater than 1.0 speed it up.
    - `sharing` VoiceSharingResponseModel
      - `status` 'enabled' | 'disabled' | 'copied' | 'copied_disabled', required — The status of the voice sharing.
      - `history_item_sample_id` string, nullable — The sample ID of the history item.
      - `date_unix` integer, required — The date of the voice sharing in Unix time.
      - `whitelisted_emails` string[], required — A list of whitelisted emails.
      - `public_owner_id` string, required — The ID of the public owner.
      - `original_voice_id` string, required — The ID of the original voice.
      - `financial_rewards_enabled` boolean, required — Whether financial rewards are enabled.
      - `free_users_allowed` boolean, required — Whether free users are allowed.
      - `live_moderation_enabled` boolean, required — Whether live moderation is enabled.
      - `rate` number, nullable — The rate of the voice sharing.
      - `fiat_rate` number, nullable — The rate of the voice sharing in USD per 1000 credits.
      - `notice_period` integer, required — The notice period of the voice sharing.
      - `disable_at_unix` integer, nullable — The date of the voice sharing in Unix time.
      - `voice_mixing_allowed` boolean, required — Whether voice mixing is allowed.
      - `featured` boolean, required — Whether the voice is featured.
      - `category` 'generated' | 'cloned' | 'premade' | 'professional' | 'famous' | 'high_quality', required — The category of the voice.
      - `reader_app_enabled` boolean, nullable — Whether the reader app is enabled.
      - `image_url` string, nullable — The image URL of the voice.
      - `ban_reason` string, nullable — The ban reason of the voice.
      - `liked_by_count` integer, required — The number of likes on the voice.
      - `cloned_by_count` integer, required — The number of clones on the voice.
      - `name` string, required — The name of the voice.
      - `description` string, nullable — The description of the voice.
      - `labels` object, required — The labels of the voice.
      - `review_status` 'not_requested' | 'pending' | 'declined' | 'allowed' | 'allowed_with_changes', required — The review status of the voice.
      - `review_message` string, nullable — The review message of the voice.
      - `enabled_in_library` boolean, required — Whether the voice is enabled in the library.
      - `instagram_username` string, nullable — The Instagram username of the voice.
      - `twitter_username` string, nullable — The Twitter/X username of the voice.
      - `youtube_username` string, nullable — The YouTube username of the voice.
      - `tiktok_username` string, nullable — The TikTok username of the voice.
      - `moderation_check` VoiceSharingModerationCheckResponseModel
        - `date_checked_unix` integer, nullable — The date the moderation check was made in Unix time.
        - `name_value` string, nullable — The name value of the voice.
        - `name_check` boolean, nullable — Whether the name check was successful.
        - `description_value` string, nullable — The description value of the voice.
        - `description_check` boolean, nullable — Whether the description check was successful.
        - `sample_ids` string[], nullable — A list of sample IDs.
        - `sample_checks` number[], nullable — A list of sample checks.
        - `captcha_ids` string[], nullable — A list of captcha IDs.
        - `captcha_checks` number[], nullable — A list of CAPTCHA check values.
      - `reader_restricted_on` ReaderResourceResponseModel[], nullable — The reader restricted on of the voice.
        - `resource_type` 'read' | 'collection', required — The type of resource.
        - `resource_id` string, required — The ID of the resource.
    - `high_quality_base_model_ids` string[], required — The base model IDs for high-quality voices.
    - `verified_languages` VerifiedVoiceLanguageResponseModel[], nullable — The verified languages of the voice.
      - `language` string, required — The language of the voice.
      - `model_id` string, required — The voice's model ID.
      - `accent` string, nullable — The voice's accent, if applicable.
      - `locale` string, nullable — The voice's locale, if applicable.
      - `preview_url` string, nullable — The voice's preview URL, if applicable.
    - `collection_ids` string[], nullable — The IDs of collections this voice belongs to.
    - `safety_control` 'NONE' | 'BAN' | 'CAPTCHA' | 'ENTERPRISE_BAN' | 'ENTERPRISE_CAPTCHA', nullable — The safety controls of the voice.
    - `voice_verification` VoiceVerificationResponseModel
      - `requires_verification` boolean, required — Whether the voice requires verification.
      - `is_verified` boolean, required — Whether the voice has been verified.
      - `verification_failures` string[], required — List of verification failures.
      - `verification_attempts_count` integer, required — The number of verification attempts.
      - `language` string, nullable — The language of the voice.
      - `verification_attempts` VerificationAttemptResponseModel[], nullable — Number of times a verification was attempted.
        - `text` string, required — The text of the verification attempt.
        - `date_unix` integer, required — The date of the verification attempt in Unix time.
        - `accepted` boolean, required — Whether the verification attempt was accepted.
        - `similarity` number, required — The similarity of the verification attempt.
        - `levenshtein_distance` number, required — The Levenshtein distance of the verification attempt.
        - `recording` RecordingResponseModel
          - `recording_id` string, required — The ID of the recording.
          - `mime_type` string, required — The MIME type of the recording.
          - `size_bytes` integer, required — The size of the recording in bytes.
          - `upload_date_unix` integer, required — The date of the recording in Unix time.
          - `transcription` string, required — The transcription of the recording.
    - `permission_on_resource` string, nullable — The permission on the resource of the voice.
    - `is_owner` boolean, nullable — Whether the voice is owned by the user.
    - `is_legacy` boolean — Whether the voice is legacy.
    - `is_mixed` boolean — Whether the voice is mixed.
    - `favorited_at_unix` integer, nullable — Timestamp when the voice was marked as favorite in Unix time.
    - `created_at_unix` integer, nullable — The creation time of the voice in Unix time.
    - `is_bookmarked` boolean, nullable — Whether the voice is bookmarked by the current user. Only relevant for community (library-copied) voices.
    - `recording_quality` 'studio' | 'good' | 'ok' | 'poor' | 'bad', nullable — The recording quality of the voice as determined by the review pipeline.
    - `labelling_status` 'in_review' | 'review_complete', nullable — The review pipeline status of the voice.
    - `recording_quality_reason` string, nullable — The reason for the recording quality assessment, as determined by the review pipeline.
  - `publishing_read` DirectPublishingReadResponseModel
    - `read_id` string, required
    - `created_at_unix` integer, required
    - `updated_at_unix` integer, required
    - `word_count` integer, required
    - `char_count` integer, required
    - `chapters` ReadMetadataChapterDBModel[], required
      - `chapter_name` string, required
      - `word_count` integer, required
      - `char_count` integer, required
      - `starting_char_offset` integer, required
      - `has_parsed_html` boolean
      - `has_summary` boolean
      - `duration_seconds` number, nullable
      - `file_number` string, nullable
      - `is_fallback_name` boolean
      - `chapter_id` string, nullable
    - `title` string, nullable
    - `author` string, nullable
    - `description` string, nullable
    - `article_image_url` string, nullable
    - `language` string, nullable
    - `locale` string, nullable
    - `display_mode` 'text' | 'audio-only' | 'text-with-audio', nullable
    - `genre` string[], nullable
    - `fiction` string, nullable
    - `content_type` string, nullable
    - `original_file_type` string, nullable
    - `target_audience` 'children' | 'young adult' | 'adult' | 'all ages', nullable
    - `mature_content` boolean, nullable
    - `safesearch_adult` boolean, nullable
    - `origin` string, nullable
    - `publication_date` string, nullable
    - `isbn` string, nullable
    - `ean` string, nullable
    - `legal_terms` ReadLegalTerms
      - `terms` string, nullable
      - `start_date` string, nullable
      - `end_date` string, nullable
    - `content_guidelines_terms` ReadLegalTerms
      - `terms` string, nullable
      - `start_date` string, nullable
      - `end_date` string, nullable
    - `last_updated_from_project_unix` integer, nullable
    - `publishing_project_id` string, nullable
    - `publishing_state` string
    - `publisher_profile_id` string, nullable
    - `quality_score` integer, nullable
    - `publisher` string, nullable
    - `copyright` string, nullable
    - `subtitle` string, nullable
    - `distribution_territories` string[], nullable
    - `edition` string, nullable
    - `contributors` Contributor[], nullable
      - `name` string, required
      - `role` string, required
      - `bio` string, nullable
      - `profile_id` string, nullable
    - `payout_type` 'none' | 'engagement_based' | 'fixed_payout', nullable
    - `list_price` number, nullable
    - `currency` 'usd', nullable
    - `original_audio_project_export_id` string, nullable
    - `original_audio_document_id` string, nullable
    - `series_id` string, nullable
    - `volume` integer, nullable
    - `published_at_unix` integer, nullable
    - `read_slug` string, nullable
    - `preview_audio_object` PreviewAudioDBModel
      - `voice_id` string, nullable
      - `text` string, nullable
      - `audio_url` string, required
      - `hls_manifest_url` string, nullable
      - `dash_manifest_url` string, nullable
      - `is_auto_generated` boolean, nullable
      - `generated_at_unix` integer, nullable
    - `sample_config` SampleConfigDBModel
      - `is_sample` boolean
      - `parent_id` string, nullable
      - `parent_type` 'read' | 'collection', nullable
      - `chapter_ids` string[], nullable
    - `review` ReviewResponseModel
      - `review_status` 'approved' | 'edits_required' | 'rejected', required
      - `reviewed_at_unix` integer, required
      - `reviewed_by` string, nullable
      - `reject_reasons` string[], nullable
      - `scores_breakdown` object, nullable
      - `rejected_details` string, nullable
      - `explanation` string, nullable
    - `voice_id` string, nullable
    - `can_use_assistant` boolean
    - `is_voice_changer_on` boolean
  - `default_title_voice_id` string, required — The default title voice ID.
  - `default_paragraph_voice_id` string, required — The default paragraph voice ID.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/versions/57d56f34628a/schema)