openapi: 3.2.0 info: title: ElevenLabs API Documentation Studio API description: This is the documentation for the ElevenLabs API. You can use this API to use our service programmatically, this is done by using your API key. You can find your API key in the dashboard at https://elevenlabs.io/app/settings/api-keys. version: '1.0' tags: - name: Studio description: Access, create and convert Studio Projects programmatically. Only specifically whitelisted accounts can access the Studio API. If you need access please contact our sales team. paths: /v1/studio/podcasts: post: tags: - Studio summary: Create Podcast description: Create and auto-convert a podcast project. Currently, the LLM cost is covered by us but you will still be charged for the audio generation. In the future, you will be charged for both the LLM and audio generation costs. operationId: create_podcast parameters: - name: safety-identifier in: header required: false schema: anyOf: - type: string - type: 'null' description: Used for moderation. Your workspace must be allowlisted to use this feature. title: Safety-Identifier description: Used for moderation. Your workspace must be allowlisted to use this feature. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Body_Create_podcast_v1_studio_podcasts_post' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PodcastProjectResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: studio x-fern-sdk-method-name: create_podcast /v1/studio/projects/{project_id}/pronunciation-dictionaries: post: tags: - Studio summary: Create Pronunciation Dictionaries description: Create a set of pronunciation dictionaries acting on a project. This will automatically mark text within this project as requiring reconverting where the new dictionary would apply or the old one no longer does. operationId: update_pronunciation_dictionaries parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Body_Create_Pronunciation_Dictionaries_v1_studio_projects__project_id__pronunciation_dictionaries_post' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreatePronunciationDictionaryResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - pronunciation_dictionaries x-fern-sdk-method-name: create /v1/studio/projects: get: tags: - Studio summary: List Studio Projects description: Returns a list of your Studio projects with metadata. operationId: get_projects parameters: - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetProjectsResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects x-fern-sdk-method-name: list post: tags: - Studio summary: Create Studio Project description: Creates a new Studio project, it can be either initialized as blank, from a document or from a URL. operationId: add_project parameters: - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/Body_Create_Studio_project_v1_studio_projects_post' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AddProjectResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects x-fern-sdk-method-name: create /v1/studio/projects/{project_id}: post: tags: - Studio summary: Update Studio Project description: Updates the specified Studio project by setting the values of the parameters passed. operationId: edit_project parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Body_Update_Studio_project_v1_studio_projects__project_id__post' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EditProjectResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects x-fern-sdk-method-name: update get: tags: - Studio summary: Get Studio Project description: Returns information about a specific Studio project. This endpoint returns more detailed information about a project than `GET /v1/studio`. operationId: get_project_by_id parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: share_id in: query required: false schema: anyOf: - type: string - type: 'null' description: The share ID of the project title: Share Id description: The share ID of the project - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProjectExtendedResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects x-fern-sdk-method-name: get delete: tags: - Studio summary: Delete Studio Project description: Deletes a Studio project. operationId: delete_project parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeleteProjectResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects x-fern-sdk-method-name: delete /v1/studio/projects/{project_id}/content: post: tags: - Studio summary: Update Studio Project Content description: Updates Studio project content. operationId: edit_project_content parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/Body_Update_Studio_project_content_v1_studio_projects__project_id__content_post' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EditProjectResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - content x-fern-sdk-method-name: update /v1/studio/projects/{project_id}/convert: post: tags: - Studio summary: Convert Studio Project description: Starts conversion of a Studio project and all of its chapters. operationId: convert_project_endpoint parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConvertProjectResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects x-fern-sdk-method-name: convert /v1/studio/projects/{project_id}/snapshots: get: tags: - Studio summary: List Studio Project Snapshots description: Retrieves a list of snapshots for a Studio project. operationId: get_project_snapshots parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProjectSnapshotsResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - snapshots x-fern-sdk-method-name: list /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}: get: tags: - Studio summary: Get Project Snapshot description: Returns the project snapshot. operationId: get_project_snapshot_endpoint parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: project_snapshot_id in: path required: true schema: type: string description: The ID of the Studio project snapshot. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Snapshot Id description: The ID of the Studio project snapshot. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProjectSnapshotExtendedResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - snapshots x-fern-sdk-method-name: get /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}/stream: post: tags: - Studio summary: Stream Studio Project Audio description: Stream the audio from a Studio project snapshot. operationId: stream_project_snapshot_audio_endpoint parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: project_snapshot_id in: path required: true schema: type: string description: The ID of the Studio project snapshot. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Snapshot Id description: The ID of the Studio project snapshot. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. requestBody: content: application/json: schema: $ref: '#/components/schemas/Body_Stream_Studio_project_audio_v1_studio_projects__project_id__snapshots__project_snapshot_id__stream_post' responses: '200': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - snapshots x-fern-sdk-method-name: stream x-fern-streaming: true /v1/studio/projects/{project_id}/snapshots/{project_snapshot_id}/archive: post: tags: - Studio summary: Stream Archive With Studio Project Audio description: Returns a compressed archive of the Studio project's audio. operationId: stream_project_snapshot_archive_endpoint parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: project_snapshot_id in: path required: true schema: type: string description: The ID of the Studio project snapshot. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Snapshot Id description: The ID of the Studio project snapshot. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Streaming archive data content: application/x-zip: schema: type: string format: binary '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - snapshots x-fern-sdk-method-name: stream_archive /v1/studio/projects/{project_id}/chapters: get: tags: - Studio summary: List Chapters description: Returns a list of a Studio project's chapters. operationId: get_chapters parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetChaptersResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - chapters x-fern-sdk-method-name: list post: tags: - Studio summary: Create Chapter description: Creates a new chapter either as blank or from a URL. operationId: add_chapter parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Body_Create_chapter_v1_studio_projects__project_id__chapters_post' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/AddChapterResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - chapters x-fern-sdk-method-name: create /v1/studio/projects/{project_id}/chapters/{chapter_id}: get: tags: - Studio summary: Get Chapter description: Returns information about a specific chapter. operationId: get_chapter_by_id_endpoint parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: chapter_id in: path required: true schema: type: string description: The ID of the chapter. examples: - 21m00Tcm4TlvDq8ikWAM title: Chapter Id description: The ID of the chapter. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ChapterWithContentResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - chapters x-fern-sdk-method-name: get post: tags: - Studio summary: Update Chapter description: Updates a chapter. operationId: edit_chapter parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: chapter_id in: path required: true schema: type: string description: The ID of the chapter. examples: - 21m00Tcm4TlvDq8ikWAM title: Chapter Id description: The ID of the chapter. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. requestBody: content: application/json: schema: $ref: '#/components/schemas/Body_Update_chapter_v1_studio_projects__project_id__chapters__chapter_id__post' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/EditChapterResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - chapters x-fern-sdk-method-name: update delete: tags: - Studio summary: Delete Chapter description: Deletes a chapter. operationId: delete_chapter_endpoint parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: chapter_id in: path required: true schema: type: string description: The ID of the chapter. examples: - 21m00Tcm4TlvDq8ikWAM title: Chapter Id description: The ID of the chapter. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DeleteChapterResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - chapters x-fern-sdk-method-name: delete /v1/studio/projects/{project_id}/chapters/{chapter_id}/convert: post: tags: - Studio summary: Convert Chapter description: Starts conversion of a specific chapter. operationId: convert_chapter_endpoint parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: chapter_id in: path required: true schema: type: string description: The ID of the chapter. examples: - 21m00Tcm4TlvDq8ikWAM title: Chapter Id description: The ID of the chapter. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConvertChapterResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - chapters x-fern-sdk-method-name: convert /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots: get: tags: - Studio summary: List Chapter Snapshots description: Gets information about all the snapshots of a chapter. Each snapshot can be downloaded as audio. Whenever a chapter is converted a snapshot will automatically be created. operationId: get_chapter_snapshots parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: chapter_id in: path required: true schema: type: string description: The ID of the chapter. examples: - 21m00Tcm4TlvDq8ikWAM title: Chapter Id description: The ID of the chapter. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ChapterSnapshotsResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - chapters - snapshots x-fern-sdk-method-name: list /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}: get: tags: - Studio summary: Get Chapter Snapshot description: Returns the chapter snapshot. operationId: get_chapter_snapshot_endpoint parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: chapter_id in: path required: true schema: type: string description: The ID of the chapter. examples: - 21m00Tcm4TlvDq8ikWAM title: Chapter Id description: The ID of the chapter. - name: chapter_snapshot_id in: path required: true schema: type: string description: The ID of the chapter snapshot. examples: - 21m00Tcm4TlvDq8ikWAM title: Chapter Snapshot Id description: The ID of the chapter snapshot. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ChapterSnapshotExtendedResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - chapters - snapshots x-fern-sdk-method-name: get /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}/stream: post: tags: - Studio summary: Stream Chapter Audio description: Stream the audio from a chapter snapshot. Use `GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots` to return the snapshots of a chapter. operationId: stream_chapter_snapshot_audio parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: chapter_id in: path required: true schema: type: string description: The ID of the chapter. examples: - 21m00Tcm4TlvDq8ikWAM title: Chapter Id description: The ID of the chapter. - name: chapter_snapshot_id in: path required: true schema: type: string description: The ID of the chapter snapshot. examples: - 21m00Tcm4TlvDq8ikWAM title: Chapter Snapshot Id description: The ID of the chapter snapshot. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. requestBody: content: application/json: schema: $ref: '#/components/schemas/Body_Stream_chapter_audio_v1_studio_projects__project_id__chapters__chapter_id__snapshots__chapter_snapshot_id__stream_post' responses: '200': description: Streaming audio data content: audio/mpeg: schema: type: string format: binary '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects - chapters - snapshots x-fern-sdk-method-name: stream x-fern-streaming: true /v1/studio/projects/{project_id}/muted-tracks: get: tags: - Studio summary: Get Project Muted Tracks description: Returns a list of chapter IDs that have muted tracks in a project. operationId: get_project_muted_tracks_endpoint parameters: - name: project_id in: path required: true schema: type: string description: The ID of the Studio project. examples: - 21m00Tcm4TlvDq8ikWAM title: Project Id description: The ID of the Studio project. - name: xi-api-key in: header required: false schema: anyOf: - type: string - type: 'null' description: 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. title: Xi-Api-Key description: 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. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProjectMutedTracksResponseModel' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: - studio - projects x-fern-sdk-method-name: get_muted_tracks components: schemas: PodcastTextSource: properties: type: type: string const: text title: Type description: The type of source to create. text: type: string title: Text description: The text to create the podcast from. type: object required: - type - text title: PodcastTextSource example: text: This is a test podcast. type: text AudioKeyMoment: properties: timestamp_ms: type: integer title: Timestamp Ms type: type: string title: Type description: type: string title: Description type: object required: - timestamp_ms - type - description title: AudioKeyMoment Contributor: properties: name: type: string title: Name role: type: string title: Role bio: anyOf: - type: string - type: 'null' title: Bio profile_id: anyOf: - type: string - type: 'null' title: Profile Id type: object required: - name - role title: Contributor QualityPresetType: type: string enum: - standard - high - ultra - ultra_lossless CaptionStyleCharacterAnimationModel: properties: enter_type: type: string enum: - none - fade - typewriter title: Enter Type exit_type: type: string enum: - none - fade title: Exit Type type: object required: - enter_type - exit_type title: CaptionStyleCharacterAnimationModel SpeakerSeparationResponseModel: properties: voice_id: type: string title: Voice Id description: The ID of the voice. sample_id: type: string title: Sample Id description: The ID of the sample. status: type: string enum: - not_started - pending - completed - failed title: Status description: The status of the speaker separation. speakers: anyOf: - additionalProperties: $ref: '#/components/schemas/SpeakerResponseModel' type: object - type: 'null' title: Speakers description: The speakers of the sample. selected_speaker_ids: anyOf: - items: type: string type: array - type: 'null' title: Selected Speaker Ids description: The IDs of the selected speakers. type: object required: - voice_id - sample_id - status title: SpeakerSeparationResponseModel example: sample_id: DCwhRBWXzGAHq8TQ4Fs18 status: not_started voice_id: DCwhRBWXzGAHq8TQ4Fs18 CharacterAlignmentModel: properties: characters: items: type: string type: array title: Characters character_start_times_seconds: items: type: number type: array title: Character Start Times Seconds character_end_times_seconds: items: type: number type: array title: Character End Times Seconds type: object required: - characters - character_start_times_seconds - character_end_times_seconds title: CharacterAlignmentModel VoiceSettingsResponseModel: properties: stability: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Stability description: 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. default: 0.5 use_speaker_boost: anyOf: - type: boolean - type: 'null' title: Use Speaker Boost description: This setting boosts the similarity to the original speaker. Using this setting requires a slightly higher computational load, which in turn increases latency. default: true similarity_boost: anyOf: - type: number maximum: 1.0 minimum: 0.0 - type: 'null' title: Similarity Boost description: Determines how closely the AI should adhere to the original voice when attempting to replicate it. default: 0.75 style: anyOf: - type: number - type: 'null' title: Style description: 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. default: 0.0 speed: anyOf: - type: number - type: 'null' title: Speed description: 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. default: 1.0 type: object title: VoiceSettingsResponseModel example: similarity_boost: 1.0 speed: 1.0 stability: 1.0 style: 0.0 use_speaker_boost: true VoiceVerificationResponseModel: properties: requires_verification: type: boolean title: Requires Verification description: Whether the voice requires verification. is_verified: type: boolean title: Is Verified description: Whether the voice has been verified. verification_failures: items: type: string type: array title: Verification Failures description: List of verification failures. verification_attempts_count: type: integer title: Verification Attempts Count description: The number of verification attempts. language: anyOf: - type: string - type: 'null' title: Language description: The language of the voice. verification_attempts: anyOf: - items: $ref: '#/components/schemas/VerificationAttemptResponseModel' type: array - type: 'null' title: Verification Attempts description: Number of times a verification was attempted. type: object required: - requires_verification - is_verified - verification_failures - verification_attempts_count title: VoiceVerificationResponseModel example: is_verified: true language: en requires_verification: false verification_attempts: - accepted: true date_unix: 1714204800 levenshtein_distance: 2 recording: mime_type: audio/mpeg recording_id: CwhRBWXzGAHq8TQ4Fs17 size_bytes: 1000000 transcription: Hello, how are you? upload_date_unix: 1714204800 similarity: 0.95 text: Hello, how are you? verification_attempts_count: 0 verification_failures: [] ConvertProjectResponseModel: properties: status: type: string title: Status description: The status of the studio project conversion request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned. type: object required: - status title: ConvertProjectResponseModel example: status: ok AddProjectResponseModel: properties: project: $ref: '#/components/schemas/ProjectResponseModel' type: object required: - project title: AddProjectResponseModel AudioSegment: properties: start_ms: type: integer title: Start Ms end_ms: type: integer title: End Ms description: type: string title: Description segment_type: anyOf: - type: string - type: 'null' title: Segment Type has_speech: type: boolean title: Has Speech default: false has_music: type: boolean title: Has Music default: false pacing: anyOf: - type: string - type: 'null' title: Pacing type: object required: - start_ms - end_ms - description title: AudioSegment CaptionStyleSectionAnimationModel: properties: enter_type: type: string enum: - none - fade - scale - pop - slide_up - slide_down - slam - scale_down - slide_in title: Enter Type exit_type: type: string enum: - none - fade - scale - pop - slide_up - slide_down - slam - scale_down - slide_in title: Exit Type type: object required: - enter_type - exit_type title: CaptionStyleSectionAnimationModel VideoKeyMoment: properties: timestamp_ms: type: integer title: Timestamp Ms type: type: string title: Type description: type: string title: Description type: object required: - timestamp_ms - type - description title: VideoKeyMoment CreatePronunciationDictionaryResponseModel: properties: status: type: string title: Status description: The status of the create pronunciation dictionary request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned. type: object required: - status title: CreatePronunciationDictionaryResponseModel example: status: ok PodcastURLSource: properties: type: type: string const: url title: Type description: The type of source to create. url: type: string title: Url description: The URL to create the podcast from. type: object required: - type - url title: PodcastURLSource example: type: url url: https://www.example.com Body_Update_Studio_project_v1_studio_projects__project_id__post: properties: name: type: string title: Name description: The name of the Studio project, used for identification only. examples: - Project 1 default_title_voice_id: type: string title: Default Title Voice Id description: The voice_id that corresponds to the default voice used for new titles. examples: - 21m00Tcm4TlvDq8ikWAM default_paragraph_voice_id: type: string title: Default Paragraph Voice Id description: The voice_id that corresponds to the default voice used for new paragraphs. examples: - 21m00Tcm4TlvDq8ikWAM title: anyOf: - type: string - type: 'null' title: Title description: 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. examples: - Romeo and Juliet author: anyOf: - type: string - type: 'null' title: Author description: 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. examples: - William Shakespeare isbn_number: anyOf: - type: string - type: 'null' title: Isbn Number description: 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. examples: - 0-306-40615-2 volume_normalization: type: boolean title: Volume Normalization description: When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements default: false examples: - false type: object required: - name - default_title_voice_id - default_paragraph_voice_id title: Body_Update_Studio_project_v1_studio_projects__project_id__post GenerationSourceContext: properties: source_type: type: string const: generation title: Source Type default: generation generation_id: type: string title: Generation Id prompt: anyOf: - type: string - type: 'null' title: Prompt model_id: type: string title: Model Id model_provider: anyOf: - type: string - type: 'null' title: Model Provider generation_session_id: anyOf: - type: string - type: 'null' title: Generation Session Id session_iteration_id: anyOf: - type: string - type: 'null' title: Session Iteration Id model_parameters: anyOf: - additionalProperties: true type: object - type: 'null' title: Model Parameters extend_video: anyOf: - $ref: '#/components/schemas/ReferenceVideo' - type: 'null' type: object required: - generation_id - model_id title: GenerationSourceContext PodcastProjectResponseModel: properties: project: $ref: '#/components/schemas/ProjectResponseModel' description: The project associated with the created podcast. type: object required: - project title: PodcastProjectResponseModel RecordingResponseModel: properties: recording_id: type: string title: Recording Id description: The ID of the recording. mime_type: type: string title: Mime Type description: The MIME type of the recording. size_bytes: type: integer title: Size Bytes description: The size of the recording in bytes. upload_date_unix: type: integer title: Upload Date Unix description: The date of the recording in Unix time. transcription: type: string title: Transcription description: The transcription of the recording. type: object required: - recording_id - mime_type - size_bytes - upload_date_unix - transcription title: RecordingResponseModel example: mime_type: audio/mpeg recording_id: CwhRBWXzGAHq8TQ4Fs17 size_bytes: 1000000 transcription: Hello, how are you? upload_date_unix: 1714204800 UtteranceResponseModel: properties: start: type: number title: Start description: The start time of the utterance in seconds. end: type: number title: End description: The end time of the utterance in seconds. type: object required: - start - end title: UtteranceResponseModel example: end: 1.0 start: 0.0 SampleConfigDBModel: properties: is_sample: type: boolean title: Is Sample default: false parent_id: anyOf: - type: string - type: 'null' title: Parent Id parent_type: anyOf: - type: string enum: - read - collection - type: 'null' title: Parent Type chapter_ids: anyOf: - items: type: string type: array - type: 'null' title: Chapter Ids type: object title: SampleConfigDBModel Body_Stream_Studio_project_audio_v1_studio_projects__project_id__snapshots__project_snapshot_id__stream_post: properties: convert_to_mpeg: type: boolean title: Convert To Mpeg description: Whether to convert the audio to mpeg format. default: false type: object title: Body_Stream_Studio_project_audio_v1_studio_projects__project_id__snapshots__project_snapshot_id__stream_post CaptionStyleModel: properties: template: anyOf: - $ref: '#/components/schemas/CaptionStyleTemplateModel' - type: 'null' text_font: anyOf: - type: string - type: 'null' title: Text Font text_scale: anyOf: - type: number - type: 'null' title: Text Scale text_color: anyOf: - type: string - type: 'null' title: Text Color text_align: anyOf: - type: string enum: - start - center - end - type: 'null' title: Text Align text_style: anyOf: - type: string enum: - normal - italic - type: 'null' title: Text Style text_weight: anyOf: - type: string enum: - normal - bold - '900' - type: 'null' title: Text Weight text_transform: anyOf: - type: string enum: - none - uppercase - type: 'null' title: Text Transform text_blend_mode: anyOf: - type: string enum: - normal - difference - multiply - type: 'null' title: Text Blend Mode text_shadow: anyOf: - $ref: '#/components/schemas/StudioTextStyleShadowModel' - type: 'null' text_outline: anyOf: - $ref: '#/components/schemas/StudioTextStyleOutlineModel' - type: 'null' background_enabled: anyOf: - type: boolean - type: 'null' title: Background Enabled background_color: anyOf: - type: string - type: 'null' title: Background Color background_opacity: anyOf: - type: number - type: 'null' title: Background Opacity background_blur: anyOf: - type: number - type: 'null' title: Background Blur background_border_radius: anyOf: - type: number - type: 'null' title: Background Border Radius word_highlights_enabled: anyOf: - type: boolean - type: 'null' title: Word Highlights Enabled word_highlights_color: anyOf: - type: string - type: 'null' title: Word Highlights Color word_highlights_background_color: anyOf: - type: string - type: 'null' title: Word Highlights Background Color word_highlights_opacity: anyOf: - type: number - type: 'null' title: Word Highlights Opacity word_highlights_border_radius: anyOf: - type: number - type: 'null' title: Word Highlights Border Radius word_highlights_blur: anyOf: - type: number - type: 'null' title: Word Highlights Blur section_animation: anyOf: - $ref: '#/components/schemas/CaptionStyleSectionAnimationModel' - type: 'null' word_animation: anyOf: - $ref: '#/components/schemas/CaptionStyleWordAnimationModel' - type: 'null' character_animation: anyOf: - $ref: '#/components/schemas/CaptionStyleCharacterAnimationModel' - type: 'null' cursor_enabled: anyOf: - type: boolean - type: 'null' title: Cursor Enabled width_pct: anyOf: - type: number - type: 'null' title: Width Pct horizontal_placement: anyOf: - $ref: '#/components/schemas/CaptionStyleHorizontalPlacementModel' - type: 'null' vertical_placement: anyOf: - $ref: '#/components/schemas/CaptionStyleVerticalPlacementModel' - type: 'null' auto_break_enabled: anyOf: - type: boolean - type: 'null' title: Auto Break Enabled max_lines_per_section: anyOf: - type: integer - type: 'null' title: Max Lines Per Section max_words_per_line: anyOf: - type: integer - type: 'null' title: Max Words Per Line type: object title: CaptionStyleModel ChapterContentBlockExtendableNodeResponseModel: properties: type: type: string const: _other title: Type type: object required: - type title: ChapterContentBlockExtendableNodeResponseModel description: Not used. Make sure you anticipate new types in the future. PodcastBulletinMode: properties: type: type: string const: bulletin title: Type description: The type of podcast to create. bulletin: $ref: '#/components/schemas/PodcastBulletinModeData' description: The voice settings for the bulletin. type: object required: - type - bulletin title: PodcastBulletinMode example: bulletin: host_voice_id: aw1NgEzBg83R7vgmiJt6 type: bulletin ChapterWithContentResponseModel: properties: chapter_id: type: string title: Chapter Id description: The ID of the chapter. name: type: string title: Name description: The name of the chapter. last_conversion_date_unix: anyOf: - type: integer - type: 'null' title: Last Conversion Date Unix description: The last conversion date of the chapter. conversion_progress: anyOf: - type: number - type: 'null' title: Conversion Progress description: The conversion progress of the chapter. can_be_downloaded: type: boolean title: Can Be Downloaded description: Whether the chapter can be downloaded. state: type: string enum: - default - converting title: State description: The state of the chapter. has_video: anyOf: - type: boolean - type: 'null' title: Has Video description: Whether the chapter has a video. has_visual_content: anyOf: - type: boolean - type: 'null' title: Has Visual Content description: Whether the chapter has any visual content (video, image, or text clips). voice_ids: anyOf: - items: type: string type: array - type: 'null' title: Voice Ids description: List of voice ids used by the chapter statistics: anyOf: - $ref: '#/components/schemas/ChapterStatisticsResponseModel' - type: 'null' description: The statistics of the chapter. last_conversion_error: anyOf: - type: string - type: 'null' title: Last Conversion Error description: The last conversion error of the chapter. content: $ref: '#/components/schemas/ChapterContentResponseModel' type: object required: - chapter_id - name - can_be_downloaded - state - content title: ChapterWithContentResponseModel example: can_be_downloaded: true chapter_id: aw1NgEzBg83R7vgmiJt6 content: blocks: [] conversion_progress: 0.5 last_conversion_date_unix: 1714204800 name: Chapter 1 state: default statistics: characters_converted: 200 characters_unconverted: 100 paragraphs_converted: 5 paragraphs_unconverted: 3 ChapterSnapshotExtendedResponseModel: properties: chapter_snapshot_id: type: string title: Chapter Snapshot Id description: The ID of the chapter snapshot. project_id: type: string title: Project Id description: The ID of the project. chapter_id: type: string title: Chapter Id description: The ID of the chapter. created_at_unix: type: integer title: Created At Unix description: The creation date of the chapter snapshot. name: type: string title: Name description: The name of the chapter snapshot. character_alignments: items: $ref: '#/components/schemas/CharacterAlignmentModel' type: array title: Character Alignments type: object required: - chapter_snapshot_id - project_id - chapter_id - created_at_unix - name - character_alignments title: ChapterSnapshotExtendedResponseModel example: chapter_id: aw1NgEzBg83R7vgmiJt3 chapter_snapshot_id: aw1NgEzBg83R7vgmiJt1 character_alignments: [] created_at_unix: 1714204800 name: My Chapter Snapshot project_id: aw1NgEzBg83R7vgmiJt2 DeleteChapterResponseModel: properties: status: type: string title: Status description: The status of the studio chapter deletion request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned. type: object required: - status title: DeleteChapterResponseModel example: status: ok SongSourceContext: properties: source_type: type: string const: song title: Source Type default: song song_id: type: string title: Song Id chat_id: anyOf: - type: string - type: 'null' title: Chat Id title: anyOf: - type: string - type: 'null' title: Title description: anyOf: - type: string - type: 'null' title: Description genres: items: type: string type: array title: Genres languages: items: type: string type: array title: Languages is_explicit: anyOf: - type: boolean - type: 'null' title: Is Explicit bpm: anyOf: - type: integer - type: 'null' title: Bpm generation_settings: anyOf: - additionalProperties: true type: object - type: 'null' title: Generation Settings type: object required: - song_id title: SongSourceContext PodcastBulletinModeData: properties: host_voice_id: type: string title: Host Voice Id description: The ID of the host voice. type: object required: - host_voice_id title: PodcastBulletinModeData example: host_voice_id: aw1NgEzBg83R7vgmiJt6 Body_Create_Studio_project_v1_studio_projects_post: properties: name: type: string title: Name description: The name of the Studio project, used for identification only. examples: - Project 1 default_title_voice_id: anyOf: - type: string - type: 'null' title: Default Title Voice Id description: The voice_id that corresponds to the default voice used for new titles. examples: - 21m00Tcm4TlvDq8ikWAM default_paragraph_voice_id: anyOf: - type: string - type: 'null' title: Default Paragraph Voice Id description: The voice_id that corresponds to the default voice used for new paragraphs. examples: - 21m00Tcm4TlvDq8ikWAM default_model_id: anyOf: - type: string - type: 'null' title: Default Model Id description: The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models. examples: - eleven_multilingual_v2 from_url: anyOf: - type: string - type: 'null' title: From Url description: An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank. examples: - https://blog.elevenlabs.io/the_first_ai_that_can_laugh/ from_document: anyOf: - type: string format: binary - type: 'null' title: From Document description: An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the Studio project with its content. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank. from_content_json: type: string title: From Content Json description: "\n An optional content to initialize the Studio project with. If this is set, 'from_url' and 'from_document' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank.\n\n Example:\n [{\"name\": \"Chapter A\", \"blocks\": [{\"sub_type\": \"p\", \"nodes\": [{\"voice_id\": \"6lCwbsX1yVjD49QmpkT0\", \"text\": \"A\", \"type\": \"tts_node\"}, {\"voice_id\": \"6lCwbsX1yVjD49QmpkT1\", \"text\": \"B\", \"type\": \"tts_node\"}]}, {\"sub_type\": \"h1\", \"nodes\": [{\"voice_id\": \"6lCwbsX1yVjD49QmpkT0\", \"text\": \"C\", \"type\": \"tts_node\"}, {\"voice_id\": \"6lCwbsX1yVjD49QmpkT1\", \"text\": \"D\", \"type\": \"tts_node\"}]}]}, {\"name\": \"Chapter B\", \"blocks\": [{\"sub_type\": \"p\", \"nodes\": [{\"voice_id\": \"6lCwbsX1yVjD49QmpkT0\", \"text\": \"E\", \"type\": \"tts_node\"}, {\"voice_id\": \"6lCwbsX1yVjD49QmpkT1\", \"text\": \"F\", \"type\": \"tts_node\"}]}, {\"sub_type\": \"h2\", \"nodes\": [{\"voice_id\": \"6lCwbsX1yVjD49QmpkT0\", \"text\": \"G\", \"type\": \"tts_node\"}, {\"voice_id\": \"6lCwbsX1yVjD49QmpkT1\", \"text\": \"H\", \"type\": \"tts_node\"}]}]}]\n " examples: - '[{"name": "Chapter A", "blocks": [{"sub_type": "p", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "A", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "B", "type": "tts_node"}]}, {"sub_type": "h1", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "C", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "D", "type": "tts_node"}]}]}, {"name": "Chapter B", "blocks": [{"sub_type": "p", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "E", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "F", "type": "tts_node"}]}, {"sub_type": "h2", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "G", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "H", "type": "tts_node"}]}]}]' quality_preset: anyOf: - $ref: '#/components/schemas/QualityPresetType' - type: 'null' title: Quality of the generated audio. description: 'Output quality of the generated audio. Must be one of: ''standard'' - standard output format, 128kbps with 44.1kHz sample rate. ''high'' - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side. ''ultra'' - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. ''ultra_lossless'' - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format. If not provided, defaults to the highest quality preset available on your subscription tier. ' examples: - standard title: anyOf: - type: string - type: 'null' title: Title description: 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. examples: - Romeo and Juliet author: anyOf: - type: string - type: 'null' title: Author description: 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. examples: - William Shakespeare description: anyOf: - type: string - type: 'null' title: Description description: An optional description of the Studio project. examples: - A tragic love story between two young lovers. genres: items: type: string type: array title: Genres description: An optional list of genres associated with the Studio project. examples: - - Romance - Drama target_audience: anyOf: - type: string enum: - children - young adult - adult - all ages - type: 'null' title: Target Audience description: An optional target audience of the Studio project. examples: - adult language: anyOf: - type: string maxLength: 2 minLength: 2 - type: 'null' title: Language description: An optional language of the Studio project. Two-letter language code (ISO 639-1). examples: - en content_type: anyOf: - type: string - type: 'null' title: Content Type description: An optional content type of the Studio project. examples: - Book original_publication_date: anyOf: - type: string pattern: ^\d{4}-\d{2}-\d{2}$|^\d{4}$ - type: 'null' title: Original Publication Date description: An optional original publication date of the Studio project, in the format YYYY-MM-DD or YYYY. examples: - '1597-01-01' mature_content: anyOf: - type: boolean - type: 'null' title: Mature Content description: An optional specification of whether this Studio project contains mature content. default: false examples: - false isbn_number: anyOf: - type: string - type: 'null' title: Isbn Number description: 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. examples: - 0-306-40615-2 acx_volume_normalization: type: boolean title: Acx Volume Normalization description: '[Deprecated] When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements' default: false examples: - false volume_normalization: type: boolean title: Volume Normalization description: When the Studio project is downloaded, should the returned audio have postprocessing in order to make it compliant with audiobook normalized volume requirements default: false examples: - false pronunciation_dictionary_locators: items: type: string type: array title: Pronunciation Dictionary Locators description: A list of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as a list of JSON strings for pronunciation dictionaries to be applied to the text. A list of json encoded strings is required as adding projects may occur through formData as opposed to jsonBody. To specify multiple dictionaries use multiple --form lines in your curl, such as --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'. examples: - - '{"pronunciation_dictionary_id": "21m00Tcm4TlvDq8ikWAM", "version_id": "BdF0s0aZ3oFoKnDYdTox"}' callback_url: anyOf: - type: string - type: 'null' title: Callback Url description: "\n A url that will be called by our service when the Studio project is converted. Request will contain a json blob containing the status of the conversion\n Messages:\n 1. When project was converted successfully:\n {\n type: \"project_conversion_status\",\n event_timestamp: 1234567890,\n data: {\n request_id: \"1234567890\",\n project_id: \"21m00Tcm4TlvDq8ikWAM\",\n conversion_status: \"success\",\n project_snapshot_id: \"22m00Tcm4TlvDq8ikMAT\",\n error_details: None,\n }\n }\n 2. When project conversion failed:\n {\n type: \"project_conversion_status\",\n event_timestamp: 1234567890,\n data: {\n request_id: \"1234567890\",\n project_id: \"21m00Tcm4TlvDq8ikWAM\",\n conversion_status: \"error\",\n project_snapshot_id: None,\n error_details: \"Error details if conversion failed\"\n }\n }\n\n 3. When chapter was converted successfully:\n {\n type: \"chapter_conversion_status\",\n event_timestamp: 1234567890,\n data: {\n request_id: \"1234567890\",\n project_id: \"21m00Tcm4TlvDq8ikWAM\",\n chapter_id: \"22m00Tcm4TlvDq8ikMAT\",\n conversion_status: \"success\",\n chapter_snapshot_id: \"23m00Tcm4TlvDq8ikMAV\",\n error_details: None,\n }\n }\n 4. When chapter conversion failed:\n {\n type: \"chapter_conversion_status\",\n event_timestamp: 1234567890,\n data: {\n request_id: \"1234567890\",\n project_id: \"21m00Tcm4TlvDq8ikWAM\",\n chapter_id: \"22m00Tcm4TlvDq8ikMAT\",\n conversion_status: \"error\",\n chapter_snapshot_id: None,\n error_details: \"Error details if conversion failed\"\n }\n }\n " examples: - - https://www.test.com/my-api/projects-status fiction: anyOf: - type: string enum: - fiction - non-fiction - type: 'null' title: Fiction description: An optional specification of whether the content of this Studio project is fiction. examples: - fiction apply_text_normalization: anyOf: - type: string enum: - auto - 'on' - 'off' - apply_english - type: 'null' title: Apply Text Normalization description: "\n This parameter controls text normalization with four modes: 'auto', 'on', 'apply_english' and 'off'.\n When set to 'auto', the system will automatically decide whether to apply text normalization\n (e.g., spelling out numbers). With 'on', text normalization will always be applied, while\n with 'off', it will be skipped. 'apply_english' is the same as 'on' but will assume that text is in English.\n " auto_convert: type: boolean title: Auto Convert description: Whether to auto convert the Studio project to audio or not. default: false auto_assign_voices: anyOf: - type: boolean - type: 'null' title: Auto Assign Voices description: '[Alpha Feature] Whether automatically assign voices to phrases in the create Project.' default: false source_type: anyOf: - type: string enum: - blank - book - article - genfm - video - screenplay - type: 'null' title: Source Type description: The type of Studio project to create. examples: - book voice_settings: items: type: string type: array title: Voice Settings description: " Optional voice settings overrides for the project, encoded as a list of JSON strings.\n\n Example:\n [\"{\\\"voice_id\\\": \\\"21m00Tcm4TlvDq8ikWAM\\\", \\\"stability\\\": 0.7, \\\"similarity_boost\\\": 0.8, \\\"style\\\": 0.5, \\\"speed\\\": 1.0, \\\"use_speaker_boost\\\": true}\"]\n " examples: - - '{"voice_id": "21m00Tcm4TlvDq8ikWAM", "stability": 0.7, "similarity_boost": 0.8, "style": 0.5, "speed": 1.0, "use_speaker_boost": true}' create_publishing_read: anyOf: - type: boolean - type: 'null' title: Create Publishing Read description: If true, creates a corresponding read for direct publishing in draft state default: false type: object required: - name title: Body_Create_Studio_project_v1_studio_projects_post ChapterSnapshotResponseModel: properties: chapter_snapshot_id: type: string title: Chapter Snapshot Id description: The ID of the chapter snapshot. project_id: type: string title: Project Id description: The ID of the project. chapter_id: type: string title: Chapter Id description: The ID of the chapter. created_at_unix: type: integer title: Created At Unix description: The creation date of the chapter snapshot. name: type: string title: Name description: The name of the chapter snapshot. type: object required: - chapter_snapshot_id - project_id - chapter_id - created_at_unix - name title: ChapterSnapshotResponseModel example: chapter_id: aw1NgEzBg83R7vgmiJt3 chapter_snapshot_id: aw1NgEzBg83R7vgmiJt1 created_at_unix: 1714204800 name: My Chapter Snapshot project_id: aw1NgEzBg83R7vgmiJt2 ConvertChapterResponseModel: properties: status: type: string title: Status description: The status of the studio chapter conversion request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned. type: object required: - status title: ConvertChapterResponseModel example: status: ok CaptionStyleHorizontalPlacementModel: properties: align: type: string enum: - left - center - right title: Align translate_pct: type: number title: Translate Pct type: object required: - align - translate_pct title: CaptionStyleHorizontalPlacementModel AssetTranscription: properties: status: type: string enum: - processing - completed - failed title: Status data: anyOf: - $ref: '#/components/schemas/AssetTranscriptionData' - type: 'null' updated_at_ms: type: integer title: Updated At Ms type: object required: - status - data title: AssetTranscription ManualVerificationResponseModel: properties: extra_text: type: string title: Extra Text description: The extra text of the manual verification. request_time_unix: type: integer title: Request Time Unix description: The date of the manual verification in Unix time. files: items: $ref: '#/components/schemas/ManualVerificationFileResponseModel' type: array title: Files description: The files of the manual verification. type: object required: - extra_text - request_time_unix - files title: ManualVerificationResponseModel example: extra_text: Please verify the voice is that of a female. files: - file_id: CwhRBWXzGAHq8TQ4Fs18 file_name: file.mp3 mime_type: audio/mpeg size_bytes: 1000000 upload_date_unix: 1714204800 request_time_unix: 1714204800 Body_Update_chapter_v1_studio_projects__project_id__chapters__chapter_id__post: properties: name: anyOf: - type: string - type: 'null' title: Name description: The name of the chapter, used for identification only. examples: - Chapter 1 content: anyOf: - $ref: '#/components/schemas/ChapterContentInputModel' - type: 'null' description: The chapter content to use. type: object title: Body_Update_chapter_v1_studio_projects__project_id__chapters__chapter_id__post ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError SpeakerResponseModel: properties: speaker_id: type: string title: Speaker Id description: The ID of the speaker. duration_secs: type: number title: Duration Secs description: The duration of the speaker segment in seconds. utterances: anyOf: - items: $ref: '#/components/schemas/UtteranceResponseModel' type: array - type: 'null' title: Utterances description: The utterances of the speaker. type: object required: - speaker_id - duration_secs title: SpeakerResponseModel example: duration_secs: 5.0 speaker_id: DCwhRBWXzGAHq8TQ4Fs18 ProjectVideoThumbnailSheetResponseModel: properties: start_thumbnail_index: type: integer title: Start Thumbnail Index thumbnail_count: type: integer title: Thumbnail Count signed_cloud_url: type: string title: Signed Cloud Url type: object required: - start_thumbnail_index - thumbnail_count - signed_cloud_url title: ProjectVideoThumbnailSheetResponseModel ChapterStatisticsResponseModel: properties: characters_unconverted: type: integer title: Characters Unconverted description: The number of unconverted characters. characters_converted: type: integer title: Characters Converted description: The number of converted characters. paragraphs_converted: type: integer title: Paragraphs Converted description: The number of converted paragraphs. paragraphs_unconverted: type: integer title: Paragraphs Unconverted description: The number of unconverted paragraphs. credits_needed_to_convert: anyOf: - type: integer - type: 'null' title: Credits Needed To Convert description: The number of credits needed to convert the remaining paragraphs. voice_statistics: anyOf: - items: $ref: '#/components/schemas/VoiceStatisticsResponseModel' type: array - type: 'null' title: Voice Statistics description: Per-voice breakdown of character counts. type: object required: - characters_unconverted - characters_converted - paragraphs_converted - paragraphs_unconverted title: ChapterStatisticsResponseModel example: 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 VideoSegment: properties: start_ms: type: integer title: Start Ms end_ms: type: integer title: End Ms description: type: string title: Description subjects: items: type: string type: array title: Subjects shot_type: anyOf: - type: string - type: 'null' title: Shot Type camera_movement: anyOf: - type: string - type: 'null' title: Camera Movement transition_in: anyOf: - type: string - type: 'null' title: Transition In has_speech: type: boolean title: Has Speech default: false has_music: type: boolean title: Has Music default: false pacing: anyOf: - type: string - type: 'null' title: Pacing type: object required: - start_ms - end_ms - description title: VideoSegment MusicExploreSongSourceContext: properties: source_type: type: string const: music_explore_song title: Source Type default: music_explore_song music_explore_song_id: type: string title: Music Explore Song Id title: anyOf: - type: string - type: 'null' title: Title description: anyOf: - type: string - type: 'null' title: Description bpm: anyOf: - type: integer - type: 'null' title: Bpm vocals: anyOf: - type: string - type: 'null' title: Vocals lyrics: anyOf: - type: string - type: 'null' title: Lyrics type: object required: - music_explore_song_id title: MusicExploreSongSourceContext ChapterContentParagraphTtsNodeInputModel: properties: type: type: string const: tts_node title: Type text: type: string title: Text voice_id: type: string title: Voice Id type: object required: - type - text - voice_id title: ChapterContentParagraphTtsNodeInputModel StudioAgentSettingsModel: properties: tool_settings: additionalProperties: $ref: '#/components/schemas/StudioAgentToolSettingsModel' type: object title: Tool Settings type: object title: StudioAgentSettingsModel ReaderResourceResponseModel: properties: resource_type: type: string enum: - read - collection title: Resource Type description: The type of resource. resource_id: type: string title: Resource Id description: The ID of the resource. type: object required: - resource_type - resource_id title: ReaderResourceResponseModel example: resource_id: FCwhRBWXzGAHq8TQ4Fs18 resource_type: read ChapterContentInputModel: properties: blocks: items: $ref: '#/components/schemas/ChapterContentBlockInputModel' type: array title: Blocks type: object required: - blocks title: ChapterContentInputModel StudioTextStyleShadowModel: properties: enabled: type: boolean title: Enabled color: type: string title: Color opacity: type: number title: Opacity blur: type: number title: Blur offset_x: type: number title: Offset X offset_y: type: number title: Offset Y type: object required: - enabled - color - opacity - blur - offset_x - offset_y title: StudioTextStyleShadowModel ProjectVoiceResponseModel: properties: project_voice_ref_id: type: string title: Project Voice Ref Id voice_id: type: string title: Voice Id alias: type: string title: Alias stability: type: number title: Stability similarity_boost: type: number title: Similarity Boost style: type: number title: Style is_pinned: type: boolean title: Is Pinned use_speaker_boost: type: boolean title: Use Speaker Boost volume_gain: type: number title: Volume Gain speed: type: number title: Speed type: object required: - project_voice_ref_id - voice_id - alias - stability - similarity_boost - style - is_pinned - use_speaker_boost - volume_gain - speed title: ProjectVoiceResponseModel Body_Create_chapter_v1_studio_projects__project_id__chapters_post: properties: name: type: string title: Name description: The name of the chapter, used for identification only. examples: - Chapter 1 from_url: anyOf: - type: string - type: 'null' title: From Url description: An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank. examples: - https://blog.elevenlabs.io/the_first_ai_that_can_laugh/ type: object required: - name title: Body_Create_chapter_v1_studio_projects__project_id__chapters_post StudioTextStyleOutlineModel: properties: enabled: type: boolean title: Enabled color: type: string title: Color opacity: type: number title: Opacity width: type: number title: Width type: object required: - enabled - color - opacity - width title: StudioTextStyleOutlineModel ProjectExternalAudioResponseModel: properties: external_audio_id: type: string title: External Audio Id filename: type: string title: Filename signed_url: anyOf: - type: string - type: 'null' title: Signed Url offset_ms: type: integer title: Offset Ms duration_ms: type: integer title: Duration Ms start_time_ms: type: integer title: Start Time Ms end_time_ms: anyOf: - type: integer - type: 'null' title: End Time Ms order: type: string title: Order track_id: type: string title: Track Id created_at_ms: type: integer title: Created At Ms updated_at_ms: type: integer title: Updated At Ms volume_gain_db: type: number title: Volume Gain Db default: 0.0 muted: type: boolean title: Muted default: false fade_in_ms: type: integer title: Fade In Ms default: 0 fade_out_ms: type: integer title: Fade Out Ms default: 0 source_external_audio_id: anyOf: - type: string - type: 'null' title: Source External Audio Id source_asset_id: anyOf: - type: string - type: 'null' title: Source Asset Id source_platform_asset_id: anyOf: - type: string - type: 'null' title: Source Platform Asset Id pending_blocks_metadata: anyOf: - $ref: '#/components/schemas/PendingBlocksMetadataModel' - type: 'null' pending_external_audios_metadata: anyOf: - $ref: '#/components/schemas/PendingExternalAudiosMetadataModel' - type: 'null' speech_imported: type: boolean title: Speech Imported default: false pending_task: anyOf: - $ref: '#/components/schemas/PendingClipTask' - type: 'null' error: anyOf: - type: string - type: 'null' title: Error current_snapshot_id: anyOf: - type: string - type: 'null' title: Current Snapshot Id source_context: anyOf: - oneOf: - $ref: '#/components/schemas/SongSourceContext' - $ref: '#/components/schemas/MusicExploreSongSourceContext' - $ref: '#/components/schemas/SfxSourceContext' discriminator: propertyName: source_type mapping: music_explore_song: '#/components/schemas/MusicExploreSongSourceContext' sfx: '#/components/schemas/SfxSourceContext' song: '#/components/schemas/SongSourceContext' - type: 'null' title: Source Context analysis: anyOf: - $ref: '#/components/schemas/AudioAnalysis' - type: 'null' transcription: anyOf: - $ref: '#/components/schemas/AssetTranscription' - type: 'null' type: type: string const: audio title: Type default: audio import_speech_progress: anyOf: - type: number - type: 'null' title: Import Speech Progress readOnly: true type: object required: - external_audio_id - filename - signed_url - offset_ms - duration_ms - start_time_ms - end_time_ms - order - track_id - created_at_ms - updated_at_ms - import_speech_progress title: ProjectExternalAudioResponseModel ChapterSnapshotsResponseModel: properties: snapshots: items: $ref: '#/components/schemas/ChapterSnapshotResponseModel' type: array title: Snapshots description: List of chapter snapshots. type: object required: - snapshots title: ChapterSnapshotsResponseModel example: snapshots: - chapter_id: aw1NgEzBg83R7vgmiJt3 chapter_snapshot_id: aw1NgEzBg83R7vgmiJt1 created_at_unix: 1714204800 name: My Chapter Snapshot project_id: aw1NgEzBg83R7vgmiJt2 ReadLegalTerms: properties: terms: anyOf: - type: string - type: 'null' title: Terms start_date: anyOf: - type: string - type: 'null' title: Start Date end_date: anyOf: - type: string - type: 'null' title: End Date type: object title: ReadLegalTerms CanvasPlacement: properties: x_relative: type: number title: X Relative default: 0.5 y_relative: type: number title: Y Relative default: 0.5 scale_x: type: number title: Scale X default: 1.0 scale_y: type: number title: Scale Y default: 1.0 pivot_x: type: number title: Pivot X default: 0.0 pivot_y: type: number title: Pivot Y default: 0.0 skew_x: type: number title: Skew X default: 0.0 skew_y: type: number title: Skew Y default: 0.0 crop_top: type: number title: Crop Top default: 0.0 crop_right: type: number title: Crop Right default: 0.0 crop_bottom: type: number title: Crop Bottom default: 0.0 crop_left: type: number title: Crop Left default: 0.0 flip_x: type: boolean title: Flip X default: false flip_y: type: boolean title: Flip Y default: false type: object title: CanvasPlacement description: Defines asset positioning and transformation on canvas. CaptionStyleVerticalPlacementModel: properties: align: type: string enum: - top - center - bottom title: Align translate_pct: type: number title: Translate Pct type: object required: - align - translate_pct title: CaptionStyleVerticalPlacementModel ReferenceVideo: properties: generation_id: anyOf: - type: string - type: 'null' title: Generation Id content_asset_id: anyOf: - type: string - type: 'null' title: Content Asset Id template_node_id: anyOf: - type: string - type: 'null' title: Template Node Id studio_clip: anyOf: - $ref: '#/components/schemas/StudioClipLocator' - type: 'null' type: object title: ReferenceVideo PreviewAudioDBModel: properties: voice_id: anyOf: - type: string - type: 'null' title: Voice Id text: anyOf: - type: string - type: 'null' title: Text audio_url: type: string title: Audio Url hls_manifest_url: anyOf: - type: string - type: 'null' title: Hls Manifest Url dash_manifest_url: anyOf: - type: string - type: 'null' title: Dash Manifest Url is_auto_generated: anyOf: - type: boolean - type: 'null' title: Is Auto Generated default: false generated_at_unix: anyOf: - type: integer - type: 'null' title: Generated At Unix type: object required: - audio_url title: PreviewAudioDBModel ClipAnimation: properties: enter_effect: type: string enum: - none - fade - float - gentle_float - zoom_in - drop - slide_left - slide_right - slide_up - slide_down - pop - bounce - spin - slide_bounce title: Enter Effect default: none enter_duration_ms: type: integer title: Enter Duration Ms default: 0 exit_effect: type: string enum: - none - fade - float - gentle_float - zoom_in - drop - slide_left - slide_right - slide_up - slide_down - pop - bounce - spin - slide_bounce title: Exit Effect default: none exit_duration_ms: type: integer title: Exit Duration Ms default: 0 type: object title: ClipAnimation ? Body_Stream_chapter_audio_v1_studio_projects__project_id__chapters__chapter_id__snapshots__chapter_snapshot_id__stream_post : properties: convert_to_mpeg: type: boolean title: Convert To Mpeg description: Whether to convert the audio to mpeg format. default: false type: object title: Body_Stream_chapter_audio_v1_studio_projects__project_id__chapters__chapter_id__snapshots__chapter_snapshot_id__stream_post ReviewResponseModel: properties: review_status: type: string enum: - approved - edits_required - rejected title: Review Status reviewed_at_unix: type: integer title: Reviewed At Unix reviewed_by: anyOf: - type: string - type: 'null' title: Reviewed By reject_reasons: anyOf: - items: type: string enum: - lacks_structure - doesnt_open - not_literary_work - language_not_supported - too_short - duplicate - promotional - formatting_issues - low_quality - metadata_incomplete - metadata_inaccurate - typos - review_error - spam - legal_violation - content_policy - public_domain - other type: array - type: 'null' title: Reject Reasons scores_breakdown: anyOf: - additionalProperties: type: integer type: object - type: 'null' title: Scores Breakdown rejected_details: anyOf: - type: string - type: 'null' title: Rejected Details explanation: anyOf: - type: string - type: 'null' title: Explanation type: object required: - review_status - reviewed_at_unix title: ReviewResponseModel PodcastConversationMode: properties: type: type: string const: conversation title: Type description: The type of podcast to create. conversation: $ref: '#/components/schemas/PodcastConversationModeData' description: The voice settings for the conversation. type: object required: - type - conversation title: PodcastConversationMode example: conversation: guest_voice_id: aw1NgEzBg83R7vgmiJt7 host_voice_id: aw1NgEzBg83R7vgmiJt6 type: conversation GetProjectsResponseModel: properties: projects: items: $ref: '#/components/schemas/ProjectResponseModel' type: array title: Projects description: A list of projects with their metadata. type: object required: - projects title: GetProjectsResponseModel example: projects: - 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 PronunciationDictionaryVersionLocatorDBModel: properties: pronunciation_dictionary_id: type: string title: Pronunciation Dictionary Id version_id: anyOf: - type: string - type: 'null' title: Version Id type: object required: - pronunciation_dictionary_id - version_id title: PronunciationDictionaryVersionLocatorDBModel CaptionStyleTemplateModel: properties: key: type: string title: Key label: type: string title: Label requires_high_fps: type: boolean title: Requires High Fps default: false type: object required: - key - label title: CaptionStyleTemplateModel VoiceResponseModel: properties: voice_id: type: string title: Voice Id description: The ID of the voice. name: type: string title: Name description: The name of the voice. samples: anyOf: - items: $ref: '#/components/schemas/SampleResponseModel' type: array - type: 'null' title: Samples description: List of samples associated with the voice. category: type: string enum: - generated - cloned - premade - professional - famous - high_quality title: Category description: The category of the voice. fine_tuning: anyOf: - $ref: '#/components/schemas/FineTuningResponseModel' - type: 'null' description: Fine-tuning information for the voice. labels: additionalProperties: type: string type: object title: Labels description: Labels associated with the voice. description: anyOf: - type: string - type: 'null' title: Description description: The description of the voice. preview_url: anyOf: - type: string - type: 'null' title: Preview Url description: The preview URL of the voice. available_for_tiers: items: type: string type: array title: Available For Tiers description: The tiers the voice is available for. settings: anyOf: - $ref: '#/components/schemas/VoiceSettingsResponseModel' - type: 'null' description: The settings of the voice. sharing: anyOf: - $ref: '#/components/schemas/VoiceSharingResponseModel' - type: 'null' description: The sharing information of the voice. high_quality_base_model_ids: items: type: string type: array title: High Quality Base Model Ids description: The base model IDs for high-quality voices. verified_languages: anyOf: - items: $ref: '#/components/schemas/VerifiedVoiceLanguageResponseModel' type: array - type: 'null' title: Verified Languages description: The verified languages of the voice. collection_ids: anyOf: - items: type: string type: array - type: 'null' title: Collection Ids description: The IDs of collections this voice belongs to. safety_control: anyOf: - type: string enum: - NONE - BAN - CAPTCHA - ENTERPRISE_BAN - ENTERPRISE_CAPTCHA - type: 'null' title: Safety Control description: The safety controls of the voice. voice_verification: anyOf: - $ref: '#/components/schemas/VoiceVerificationResponseModel' - type: 'null' description: The voice verification of the voice. permission_on_resource: anyOf: - type: string - type: 'null' title: Permission On Resource description: The permission on the resource of the voice. is_owner: anyOf: - type: boolean - type: 'null' title: Is Owner description: Whether the voice is owned by the user. is_legacy: type: boolean title: Is Legacy description: Whether the voice is legacy. default: false is_mixed: type: boolean title: Is Mixed description: Whether the voice is mixed. default: false favorited_at_unix: anyOf: - type: integer - type: 'null' title: Favorited At Unix description: Timestamp when the voice was marked as favorite in Unix time. created_at_unix: anyOf: - type: integer - type: 'null' title: Created At Unix description: The creation time of the voice in Unix time. is_bookmarked: anyOf: - type: boolean - type: 'null' title: Is Bookmarked description: Whether the voice is bookmarked by the current user. Only relevant for community (library-copied) voices. recording_quality: anyOf: - type: string enum: - studio - good - ok - poor - bad - type: 'null' title: Recording Quality description: The recording quality of the voice as determined by the review pipeline. labelling_status: anyOf: - type: string enum: - in_review - review_complete - type: 'null' title: Labelling Status description: The review pipeline status of the voice. recording_quality_reason: anyOf: - type: string - type: 'null' title: Recording Quality Reason description: The reason for the recording quality assessment, as determined by the review pipeline. type: object required: - voice_id - name - category - labels - available_for_tiers - high_quality_base_model_ids title: VoiceResponseModel example: available_for_tiers: - creator - enterprise category: professional description: A warm, expressive voice with a touch of humor. fine_tuning: is_allowed_to_fine_tune: true manual_verification_requested: false state: eleven_multilingual_v2: fine_tuned verification_attempts_count: 2 verification_failures: [] high_quality_base_model_ids: - eleven_v2_flash - eleven_flash_v2 - eleven_turbo_v2_5 - eleven_multilingual_v2 - eleven_v2_5_flash - eleven_flash_v2_5 - eleven_turbo_v2 is_legacy: false is_mixed: false is_owner: false labels: accent: American age: middle-aged description: expressive gender: female use_case: social media name: Rachel preview_url: https://storage.googleapis.com/eleven-public-prod/premade/voices/9BWtsMINqrJLrRacOk9x/405766b8-1f4e-4d3c-aba1-6f25333823ec.mp3 settings: similarity_boost: 1.0 speed: 1.0 stability: 1.0 style: 0.0 use_speaker_boost: true sharing: category: professional cloned_by_count: 50 date_unix: 1714204800 description: A female voice with a soft and friendly tone. disable_at_unix: 1714204800 enabled_in_library: true featured: true financial_rewards_enabled: true free_users_allowed: true history_item_sample_id: DCwhRBWXzGAHq8TQ4Fs18 labels: accent: American gender: female liked_by_count: 100 live_moderation_enabled: true moderation_check: captcha_checks: - 0.95 - 0.98 captcha_ids: - captcha1 - captcha2 date_checked_unix: 1714204800 description_check: true description_value: A female voice with a soft and friendly tone. name_check: true name_value: Rachel sample_checks: - 0.95 - 0.98 sample_ids: - sample1 - sample2 name: Rachel notice_period: 30 original_voice_id: DCwhRBWXzGAHq8TQ4Fs18 public_owner_id: DCwhRBWXzGAHq8TQ4Fs18 rate: 0.05 reader_app_enabled: true reader_restricted_on: - resource_id: FCwhRBWXzGAHq8TQ4Fs18 resource_type: read review_status: allowed status: enabled voice_mixing_allowed: false whitelisted_emails: - example@example.com verified_languages: - accent: american language: en locale: en-US model_id: eleven_multilingual_v2 preview_url: https://storage.googleapis.com/eleven-public-prod/premade/voices/9BWtsMINqrJLrRacOk9x/405766b8-1f4e-4d3c-aba1-6f25333823ec.mp3 voice_id: 21m00Tcm4TlvDq8ikWAM voice_verification: is_verified: true language: en requires_verification: false verification_attempts: - accepted: true date_unix: 1714204800 levenshtein_distance: 2 recording: mime_type: audio/mpeg recording_id: CwhRBWXzGAHq8TQ4Fs17 size_bytes: 1000000 transcription: Hello, how are you? upload_date_unix: 1714204800 similarity: 0.95 text: Hello, how are you? verification_attempts_count: 0 verification_failures: [] ChapterContentBlockInputModel: properties: sub_type: anyOf: - type: string enum: - p - h1 - h2 - h3 - type: 'null' title: Sub Type nodes: items: $ref: '#/components/schemas/ChapterContentParagraphTtsNodeInputModel' type: array title: Nodes block_id: anyOf: - type: string - type: 'null' title: Block Id type: object required: - nodes title: ChapterContentBlockInputModel ProjectSnapshotResponseModel: properties: project_snapshot_id: type: string title: Project Snapshot Id description: The ID of the project snapshot. project_id: type: string title: Project Id description: The ID of the project. created_at_unix: type: integer title: Created At Unix description: The creation date of the project snapshot. name: type: string title: Name description: The name of the project snapshot. audio_upload: anyOf: - additionalProperties: true type: object - type: 'null' title: Audio Upload description: (Deprecated) zip_upload: anyOf: - additionalProperties: true type: object - type: 'null' title: Zip Upload description: (Deprecated) type: object required: - project_snapshot_id - project_id - created_at_unix - name title: ProjectSnapshotResponseModel example: created_at_unix: 1714204800 name: My Project Snapshot project_id: aw1NgEzBg83R7vgmiJt6 project_snapshot_id: aw1NgEzBg83R7vgmiJt6 ReadMetadataChapterDBModel: properties: chapter_name: type: string title: Chapter Name word_count: type: integer title: Word Count char_count: type: integer title: Char Count starting_char_offset: type: integer title: Starting Char Offset has_parsed_html: type: boolean title: Has Parsed Html default: false has_summary: type: boolean title: Has Summary default: false duration_seconds: anyOf: - type: number - type: 'null' title: Duration Seconds file_number: anyOf: - type: string - type: 'null' title: File Number is_fallback_name: type: boolean title: Is Fallback Name default: false chapter_id: anyOf: - type: string - type: 'null' title: Chapter Id type: object required: - chapter_name - word_count - char_count - starting_char_offset title: ReadMetadataChapterDBModel VideoAnalysisResult: properties: title: type: string title: Title description: type: string title: Description content_type: anyOf: - type: string - type: 'null' title: Content Type overall_pacing: anyOf: - type: string - type: 'null' title: Overall Pacing subjects: items: $ref: '#/components/schemas/VideoSubject' type: array title: Subjects segments: items: $ref: '#/components/schemas/VideoSegment' type: array title: Segments key_moments: items: $ref: '#/components/schemas/VideoKeyMoment' type: array title: Key Moments type: object required: - title - description title: VideoAnalysisResult GetChaptersResponseModel: properties: chapters: items: $ref: '#/components/schemas/ChapterResponseModel' type: array title: Chapters type: object required: - chapters title: GetChaptersResponseModel ProjectVideoResponseModel: properties: video_id: type: string title: Video Id filename: type: string title: Filename signed_url: anyOf: - type: string - type: 'null' title: Signed Url signed_preview_url: anyOf: - type: string - type: 'null' title: Signed Preview Url offset_ms: type: integer title: Offset Ms duration_ms: type: integer title: Duration Ms volume_gain_db: type: number title: Volume Gain Db muted: type: boolean title: Muted fade_in_ms: type: integer title: Fade In Ms default: 0 fade_out_ms: type: integer title: Fade Out Ms default: 0 width: type: integer title: Width height: type: integer title: Height codec: type: string title: Codec order: type: string title: Order created_at_ms: type: integer title: Created At Ms updated_at_ms: type: integer title: Updated At Ms error: anyOf: - type: string - type: 'null' title: Error thumbnail_interval_seconds: type: number title: Thumbnail Interval Seconds thumbnail_size: prefixItems: - type: integer - type: integer items: type: integer type: array maxItems: 2 minItems: 2 title: Thumbnail Size thumbnail_sheets: items: $ref: '#/components/schemas/ProjectVideoThumbnailSheetResponseModel' type: array title: Thumbnail Sheets start_time_ms: type: integer title: Start Time Ms end_time_ms: anyOf: - type: integer - type: 'null' title: End Time Ms asset_preview_signed_url: anyOf: - type: string - type: 'null' title: Asset Preview Signed Url source_video_id: anyOf: - type: string - type: 'null' title: Source Video Id source_asset_id: anyOf: - type: string - type: 'null' title: Source Asset Id source_platform_asset_id: anyOf: - type: string - type: 'null' title: Source Platform Asset Id pending_blocks_metadata: anyOf: - $ref: '#/components/schemas/PendingBlocksMetadataModel' - type: 'null' pending_external_audios_metadata: anyOf: - $ref: '#/components/schemas/PendingExternalAudiosMetadataModel' - type: 'null' speech_imported: type: boolean title: Speech Imported default: false pending_task: anyOf: - $ref: '#/components/schemas/PendingClipTask' - type: 'null' audio_track_ready: type: boolean title: Audio Track Ready default: true export_format_ready: type: boolean title: Export Format Ready default: true current_snapshot_id: anyOf: - type: string - type: 'null' title: Current Snapshot Id source_context: anyOf: - $ref: '#/components/schemas/GenerationSourceContext' - type: 'null' analysis: anyOf: - $ref: '#/components/schemas/VideoAnalysis' - type: 'null' transcription: anyOf: - $ref: '#/components/schemas/AssetTranscription' - type: 'null' type: type: string const: video title: Type default: video canvas_placement: $ref: '#/components/schemas/CanvasPlacement' animation: $ref: '#/components/schemas/ClipAnimation' playback_speed: type: number title: Playback Speed default: 1.0 opacity: type: number maximum: 1.0 minimum: 0.0 title: Opacity default: 1.0 track_id: type: string title: Track Id default: v0 preview_job_progress: type: number title: Preview Job Progress readOnly: true import_speech_progress: anyOf: - type: number - type: 'null' title: Import Speech Progress readOnly: true type: object required: - video_id - filename - signed_url - signed_preview_url - offset_ms - duration_ms - volume_gain_db - muted - width - height - codec - order - created_at_ms - updated_at_ms - thumbnail_interval_seconds - thumbnail_size - thumbnail_sheets - start_time_ms - end_time_ms - preview_job_progress - import_speech_progress title: ProjectVideoResponseModel VerifiedVoiceLanguageResponseModel: properties: language: type: string title: Language description: The language of the voice. model_id: type: string title: Model Id description: The voice's model ID. accent: anyOf: - type: string - type: 'null' title: Accent description: The voice's accent, if applicable. locale: anyOf: - type: string - type: 'null' title: Locale description: The voice's locale, if applicable. preview_url: anyOf: - type: string - type: 'null' title: Preview Url description: The voice's preview URL, if applicable. type: object required: - language - model_id title: VerifiedVoiceLanguageResponseModel example: accent: American language: en model_id: eleven_turbo_v2_5 ProjectCreationMetaResponseModel: properties: creation_progress: type: number title: Creation Progress description: The progress of the project creation. status: type: string enum: - draft - pending - creating - finished - failed title: Status description: The status of the project creation action. type: $ref: '#/components/schemas/ProjectCreationMetaType' description: The type of the project creation action. type: object required: - creation_progress - status - type title: ProjectCreationMetaResponseModel example: creation_progress: 0.5 status: pending type: blank AudioAnalysis: properties: status: type: string enum: - processing - completed - failed title: Status data: anyOf: - $ref: '#/components/schemas/AudioAnalysisResult' - type: 'null' updated_at_ms: type: integer title: Updated At Ms type: object required: - status - data title: AudioAnalysis VoiceSharingResponseModel: properties: status: type: string enum: - enabled - disabled - copied - copied_disabled title: Status description: The status of the voice sharing. history_item_sample_id: anyOf: - type: string - type: 'null' title: History Item Sample Id description: The sample ID of the history item. date_unix: type: integer title: Date Unix description: The date of the voice sharing in Unix time. whitelisted_emails: items: type: string type: array title: Whitelisted Emails description: A list of whitelisted emails. public_owner_id: type: string title: Public Owner Id description: The ID of the public owner. original_voice_id: type: string title: Original Voice Id description: The ID of the original voice. financial_rewards_enabled: type: boolean title: Financial Rewards Enabled description: Whether financial rewards are enabled. free_users_allowed: type: boolean title: Free Users Allowed description: Whether free users are allowed. live_moderation_enabled: type: boolean title: Live Moderation Enabled description: Whether live moderation is enabled. rate: anyOf: - type: number - type: 'null' title: Rate description: The rate of the voice sharing. fiat_rate: anyOf: - type: number - type: 'null' title: Fiat Rate description: The rate of the voice sharing in USD per 1000 credits. notice_period: type: integer title: Notice Period description: The notice period of the voice sharing. disable_at_unix: anyOf: - type: integer - type: 'null' title: Disable At Unix description: The date of the voice sharing in Unix time. voice_mixing_allowed: type: boolean title: Voice Mixing Allowed description: Whether voice mixing is allowed. featured: type: boolean title: Featured description: Whether the voice is featured. category: type: string enum: - generated - cloned - premade - professional - famous - high_quality title: Category description: The category of the voice. reader_app_enabled: anyOf: - type: boolean - type: 'null' title: Reader App Enabled description: Whether the reader app is enabled. image_url: anyOf: - type: string - type: 'null' title: Image Url description: The image URL of the voice. ban_reason: anyOf: - type: string - type: 'null' title: Ban Reason description: The ban reason of the voice. liked_by_count: type: integer title: Liked By Count description: The number of likes on the voice. cloned_by_count: type: integer title: Cloned By Count description: The number of clones on the voice. name: type: string title: Name description: The name of the voice. description: anyOf: - type: string - type: 'null' title: Description description: The description of the voice. labels: additionalProperties: type: string type: object title: Labels description: The labels of the voice. review_status: type: string enum: - not_requested - pending - declined - allowed - allowed_with_changes title: Review Status description: The review status of the voice. review_message: anyOf: - type: string - type: 'null' title: Review Message description: The review message of the voice. enabled_in_library: type: boolean title: Enabled In Library description: Whether the voice is enabled in the library. instagram_username: anyOf: - type: string - type: 'null' title: Instagram Username description: The Instagram username of the voice. twitter_username: anyOf: - type: string - type: 'null' title: Twitter Username description: The Twitter/X username of the voice. youtube_username: anyOf: - type: string - type: 'null' title: Youtube Username description: The YouTube username of the voice. tiktok_username: anyOf: - type: string - type: 'null' title: Tiktok Username description: The TikTok username of the voice. moderation_check: anyOf: - $ref: '#/components/schemas/VoiceSharingModerationCheckResponseModel' - type: 'null' description: The moderation check of the voice. reader_restricted_on: anyOf: - items: $ref: '#/components/schemas/ReaderResourceResponseModel' type: array - type: 'null' title: Reader Restricted On description: The reader restricted on of the voice. type: object required: - status - date_unix - whitelisted_emails - public_owner_id - original_voice_id - financial_rewards_enabled - free_users_allowed - live_moderation_enabled - notice_period - voice_mixing_allowed - featured - category - liked_by_count - cloned_by_count - name - labels - review_status - enabled_in_library title: VoiceSharingResponseModel example: category: professional cloned_by_count: 50 date_unix: 1714204800 description: A female voice with a soft and friendly tone. disable_at_unix: 1714204800 enabled_in_library: true featured: true financial_rewards_enabled: true free_users_allowed: true history_item_sample_id: DCwhRBWXzGAHq8TQ4Fs18 labels: accent: American gender: female liked_by_count: 100 live_moderation_enabled: true moderation_check: captcha_checks: - 0.95 - 0.98 captcha_ids: - captcha1 - captcha2 date_checked_unix: 1714204800 description_check: true description_value: A female voice with a soft and friendly tone. name_check: true name_value: Rachel sample_checks: - 0.95 - 0.98 sample_ids: - sample1 - sample2 name: Rachel notice_period: 30 original_voice_id: DCwhRBWXzGAHq8TQ4Fs18 public_owner_id: DCwhRBWXzGAHq8TQ4Fs18 rate: 0.05 reader_app_enabled: true reader_restricted_on: - resource_id: FCwhRBWXzGAHq8TQ4Fs18 resource_type: read review_status: allowed status: enabled voice_mixing_allowed: false whitelisted_emails: - example@example.com PendingExternalAudiosMetadataModel: properties: target_global_offset_ms: anyOf: - type: integer - type: 'null' title: Target Global Offset Ms external_audio_ids: items: type: string type: array title: External Audio Ids type: object required: - target_global_offset_ms - external_audio_ids title: PendingExternalAudiosMetadataModel ProjectCreationMetaType: type: string enum: - blank - generate_podcast - auto_assign_voices - dub_video - import_speech title: ProjectCreationMetaType AssetTranscriptionData: properties: language_code: type: string title: Language Code text: type: string title: Text words: items: type: string type: array title: Words word_start_times_ms: items: type: integer type: array title: Word Start Times Ms word_end_times_ms: items: type: integer type: array title: Word End Times Ms word_speaker_ids: items: anyOf: - type: string - type: 'null' type: array title: Word Speaker Ids type: object required: - language_code - text - words - word_start_times_ms - word_end_times_ms - word_speaker_ids title: AssetTranscriptionData PronunciationDictionaryLocatorResponseModel: properties: pronunciation_dictionary_id: type: string title: Pronunciation Dictionary Id version_id: anyOf: - type: string - type: 'null' title: Version Id type: object required: - pronunciation_dictionary_id - version_id title: PronunciationDictionaryLocatorResponseModel Body_Create_Pronunciation_Dictionaries_v1_studio_projects__project_id__pronunciation_dictionaries_post: properties: pronunciation_dictionary_locators: items: $ref: '#/components/schemas/PronunciationDictionaryVersionLocatorDBModel' type: array title: Pronunciation Dictionary Locators description: A list of pronunciation dictionary locators (pronunciation_dictionary_id, version_id) encoded as a list of JSON strings for pronunciation dictionaries to be applied to the text. A list of json encoded strings is required as adding projects may occur through formData as opposed to jsonBody. To specify multiple dictionaries use multiple --form lines in your curl, such as --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"Vmd4Zor6fplcA7WrINey\",\"version_id\":\"hRPaxjlTdR7wFMhV4w0b\"}"' --form 'pronunciation_dictionary_locators="{\"pronunciation_dictionary_id\":\"JzWtcGQMJ6bnlWwyMo7e\",\"version_id\":\"lbmwxiLu4q6txYxgdZqn\"}"'. examples: - - '{"pronunciation_dictionary_id": "21m00Tcm4TlvDq8ikWAM", "version_id": "BdF0s0aZ3oFoKnDYdTox"}' invalidate_affected_text: type: boolean title: Invalidate Affected Text description: This will automatically mark text in this project for reconversion when the new dictionary applies or the old one no longer does. default: true examples: - false type: object required: - pronunciation_dictionary_locators title: Body_Create_Pronunciation_Dictionaries_v1_studio_projects__project_id__pronunciation_dictionaries_post Body_Create_podcast_v1_studio_podcasts_post: properties: model_id: type: string title: Model Id description: The ID of the model to be used for this Studio project, you can query GET /v1/models to list all available models. examples: - eleven_multilingual_v2 mode: anyOf: - $ref: '#/components/schemas/PodcastConversationMode' - $ref: '#/components/schemas/PodcastBulletinMode' title: Mode description: The type of podcast to generate. Can be 'conversation', an interaction between two voices, or 'bulletin', a monologue. examples: - conversation: guest_voice_id: bYTqZQo3Jz7LQtmGTgwi host_voice_id: 6lCwbsX1yVjD49QmpkTR type: conversation source: anyOf: - $ref: '#/components/schemas/PodcastTextSource' - $ref: '#/components/schemas/PodcastURLSource' - items: anyOf: - $ref: '#/components/schemas/PodcastTextSource' - $ref: '#/components/schemas/PodcastURLSource' type: array title: Source description: The source content for the Podcast. examples: - type: url url: https://en.wikipedia.org/wiki/Cognitive_science quality_preset: anyOf: - $ref: '#/components/schemas/QualityPresetType' - type: 'null' title: Quality of the generated audio. description: 'Output quality of the generated audio. Must be one of: ''standard'' - standard output format, 128kbps with 44.1kHz sample rate. ''high'' - high quality output format, 192kbps with 44.1kHz sample rate and major improvements on our side. ''ultra'' - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. ''ultra_lossless'' - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format. If not provided, defaults to the highest quality preset available on your subscription tier. ' examples: - standard duration_scale: type: string enum: - short - default - long title: The duration of the generated podcast. This varies depending on the format, voice and language. description: 'Duration of the generated podcast. Must be one of: short - produces podcasts shorter than 3 minutes. default - produces podcasts roughly between 3-7 minutes. long - produces podcasts longer than 7 minutes. ' default: default examples: - short language: anyOf: - type: string maxLength: 2 minLength: 2 - type: 'null' title: Language description: An optional language of the Studio project. Two-letter language code (ISO 639-1). examples: - en intro: anyOf: - type: string maxLength: 1500 - type: 'null' title: Intro description: The intro text that will always be added to the beginning of the podcast. examples: - Welcome to the podcast. outro: anyOf: - type: string maxLength: 1500 - type: 'null' title: Outro description: The outro text that will always be added to the end of the podcast. examples: - Thank you for listening! instructions_prompt: anyOf: - type: string maxLength: 3000 - type: 'null' title: Instructions Prompt description: Additional instructions prompt for the podcast generation used to adjust the podcast's style and tone. examples: - Ensure the podcast remains factual, accurate and appropriate for all audiences. highlights: anyOf: - items: type: string maxLength: 70 minLength: 10 type: array - type: 'null' title: Highlights description: A brief summary or highlights of the Studio project's content, providing key points or themes. This should be between 10 and 70 characters. examples: - - Emphasize the importance of AI on education callback_url: anyOf: - type: string - type: 'null' title: Callback Url description: "\n A url that will be called by our service when the Studio project is converted. Request will contain a json blob containing the status of the conversion\n Messages:\n 1. When project was converted successfully:\n {\n type: \"project_conversion_status\",\n event_timestamp: 1234567890,\n data: {\n request_id: \"1234567890\",\n project_id: \"21m00Tcm4TlvDq8ikWAM\",\n conversion_status: \"success\",\n project_snapshot_id: \"22m00Tcm4TlvDq8ikMAT\",\n error_details: None,\n }\n }\n 2. When project conversion failed:\n {\n type: \"project_conversion_status\",\n event_timestamp: 1234567890,\n data: {\n request_id: \"1234567890\",\n project_id: \"21m00Tcm4TlvDq8ikWAM\",\n conversion_status: \"error\",\n project_snapshot_id: None,\n error_details: \"Error details if conversion failed\"\n }\n }\n\n 3. When chapter was converted successfully:\n {\n type: \"chapter_conversion_status\",\n event_timestamp: 1234567890,\n data: {\n request_id: \"1234567890\",\n project_id: \"21m00Tcm4TlvDq8ikWAM\",\n chapter_id: \"22m00Tcm4TlvDq8ikMAT\",\n conversion_status: \"success\",\n chapter_snapshot_id: \"23m00Tcm4TlvDq8ikMAV\",\n error_details: None,\n }\n }\n 4. When chapter conversion failed:\n {\n type: \"chapter_conversion_status\",\n event_timestamp: 1234567890,\n data: {\n request_id: \"1234567890\",\n project_id: \"21m00Tcm4TlvDq8ikWAM\",\n chapter_id: \"22m00Tcm4TlvDq8ikMAT\",\n conversion_status: \"error\",\n chapter_snapshot_id: None,\n error_details: \"Error details if conversion failed\"\n }\n }\n " examples: - - https://www.test.com/my-api/projects-status apply_text_normalization: anyOf: - type: string enum: - auto - 'on' - 'off' - apply_english - type: 'null' title: Apply Text Normalization description: "\n This parameter controls text normalization with four modes: 'auto', 'on', 'apply_english' and 'off'.\n When set to 'auto', the system will automatically decide whether to apply text normalization\n (e.g., spelling out numbers). With 'on', text normalization will always be applied, while\n with 'off', it will be skipped. 'apply_english' is the same as 'on' but will assume that text is in English.\n " type: object required: - model_id - mode - source title: Body_Create_podcast_v1_studio_podcasts_post PendingClipTask: properties: type: type: string enum: - preprocessing - speech_import - dubbing - video_to_music - media_generation title: Type progress: type: number title: Progress default: 0.0 started_at_ms: type: integer title: Started At Ms updated_at_ms: type: integer title: Updated At Ms metadata: additionalProperties: true type: object title: Metadata type: object required: - type title: PendingClipTask ProjectMutedTracksResponseModel: properties: chapter_ids: items: type: string type: array title: Chapter Ids description: List of chapter IDs that have muted tracks. type: object required: - chapter_ids title: ProjectMutedTracksResponseModel example: chapter_ids: - aw1NgEzBg83R7vgmiJt6 ChapterContentResponseModel: properties: blocks: items: $ref: '#/components/schemas/ChapterContentBlockResponseModel' type: array title: Blocks type: object required: - blocks title: ChapterContentResponseModel SampleResponseModel: properties: sample_id: type: string title: Sample Id description: The ID of the sample. file_name: type: string title: File Name description: The name of the sample file. mime_type: type: string title: Mime Type description: The MIME type of the sample file. size_bytes: type: integer title: Size Bytes description: The size of the sample file in bytes. hash: type: string title: Hash description: The hash of the sample file. duration_secs: anyOf: - type: number - type: 'null' title: Duration Secs remove_background_noise: anyOf: - type: boolean - type: 'null' title: Remove Background Noise has_isolated_audio: anyOf: - type: boolean - type: 'null' title: Has Isolated Audio has_isolated_audio_preview: anyOf: - type: boolean - type: 'null' title: Has Isolated Audio Preview speaker_separation: anyOf: - $ref: '#/components/schemas/SpeakerSeparationResponseModel' - type: 'null' trim_start: anyOf: - type: integer - type: 'null' title: Trim Start trim_end: anyOf: - type: integer - type: 'null' title: Trim End type: object required: - sample_id - file_name - mime_type - size_bytes - hash title: SampleResponseModel example: file_name: sample.mp3 hash: '1234567890' mime_type: audio/mpeg sample_id: DCwhRBWXzGAHq8TQ4Fs18 size_bytes: 1000000 VoiceSharingModerationCheckResponseModel: properties: date_checked_unix: anyOf: - type: integer - type: 'null' title: Date Checked Unix description: The date the moderation check was made in Unix time. name_value: anyOf: - type: string - type: 'null' title: Name Value description: The name value of the voice. name_check: anyOf: - type: boolean - type: 'null' title: Name Check description: Whether the name check was successful. description_value: anyOf: - type: string - type: 'null' title: Description Value description: The description value of the voice. description_check: anyOf: - type: boolean - type: 'null' title: Description Check description: Whether the description check was successful. sample_ids: anyOf: - items: type: string type: array - type: 'null' title: Sample Ids description: A list of sample IDs. sample_checks: anyOf: - items: type: number type: array - type: 'null' title: Sample Checks description: A list of sample checks. captcha_ids: anyOf: - items: type: string type: array - type: 'null' title: Captcha Ids description: A list of captcha IDs. captcha_checks: anyOf: - items: type: number type: array - type: 'null' title: Captcha Checks description: A list of CAPTCHA check values. type: object title: VoiceSharingModerationCheckResponseModel example: captcha_checks: - 0.95 - 0.98 captcha_ids: - captcha1 - captcha2 date_checked_unix: 1714204800 description_check: true description_value: A female voice with a soft and friendly tone. name_check: true name_value: Rachel sample_checks: - 0.95 - 0.98 sample_ids: - sample1 - sample2 ImageSubject: properties: name: type: string title: Name description: type: string title: Description type: object required: - name - description title: ImageSubject SfxSourceContext: properties: source_type: type: string const: sfx title: Source Type default: sfx sound_generation_history_item_id: anyOf: - type: string - type: 'null' title: Sound Generation History Item Id text: anyOf: - type: string - type: 'null' title: Text generation_config: anyOf: - additionalProperties: true type: object - type: 'null' title: Generation Config type: object title: SfxSourceContext description: Context for sound effect clips. ProjectSnapshotExtendedResponseModel: properties: project_snapshot_id: type: string title: Project Snapshot Id description: The ID of the project snapshot. project_id: type: string title: Project Id description: The ID of the project. created_at_unix: type: integer title: Created At Unix description: The creation date of the project snapshot. name: type: string title: Name description: The name of the project snapshot. audio_upload: anyOf: - additionalProperties: true type: object - type: 'null' title: Audio Upload description: (Deprecated) zip_upload: anyOf: - additionalProperties: true type: object - type: 'null' title: Zip Upload description: (Deprecated) character_alignments: items: $ref: '#/components/schemas/CharacterAlignmentModel' type: array title: Character Alignments audio_duration_secs: type: number title: Audio Duration Secs description: The total duration of the audio in seconds. type: object required: - project_snapshot_id - project_id - created_at_unix - name - character_alignments - audio_duration_secs title: ProjectSnapshotExtendedResponseModel example: audio_duration_secs: 123.45 character_alignments: [] created_at_unix: 1714204800 name: My Project Snapshot project_id: aw1NgEzBg83R7vgmiJt6 project_snapshot_id: aw1NgEzBg83R7vgmiJt6 ProjectImageResponseModel: properties: image_id: type: string title: Image Id filename: type: string title: Filename signed_url: anyOf: - type: string - type: 'null' title: Signed Url thumbnail_signed_url: anyOf: - type: string - type: 'null' title: Thumbnail Signed Url type: type: string const: image title: Type default: image source: type: string const: upload title: Source default: upload file_size_bytes: type: integer title: File Size Bytes width: type: integer title: Width height: type: integer title: Height track_id: type: string title: Track Id default: v0 offset_ms: type: integer title: Offset Ms duration_ms: type: integer title: Duration Ms order: type: string title: Order canvas_placement: $ref: '#/components/schemas/CanvasPlacement' animation: $ref: '#/components/schemas/ClipAnimation' default: enter_effect: none enter_duration_ms: 0 exit_effect: none exit_duration_ms: 0 opacity: type: number maximum: 1.0 minimum: 0.0 title: Opacity default: 1.0 created_at_ms: type: integer title: Created At Ms updated_at_ms: type: integer title: Updated At Ms current_snapshot_id: anyOf: - type: string - type: 'null' title: Current Snapshot Id source_asset_id: anyOf: - type: string - type: 'null' title: Source Asset Id source_platform_asset_id: anyOf: - type: string - type: 'null' title: Source Platform Asset Id error: anyOf: - type: string - type: 'null' title: Error pending_task: anyOf: - $ref: '#/components/schemas/PendingClipTask' - type: 'null' analysis: anyOf: - $ref: '#/components/schemas/ImageAnalysis' - type: 'null' type: object required: - image_id - filename - file_size_bytes - width - height - offset_ms - duration_ms - order - canvas_placement - created_at_ms - updated_at_ms title: ProjectImageResponseModel DirectPublishingReadResponseModel: properties: read_id: type: string title: Read Id created_at_unix: type: integer title: Created At Unix updated_at_unix: type: integer title: Updated At Unix word_count: type: integer title: Word Count char_count: type: integer title: Char Count chapters: items: $ref: '#/components/schemas/ReadMetadataChapterDBModel' type: array title: Chapters title: anyOf: - type: string - type: 'null' title: Title author: anyOf: - type: string - type: 'null' title: Author description: anyOf: - type: string - type: 'null' title: Description article_image_url: anyOf: - type: string - type: 'null' title: Article Image Url language: anyOf: - type: string - type: 'null' title: Language locale: anyOf: - type: string - type: 'null' title: Locale display_mode: anyOf: - type: string enum: - text - audio-only - text-with-audio - type: 'null' title: Display Mode genre: anyOf: - items: type: string enum: - Fantasy - Romance - Science Fiction - Mystery and Thriller - Action and Adventure - Dystopia - Business and Economics - Technology - Christian & Inspirational - Horror - Biography and Memoir - Education and Learning - History - Children's Literature - Young Adult - Fairy Tales and Folklore - Fan Fiction - General Fiction - Health and Wellness - Historical Fiction - Humor - Literary Classics - Philosophy - Poetry - Politics and Government - Psychology - Science and Nature - Self-Help - Spirituality and Religion - Travel - True Crime - Other type: array - type: 'null' title: Genre fiction: anyOf: - type: string - type: 'null' title: Fiction content_type: anyOf: - type: string - type: 'null' title: Content Type original_file_type: anyOf: - type: string - type: 'null' title: Original File Type target_audience: anyOf: - type: string enum: - children - young adult - adult - all ages - type: 'null' title: Target Audience mature_content: anyOf: - type: boolean - type: 'null' title: Mature Content safesearch_adult: anyOf: - type: boolean - type: 'null' title: Safesearch Adult origin: anyOf: - type: string - type: 'null' title: Origin publication_date: anyOf: - type: string - type: 'null' title: Publication Date isbn: anyOf: - type: string - type: 'null' title: Isbn ean: anyOf: - type: string - type: 'null' title: Ean legal_terms: anyOf: - $ref: '#/components/schemas/ReadLegalTerms' - type: 'null' content_guidelines_terms: anyOf: - $ref: '#/components/schemas/ReadLegalTerms' - type: 'null' last_updated_from_project_unix: anyOf: - type: integer - type: 'null' title: Last Updated From Project Unix publishing_project_id: anyOf: - type: string - type: 'null' title: Publishing Project Id publishing_state: type: string title: Publishing State default: published publisher_profile_id: anyOf: - type: string - type: 'null' title: Publisher Profile Id quality_score: anyOf: - type: integer - type: 'null' title: Quality Score publisher: anyOf: - type: string - type: 'null' title: Publisher copyright: anyOf: - type: string - type: 'null' title: Copyright subtitle: anyOf: - type: string - type: 'null' title: Subtitle distribution_territories: anyOf: - items: type: string type: array - type: 'null' title: Distribution Territories edition: anyOf: - type: string - type: 'null' title: Edition contributors: anyOf: - items: $ref: '#/components/schemas/Contributor' type: array - type: 'null' title: Contributors payout_type: anyOf: - type: string enum: - none - engagement_based - fixed_payout - type: 'null' title: Payout Type list_price: anyOf: - type: number - type: 'null' title: List Price currency: anyOf: - type: string const: usd - type: 'null' title: Currency original_audio_project_export_id: anyOf: - type: string - type: 'null' title: Original Audio Project Export Id original_audio_document_id: anyOf: - type: string - type: 'null' title: Original Audio Document Id series_id: anyOf: - type: string - type: 'null' title: Series Id volume: anyOf: - type: integer - type: 'null' title: Volume published_at_unix: anyOf: - type: integer - type: 'null' title: Published At Unix read_slug: anyOf: - type: string - type: 'null' title: Read Slug preview_audio_object: anyOf: - $ref: '#/components/schemas/PreviewAudioDBModel' - type: 'null' sample_config: anyOf: - $ref: '#/components/schemas/SampleConfigDBModel' - type: 'null' review: anyOf: - $ref: '#/components/schemas/ReviewResponseModel' - type: 'null' voice_id: anyOf: - type: string - type: 'null' title: Voice Id can_use_assistant: type: boolean title: Can Use Assistant default: true is_voice_changer_on: type: boolean title: Is Voice Changer On default: false restricted_to_user_email_domains: anyOf: - items: type: string type: array - type: 'null' title: Restricted To User Email Domains type: object required: - read_id - created_at_unix - updated_at_unix - word_count - char_count - chapters title: DirectPublishingReadResponseModel DeleteProjectResponseModel: properties: status: type: string title: Status description: The status of the studio project deletion request. If the request was successful, the status will be 'ok'. Otherwise an error message with status 500 will be returned. type: object required: - status title: DeleteProjectResponseModel example: status: ok Body_Update_Studio_project_content_v1_studio_projects__project_id__content_post: properties: from_url: anyOf: - type: string - type: 'null' title: From Url description: An optional URL from which we will extract content to initialize the Studio project. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank. examples: - https://blog.elevenlabs.io/the_first_ai_that_can_laugh/ from_document: anyOf: - type: string format: binary - type: 'null' title: From Document description: An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the Studio project with its content. If this is set, 'from_url' and 'from_content' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank. from_content_json: type: string title: From Content Json description: "\n An optional content to initialize the Studio project with. If this is set, 'from_url' and 'from_document' must be null. If neither 'from_url', 'from_document', 'from_content' are provided we will initialize the Studio project as blank.\n\n Example:\n [{\"name\": \"Chapter A\", \"blocks\": [{\"sub_type\": \"p\", \"nodes\": [{\"voice_id\": \"6lCwbsX1yVjD49QmpkT0\", \"text\": \"A\", \"type\": \"tts_node\"}, {\"voice_id\": \"6lCwbsX1yVjD49QmpkT1\", \"text\": \"B\", \"type\": \"tts_node\"}]}, {\"sub_type\": \"h1\", \"nodes\": [{\"voice_id\": \"6lCwbsX1yVjD49QmpkT0\", \"text\": \"C\", \"type\": \"tts_node\"}, {\"voice_id\": \"6lCwbsX1yVjD49QmpkT1\", \"text\": \"D\", \"type\": \"tts_node\"}]}]}, {\"name\": \"Chapter B\", \"blocks\": [{\"sub_type\": \"p\", \"nodes\": [{\"voice_id\": \"6lCwbsX1yVjD49QmpkT0\", \"text\": \"E\", \"type\": \"tts_node\"}, {\"voice_id\": \"6lCwbsX1yVjD49QmpkT1\", \"text\": \"F\", \"type\": \"tts_node\"}]}, {\"sub_type\": \"h2\", \"nodes\": [{\"voice_id\": \"6lCwbsX1yVjD49QmpkT0\", \"text\": \"G\", \"type\": \"tts_node\"}, {\"voice_id\": \"6lCwbsX1yVjD49QmpkT1\", \"text\": \"H\", \"type\": \"tts_node\"}]}]}]\n " examples: - '[{"name": "Chapter A", "blocks": [{"sub_type": "p", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "A", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "B", "type": "tts_node"}]}, {"sub_type": "h1", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "C", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "D", "type": "tts_node"}]}]}, {"name": "Chapter B", "blocks": [{"sub_type": "p", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "E", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "F", "type": "tts_node"}]}, {"sub_type": "h2", "nodes": [{"voice_id": "6lCwbsX1yVjD49QmpkT0", "text": "G", "type": "tts_node"}, {"voice_id": "6lCwbsX1yVjD49QmpkT1", "text": "H", "type": "tts_node"}]}]}]' auto_convert: type: boolean title: Auto Convert description: Whether to auto convert the Studio project to audio or not. default: false type: object title: Body_Update_Studio_project_content_v1_studio_projects__project_id__content_post ProjectSnapshotsResponseModel: properties: snapshots: items: $ref: '#/components/schemas/ProjectSnapshotResponseModel' type: array title: Snapshots description: List of project snapshots. type: object required: - snapshots title: ProjectSnapshotsResponseModel example: snapshots: - created_at_unix: 1714204800 name: My Project Snapshot project_id: aw1NgEzBg83R7vgmiJt6 project_snapshot_id: aw1NgEzBg83R7vgmiJt6 ChapterContentBlockTtsNodeResponseModel: properties: type: type: string const: tts_node title: Type project_voice_ref_id: type: string title: Project Voice Ref Id text: type: string title: Text voice_id: type: string title: Voice Id deprecated: true readOnly: true type: object required: - type - project_voice_ref_id - text - voice_id title: ChapterContentBlockTtsNodeResponseModel FineTuningResponseModel: properties: is_allowed_to_fine_tune: type: boolean title: Is Allowed To Fine Tune description: Whether the user is allowed to fine-tune the voice. state: additionalProperties: type: string enum: - not_started - queued - fine_tuning - fine_tuned - failed - delayed type: object title: State description: The state of the fine-tuning process for each model. verification_failures: items: type: string type: array title: Verification Failures description: List of verification failures in the fine-tuning process. verification_attempts_count: type: integer title: Verification Attempts Count description: The number of verification attempts in the fine-tuning process. manual_verification_requested: type: boolean title: Manual Verification Requested description: Whether a manual verification was requested for the fine-tuning process. language: anyOf: - type: string - type: 'null' title: Language description: The language of the fine-tuning process. progress: anyOf: - additionalProperties: type: number type: object - type: 'null' title: Progress description: The progress of the fine-tuning process. message: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Message description: The message of the fine-tuning process. dataset_duration_seconds: anyOf: - type: number - type: 'null' title: Dataset Duration Seconds description: The duration of the dataset in seconds. verification_attempts: anyOf: - items: $ref: '#/components/schemas/VerificationAttemptResponseModel' type: array - type: 'null' title: Verification Attempts description: The number of verification attempts. slice_ids: anyOf: - items: type: string type: array - type: 'null' title: Slice Ids description: List of slice IDs. manual_verification: anyOf: - $ref: '#/components/schemas/ManualVerificationResponseModel' - type: 'null' description: The manual verification of the fine-tuning process. max_verification_attempts: anyOf: - type: integer - type: 'null' title: Max Verification Attempts description: The maximum number of verification attempts. next_max_verification_attempts_reset_unix_ms: anyOf: - type: integer - type: 'null' title: Next Max Verification Attempts Reset Unix Ms description: The next maximum verification attempts reset time in Unix milliseconds. type: object required: - is_allowed_to_fine_tune - state - verification_failures - verification_attempts_count - manual_verification_requested title: FineTuningResponseModel example: is_allowed_to_fine_tune: true manual_verification_requested: false state: eleven_multilingual_v2: fine_tuned verification_attempts_count: 2 verification_failures: [] VerificationAttemptResponseModel: properties: text: type: string title: Text description: The text of the verification attempt. date_unix: type: integer title: Date Unix description: The date of the verification attempt in Unix time. accepted: type: boolean title: Accepted description: Whether the verification attempt was accepted. similarity: type: number title: Similarity description: The similarity of the verification attempt. levenshtein_distance: type: number title: Levenshtein Distance description: The Levenshtein distance of the verification attempt. recording: anyOf: - $ref: '#/components/schemas/RecordingResponseModel' - type: 'null' description: The recording of the verification attempt. type: object required: - text - date_unix - accepted - similarity - levenshtein_distance title: VerificationAttemptResponseModel example: accepted: true date_unix: 1714204800 levenshtein_distance: 2 recording: mime_type: audio/mpeg recording_id: CwhRBWXzGAHq8TQ4Fs17 size_bytes: 1000000 transcription: Hello, how are you? upload_date_unix: 1714204800 similarity: 0.95 text: Hello, how are you? VoiceStatisticsResponseModel: properties: project_voice_ref_id: type: string title: Project Voice Ref Id description: The project voice reference ID. characters_unconverted: type: integer title: Characters Unconverted description: The number of unconverted characters for this voice. characters_converted: type: integer title: Characters Converted description: The number of converted characters for this voice. credits_needed_to_convert: anyOf: - type: integer - type: 'null' title: Credits Needed To Convert description: The number of credits needed to convert the remaining audio for this voice. voice_id: type: string title: Voice Id description: The voice ID. deprecated: true readOnly: true type: object required: - project_voice_ref_id - characters_unconverted - characters_converted - voice_id title: VoiceStatisticsResponseModel PodcastConversationModeData: properties: host_voice_id: type: string title: Host Voice Id description: The ID of the host voice. guest_voice_id: type: string title: Guest Voice Id description: The ID of the guest voice. type: object required: - host_voice_id - guest_voice_id title: PodcastConversationModeData example: guest_voice_id: aw1NgEzBg83R7vgmiJt7 host_voice_id: aw1NgEzBg83R7vgmiJt6 ImageAnalysisResult: properties: title: type: string title: Title description: type: string title: Description content_type: anyOf: - type: string - type: 'null' title: Content Type mood_and_style: anyOf: - type: string - type: 'null' title: Mood And Style composition_notes: anyOf: - type: string - type: 'null' title: Composition Notes visible_text: anyOf: - type: string - type: 'null' title: Visible Text description: Readable text overlaid or shown in the image, if any. subjects: items: $ref: '#/components/schemas/ImageSubject' type: array title: Subjects type: object required: - title - description title: ImageAnalysisResult HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ProjectExtendedResponseModel: properties: project_id: type: string title: Project Id description: The ID of the project. name: type: string title: Name description: The name of the project. create_date_unix: type: integer title: Create Date Unix description: The creation date of the project. created_by_user_id: anyOf: - type: string - type: 'null' title: Created By User Id description: The user ID who created the project. default_title_voice_ref_id: type: string title: Default Title Voice Ref Id description: The default title project voice reference ID. default_paragraph_voice_ref_id: type: string title: Default Paragraph Voice Ref Id description: The default paragraph project voice reference ID. default_model_id: type: string title: Default Model Id description: The default model ID. last_conversion_date_unix: anyOf: - type: integer - type: 'null' title: Last Conversion Date Unix description: The last conversion date of the project. can_be_downloaded: type: boolean title: Can Be Downloaded description: Whether the project can be downloaded. title: anyOf: - type: string - type: 'null' title: Title description: The title of the project. author: anyOf: - type: string - type: 'null' title: Author description: The author of the project. description: anyOf: - type: string - type: 'null' title: Description description: The description of the project. genres: anyOf: - items: type: string type: array - type: 'null' title: Genres description: List of genres of the project. cover_image_url: anyOf: - type: string - type: 'null' title: Cover Image Url description: The cover image URL of the project. target_audience: anyOf: - type: string enum: - children - young adult - adult - all ages - type: 'null' title: Target Audience description: The target audience of the project. language: anyOf: - type: string - type: 'null' title: Language description: Two-letter language code (ISO 639-1) of the language of the project. content_type: anyOf: - type: string - type: 'null' title: Content Type description: The content type of the project, e.g. 'Novel' or 'Short Story' original_publication_date: anyOf: - type: string - type: 'null' title: Original Publication Date description: The original publication date of the project. mature_content: anyOf: - type: boolean - type: 'null' title: Mature Content description: Whether the project contains mature content. isbn_number: anyOf: - type: string - type: 'null' title: Isbn Number description: The ISBN number of the project. volume_normalization: type: boolean title: Volume Normalization description: Whether the project uses volume normalization. state: type: string enum: - creating - default - converting - in_queue title: State description: The state of the project. access_level: type: string enum: - admin - editor - commenter - viewer title: Access Level description: The access level of the project. fiction: anyOf: - type: string enum: - fiction - non-fiction - type: 'null' title: Fiction description: Whether the project is fiction. quality_check_on: type: boolean title: Quality Check On description: Whether quality check is enabled for this project. deprecated: true quality_check_on_when_bulk_convert: type: boolean title: Quality Check On When Bulk Convert description: Whether quality check is enabled on the project when bulk converting. deprecated: true creation_meta: anyOf: - $ref: '#/components/schemas/ProjectCreationMetaResponseModel' - type: 'null' description: The creation meta of the project. source_type: anyOf: - type: string enum: - blank - book - article - genfm - video - screenplay - type: 'null' title: Source Type description: The source type of the project. chapters_enabled: anyOf: - type: boolean - type: 'null' title: Chapters Enabled description: Whether chapters are enabled for the project. default: true captions_enabled: anyOf: - type: boolean - type: 'null' title: Captions Enabled description: Whether captions are enabled for the project. default: true caption_style: anyOf: - $ref: '#/components/schemas/CaptionStyleModel' - type: 'null' description: Global styling to be applied to all captions caption_style_template_overrides: anyOf: - additionalProperties: $ref: '#/components/schemas/CaptionStyleModel' type: object - type: 'null' title: Caption Style Template Overrides description: Styling changes that have been made to the provided templates public_share_id: anyOf: - type: string - type: 'null' title: Public Share Id description: The public share ID of the project. aspect_ratio: anyOf: - type: string enum: - '16:9' - '9:16' - '4:5' - '1:1' - type: 'null' title: Aspect Ratio description: The aspect ratio of the project. agent_settings: anyOf: - $ref: '#/components/schemas/StudioAgentSettingsModel' - type: 'null' description: Agent-related settings for the project quality_preset: $ref: '#/components/schemas/QualityPresetType' description: The quality preset level of the project. chapters: items: $ref: '#/components/schemas/ChapterResponseModel' type: array title: Chapters description: List of chapters of the project and their metadata. pronunciation_dictionary_versions: items: $ref: '#/components/schemas/PronunciationDictionaryVersionResponseModel' type: array title: Pronunciation Dictionary Versions description: List of pronunciation dictionary versions of the project and their metadata. pronunciation_dictionary_locators: items: $ref: '#/components/schemas/PronunciationDictionaryLocatorResponseModel' type: array title: Pronunciation Dictionary Locators description: List of pronunciation dictionary locators. apply_text_normalization: type: string enum: - auto - 'on' - 'off' - apply_english title: Apply Text Normalization description: Whether text normalization is applied to the project. experimental: additionalProperties: true type: object title: Experimental description: Experimental features for the project. assets: items: anyOf: - $ref: '#/components/schemas/ProjectVideoResponseModel' - $ref: '#/components/schemas/ProjectExternalAudioResponseModel' - $ref: '#/components/schemas/ProjectImageResponseModel' type: array title: Assets description: List of uploaded assets e.g. videos, audios. voices: items: $ref: '#/components/schemas/ProjectVoiceResponseModel' type: array title: Voices description: List of configured project voices. base_voices: anyOf: - items: $ref: '#/components/schemas/VoiceResponseModel' type: array - type: 'null' title: Base Voices description: List of voices used by the project. publishing_read: anyOf: - $ref: '#/components/schemas/DirectPublishingReadResponseModel' - type: 'null' description: The ElevenReader data if the book was published. default_title_voice_id: type: string title: Default Title Voice Id description: The default title voice ID. deprecated: true readOnly: true default_paragraph_voice_id: type: string title: Default Paragraph Voice Id description: The default paragraph voice ID. deprecated: true readOnly: true type: object required: - project_id - name - create_date_unix - created_by_user_id - default_title_voice_ref_id - default_paragraph_voice_ref_id - default_model_id - can_be_downloaded - volume_normalization - state - access_level - quality_check_on - quality_check_on_when_bulk_convert - quality_preset - chapters - pronunciation_dictionary_versions - pronunciation_dictionary_locators - apply_text_normalization - assets - voices - default_title_voice_id - default_paragraph_voice_id title: ProjectExtendedResponseModel example: 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 PendingBlocksMetadataModel: properties: target_global_offset_ms: anyOf: - type: integer - type: 'null' title: Target Global Offset Ms block_ids: items: type: string type: array title: Block Ids type: object required: - target_global_offset_ms - block_ids title: PendingBlocksMetadataModel AddChapterResponseModel: properties: chapter: $ref: '#/components/schemas/ChapterWithContentResponseModel' type: object required: - chapter title: AddChapterResponseModel ImageAnalysis: properties: status: type: string enum: - processing - completed - failed title: Status data: anyOf: - $ref: '#/components/schemas/ImageAnalysisResult' - type: 'null' updated_at_ms: type: integer title: Updated At Ms type: object required: - status - data title: ImageAnalysis AudioAnalysisResult: properties: title: type: string title: Title description: type: string title: Description content_type: anyOf: - type: string - type: 'null' title: Content Type overall_pacing: anyOf: - type: string - type: 'null' title: Overall Pacing segments: items: $ref: '#/components/schemas/AudioSegment' type: array title: Segments key_moments: items: $ref: '#/components/schemas/AudioKeyMoment' type: array title: Key Moments type: object required: - title - description title: AudioAnalysisResult StudioClipLocator: properties: project_id: type: string title: Project Id chapter_id: type: string title: Chapter Id clip_type: type: string enum: - video - image - external_audio - tts_node title: Clip Type clip_id: type: string title: Clip Id block_id: anyOf: - type: string - type: 'null' title: Block Id preview_url: anyOf: - type: string - type: 'null' title: Preview Url type: object required: - project_id - chapter_id - clip_type - clip_id title: StudioClipLocator description: 'Coordinates of a clip inside a Studio project: the payload of a studio_clip reference.' EditProjectResponseModel: properties: project: $ref: '#/components/schemas/ProjectResponseModel' type: object required: - project title: EditProjectResponseModel ProjectResponseModel: properties: project_id: type: string title: Project Id description: The ID of the project. name: type: string title: Name description: The name of the project. create_date_unix: type: integer title: Create Date Unix description: The creation date of the project. created_by_user_id: anyOf: - type: string - type: 'null' title: Created By User Id description: The user ID who created the project. default_title_voice_ref_id: type: string title: Default Title Voice Ref Id description: The default title project voice reference ID. default_paragraph_voice_ref_id: type: string title: Default Paragraph Voice Ref Id description: The default paragraph project voice reference ID. default_model_id: type: string title: Default Model Id description: The default model ID. last_conversion_date_unix: anyOf: - type: integer - type: 'null' title: Last Conversion Date Unix description: The last conversion date of the project. can_be_downloaded: type: boolean title: Can Be Downloaded description: Whether the project can be downloaded. title: anyOf: - type: string - type: 'null' title: Title description: The title of the project. author: anyOf: - type: string - type: 'null' title: Author description: The author of the project. description: anyOf: - type: string - type: 'null' title: Description description: The description of the project. genres: anyOf: - items: type: string type: array - type: 'null' title: Genres description: List of genres of the project. cover_image_url: anyOf: - type: string - type: 'null' title: Cover Image Url description: The cover image URL of the project. target_audience: anyOf: - type: string enum: - children - young adult - adult - all ages - type: 'null' title: Target Audience description: The target audience of the project. language: anyOf: - type: string - type: 'null' title: Language description: Two-letter language code (ISO 639-1) of the language of the project. content_type: anyOf: - type: string - type: 'null' title: Content Type description: The content type of the project, e.g. 'Novel' or 'Short Story' original_publication_date: anyOf: - type: string - type: 'null' title: Original Publication Date description: The original publication date of the project. mature_content: anyOf: - type: boolean - type: 'null' title: Mature Content description: Whether the project contains mature content. isbn_number: anyOf: - type: string - type: 'null' title: Isbn Number description: The ISBN number of the project. volume_normalization: type: boolean title: Volume Normalization description: Whether the project uses volume normalization. state: type: string enum: - creating - default - converting - in_queue title: State description: The state of the project. access_level: type: string enum: - admin - editor - commenter - viewer title: Access Level description: The access level of the project. fiction: anyOf: - type: string enum: - fiction - non-fiction - type: 'null' title: Fiction description: Whether the project is fiction. quality_check_on: type: boolean title: Quality Check On description: Whether quality check is enabled for this project. deprecated: true quality_check_on_when_bulk_convert: type: boolean title: Quality Check On When Bulk Convert description: Whether quality check is enabled on the project when bulk converting. deprecated: true creation_meta: anyOf: - $ref: '#/components/schemas/ProjectCreationMetaResponseModel' - type: 'null' description: The creation meta of the project. source_type: anyOf: - type: string enum: - blank - book - article - genfm - video - screenplay - type: 'null' title: Source Type description: The source type of the project. chapters_enabled: anyOf: - type: boolean - type: 'null' title: Chapters Enabled description: Whether chapters are enabled for the project. default: true captions_enabled: anyOf: - type: boolean - type: 'null' title: Captions Enabled description: Whether captions are enabled for the project. default: true caption_style: anyOf: - $ref: '#/components/schemas/CaptionStyleModel' - type: 'null' description: Global styling to be applied to all captions caption_style_template_overrides: anyOf: - additionalProperties: $ref: '#/components/schemas/CaptionStyleModel' type: object - type: 'null' title: Caption Style Template Overrides description: Styling changes that have been made to the provided templates public_share_id: anyOf: - type: string - type: 'null' title: Public Share Id description: The public share ID of the project. aspect_ratio: anyOf: - type: string enum: - '16:9' - '9:16' - '4:5' - '1:1' - type: 'null' title: Aspect Ratio description: The aspect ratio of the project. agent_settings: anyOf: - $ref: '#/components/schemas/StudioAgentSettingsModel' - type: 'null' description: Agent-related settings for the project default_title_voice_id: type: string title: Default Title Voice Id description: The default title voice ID. deprecated: true readOnly: true default_paragraph_voice_id: type: string title: Default Paragraph Voice Id description: The default paragraph voice ID. deprecated: true readOnly: true type: object required: - project_id - name - create_date_unix - created_by_user_id - default_title_voice_ref_id - default_paragraph_voice_ref_id - default_model_id - can_be_downloaded - volume_normalization - state - access_level - quality_check_on - quality_check_on_when_bulk_convert - default_title_voice_id - default_paragraph_voice_id title: ProjectResponseModel example: 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 VideoSubject: properties: name: type: string title: Name description: type: string title: Description type: object required: - name - description title: VideoSubject ManualVerificationFileResponseModel: properties: file_id: type: string title: File Id description: The ID of the file. file_name: type: string title: File Name description: The name of the file. mime_type: type: string title: Mime Type description: The MIME type of the file. size_bytes: type: integer title: Size Bytes description: The size of the file in bytes. upload_date_unix: type: integer title: Upload Date Unix description: The date of the file in Unix time. type: object required: - file_id - file_name - mime_type - size_bytes - upload_date_unix title: ManualVerificationFileResponseModel example: file_id: CwhRBWXzGAHq8TQ4Fs18 file_name: file.mp3 mime_type: audio/mpeg size_bytes: 1000000 upload_date_unix: 1714204800 ChapterContentBlockResponseModel: properties: block_id: type: string title: Block Id nodes: items: anyOf: - $ref: '#/components/schemas/ChapterContentBlockTtsNodeResponseModel' - $ref: '#/components/schemas/ChapterContentBlockExtendableNodeResponseModel' type: array title: Nodes type: object required: - block_id - nodes title: ChapterContentBlockResponseModel StudioAgentToolSettingsModel: properties: skip_confirmation: type: boolean title: Skip Confirmation default: false type: object title: StudioAgentToolSettingsModel PronunciationDictionaryVersionResponseModel: properties: version_id: type: string title: Version Id version_rules_num: type: integer title: Version Rules Num pronunciation_dictionary_id: type: string title: Pronunciation Dictionary Id dictionary_name: type: string title: Dictionary Name version_name: type: string title: Version Name permission_on_resource: anyOf: - type: string enum: - admin - editor - commenter - viewer - type: 'null' title: Permission On Resource created_by: type: string title: Created By creation_time_unix: type: integer title: Creation Time Unix archived_time_unix: anyOf: - type: integer - type: 'null' title: Archived Time Unix type: object required: - version_id - version_rules_num - pronunciation_dictionary_id - dictionary_name - version_name - permission_on_resource - created_by - creation_time_unix title: PronunciationDictionaryVersionResponseModel EditChapterResponseModel: properties: chapter: $ref: '#/components/schemas/ChapterWithContentResponseModel' type: object required: - chapter title: EditChapterResponseModel VideoAnalysis: properties: status: type: string enum: - processing - completed - failed title: Status data: anyOf: - $ref: '#/components/schemas/VideoAnalysisResult' - type: 'null' updated_at_ms: type: integer title: Updated At Ms type: object required: - status - data title: VideoAnalysis CaptionStyleWordAnimationModel: properties: enter_type: type: string enum: - none - fade - scale - pop - slide_up - slide_down - slam - scale_down - slide_in title: Enter Type exit_type: type: string enum: - none - fade - scale - pop - slide_up - slide_down - slam - scale_down - slide_in title: Exit Type type: object required: - enter_type - exit_type title: CaptionStyleWordAnimationModel ChapterResponseModel: properties: chapter_id: type: string title: Chapter Id description: The ID of the chapter. name: type: string title: Name description: The name of the chapter. last_conversion_date_unix: anyOf: - type: integer - type: 'null' title: Last Conversion Date Unix description: The last conversion date of the chapter. conversion_progress: anyOf: - type: number - type: 'null' title: Conversion Progress description: The conversion progress of the chapter. can_be_downloaded: type: boolean title: Can Be Downloaded description: Whether the chapter can be downloaded. state: type: string enum: - default - converting title: State description: The state of the chapter. has_video: anyOf: - type: boolean - type: 'null' title: Has Video description: Whether the chapter has a video. has_visual_content: anyOf: - type: boolean - type: 'null' title: Has Visual Content description: Whether the chapter has any visual content (video, image, or text clips). voice_ids: anyOf: - items: type: string type: array - type: 'null' title: Voice Ids description: List of voice ids used by the chapter statistics: anyOf: - $ref: '#/components/schemas/ChapterStatisticsResponseModel' - type: 'null' description: The statistics of the chapter. last_conversion_error: anyOf: - type: string - type: 'null' title: Last Conversion Error description: The last conversion error of the chapter. type: object required: - chapter_id - name - can_be_downloaded - state title: ChapterResponseModel example: 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