Pronunciation Dictionary

Add A Pronunciation Dictionary

Changed on

Creates a new pronunciation dictionary from a lexicon .PLS file

post/v1/pronunciation-dictionaries/add-from-file

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/pronunciation-dictionaries/add-from-file
  • Auth
    none declared

Headers

xi-api-keystring nullable

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

Request body multipart/form-data

namestring required

The name of the pronunciation dictionary, used for identification only.

filestring binary nullable

A lexicon .pls file which we will use to initialize the project with.

descriptionstring nullable

A description of the pronunciation dictionary, used for identification only.

workspace_access'admin' | 'editor' | 'commenter' | 'viewer' nullable

Should be one of 'admin', 'editor' or 'viewer'. If not provided, defaults to no access.

Example request

{
  "name": "My Dictionary",
  "description": "Contains pronunciation's of our character names",
  "workspace_access": "viewer"
}

Response

Successful Response

idstring required

The ID of the created pronunciation dictionary.

namestring required

The name of the created pronunciation dictionary.

created_bystring required

The user ID of the creator of the pronunciation dictionary.

creation_time_unixinteger required

The creation time of the pronunciation dictionary in Unix timestamp.

version_idstring required

The ID of the created pronunciation dictionary version.

version_rules_numinteger required

The number of rules in the version of the pronunciation dictionary.

descriptionstring nullable

The description of the pronunciation dictionary.

permission_on_resource'admin' | 'editor' | 'commenter' | 'viewer' nullable required

The permission on the resource of the pronunciation dictionary.

Example response

{
  "created_by": "ar6633Es2kUjFXBdR1iVc9ztsXl1",
  "creation_time_unix": 1714156800,
  "description": "This is a test dictionary",
  "id": "5xM3yVvZQKV0EfqQpLrJ",
  "name": "My Dictionary",
  "permission_on_resource": "admin",
  "version_id": "5xM3yVvZQKV0EfqQpLrJ",
  "version_rules_num": 5
}

Changes

  • 5b595807512cRevision changes
    • warning

      added the new commenter enum value to the / response property for the response status

    • info

      api operation id Add_a_pronunciation_dictionary_v1_pronunciation_dictionaries_add_from_file_post removed and replaced with add_from_file

    • info

      added the new commenter enum value to the request property /

  • 503db4198a44Revision changes
    • breaking

      removed the enum value admin of the request property

    • breaking

      removed the enum value editor of the request property

    • breaking

      removed the enum value viewer of the request property

    • breaking

      response property description list-of-types was widened by adding types null to media type application/json of response 200

    • info

      header request parameter xi-api-key list-of-types was widened by adding types null

    • info

      for the header request parameter xi-api-key, the type was generalized from string to no type

    • info

      request property list-of-types was widened by adding types null to media type multipart/form-data

    • info

      request property list-of-types was widened by adding types null to media type multipart/form-data

    • info

      request property list-of-types was widened by adding types null to media type multipart/form-data

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status