POST
/
v1
/
projects
/
add
curl --request POST \
  --url https://api.elevenlabs.io/v1/projects/add \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=<string>' \
  --form 'from_url=<string>' \
  --form 'from_document=<string>' \
  --form 'default_title_voice_id=<string>' \
  --form 'default_paragraph_voice_id=<string>' \
  --form 'default_model_id=<string>' \
  --form 'quality_preset=<string>' \
  --form 'title=<string>' \
  --form 'author=<string>' \
  --form 'isbn_number=<string>' \
  --form acx_volume_normalization=true \
  --form volume_normalization=true \
  --form 'pronunciation_dictionary_locators=[
  "<string>"
]' \
  --form 'callback_url=<string>'
{
  "project": {
    "project_id": "<string>",
    "name": "<string>",
    "create_date_unix": 123,
    "default_title_voice_id": "<string>",
    "default_paragraph_voice_id": "<string>",
    "default_model_id": "<string>",
    "last_conversion_date_unix": 123,
    "can_be_downloaded": true,
    "title": "<string>",
    "author": "<string>",
    "isbn_number": "<string>",
    "volume_normalization": true,
    "state": "default"
  }
}
Projects API avaliable upon request. To get access, contact sales.

Headers

xi-api-key
string

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

Body

multipart/form-data
name
string
required

The name of the project, used for identification only.

from_url
string

An optional URL from which we will extract content to initialize the project. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the project as blank.

from_document
string

An optional .epub, .pdf, .txt or similar file can be provided. If provided, we will initialize the project with its content. If this is set, 'from_url' must be null. If neither 'from_url' or 'from_document' are provided we will initialize the project as blank.

default_title_voice_id
string
required

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

default_paragraph_voice_id
string
required

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

default_model_id
string
required

The model_id of the model to be used for this project, you can query GET https://api.elevenlabs.io/v1/models to list all available models.

quality_preset
string
default: standard

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. Using this setting increases the character cost by 20%. ultra - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side. Using this setting increases the character cost by 50%. ultra lossless - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format. Using this setting increases the character cost by 100%.

title
string

An optional name of the author of the project, this will be added as metadata to the mp3 file on project / chapter download.

author
string

An optional name of the author of the project, this will be added as metadata to the mp3 file on project / chapter download.

isbn_number
string

An optional ISBN number of the project you want to create, this will be added as metadata to the mp3 file on project / chapter download.

acx_volume_normalization
boolean
default: false

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

volume_normalization
boolean
default: false

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

pronunciation_dictionary_locators
string[]

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"}"'. Note that multiple dictionaries are not currently supported by our UI which will only show the first.

callback_url
string

A url that will be called by our service when the project is converted with a json containing the status of the conversion

Response

200 - application/json
project
object
required
Get Project By IdDelete Project