diff --git a/.fern/metadata.json b/.fern/metadata.json
index ebefebba..aad42f61 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -7,7 +7,7 @@
"default_bytes_stream_chunk_size": 1024,
"inline_request_params": false,
"follow_redirects_by_default": true,
- "recursion_limit": 5000,
+ "recursion_limit": 10000,
"pydantic_config": {
"skip_validation": true
},
diff --git a/poetry.lock b/poetry.lock
index 08c13181..a2b4ed0e 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -701,58 +701,58 @@ files = [
[[package]]
name = "tomli"
-version = "2.4.0"
+version = "2.4.1"
description = "A lil' TOML parser"
optional = false
python-versions = ">=3.8"
files = [
- {file = "tomli-2.4.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b5ef256a3fd497d4973c11bf142e9ed78b150d36f5773f1ca6088c230ffc5867"},
- {file = "tomli-2.4.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5572e41282d5268eb09a697c89a7bee84fae66511f87533a6f88bd2f7b652da9"},
- {file = "tomli-2.4.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:551e321c6ba03b55676970b47cb1b73f14a0a4dce6a3e1a9458fd6d921d72e95"},
- {file = "tomli-2.4.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5e3f639a7a8f10069d0e15408c0b96a2a828cfdec6fca05296ebcdcc28ca7c76"},
- {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:1b168f2731796b045128c45982d3a4874057626da0e2ef1fdd722848b741361d"},
- {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:133e93646ec4300d651839d382d63edff11d8978be23da4cc106f5a18b7d0576"},
- {file = "tomli-2.4.0-cp311-cp311-win32.whl", hash = "sha256:b6c78bdf37764092d369722d9946cb65b8767bfa4110f902a1b2542d8d173c8a"},
- {file = "tomli-2.4.0-cp311-cp311-win_amd64.whl", hash = "sha256:d3d1654e11d724760cdb37a3d7691f0be9db5fbdaef59c9f532aabf87006dbaa"},
- {file = "tomli-2.4.0-cp311-cp311-win_arm64.whl", hash = "sha256:cae9c19ed12d4e8f3ebf46d1a75090e4c0dc16271c5bce1c833ac168f08fb614"},
- {file = "tomli-2.4.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:920b1de295e72887bafa3ad9f7a792f811847d57ea6b1215154030cf131f16b1"},
- {file = "tomli-2.4.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7d6d9a4aee98fac3eab4952ad1d73aee87359452d1c086b5ceb43ed02ddb16b8"},
- {file = "tomli-2.4.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:36b9d05b51e65b254ea6c2585b59d2c4cb91c8a3d91d0ed0f17591a29aaea54a"},
- {file = "tomli-2.4.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1c8a885b370751837c029ef9bc014f27d80840e48bac415f3412e6593bbc18c1"},
- {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:8768715ffc41f0008abe25d808c20c3d990f42b6e2e58305d5da280ae7d1fa3b"},
- {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7b438885858efd5be02a9a133caf5812b8776ee0c969fea02c45e8e3f296ba51"},
- {file = "tomli-2.4.0-cp312-cp312-win32.whl", hash = "sha256:0408e3de5ec77cc7f81960c362543cbbd91ef883e3138e81b729fc3eea5b9729"},
- {file = "tomli-2.4.0-cp312-cp312-win_amd64.whl", hash = "sha256:685306e2cc7da35be4ee914fd34ab801a6acacb061b6a7abca922aaf9ad368da"},
- {file = "tomli-2.4.0-cp312-cp312-win_arm64.whl", hash = "sha256:5aa48d7c2356055feef06a43611fc401a07337d5b006be13a30f6c58f869e3c3"},
- {file = "tomli-2.4.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:84d081fbc252d1b6a982e1870660e7330fb8f90f676f6e78b052ad4e64714bf0"},
- {file = "tomli-2.4.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:9a08144fa4cba33db5255f9b74f0b89888622109bd2776148f2597447f92a94e"},
- {file = "tomli-2.4.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c73add4bb52a206fd0c0723432db123c0c75c280cbd67174dd9d2db228ebb1b4"},
- {file = "tomli-2.4.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1fb2945cbe303b1419e2706e711b7113da57b7db31ee378d08712d678a34e51e"},
- {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:bbb1b10aa643d973366dc2cb1ad94f99c1726a02343d43cbc011edbfac579e7c"},
- {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:4cbcb367d44a1f0c2be408758b43e1ffb5308abe0ea222897d6bfc8e8281ef2f"},
- {file = "tomli-2.4.0-cp313-cp313-win32.whl", hash = "sha256:7d49c66a7d5e56ac959cb6fc583aff0651094ec071ba9ad43df785abc2320d86"},
- {file = "tomli-2.4.0-cp313-cp313-win_amd64.whl", hash = "sha256:3cf226acb51d8f1c394c1b310e0e0e61fecdd7adcb78d01e294ac297dd2e7f87"},
- {file = "tomli-2.4.0-cp313-cp313-win_arm64.whl", hash = "sha256:d20b797a5c1ad80c516e41bc1fb0443ddb5006e9aaa7bda2d71978346aeb9132"},
- {file = "tomli-2.4.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:26ab906a1eb794cd4e103691daa23d95c6919cc2fa9160000ac02370cc9dd3f6"},
- {file = "tomli-2.4.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:20cedb4ee43278bc4f2fee6cb50daec836959aadaf948db5172e776dd3d993fc"},
- {file = "tomli-2.4.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:39b0b5d1b6dd03684b3fb276407ebed7090bbec989fa55838c98560c01113b66"},
- {file = "tomli-2.4.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a26d7ff68dfdb9f87a016ecfd1e1c2bacbe3108f4e0f8bcd2228ef9a766c787d"},
- {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:20ffd184fb1df76a66e34bd1b36b4a4641bd2b82954befa32fe8163e79f1a702"},
- {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:75c2f8bbddf170e8effc98f5e9084a8751f8174ea6ccf4fca5398436e0320bc8"},
- {file = "tomli-2.4.0-cp314-cp314-win32.whl", hash = "sha256:31d556d079d72db7c584c0627ff3a24c5d3fb4f730221d3444f3efb1b2514776"},
- {file = "tomli-2.4.0-cp314-cp314-win_amd64.whl", hash = "sha256:43e685b9b2341681907759cf3a04e14d7104b3580f808cfde1dfdb60ada85475"},
- {file = "tomli-2.4.0-cp314-cp314-win_arm64.whl", hash = "sha256:3d895d56bd3f82ddd6faaff993c275efc2ff38e52322ea264122d72729dca2b2"},
- {file = "tomli-2.4.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:5b5807f3999fb66776dbce568cc9a828544244a8eb84b84b9bafc080c99597b9"},
- {file = "tomli-2.4.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c084ad935abe686bd9c898e62a02a19abfc9760b5a79bc29644463eaf2840cb0"},
- {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0f2e3955efea4d1cfbcb87bc321e00dc08d2bcb737fd1d5e398af111d86db5df"},
- {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0e0fe8a0b8312acf3a88077a0802565cb09ee34107813bba1c7cd591fa6cfc8d"},
- {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:413540dce94673591859c4c6f794dfeaa845e98bf35d72ed59636f869ef9f86f"},
- {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:0dc56fef0e2c1c470aeac5b6ca8cc7b640bb93e92d9803ddaf9ea03e198f5b0b"},
- {file = "tomli-2.4.0-cp314-cp314t-win32.whl", hash = "sha256:d878f2a6707cc9d53a1be1414bbb419e629c3d6e67f69230217bb663e76b5087"},
- {file = "tomli-2.4.0-cp314-cp314t-win_amd64.whl", hash = "sha256:2add28aacc7425117ff6364fe9e06a183bb0251b03f986df0e78e974047571fd"},
- {file = "tomli-2.4.0-cp314-cp314t-win_arm64.whl", hash = "sha256:2b1e3b80e1d5e52e40e9b924ec43d81570f0e7d09d11081b797bc4692765a3d4"},
- {file = "tomli-2.4.0-py3-none-any.whl", hash = "sha256:1f776e7d669ebceb01dee46484485f43a4048746235e683bcdffacdf1fb4785a"},
- {file = "tomli-2.4.0.tar.gz", hash = "sha256:aa89c3f6c277dd275d8e243ad24f3b5e701491a860d5121f2cdd399fbb31fc9c"},
+ {file = "tomli-2.4.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:f8f0fc26ec2cc2b965b7a3b87cd19c5c6b8c5e5f436b984e85f486d652285c30"},
+ {file = "tomli-2.4.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4ab97e64ccda8756376892c53a72bd1f964e519c77236368527f758fbc36a53a"},
+ {file = "tomli-2.4.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:96481a5786729fd470164b47cdb3e0e58062a496f455ee41b4403be77cb5a076"},
+ {file = "tomli-2.4.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5a881ab208c0baf688221f8cecc5401bd291d67e38a1ac884d6736cbcd8247e9"},
+ {file = "tomli-2.4.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:47149d5bd38761ac8be13a84864bf0b7b70bc051806bc3669ab1cbc56216b23c"},
+ {file = "tomli-2.4.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:ec9bfaf3ad2df51ace80688143a6a4ebc09a248f6ff781a9945e51937008fcbc"},
+ {file = "tomli-2.4.1-cp311-cp311-win32.whl", hash = "sha256:ff2983983d34813c1aeb0fa89091e76c3a22889ee83ab27c5eeb45100560c049"},
+ {file = "tomli-2.4.1-cp311-cp311-win_amd64.whl", hash = "sha256:5ee18d9ebdb417e384b58fe414e8d6af9f4e7a0ae761519fb50f721de398dd4e"},
+ {file = "tomli-2.4.1-cp311-cp311-win_arm64.whl", hash = "sha256:c2541745709bad0264b7d4705ad453b76ccd191e64aa6f0fc66b69a293a45ece"},
+ {file = "tomli-2.4.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:c742f741d58a28940ce01d58f0ab2ea3ced8b12402f162f4d534dfe18ba1cd6a"},
+ {file = "tomli-2.4.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7f86fd587c4ed9dd76f318225e7d9b29cfc5a9d43de44e5754db8d1128487085"},
+ {file = "tomli-2.4.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ff18e6a727ee0ab0388507b89d1bc6a22b138d1e2fa56d1ad494586d61d2eae9"},
+ {file = "tomli-2.4.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:136443dbd7e1dee43c68ac2694fde36b2849865fa258d39bf822c10e8068eac5"},
+ {file = "tomli-2.4.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:5e262d41726bc187e69af7825504c933b6794dc3fbd5945e41a79bb14c31f585"},
+ {file = "tomli-2.4.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:5cb41aa38891e073ee49d55fbc7839cfdb2bc0e600add13874d048c94aadddd1"},
+ {file = "tomli-2.4.1-cp312-cp312-win32.whl", hash = "sha256:da25dc3563bff5965356133435b757a795a17b17d01dbc0f42fb32447ddfd917"},
+ {file = "tomli-2.4.1-cp312-cp312-win_amd64.whl", hash = "sha256:52c8ef851d9a240f11a88c003eacb03c31fc1c9c4ec64a99a0f922b93874fda9"},
+ {file = "tomli-2.4.1-cp312-cp312-win_arm64.whl", hash = "sha256:f758f1b9299d059cc3f6546ae2af89670cb1c4d48ea29c3cacc4fe7de3058257"},
+ {file = "tomli-2.4.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:36d2bd2ad5fb9eaddba5226aa02c8ec3fa4f192631e347b3ed28186d43be6b54"},
+ {file = "tomli-2.4.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:eb0dc4e38e6a1fd579e5d50369aa2e10acfc9cace504579b2faabb478e76941a"},
+ {file = "tomli-2.4.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c7f2c7f2b9ca6bdeef8f0fa897f8e05085923eb091721675170254cbc5b02897"},
+ {file = "tomli-2.4.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:f3c6818a1a86dd6dca7ddcaaf76947d5ba31aecc28cb1b67009a5877c9a64f3f"},
+ {file = "tomli-2.4.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:d312ef37c91508b0ab2cee7da26ec0b3ed2f03ce12bd87a588d771ae15dcf82d"},
+ {file = "tomli-2.4.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:51529d40e3ca50046d7606fa99ce3956a617f9b36380da3b7f0dd3dd28e68cb5"},
+ {file = "tomli-2.4.1-cp313-cp313-win32.whl", hash = "sha256:2190f2e9dd7508d2a90ded5ed369255980a1bcdd58e52f7fe24b8162bf9fedbd"},
+ {file = "tomli-2.4.1-cp313-cp313-win_amd64.whl", hash = "sha256:8d65a2fbf9d2f8352685bc1364177ee3923d6baf5e7f43ea4959d7d8bc326a36"},
+ {file = "tomli-2.4.1-cp313-cp313-win_arm64.whl", hash = "sha256:4b605484e43cdc43f0954ddae319fb75f04cc10dd80d830540060ee7cd0243cd"},
+ {file = "tomli-2.4.1-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:fd0409a3653af6c147209d267a0e4243f0ae46b011aa978b1080359fddc9b6cf"},
+ {file = "tomli-2.4.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:a120733b01c45e9a0c34aeef92bf0cf1d56cfe81ed9d47d562f9ed591a9828ac"},
+ {file = "tomli-2.4.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:559db847dc486944896521f68d8190be1c9e719fced785720d2216fe7022b662"},
+ {file = "tomli-2.4.1-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:01f520d4f53ef97964a240a035ec2a869fe1a37dde002b57ebc4417a27ccd853"},
+ {file = "tomli-2.4.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:7f94b27a62cfad8496c8d2513e1a222dd446f095fca8987fceef261225538a15"},
+ {file = "tomli-2.4.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:ede3e6487c5ef5d28634ba3f31f989030ad6af71edfb0055cbbd14189ff240ba"},
+ {file = "tomli-2.4.1-cp314-cp314-win32.whl", hash = "sha256:3d48a93ee1c9b79c04bb38772ee1b64dcf18ff43085896ea460ca8dec96f35f6"},
+ {file = "tomli-2.4.1-cp314-cp314-win_amd64.whl", hash = "sha256:88dceee75c2c63af144e456745e10101eb67361050196b0b6af5d717254dddf7"},
+ {file = "tomli-2.4.1-cp314-cp314-win_arm64.whl", hash = "sha256:b8c198f8c1805dc42708689ed6864951fd2494f924149d3e4bce7710f8eb5232"},
+ {file = "tomli-2.4.1-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:d4d8fe59808a54658fcc0160ecfb1b30f9089906c50b23bcb4c69eddc19ec2b4"},
+ {file = "tomli-2.4.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:7008df2e7655c495dd12d2a4ad038ff878d4ca4b81fccaf82b714e07eae4402c"},
+ {file = "tomli-2.4.1-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1d8591993e228b0c930c4bb0db464bdad97b3289fb981255d6c9a41aedc84b2d"},
+ {file = "tomli-2.4.1-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:734e20b57ba95624ecf1841e72b53f6e186355e216e5412de414e3c51e5e3c41"},
+ {file = "tomli-2.4.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:8a650c2dbafa08d42e51ba0b62740dae4ecb9338eefa093aa5c78ceb546fcd5c"},
+ {file = "tomli-2.4.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:504aa796fe0569bb43171066009ead363de03675276d2d121ac1a4572397870f"},
+ {file = "tomli-2.4.1-cp314-cp314t-win32.whl", hash = "sha256:b1d22e6e9387bf4739fbe23bfa80e93f6b0373a7f1b96c6227c32bef95a4d7a8"},
+ {file = "tomli-2.4.1-cp314-cp314t-win_amd64.whl", hash = "sha256:2c1c351919aca02858f740c6d33adea0c5deea37f9ecca1cc1ef9e884a619d26"},
+ {file = "tomli-2.4.1-cp314-cp314t-win_arm64.whl", hash = "sha256:eab21f45c7f66c13f2a9e0e1535309cee140182a9cdae1e041d02e47291e8396"},
+ {file = "tomli-2.4.1-py3-none-any.whl", hash = "sha256:0d85819802132122da43cb86656f8d1f8c6587d54ae7dcaf30e90533028b49fe"},
+ {file = "tomli-2.4.1.tar.gz", hash = "sha256:7c7e1a961a0b2f2472c1ac5b69affa0ae1132c39adcb67aba98568702b9cc23f"},
]
[[package]]
diff --git a/pyproject.toml b/pyproject.toml
index 415e0dc6..883ca39a 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ dynamic = ["version"]
[tool.poetry]
name = "elevenlabs"
-version = "v2.40.0"
+version = "2.41.0"
description = ""
readme = "README.md"
authors = []
diff --git a/reference.md b/reference.md
index aaa8f3c4..98da58b3 100644
--- a/reference.md
+++ b/reference.md
@@ -1,69 +1,4 @@
# Reference
-client.delete_v_1_convai_agents_agent_id_branches_branch_id(...)
-
--
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.delete_v_1_convai_agents_agent_id_branches_branch_id(
- agent_id="agent_id",
- branch_id="branch_id",
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-
--
-
-**agent_id:** `str`
-
-
-
-
-
--
-
-**branch_id:** `str`
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.save_a_voice_preview()
-
@@ -946,6 +881,14 @@ Defaults to None.
-
+**avatar_context:** `typing.Optional[AvatarContextRequestModel]` — Avatar context when this generation is made from the Avatars video editor.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -1367,6 +1310,14 @@ Defaults to None.
-
+**avatar_context:** `typing.Optional[AvatarContextRequestModel]` — Avatar context when this generation is made from the Avatars video editor.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -1717,6 +1668,14 @@ client.text_to_dialogue.convert(
-
+**avatar_context:** `typing.Optional[AvatarContextRequestModel]` — Avatar context when this generation is made from the Avatars video editor.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -1854,6 +1813,14 @@ client.text_to_dialogue.stream(
-
+**avatar_context:** `typing.Optional[AvatarContextRequestModel]` — Avatar context when this generation is made from the Avatars video editor.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -4248,8 +4215,8 @@ long - produces podcasts longer than 7 minutes.
client.dubbing.list(...)
+## Music
+client.music.compose(...)
-
@@ -4261,7 +4228,7 @@ long - produces podcasts longer than 7 minutes.
-
-List the dubs you have access to.
+Compose a song from a prompt or a composition plan.
@@ -4281,13 +4248,7 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.dubbing.list(
- cursor="cursor",
- page_size=1,
- dubbing_status="dubbing",
- filter_by_creator="personal",
- order_direction="DESCENDING",
-)
+client.music.compose()
```
@@ -4303,7 +4264,7 @@ client.dubbing.list(
-
-**cursor:** `typing.Optional[str]` — Used for fetching next page. Cursor is returned in the response.
+**output_format:** `typing.Optional[AllowedOutputFormats]` — Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
@@ -4311,7 +4272,7 @@ client.dubbing.list(
-
-**page_size:** `typing.Optional[int]` — How many dubs to return at maximum. Can not exceed 200, defaults to 100.
+**prompt:** `typing.Optional[str]` — A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`.
@@ -4319,7 +4280,7 @@ client.dubbing.list(
-
-**dubbing_status:** `typing.Optional[DubbingListRequestDubbingStatus]` — What state the dub is currently in.
+**composition_plan:** `typing.Optional[MusicPrompt]` — A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`.
@@ -4327,7 +4288,7 @@ client.dubbing.list(
-
-**filter_by_creator:** `typing.Optional[DubbingListRequestFilterByCreator]` — Filters who created the resources being listed, whether it was the user running the request or someone else that shared the resource with them.
+**music_length_ms:** `typing.Optional[int]` — The length of the song to generate in milliseconds. Used only in conjunction with `prompt`. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt.
@@ -4335,7 +4296,7 @@ client.dubbing.list(
-
-**order_by:** `typing.Optional[typing.Literal["created_at"]]` — The field to use for ordering results from this query.
+**model_id:** `typing.Optional[typing.Literal["music_v1"]]` — The model to use for the generation.
@@ -4343,7 +4304,7 @@ client.dubbing.list(
-
-**order_direction:** `typing.Optional[DubbingListRequestOrderDirection]` — The order direction to use for results from this query.
+**seed:** `typing.Optional[int]` — Random seed to initialize the music generation process. Providing the same seed with the same parameters can help achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used in conjunction with prompt.
@@ -4351,7 +4312,39 @@ client.dubbing.list(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**force_instrumental:** `typing.Optional[bool]` — If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the `prompt`. Can only be used with `prompt`.
+
+
+
+
+
+-
+
+**respect_sections_durations:** `typing.Optional[bool]` — Controls how strictly section durations in the `composition_plan` are enforced. Only used with `composition_plan`. When set to true, the model will precisely respect each section's `duration_ms` from the plan. When set to false, the model may adjust individual section durations which will generally lead to better generation quality and improved latency, while always preserving the total song duration from the plan.
+
+
+
+
+
+-
+
+**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting feature.
+
+
+
+
+
+-
+
+**sign_with_c_2_pa:** `typing.Optional[bool]` — Whether to sign the generated song with C2PA. Applicable only for mp3 files.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -4363,7 +4356,7 @@ client.dubbing.list(
client.dubbing.create(...)
+client.music.compose_detailed(...)
-
@@ -4375,7 +4368,7 @@ client.dubbing.list(
-
-Dubs a provided audio or video file into given language.
+Compose a song from a prompt or a composition plan.
@@ -4395,7 +4388,7 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.dubbing.create()
+client.music.compose_detailed()
```
@@ -4411,9 +4404,7 @@ client.dubbing.create()
-
-**file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
+**output_format:** `typing.Optional[AllowedOutputFormats]` — Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
@@ -4421,9 +4412,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**csv_file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
+**prompt:** `typing.Optional[str]` — A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`.
@@ -4431,9 +4420,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**foreground_audio_file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
+**composition_plan:** `typing.Optional[MusicPrompt]` — A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`.
@@ -4441,9 +4428,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**background_audio_file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
+**music_length_ms:** `typing.Optional[int]` — The length of the song to generate in milliseconds. Used only in conjunction with `prompt`. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt.
@@ -4451,7 +4436,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**name:** `typing.Optional[str]` — Name of the dubbing project.
+**model_id:** `typing.Optional[typing.Literal["music_v1"]]` — The model to use for the generation.
@@ -4459,7 +4444,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**source_url:** `typing.Optional[str]` — URL of the source video/audio file.
+**seed:** `typing.Optional[int]` — Random seed to initialize the music generation process. Providing the same seed with the same parameters can help achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used in conjunction with prompt.
@@ -4467,7 +4452,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**source_lang:** `typing.Optional[str]` — Source language. Expects a valid iso639-1 or iso639-3 language code.
+**force_instrumental:** `typing.Optional[bool]` — If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the `prompt`. Can only be used with `prompt`.
@@ -4475,7 +4460,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**target_lang:** `typing.Optional[str]` — The Target language to dub the content into. Expects a valid iso639-1 or iso639-3 language code.
+**respect_sections_durations:** `typing.Optional[bool]` — Controls how strictly section durations in the `composition_plan` are enforced. Only used with `composition_plan`. When set to true, the model will precisely respect each section's `duration_ms` from the plan. When set to false, the model may adjust individual section durations which will generally lead to better generation quality and improved latency, while always preserving the total song duration from the plan.
@@ -4483,7 +4468,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**target_accent:** `typing.Optional[str]` — [Experimental] An accent to apply when selecting voices from the library and to use to inform translation of the dialect to prefer.
+**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting feature.
@@ -4491,7 +4476,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**num_speakers:** `typing.Optional[int]` — Number of speakers to use for the dubbing. Set to 0 to automatically detect the number of speakers
+**with_timestamps:** `typing.Optional[bool]` — Whether to return the timestamps of the words in the generated song.
@@ -4499,7 +4484,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**watermark:** `typing.Optional[bool]` — Whether to apply watermark to the output video.
+**sign_with_c_2_pa:** `typing.Optional[bool]` — Whether to sign the generated song with C2PA. Applicable only for mp3 files.
@@ -4507,31 +4492,67 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**start_time:** `typing.Optional[int]` — Start time of the source video/audio file.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+
+
+
+
+
+
+client.music.stream(...)
-
-**end_time:** `typing.Optional[int]` — End time of the source video/audio file.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Stream a composed song from a prompt or a composition plan.
+
+
+#### 🔌 Usage
+
-
-**highest_resolution:** `typing.Optional[bool]` — Whether to use the highest resolution available.
-
+
+-
+
+```python
+from elevenlabs import ElevenLabs
+
+client = ElevenLabs(
+ api_key="YOUR_API_KEY",
+)
+client.music.stream()
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**drop_background_audio:** `typing.Optional[bool]` — An advanced setting. Whether to drop background audio from the final dub. This can improve dub quality where it's known that audio shouldn't have a background track such as for speeches or monologues.
+
+-
+
+**output_format:** `typing.Optional[AllowedOutputFormats]` — Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
@@ -4539,7 +4560,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**use_profanity_filter:** `typing.Optional[bool]` — [BETA] Whether transcripts should have profanities censored with the words '[censored]'
+**prompt:** `typing.Optional[str]` — A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`.
@@ -4547,7 +4568,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**dubbing_studio:** `typing.Optional[bool]` — Whether to prepare dub for edits in dubbing studio or edits as a dubbing resource.
+**composition_plan:** `typing.Optional[MusicPrompt]` — A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`.
@@ -4555,7 +4576,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**disable_voice_cloning:** `typing.Optional[bool]` — Instead of using a voice clone in dubbing, use a similar voice from the ElevenLabs Voice Library. Voices used from the library will contribute towards a workspace's custom voices limit, and if there aren't enough available slots the dub will fail. Using this feature requires the caller to have the 'add_voice_from_voice_library' permission on their workspace to access new voices.
+**music_length_ms:** `typing.Optional[int]` — The length of the song to generate in milliseconds. Used only in conjunction with `prompt`. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt.
@@ -4563,7 +4584,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**mode:** `typing.Optional[DubbingCreateRequestMode]` — The mode in which to run this Dubbing job. Defaults to automatic, use manual if specifically providing a CSV transcript to use. Note that manual mode is experimental and production use is strongly discouraged.
+**model_id:** `typing.Optional[typing.Literal["music_v1"]]` — The model to use for the generation.
@@ -4571,7 +4592,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**csv_fps:** `typing.Optional[float]` — Frames per second to use when parsing a CSV file for dubbing. If not provided, FPS will be inferred from timecodes.
+**seed:** `typing.Optional[int]` — Random seed to initialize the music generation process. Providing the same seed with the same parameters can help achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used in conjunction with prompt.
@@ -4579,31 +4600,47 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**force_instrumental:** `typing.Optional[bool]` — If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the `prompt`. Can only be used with `prompt`.
-
-
+
+-
+**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting feature.
+
-
client.dubbing.get(...)
-
-#### 📝 Description
-
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+
+
+
+
+
+
+
+
+
+client.music.upload(...)
-
+#### 📝 Description
+
-
-Returns metadata about a dubbing project, including whether it's still in progress or not
+
+-
+
+Upload a music file to be later used for inpainting. Only available to enterprise clients with access to the inpainting feature.
@@ -4623,9 +4660,7 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.dubbing.get(
- dubbing_id="dubbing_id",
-)
+client.music.upload()
```
@@ -4641,7 +4676,17 @@ client.dubbing.get(
-
-**dubbing_id:** `str` — ID of the dubbing project.
+**file:** `from __future__ import annotations
+
+core.File` — See core.File for more documentation
+
+
+
+
+
+-
+
+**extract_composition_plan:** `typing.Optional[bool]` — Whether to generate and return the composition plan for the uploaded song. If True, the response will include the composition_plan but will increase the latency.
@@ -4661,7 +4706,8 @@ client.dubbing.get(
client.dubbing.delete(...)
+## Dubbing
+client.dubbing.list(...)
-
@@ -4673,7 +4719,7 @@ client.dubbing.get(
-
-Deletes a dubbing project.
+List the dubs you have access to.
@@ -4693,8 +4739,12 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.dubbing.delete(
- dubbing_id="dubbing_id",
+client.dubbing.list(
+ cursor="cursor",
+ page_size=1,
+ dubbing_status="dubbing",
+ filter_by_creator="personal",
+ order_direction="DESCENDING",
)
```
@@ -4711,7 +4761,7 @@ client.dubbing.delete(
-
-**dubbing_id:** `str` — ID of the dubbing project.
+**cursor:** `typing.Optional[str]` — Used for fetching next page. Cursor is returned in the response.
@@ -4719,64 +4769,43 @@ client.dubbing.delete(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**page_size:** `typing.Optional[int]` — How many dubs to return at maximum. Can not exceed 200, defaults to 100.
-
-
+
+-
+**dubbing_status:** `typing.Optional[DubbingListRequestDubbingStatus]` — What state the dub is currently in.
+
-client.models.list()
-
-#### 📝 Description
-
-
--
+**filter_by_creator:** `typing.Optional[DubbingListRequestFilterByCreator]` — Filters who created the resources being listed, whether it was the user running the request or someone else that shared the resource with them.
+
+
+
-
-Gets a list of available models.
-
-
+**order_by:** `typing.Optional[typing.Literal["created_at"]]` — The field to use for ordering results from this query.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.models.list()
-
-```
-
-
+**order_direction:** `typing.Optional[DubbingListRequestOrderDirection]` — The order direction to use for results from this query.
+
-#### ⚙️ Parameters
-
-
--
-
-
@@ -4792,8 +4821,7 @@ client.models.list()
client.audio_native.create(...)
+client.dubbing.create(...)
-
@@ -4805,7 +4833,7 @@ client.models.list()
-
-Creates Audio Native enabled project, optionally starts conversion and returns project ID and embeddable HTML snippet.
+Dubs a provided audio or video file into given language.
@@ -4825,9 +4853,7 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.audio_native.create(
- name="name",
-)
+client.dubbing.create()
```
@@ -4843,7 +4869,9 @@ client.audio_native.create(
-
-**name:** `str` — Project name.
+**file:** `from __future__ import annotations
+
+typing.Optional[core.File]` — See core.File for more documentation
@@ -4851,7 +4879,9 @@ client.audio_native.create(
-
-**image:** `typing.Optional[str]` — (Deprecated) Image URL used in the player. If not provided, default image set in the Player settings is used.
+**csv_file:** `from __future__ import annotations
+
+typing.Optional[core.File]` — See core.File for more documentation
@@ -4859,7 +4889,9 @@ client.audio_native.create(
-
-**author:** `typing.Optional[str]` — Author used in the player and inserted at the start of the uploaded article. If not provided, the default author set in the Player settings is used.
+**foreground_audio_file:** `from __future__ import annotations
+
+typing.Optional[core.File]` — See core.File for more documentation
@@ -4867,7 +4899,9 @@ client.audio_native.create(
-
-**title:** `typing.Optional[str]` — Title used in the player and inserted at the top of the uploaded article. If not provided, the default title set in the Player settings is used.
+**background_audio_file:** `from __future__ import annotations
+
+typing.Optional[core.File]` — See core.File for more documentation
@@ -4875,7 +4909,7 @@ client.audio_native.create(
-
-**small:** `typing.Optional[bool]` — (Deprecated) Whether to use small player or not. If not provided, default value set in the Player settings is used.
+**name:** `typing.Optional[str]` — Name of the dubbing project.
@@ -4883,7 +4917,7 @@ client.audio_native.create(
-
-**text_color:** `typing.Optional[str]` — Text color used in the player. If not provided, default text color set in the Player settings is used.
+**source_url:** `typing.Optional[str]` — URL of the source video/audio file.
@@ -4891,7 +4925,7 @@ client.audio_native.create(
-
-**background_color:** `typing.Optional[str]` — Background color used in the player. If not provided, default background color set in the Player settings is used.
+**source_lang:** `typing.Optional[str]` — Source language. Expects a valid iso639-1 or iso639-3 language code.
@@ -4899,7 +4933,7 @@ client.audio_native.create(
-
-**sessionization:** `typing.Optional[int]` — (Deprecated) Specifies for how many minutes to persist the session across page reloads. If not provided, default sessionization set in the Player settings is used.
+**target_lang:** `typing.Optional[str]` — The Target language to dub the content into. Expects a valid iso639-1 or iso639-3 language code.
@@ -4907,7 +4941,7 @@ client.audio_native.create(
-
-**voice_id:** `typing.Optional[str]` — Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used.
+**target_accent:** `typing.Optional[str]` — [Experimental] An accent to apply when selecting voices from the library and to use to inform translation of the dialect to prefer.
@@ -4915,7 +4949,7 @@ client.audio_native.create(
-
-**model_id:** `typing.Optional[str]` — TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used.
+**num_speakers:** `typing.Optional[int]` — Number of speakers to use for the dubbing. Set to 0 to automatically detect the number of speakers
@@ -4923,9 +4957,15 @@ client.audio_native.create(
-
-**file:** `from __future__ import annotations
+**watermark:** `typing.Optional[bool]` — Whether to apply watermark to the output video.
+
+
+
-typing.Optional[core.File]` — See core.File for more documentation
+
+-
+
+**start_time:** `typing.Optional[int]` — Start time of the source video/audio file.
@@ -4933,7 +4973,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**auto_convert:** `typing.Optional[bool]` — Whether to auto convert the project to audio or not.
+**end_time:** `typing.Optional[int]` — End time of the source video/audio file.
@@ -4941,14 +4981,31 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**apply_text_normalization:** `typing.Optional[AudioNativeCreateRequestApplyTextNormalization]`
+**highest_resolution:** `typing.Optional[bool]` — Whether to use the highest resolution available.
+
+
+
+
+-
- This parameter controls text normalization with four modes: 'auto', 'on', 'apply_english' and 'off'.
- When set to 'auto', the system will automatically decide whether to apply text normalization
- (e.g., spelling out numbers). With 'on', text normalization will always be applied, while
- with 'off', it will be skipped. 'apply_english' is the same as 'on' but will assume that text is in English.
+**drop_background_audio:** `typing.Optional[bool]` — An advanced setting. Whether to drop background audio from the final dub. This can improve dub quality where it's known that audio shouldn't have a background track such as for speeches or monologues.
+
+
+
+
+
+-
+
+**use_profanity_filter:** `typing.Optional[bool]` — [BETA] Whether transcripts should have profanities censored with the words '[censored]'
+
+
+
+
+-
+
+**dubbing_studio:** `typing.Optional[bool]` — Whether to prepare dub for edits in dubbing studio or edits as a dubbing resource.
@@ -4956,7 +5013,23 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**pronunciation_dictionary_locators:** `typing.Optional[typing.List[str]]` — 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\"}"'.
+**disable_voice_cloning:** `typing.Optional[bool]` — Instead of using a voice clone in dubbing, use a similar voice from the ElevenLabs Voice Library. Voices used from the library will contribute towards a workspace's custom voices limit, and if there aren't enough available slots the dub will fail. Using this feature requires the caller to have the 'add_voice_from_voice_library' permission on their workspace to access new voices.
+
+
+
+
+
+-
+
+**mode:** `typing.Optional[DubbingCreateRequestMode]` — The mode in which to run this Dubbing job. Defaults to automatic, use manual if specifically providing a CSV transcript to use. Note that manual mode is experimental and production use is strongly discouraged.
+
+
+
+
+
+-
+
+**csv_fps:** `typing.Optional[float]` — Frames per second to use when parsing a CSV file for dubbing. If not provided, FPS will be inferred from timecodes.
@@ -4976,7 +5049,7 @@ typing.Optional[core.File]` — See core.File for more documentation
client.audio_native.get_settings(...)
+client.dubbing.get(...)
-
@@ -4988,7 +5061,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-Get player settings for the specific project.
+Returns metadata about a dubbing project, including whether it's still in progress or not
@@ -5008,8 +5081,8 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.audio_native.get_settings(
- project_id="21m00Tcm4TlvDq8ikWAM",
+client.dubbing.get(
+ dubbing_id="dubbing_id",
)
```
@@ -5026,7 +5099,7 @@ client.audio_native.get_settings(
-
-**project_id:** `str` — The ID of the Studio project.
+**dubbing_id:** `str` — ID of the dubbing project.
@@ -5046,7 +5119,7 @@ client.audio_native.get_settings(
client.audio_native.update(...)
+client.dubbing.delete(...)
-
@@ -5058,7 +5131,7 @@ client.audio_native.get_settings(
-
-Updates content for the specific AudioNative Project.
+Deletes a dubbing project.
@@ -5078,8 +5151,8 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.audio_native.update(
- project_id="21m00Tcm4TlvDq8ikWAM",
+client.dubbing.delete(
+ dubbing_id="dubbing_id",
)
```
@@ -5096,33 +5169,7 @@ client.audio_native.update(
-
-**project_id:** `str` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
-
-
-
-
-
--
-
-**file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
-
-
-
-
-
--
-
-**auto_convert:** `typing.Optional[bool]` — Whether to auto convert the project to audio or not.
-
-
-
-
-
--
-
-**auto_publish:** `typing.Optional[bool]` — Whether to auto publish the new project snapshot after it's converted.
+**dubbing_id:** `str` — ID of the dubbing project.
@@ -5142,7 +5189,8 @@ typing.Optional[core.File]` — See core.File for more documentation
client.audio_native.update_content_from_url(...)
+## Models
+client.models.list()
-
@@ -5154,7 +5202,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-Finds an AudioNative project matching the provided URL, extracts content from the URL, updates the project content, and queues it for conversion and auto-publishing.
+Gets a list of available models.
@@ -5174,9 +5222,7 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.audio_native.update_content_from_url(
- url="https://elevenlabs.io/blog/the_first_ai_that_can_laugh/",
-)
+client.models.list()
```
@@ -5192,44 +5238,20 @@ client.audio_native.update_content_from_url(
-
-**url:** `str` — URL of the page to extract content from.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**author:** `typing.Optional[str]` — Author used in the player and inserted at the start of the uploaded article. If not provided, the default author set in the Player settings is used.
-
+
--
-
-**title:** `typing.Optional[str]` — Title used in the player and inserted at the top of the uploaded article. If not provided, the default title set in the Player settings is used.
-
-
-
-
-
--
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
-
-
-
-
-
-
-
-client.usage.get(...)
+## AudioNative
+client.audio_native.create(...)
-
@@ -5241,7 +5263,7 @@ client.audio_native.update_content_from_url(
-
-Returns the usage metrics for the current user or the entire workspace they are part of. The response provides a time axis based on the specified aggregation interval (default: day), with usage values for each interval along that axis. Usage is broken down by the selected breakdown type. For example, breakdown type "voice" will return the usage of each voice for each interval along the time axis.
+Creates Audio Native enabled project, optionally starts conversion and returns project ID and embeddable HTML snippet.
@@ -5261,14 +5283,8 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.usage.get(
- start_unix=1,
- end_unix=1,
- include_workspace_metrics=True,
- breakdown_type="none",
- aggregation_interval="hour",
- aggregation_bucket_size=1,
- metric="credits",
+client.audio_native.create(
+ name="name",
)
```
@@ -5285,7 +5301,7 @@ client.usage.get(
-
-**start_unix:** `int` — UTC Unix timestamp for the start of the usage window, in milliseconds. To include the first day of the window, the timestamp should be at 00:00:00 of that day.
+**name:** `str` — Project name.
@@ -5293,7 +5309,7 @@ client.usage.get(
-
-**end_unix:** `int` — UTC Unix timestamp for the end of the usage window, in milliseconds. To include the last day of the window, the timestamp should be at 23:59:59 of that day.
+**image:** `typing.Optional[str]` — (Deprecated) Image URL used in the player. If not provided, default image set in the Player settings is used.
@@ -5301,7 +5317,7 @@ client.usage.get(
-
-**include_workspace_metrics:** `typing.Optional[bool]` — Whether or not to include the statistics of the entire workspace.
+**author:** `typing.Optional[str]` — Author used in the player and inserted at the start of the uploaded article. If not provided, the default author set in the Player settings is used.
@@ -5309,7 +5325,7 @@ client.usage.get(
-
-**breakdown_type:** `typing.Optional[BreakdownTypes]` — How to break down the information. Cannot be "user" if include_workspace_metrics is False.
+**title:** `typing.Optional[str]` — Title used in the player and inserted at the top of the uploaded article. If not provided, the default title set in the Player settings is used.
@@ -5317,7 +5333,7 @@ client.usage.get(
-
-**aggregation_interval:** `typing.Optional[UsageAggregationInterval]` — How to aggregate usage data over time. Can be "hour", "day", "week", "month", or "cumulative".
+**small:** `typing.Optional[bool]` — (Deprecated) Whether to use small player or not. If not provided, default value set in the Player settings is used.
@@ -5325,7 +5341,7 @@ client.usage.get(
-
-**aggregation_bucket_size:** `typing.Optional[int]` — Aggregation bucket size in seconds. Overrides the aggregation interval.
+**text_color:** `typing.Optional[str]` — Text color used in the player. If not provided, default text color set in the Player settings is used.
@@ -5333,7 +5349,7 @@ client.usage.get(
-
-**metric:** `typing.Optional[MetricType]` — Which metric to aggregate.
+**background_color:** `typing.Optional[str]` — Background color used in the player. If not provided, default background color set in the Player settings is used.
@@ -5341,70 +5357,33 @@ client.usage.get(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**sessionization:** `typing.Optional[int]` — (Deprecated) Specifies for how many minutes to persist the session across page reloads. If not provided, default sessionization set in the Player settings is used.
-
-
-
-
-
-
-client.pronunciation_dictionaries.create_from_file(...)
-
--
-
-#### 📝 Description
-
-
--
-
-Creates a new pronunciation dictionary from a lexicon .PLS file
-
-
+**voice_id:** `typing.Optional[str]` — Voice ID used to voice the content. If not provided, default voice ID set in the Player settings is used.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.pronunciation_dictionaries.create_from_file(
- name="name",
-)
-
-```
-
-
+**model_id:** `typing.Optional[str]` — TTS Model ID used in the player. If not provided, default model ID set in the Player settings is used.
+
-#### ⚙️ Parameters
-
-
-
--
+**file:** `from __future__ import annotations
-**name:** `str` — The name of the pronunciation dictionary, used for identification only.
+typing.Optional[core.File]` — See core.File for more documentation
@@ -5412,9 +5391,7 @@ client.pronunciation_dictionaries.create_from_file(
-
-**file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
+**auto_convert:** `typing.Optional[bool]` — Whether to auto convert the project to audio or not.
@@ -5422,7 +5399,14 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**description:** `typing.Optional[str]` — A description of the pronunciation dictionary, used for identification only.
+**apply_text_normalization:** `typing.Optional[AudioNativeCreateRequestApplyTextNormalization]`
+
+
+ This parameter controls text normalization with four modes: 'auto', 'on', 'apply_english' and 'off'.
+ When set to 'auto', the system will automatically decide whether to apply text normalization
+ (e.g., spelling out numbers). With 'on', text normalization will always be applied, while
+ with 'off', it will be skipped. 'apply_english' is the same as 'on' but will assume that text is in English.
+
@@ -5430,7 +5414,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**workspace_access:** `typing.Optional[PronunciationDictionariesCreateFromFileRequestWorkspaceAccess]` — Should be one of 'admin', 'editor' or 'viewer'. If not provided, defaults to no access.
+**pronunciation_dictionary_locators:** `typing.Optional[typing.List[str]]` — 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\"}"'.
@@ -5450,7 +5434,7 @@ typing.Optional[core.File]` — See core.File for more documentation
client.pronunciation_dictionaries.create_from_rules(...)
+client.audio_native.get_settings(...)
-
@@ -5462,7 +5446,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-Creates a new pronunciation dictionary from provided rules.
+Get player settings for the specific project.
@@ -5478,23 +5462,12 @@ Creates a new pronunciation dictionary from provided rules.
```python
from elevenlabs import ElevenLabs
-from elevenlabs.pronunciation_dictionaries import (
- BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem_Alias,
-)
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.pronunciation_dictionaries.create_from_rules(
- rules=[
- BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem_Alias(
- string_to_replace="Thailand",
- case_sensitive=True,
- word_boundaries=True,
- alias="tie-land",
- )
- ],
- name="My Dictionary",
+client.audio_native.get_settings(
+ project_id="21m00Tcm4TlvDq8ikWAM",
)
```
@@ -5511,39 +5484,7 @@ client.pronunciation_dictionaries.create_from_rules(
-
-**rules:** `typing.Sequence[
- BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem
-]`
-
-List of pronunciation rules. Rule can be either:
- an alias rule: {'string_to_replace': 'a', 'type': 'alias', 'alias': 'b', }
- or a phoneme rule: {'string_to_replace': 'a', 'type': 'phoneme', 'phoneme': 'b', 'alphabet': 'ipa' }
-
-
-
-
-
--
-
-**name:** `str` — The name of the pronunciation dictionary, used for identification only.
-
-
-
-
-
--
-
-**description:** `typing.Optional[str]` — A description of the pronunciation dictionary, used for identification only.
-
-
-
-
-
--
-
-**workspace_access:** `typing.Optional[
- BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostWorkspaceAccess
-]` — Should be one of 'admin', 'editor' or 'viewer'. If not provided, defaults to no access.
+**project_id:** `str` — The ID of the Studio project.
@@ -5563,7 +5504,7 @@ List of pronunciation rules. Rule can be either:
client.pronunciation_dictionaries.get(...)
+client.audio_native.update(...)
-
@@ -5575,7 +5516,7 @@ List of pronunciation rules. Rule can be either:
-
-Get metadata for a pronunciation dictionary
+Updates content for the specific AudioNative Project.
@@ -5595,8 +5536,8 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.pronunciation_dictionaries.get(
- pronunciation_dictionary_id="21m00Tcm4TlvDq8ikWAM",
+client.audio_native.update(
+ project_id="21m00Tcm4TlvDq8ikWAM",
)
```
@@ -5613,7 +5554,33 @@ client.pronunciation_dictionaries.get(
-
-**pronunciation_dictionary_id:** `str` — The id of the pronunciation dictionary
+**project_id:** `str` — The ID of the project to be used. You can use the [List projects](/docs/api-reference/studio/get-projects) endpoint to list all the available projects.
+
+
+
+
+
+-
+
+**file:** `from __future__ import annotations
+
+typing.Optional[core.File]` — See core.File for more documentation
+
+
+
+
+
+-
+
+**auto_convert:** `typing.Optional[bool]` — Whether to auto convert the project to audio or not.
+
+
+
+
+
+-
+
+**auto_publish:** `typing.Optional[bool]` — Whether to auto publish the new project snapshot after it's converted.
@@ -5633,7 +5600,7 @@ client.pronunciation_dictionaries.get(
client.pronunciation_dictionaries.update(...)
+client.audio_native.update_content_from_url(...)
-
@@ -5645,7 +5612,7 @@ client.pronunciation_dictionaries.get(
-
-Partially update the pronunciation dictionary without changing the version
+Finds an AudioNative project matching the provided URL, extracts content from the URL, updates the project content, and queues it for conversion and auto-publishing.
@@ -5665,8 +5632,8 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.pronunciation_dictionaries.update(
- pronunciation_dictionary_id="21m00Tcm4TlvDq8ikWAM",
+client.audio_native.update_content_from_url(
+ url="https://elevenlabs.io/blog/the_first_ai_that_can_laugh/",
)
```
@@ -5683,7 +5650,7 @@ client.pronunciation_dictionaries.update(
-
-**pronunciation_dictionary_id:** `str` — The id of the pronunciation dictionary
+**url:** `str` — URL of the page to extract content from.
@@ -5691,7 +5658,7 @@ client.pronunciation_dictionaries.update(
-
-**archived:** `typing.Optional[bool]` — Whether to archive the pronunciation dictionary.
+**author:** `typing.Optional[str]` — Author used in the player and inserted at the start of the uploaded article. If not provided, the default author set in the Player settings is used.
@@ -5699,7 +5666,7 @@ client.pronunciation_dictionaries.update(
-
-**name:** `typing.Optional[str]` — The name of the pronunciation dictionary, used for identification only.
+**title:** `typing.Optional[str]` — Title used in the player and inserted at the top of the uploaded article. If not provided, the default title set in the Player settings is used.
@@ -5719,7 +5686,8 @@ client.pronunciation_dictionaries.update(
client.pronunciation_dictionaries.download(...)
+## Usage
+client.usage.get(...)
-
@@ -5731,7 +5699,7 @@ client.pronunciation_dictionaries.update(
-
-Get a PLS file with a pronunciation dictionary version rules
+Returns the usage metrics for the current user or the entire workspace they are part of. The response provides a time axis based on the specified aggregation interval (default: day), with usage values for each interval along that axis. Usage is broken down by the selected breakdown type. For example, breakdown type "voice" will return the usage of each voice for each interval along the time axis.
@@ -5751,9 +5719,14 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.pronunciation_dictionaries.download(
- dictionary_id="dictionary_id",
- version_id="version_id",
+client.usage.get(
+ start_unix=1,
+ end_unix=1,
+ include_workspace_metrics=True,
+ breakdown_type="none",
+ aggregation_interval="hour",
+ aggregation_bucket_size=1,
+ metric="credits",
)
```
@@ -5770,7 +5743,7 @@ client.pronunciation_dictionaries.download(
-
-**dictionary_id:** `str` — The id of the pronunciation dictionary
+**start_unix:** `int` — UTC Unix timestamp for the start of the usage window, in milliseconds. To include the first day of the window, the timestamp should be at 00:00:00 of that day.
@@ -5778,7 +5751,7 @@ client.pronunciation_dictionaries.download(
-
-**version_id:** `str` — The id of the pronunciation dictionary version
+**end_unix:** `int` — UTC Unix timestamp for the end of the usage window, in milliseconds. To include the last day of the window, the timestamp should be at 23:59:59 of that day.
@@ -5786,19 +5759,60 @@ client.pronunciation_dictionaries.download(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+**include_workspace_metrics:** `typing.Optional[bool]` — Whether or not to include the statistics of the entire workspace.
+
+
+-
+
+**breakdown_type:** `typing.Optional[BreakdownTypes]` — How to break down the information. Cannot be "user" if include_workspace_metrics is False.
+
+
+-
+**aggregation_interval:** `typing.Optional[UsageAggregationInterval]` — How to aggregate usage data over time. Can be "hour", "day", "week", "month", or "cumulative".
+
-
client.pronunciation_dictionaries.list(...)
+
+-
+
+**aggregation_bucket_size:** `typing.Optional[int]` — Aggregation bucket size in seconds. Overrides the aggregation interval.
+
+
+
+
+
+-
+
+**metric:** `typing.Optional[MetricType]` — Which metric to aggregate.
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+
+
+
+client.pronunciation_dictionaries.create_from_file(...)
-
@@ -5810,7 +5824,7 @@ client.pronunciation_dictionaries.download(
-
-Get a list of the pronunciation dictionaries you have access to and their metadata
+Creates a new pronunciation dictionary from a lexicon .PLS file
@@ -5830,11 +5844,8 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.pronunciation_dictionaries.list(
- cursor="cursor",
- page_size=1,
- sort="creation_time_unix",
- sort_direction="sort_direction",
+client.pronunciation_dictionaries.create_from_file(
+ name="name",
)
```
@@ -5851,7 +5862,7 @@ client.pronunciation_dictionaries.list(
-
-**cursor:** `typing.Optional[str]` — Used for fetching next page. Cursor is returned in the response.
+**name:** `str` — The name of the pronunciation dictionary, used for identification only.
@@ -5859,7 +5870,9 @@ client.pronunciation_dictionaries.list(
-
-**page_size:** `typing.Optional[int]` — How many pronunciation dictionaries to return at maximum. Can not exceed 100, defaults to 30.
+**file:** `from __future__ import annotations
+
+typing.Optional[core.File]` — See core.File for more documentation
@@ -5867,7 +5880,7 @@ client.pronunciation_dictionaries.list(
-
-**sort:** `typing.Optional[PronunciationDictionariesListRequestSort]` — Which field to sort by, one of 'created_at_unix' or 'name'.
+**description:** `typing.Optional[str]` — A description of the pronunciation dictionary, used for identification only.
@@ -5875,7 +5888,7 @@ client.pronunciation_dictionaries.list(
-
-**sort_direction:** `typing.Optional[str]` — Which direction to sort the voices in. 'ascending' or 'descending'.
+**workspace_access:** `typing.Optional[PronunciationDictionariesCreateFromFileRequestWorkspaceAccess]` — Should be one of 'admin', 'editor' or 'viewer'. If not provided, defaults to no access.
@@ -5895,8 +5908,7 @@ client.pronunciation_dictionaries.list(
client.service_accounts.list()
+client.pronunciation_dictionaries.create_from_rules(...)
-
@@ -5908,7 +5920,7 @@ client.pronunciation_dictionaries.list(
-
-List all service accounts in the workspace
+Creates a new pronunciation dictionary from provided rules.
@@ -5924,11 +5936,24 @@ List all service accounts in the workspace
```python
from elevenlabs import ElevenLabs
+from elevenlabs.pronunciation_dictionaries import (
+ BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem_Alias,
+)
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.service_accounts.list()
+client.pronunciation_dictionaries.create_from_rules(
+ rules=[
+ BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem_Alias(
+ string_to_replace="Thailand",
+ case_sensitive=True,
+ word_boundaries=True,
+ alias="tie-land",
+ )
+ ],
+ name="My Dictionary",
+)
```
@@ -5944,6 +5969,46 @@ client.service_accounts.list()
-
+**rules:** `typing.Sequence[
+ BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostRulesItem
+]`
+
+List of pronunciation rules. Rule can be either:
+ an alias rule: {'string_to_replace': 'a', 'type': 'alias', 'alias': 'b', }
+ or a phoneme rule: {'string_to_replace': 'a', 'type': 'phoneme', 'phoneme': 'b', 'alphabet': 'ipa' }
+
+
+
+
+
+-
+
+**name:** `str` — The name of the pronunciation dictionary, used for identification only.
+
+
+
+
+
+-
+
+**description:** `typing.Optional[str]` — A description of the pronunciation dictionary, used for identification only.
+
+
+
+
+
+-
+
+**workspace_access:** `typing.Optional[
+ BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPostWorkspaceAccess
+]` — Should be one of 'admin', 'editor' or 'viewer'. If not provided, defaults to no access.
+
+
+
+
+
+-
+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -5956,8 +6021,7 @@ client.service_accounts.list()
client.webhooks.list(...)
+client.pronunciation_dictionaries.get(...)
-
@@ -5969,7 +6033,7 @@ client.service_accounts.list()
-
-List all webhooks for a workspace
+Get metadata for a pronunciation dictionary
@@ -5989,8 +6053,8 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.webhooks.list(
- include_usages=False,
+client.pronunciation_dictionaries.get(
+ pronunciation_dictionary_id="21m00Tcm4TlvDq8ikWAM",
)
```
@@ -6007,7 +6071,7 @@ client.webhooks.list(
-
-**include_usages:** `typing.Optional[bool]` — Whether to include active usages of the webhook, only usable by admins
+**pronunciation_dictionary_id:** `str` — The id of the pronunciation dictionary
@@ -6027,7 +6091,7 @@ client.webhooks.list(
client.webhooks.create(...)
+client.pronunciation_dictionaries.update(...)
-
@@ -6039,7 +6103,7 @@ client.webhooks.list(
-
-Create a new webhook for the workspace with the specified authentication type.
+Partially update the pronunciation dictionary without changing the version
@@ -6054,16 +6118,13 @@ Create a new webhook for the workspace with the specified authentication type.
-
```python
-from elevenlabs import ElevenLabs, WebhookHmacSettings
+from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.webhooks.create(
- settings=WebhookHmacSettings(
- name="name",
- webhook_url="webhook_url",
- ),
+client.pronunciation_dictionaries.update(
+ pronunciation_dictionary_id="21m00Tcm4TlvDq8ikWAM",
)
```
@@ -6080,7 +6141,23 @@ client.webhooks.create(
-
-**settings:** `WebhookHmacSettings` — Webhook settings object containing auth_type and corresponding configuration
+**pronunciation_dictionary_id:** `str` — The id of the pronunciation dictionary
+
+
+
+
+
+-
+
+**archived:** `typing.Optional[bool]` — Whether to archive the pronunciation dictionary.
+
+
+
+
+
+-
+
+**name:** `typing.Optional[str]` — The name of the pronunciation dictionary, used for identification only.
@@ -6100,7 +6177,7 @@ client.webhooks.create(
client.webhooks.delete(...)
+client.pronunciation_dictionaries.download(...)
-
@@ -6112,7 +6189,7 @@ client.webhooks.create(
-
-Delete the specified workspace webhook
+Get a PLS file with a pronunciation dictionary version rules
@@ -6132,8 +6209,9 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.webhooks.delete(
- webhook_id="G007vmtq9uWYl7SUW9zGS8GZZa1K",
+client.pronunciation_dictionaries.download(
+ dictionary_id="dictionary_id",
+ version_id="version_id",
)
```
@@ -6150,7 +6228,7 @@ client.webhooks.delete(
-
-**webhook_id:** `str` — The unique ID for the webhook
+**dictionary_id:** `str` — The id of the pronunciation dictionary
@@ -6158,7 +6236,15 @@ client.webhooks.delete(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**version_id:** `str` — The id of the pronunciation dictionary version
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
@@ -6170,7 +6256,7 @@ client.webhooks.delete(
client.webhooks.update(...)
+client.pronunciation_dictionaries.list(...)
-
@@ -6182,7 +6268,7 @@ client.webhooks.delete(
-
-Update the specified workspace webhook
+Get a list of the pronunciation dictionaries you have access to and their metadata
@@ -6202,10 +6288,11 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.webhooks.update(
- webhook_id="G007vmtq9uWYl7SUW9zGS8GZZa1K",
- is_disabled=True,
- name="My Callback Webhook",
+client.pronunciation_dictionaries.list(
+ cursor="cursor",
+ page_size=1,
+ sort="creation_time_unix",
+ sort_direction="sort_direction",
)
```
@@ -6222,7 +6309,7 @@ client.webhooks.update(
-
-**webhook_id:** `str` — The unique ID for the webhook
+**cursor:** `typing.Optional[str]` — Used for fetching next page. Cursor is returned in the response.
@@ -6230,7 +6317,7 @@ client.webhooks.update(
-
-**is_disabled:** `bool` — Whether to disable or enable the webhook
+**page_size:** `typing.Optional[int]` — How many pronunciation dictionaries to return at maximum. Can not exceed 100, defaults to 30.
@@ -6238,7 +6325,7 @@ client.webhooks.update(
-
-**name:** `str` — The display name of the webhook (used for display purposes only).
+**sort:** `typing.Optional[PronunciationDictionariesListRequestSort]` — Which field to sort by, one of 'created_at_unix' or 'name'.
@@ -6246,7 +6333,7 @@ client.webhooks.update(
-
-**retry_enabled:** `typing.Optional[bool]` — Whether to enable automatic retries for transient failures (5xx, 429, timeout)
+**sort_direction:** `typing.Optional[str]` — Which direction to sort the voices in. 'ascending' or 'descending'.
@@ -6266,8 +6353,8 @@ client.webhooks.update(
client.speech_to_text.convert(...)
+## ServiceAccounts
+client.service_accounts.list()
-
@@ -6279,7 +6366,7 @@ client.webhooks.update(
-
-Transcribe an audio or video file. If webhook is set to true, the request will be processed asynchronously and results sent to configured webhooks. When use_multi_channel is true and the provided audio has multiple channels, a 'transcripts' object with separate transcripts for each channel is returned. Otherwise, returns a single transcript. The optional webhook_metadata parameter allows you to attach custom data that will be included in webhook responses for request correlation and tracking.
+List all service accounts in the workspace
@@ -6299,10 +6386,7 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.speech_to_text.convert(
- enable_logging=True,
- model_id="scribe_v2",
-)
+client.service_accounts.list()
```
@@ -6318,113 +6402,70 @@ client.speech_to_text.convert(
-
-**model_id:** `SpeechToTextConvertRequestModelId` — The ID of the model to use for transcription.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**enable_logging:** `typing.Optional[bool]` — When enable_logging is set to false zero retention mode will be used for the request. This will mean log and transcript storage features are unavailable for this request. Zero retention mode may only be used by enterprise customers.
-
-
--
-
-**file:** `from __future__ import annotations
-typing.Optional[core.File]` — See core.File for more documentation
-
+
client.webhooks.list(...)
-
-**language_code:** `typing.Optional[str]` — An ISO-639-1 or ISO-639-3 language_code corresponding to the language of the audio file. Can sometimes improve transcription performance if known beforehand. Defaults to null, in this case the language is predicted automatically.
-
-
-
+#### 📝 Description
-
-**tag_audio_events:** `typing.Optional[bool]` — Whether to tag audio events like (laughter), (footsteps), etc. in the transcription.
-
-
-
-
-
-**num_speakers:** `typing.Optional[int]` — The maximum amount of speakers talking in the uploaded file. Can help with predicting who speaks when. The maximum amount of speakers that can be predicted is 32. Defaults to null, in this case the amount of speakers is set to the maximum value the model supports.
-
+List all webhooks for a workspace
-
-
--
-
-**timestamps_granularity:** `typing.Optional[SpeechToTextConvertRequestTimestampsGranularity]` — The granularity of the timestamps in the transcription. 'word' provides word-level timestamps and 'character' provides character-level timestamps per word.
-
-
--
-
-**diarize:** `typing.Optional[bool]` — Whether to annotate which speaker is currently talking in the uploaded file.
-
-
-
+#### 🔌 Usage
-
-**diarization_threshold:** `typing.Optional[float]` — Diarization threshold to apply during speaker diarization. A higher value means there will be a lower chance of one speaker being diarized as two different speakers but also a higher chance of two different speakers being diarized as one speaker (less total speakers predicted). A low value means there will be a higher chance of one speaker being diarized as two different speakers but also a lower chance of two different speakers being diarized as one speaker (more total speakers predicted). Can only be set when diarize=True and num_speakers=None. Defaults to None, in which case we will choose a threshold based on the model_id (0.22 usually).
-
-
-
-
-
-**additional_formats:** `typing.Optional[AdditionalFormats]` — A list of additional formats to export the transcript to.
-
-
-
+```python
+from elevenlabs import ElevenLabs
-
--
+client = ElevenLabs(
+ api_key="YOUR_API_KEY",
+)
+client.webhooks.list(
+ include_usages=False,
+)
-**file_format:** `typing.Optional[SpeechToTextConvertRequestFileFormat]` — The format of input audio. Options are 'pcm_s16le_16' or 'other' For `pcm_s16le_16`, the input audio must be 16-bit PCM at a 16kHz sample rate, single channel (mono), and little-endian byte order. Latency will be lower than with passing an encoded waveform.
-
+```
-
-
--
-
-**cloud_storage_url:** `typing.Optional[str]` — The HTTPS URL of the file to transcribe. Exactly one of the file or cloud_storage_url parameters must be provided. The file must be accessible via HTTPS and the file size must be less than 2GB. Any valid HTTPS URL is accepted, including URLs from cloud storage providers (AWS S3, Google Cloud Storage, Cloudflare R2, etc.), CDNs, or any other HTTPS source. URLs can be pre-signed or include authentication tokens in query parameters.
-
+#### ⚙️ Parameters
+
-
-**webhook:** `typing.Optional[bool]` — Whether to send the transcription result to configured speech-to-text webhooks. If set the request will return early without the transcription, which will be delivered later via webhook.
-
-
-
-
-
-**webhook_id:** `typing.Optional[str]` — Optional specific webhook ID to send the transcription result to. Only valid when webhook is set to true. If not provided, transcription will be sent to all configured speech-to-text webhooks.
+**include_usages:** `typing.Optional[bool]` — Whether to include active usages of the webhook, only usable by admins
@@ -6432,71 +6473,72 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-**temperature:** `typing.Optional[float]` — Controls the randomness of the transcription output. Accepts values between 0.0 and 2.0, where higher values result in more diverse and less deterministic results. If omitted, we will use a temperature based on the model you selected which is usually 0.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**seed:** `typing.Optional[int]` — If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be an integer between 0 and 2147483647.
-
+client.webhooks.create(...)
-
-**use_multi_channel:** `typing.Optional[bool]` — Whether the audio file contains multiple channels where each channel contains a single speaker. When enabled, each channel will be transcribed independently and the results will be combined. Each word in the response will include a 'channel_index' field indicating which channel it was spoken on. A maximum of 5 channels is supported.
-
-
-
+#### 📝 Description
-
-**webhook_metadata:** `typing.Optional[SpeechToTextConvertRequestWebhookMetadata]` — Optional metadata to be included in the webhook response. This should be a JSON string representing an object with a maximum depth of 2 levels and maximum size of 16KB. Useful for tracking internal IDs, job references, or other contextual information.
-
-
-
-
-
-**entity_detection:** `typing.Optional[SpeechToTextConvertRequestEntityDetection]` — Detect entities in the transcript. Can be 'all' to detect all entities, a single entity type or category string, or a list of entity types/categories. Categories include 'pii', 'phi', 'pci', 'other', 'offensive_language'. When enabled, detected entities will be returned in the 'entities' field with their text, type, and character positions. Usage of this parameter will incur additional costs.
-
+Create a new webhook for the workspace with the specified authentication type.
+
+
+#### 🔌 Usage
+
-
-**no_verbatim:** `typing.Optional[bool]` — If true, the transcription will not have any filler words, false starts and non-speech sounds. Only supported with scribe_v2 model.
-
-
-
-
-
-**entity_redaction:** `typing.Optional[SpeechToTextConvertRequestEntityRedaction]` — Redact entities from the transcript text. Accepts the same format as entity_detection: 'all', a category ('pii', 'phi'), or specific entity types. Must be a subset of entity_detection. When redaction is enabled, the entities field will not be returned.
-
+```python
+from elevenlabs import ElevenLabs, WebhookHmacSettings
+
+client = ElevenLabs(
+ api_key="YOUR_API_KEY",
+)
+client.webhooks.create(
+ settings=WebhookHmacSettings(
+ name="name",
+ webhook_url="webhook_url",
+ ),
+)
+
+```
+
+
+
+#### ⚙️ Parameters
-
-**entity_redaction_mode:** `typing.Optional[str]` — How to format redacted entities. 'redacted' replaces with {REDACTED}, 'entity_type' replaces with {ENTITY_TYPE}, 'enumerated_entity_type' replaces with {ENTITY_TYPE_N} where N enumerates each occurrence. Only used when entity_redaction is set.
-
-
-
-
-
-**keyterms:** `typing.Optional[typing.List[str]]` — A list of keyterms to bias the transcription towards. The keyterms are words or phrases you want the model to recognise more accurately. The number of keyterms cannot exceed 1000. The length of each keyterm must be less than 50 characters. Keyterms can contain at most 5 words (after normalisation). For example ["hello", "world", "technical term"]. Usage of this parameter will incur additional costs. When more than 100 keyterms are provided, a minimum billable duration of 20 seconds applies per request.
+**settings:** `WebhookHmacSettings` — Webhook settings object containing auth_type and corresponding configuration
@@ -6516,8 +6558,7 @@ typing.Optional[core.File]` — See core.File for more documentation
client.forced_alignment.create(...)
+client.webhooks.delete(...)
-
@@ -6529,7 +6570,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-Force align an audio file to text. Use this endpoint to get the timing information for each character and word in an audio file based on a provided text transcript.
+Delete the specified workspace webhook
@@ -6549,8 +6590,8 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.forced_alignment.create(
- text="text",
+client.webhooks.delete(
+ webhook_id="G007vmtq9uWYl7SUW9zGS8GZZa1K",
)
```
@@ -6567,25 +6608,7 @@ client.forced_alignment.create(
-
-**file:** `from __future__ import annotations
-
-core.File` — See core.File for more documentation
-
-
-
-
-
--
-
-**text:** `str` — The text to align with the audio. The input text can be in any format, however diarization is not supported at this time.
-
-
-
-
-
--
-
-**enabled_spooled_file:** `typing.Optional[bool]` — If true, the file will be streamed to the server and processed in chunks. This is useful for large files that cannot be loaded into memory. The default is false.
+**webhook_id:** `str` — The unique ID for the webhook
@@ -6605,8 +6628,7 @@ core.File` — See core.File for more documentation
client.conversational_ai.add_to_knowledge_base(...)
+client.webhooks.update(...)
-
@@ -6618,7 +6640,7 @@ core.File` — See core.File for more documentation
-
-Upload a file or webpage URL to create a knowledge base document.
After creating the document, update the agent's knowledge base by calling [Update agent](/docs/api-reference/agents/update).
+Update the specified workspace webhook
@@ -6638,8 +6660,10 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.conversational_ai.add_to_knowledge_base(
- agent_id="agent_id",
+client.webhooks.update(
+ webhook_id="G007vmtq9uWYl7SUW9zGS8GZZa1K",
+ is_disabled=True,
+ name="My Callback Webhook",
)
```
@@ -6656,7 +6680,7 @@ client.conversational_ai.add_to_knowledge_base(
-
-**agent_id:** `typing.Optional[str]`
+**webhook_id:** `str` — The unique ID for the webhook
@@ -6664,7 +6688,7 @@ client.conversational_ai.add_to_knowledge_base(
-
-**name:** `typing.Optional[str]` — A custom, human-readable name for the document.
+**is_disabled:** `bool` — Whether to disable or enable the webhook
@@ -6672,7 +6696,7 @@ client.conversational_ai.add_to_knowledge_base(
-
-**url:** `typing.Optional[str]` — URL to a page of documentation that the agent will have access to in order to interact with users.
+**name:** `str` — The display name of the webhook (used for display purposes only).
@@ -6680,9 +6704,7 @@ client.conversational_ai.add_to_knowledge_base(
-
-**file:** `from __future__ import annotations
-
-typing.Optional[core.File]` — See core.File for more documentation
+**retry_enabled:** `typing.Optional[bool]` — Whether to enable automatic retries for transient failures (5xx, 429, timeout)
@@ -6702,7 +6724,8 @@ typing.Optional[core.File]` — See core.File for more documentation
client.conversational_ai.rag_index_overview()
+## SpeechToText
+client.speech_to_text.convert(...)
-
@@ -6714,7 +6737,7 @@ typing.Optional[core.File]` — See core.File for more documentation
-
-Provides total size and other information of RAG indexes used by knowledgebase documents
+Transcribe an audio or video file. If webhook is set to true, the request will be processed asynchronously and results sent to configured webhooks. When use_multi_channel is true and the provided audio has multiple channels, a 'transcripts' object with separate transcripts for each channel is returned. Otherwise, returns a single transcript. The optional webhook_metadata parameter allows you to attach custom data that will be included in webhook responses for request correlation and tracking.
@@ -6734,7 +6757,10 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.conversational_ai.rag_index_overview()
+client.speech_to_text.convert(
+ enable_logging=True,
+ model_id="scribe_v2",
+)
```
@@ -6750,69 +6776,49 @@ client.conversational_ai.rag_index_overview()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**model_id:** `SpeechToTextConvertRequestModelId` — The ID of the model to use for transcription.
-
-
+
+-
+**enable_logging:** `typing.Optional[bool]` — When enable_logging is set to false zero retention mode will be used for the request. This will mean log and transcript storage features are unavailable for this request. Zero retention mode may only be used by enterprise customers.
+
-client.conversational_ai.get_document_rag_indexes(...)
-
-#### 📝 Description
+**file:** `from __future__ import annotations
-
--
+typing.Optional[core.File]` — See core.File for more documentation
+
+
+
-
-Provides information about all RAG indexes of the specified knowledgebase document.
-
-
+**language_code:** `typing.Optional[str]` — An ISO-639-1 or ISO-639-3 language_code corresponding to the language of the audio file. Can sometimes improve transcription performance if known beforehand. Defaults to null, in this case the language is predicted automatically.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.get_document_rag_indexes(
- documentation_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
+**tag_audio_events:** `typing.Optional[bool]` — Whether to tag audio events like (laughter), (footsteps), etc. in the transcription.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
+**num_speakers:** `typing.Optional[int]` — The maximum amount of speakers talking in the uploaded file. Can help with predicting who speaks when. The maximum amount of speakers that can be predicted is 32. Defaults to null, in this case the amount of speakers is set to the maximum value the model supports.
@@ -6820,70 +6826,47 @@ client.conversational_ai.get_document_rag_indexes(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**timestamps_granularity:** `typing.Optional[SpeechToTextConvertRequestTimestampsGranularity]` — The granularity of the timestamps in the transcription. 'word' provides word-level timestamps and 'character' provides character-level timestamps per word.
-
-
+
+-
+**diarize:** `typing.Optional[bool]` — Whether to annotate which speaker is currently talking in the uploaded file.
+
-client.conversational_ai.delete_document_rag_index(...)
-
-#### 📝 Description
-
-
--
+**diarization_threshold:** `typing.Optional[float]` — Diarization threshold to apply during speaker diarization. A higher value means there will be a lower chance of one speaker being diarized as two different speakers but also a higher chance of two different speakers being diarized as one speaker (less total speakers predicted). A low value means there will be a higher chance of one speaker being diarized as two different speakers but also a lower chance of two different speakers being diarized as one speaker (more total speakers predicted). Can only be set when diarize=True and num_speakers=None. Defaults to None, in which case we will choose a threshold based on the model_id (0.22 usually).
+
+
+
-
-Delete RAG index for the knowledgebase document.
-
-
+**additional_formats:** `typing.Optional[AdditionalFormats]` — A list of additional formats to export the transcript to.
+
-#### 🔌 Usage
-
-
--
-
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.conversational_ai.delete_document_rag_index(
- documentation_id="21m00Tcm4TlvDq8ikWAM",
- rag_index_id="21m00Tcm4TlvDq8ikWAM",
-)
-
-```
-
-
+**file_format:** `typing.Optional[SpeechToTextConvertRequestFileFormat]` — The format of input audio. Options are 'pcm_s16le_16' or 'other' For `pcm_s16le_16`, the input audio must be 16-bit PCM at a 16kHz sample rate, single channel (mono), and little-endian byte order. Latency will be lower than with passing an encoded waveform.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
+**source_url:** `typing.Optional[str]` — The URL of an audio or video file to transcribe. Supports hosted video or audio files, YouTube video URLs, TikTok video URLs, and other video hosting services.
@@ -6891,7 +6874,7 @@ client.conversational_ai.delete_document_rag_index(
-
-**rag_index_id:** `str` — The id of RAG index of document from the knowledge base.
+**webhook:** `typing.Optional[bool]` — Whether to send the transcription result to configured speech-to-text webhooks. If set the request will return early without the transcription, which will be delivered later via webhook.
@@ -6899,74 +6882,47 @@ client.conversational_ai.delete_document_rag_index(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**webhook_id:** `typing.Optional[str]` — Optional specific webhook ID to send the transcription result to. Only valid when webhook is set to true. If not provided, transcription will be sent to all configured speech-to-text webhooks.
-
-
+
+-
+**temperature:** `typing.Optional[float]` — Controls the randomness of the transcription output. Accepts values between 0.0 and 2.0, where higher values result in more diverse and less deterministic results. If omitted, we will use a temperature based on the model you selected which is usually 0.
+
-client.environment_variables.list(...)
-
-#### 📝 Description
-
-
--
+**seed:** `typing.Optional[int]` — If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be an integer between 0 and 2147483647.
+
+
+
-
-List all environment variables for the workspace with optional filtering
-
-
+**use_multi_channel:** `typing.Optional[bool]` — Whether the audio file contains multiple channels where each channel contains a single speaker. When enabled, each channel will be transcribed independently and the results will be combined. Each word in the response will include a 'channel_index' field indicating which channel it was spoken on. A maximum of 5 channels is supported.
+
-#### 🔌 Usage
-
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.environment_variables.list(
- cursor="cursor",
- page_size=1,
- label="label",
- environment="environment",
- type="string",
-)
-
-```
-
-
+**webhook_metadata:** `typing.Optional[SpeechToTextConvertRequestWebhookMetadata]` — Optional metadata to be included in the webhook response. This should be a JSON string representing an object with a maximum depth of 2 levels and maximum size of 16KB. Useful for tracking internal IDs, job references, or other contextual information.
+
-#### ⚙️ Parameters
-
-
--
-
-
-**cursor:** `typing.Optional[str]` — Pagination cursor from previous response
+**entity_detection:** `typing.Optional[SpeechToTextConvertRequestEntityDetection]` — Detect entities in the transcript. Can be 'all' to detect all entities, a single entity type or category string, or a list of entity types/categories. Categories include 'pii', 'phi', 'pci', 'other', 'offensive_language'. When enabled, detected entities will be returned in the 'entities' field with their text, type, and character positions. Usage of this parameter will incur additional costs.
@@ -6974,7 +6930,7 @@ client.environment_variables.list(
-
-**page_size:** `typing.Optional[int]` — Number of items to return (1-100)
+**no_verbatim:** `typing.Optional[bool]` — If true, the transcription will not have any filler words, false starts and non-speech sounds. Only supported with scribe_v2 model.
@@ -6982,7 +6938,7 @@ client.environment_variables.list(
-
-**label:** `typing.Optional[str]` — Filter by exact label match
+**entity_redaction:** `typing.Optional[SpeechToTextConvertRequestEntityRedaction]` — Redact entities from the transcript text. Accepts the same format as entity_detection: 'all', a category ('pii', 'phi'), or specific entity types. Must be a subset of entity_detection. When redaction is enabled, the entities field will not be returned.
@@ -6990,7 +6946,7 @@ client.environment_variables.list(
-
-**environment:** `typing.Optional[str]` — Filter to only return variables that have this environment. When specified, the values dict in the response will only contain this environment.
+**entity_redaction_mode:** `typing.Optional[str]` — How to format redacted entities. 'redacted' replaces with {REDACTED}, 'entity_type' replaces with {ENTITY_TYPE}, 'enumerated_entity_type' replaces with {ENTITY_TYPE_N} where N enumerates each occurrence. Only used when entity_redaction is set.
@@ -6998,7 +6954,7 @@ client.environment_variables.list(
-
-**type:** `typing.Optional[EnvironmentVariablesListRequestType]` — Filter by variable type
+**keyterms:** `typing.Optional[typing.List[str]]` — A list of keyterms to bias the transcription towards. The keyterms are words or phrases you want the model to recognise more accurately. The number of keyterms cannot exceed 1000. The length of each keyterm must be less than 50 characters. Keyterms can contain at most 5 words (after normalisation). For example ["hello", "world", "technical term"]. Usage of this parameter will incur additional costs. When more than 100 keyterms are provided, a minimum billable duration of 20 seconds applies per request.
@@ -7018,7 +6974,8 @@ client.environment_variables.list(
client.environment_variables.create(...)
+## ForcedAlignment
+client.forced_alignment.create(...)
-
@@ -7030,7 +6987,7 @@ client.environment_variables.list(
-
-Create a new environment variable for the workspace
+Force align an audio file to text. Use this endpoint to get the timing information for each character and word in an audio file based on a provided text transcript.
@@ -7046,18 +7003,12 @@ Create a new environment variable for the workspace
```python
from elevenlabs import ElevenLabs
-from elevenlabs.environment_variables import (
- EnvironmentVariablesCreateRequestBody_String,
-)
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.environment_variables.create(
- request=EnvironmentVariablesCreateRequestBody_String(
- label="label",
- values={"key": "value"},
- ),
+client.forced_alignment.create(
+ text="text",
)
```
@@ -7074,7 +7025,17 @@ client.environment_variables.create(
-
-**request:** `EnvironmentVariablesCreateRequestBody`
+**file:** `from __future__ import annotations
+
+core.File` — See core.File for more documentation
+
+
+
+
+
+-
+
+**text:** `str` — The text to align with the audio. The input text can be in any format, however diarization is not supported at this time.
@@ -7094,7 +7055,8 @@ client.environment_variables.create(
client.environment_variables.get(...)
+## ConversationalAi
+client.conversational_ai.add_to_knowledge_base(...)
-
@@ -7106,7 +7068,7 @@ client.environment_variables.create(
-
-Get a specific environment variable by ID
+Upload a file or webpage URL to create a knowledge base document.
After creating the document, update the agent's knowledge base by calling [Update agent](/docs/api-reference/agents/update).
@@ -7126,8 +7088,8 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.environment_variables.get(
- env_var_id="env_var_id",
+client.conversational_ai.add_to_knowledge_base(
+ agent_id="agent_id",
)
```
@@ -7144,7 +7106,7 @@ client.environment_variables.get(
-
-**env_var_id:** `str`
+**agent_id:** `typing.Optional[str]`
@@ -7152,70 +7114,15 @@ client.environment_variables.get(
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+**name:** `typing.Optional[str]` — A custom, human-readable name for the document.
-
-
-
-
-
-
-client.environment_variables.update(...)
-
--
-
-#### 📝 Description
-
-
--
-
-
--
-
-Replace an environment variable's values. Use null to remove an environment (except production).
-
-
-
-
-
-#### 🔌 Usage
-
-
--
-
-
--
-
-```python
-from elevenlabs import ElevenLabs
-
-client = ElevenLabs(
- api_key="YOUR_API_KEY",
-)
-client.environment_variables.update(
- env_var_id="env_var_id",
- values={},
-)
-
-```
-
-
-
-
-
-#### ⚙️ Parameters
-
-
--
-
-**env_var_id:** `str`
+**url:** `typing.Optional[str]` — URL to a page of documentation that the agent will have access to in order to interact with users.
@@ -7223,7 +7130,9 @@ client.environment_variables.update(
-
-**values:** `typing.Dict[str, typing.Optional[UpdateEnvironmentVariableRequestValuesValue]]` — Values to replace. Set to null to remove an environment (except 'production').
+**file:** `from __future__ import annotations
+
+typing.Optional[core.File]` — See core.File for more documentation
@@ -7243,8 +7152,7 @@ client.environment_variables.update(
client.music.compose(...)
+client.conversational_ai.rag_index_overview()
-
@@ -7256,7 +7164,7 @@ client.environment_variables.update(
-
-Compose a song from a prompt or a composition plan.
+Provides total size and other information of RAG indexes used by knowledgebase documents
@@ -7276,7 +7184,7 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.music.compose()
+client.conversational_ai.rag_index_overview()
```
@@ -7292,79 +7200,69 @@ client.music.compose()
-
-**output_format:** `typing.Optional[AllowedOutputFormats]` — Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
-
-
--
-
-**prompt:** `typing.Optional[str]` — A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`.
-
-
--
-**composition_plan:** `typing.Optional[MusicPrompt]` — A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`.
-
+
client.conversational_ai.get_document_rag_indexes(...)
-
-**music_length_ms:** `typing.Optional[int]` — The length of the song to generate in milliseconds. Used only in conjunction with `prompt`. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt.
-
-
-
+#### 📝 Description
-
-**model_id:** `typing.Optional[typing.Literal["music_v1"]]` — The model to use for the generation.
-
-
-
-
-
-**seed:** `typing.Optional[int]` — Random seed to initialize the music generation process. Providing the same seed with the same parameters can help achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used in conjunction with prompt.
-
+Provides information about all RAG indexes of the specified knowledgebase document.
-
-
--
-
-**force_instrumental:** `typing.Optional[bool]` — If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the `prompt`. Can only be used with `prompt`.
-
+#### 🔌 Usage
+
-
-**respect_sections_durations:** `typing.Optional[bool]` — Controls how strictly section durations in the `composition_plan` are enforced. Only used with `composition_plan`. When set to true, the model will precisely respect each section's `duration_ms` from the plan. When set to false, the model may adjust individual section durations which will generally lead to better generation quality and improved latency, while always preserving the total song duration from the plan.
-
-
-
-
-
-**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting feature.
-
+```python
+from elevenlabs import ElevenLabs
+
+client = ElevenLabs(
+ api_key="YOUR_API_KEY",
+)
+client.conversational_ai.get_document_rag_indexes(
+ documentation_id="21m00Tcm4TlvDq8ikWAM",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
+
+-
+
-
-**sign_with_c_2_pa:** `typing.Optional[bool]` — Whether to sign the generated song with C2PA. Applicable only for mp3 files.
+**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
@@ -7372,7 +7270,7 @@ client.music.compose()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -7384,7 +7282,7 @@ client.music.compose()
client.music.compose_detailed(...)
+client.conversational_ai.delete_document_rag_index(...)
-
@@ -7396,7 +7294,7 @@ client.music.compose()
-
-Compose a song from a prompt or a composition plan.
+Delete RAG index for the knowledgebase document.
@@ -7416,7 +7314,10 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.music.compose_detailed()
+client.conversational_ai.delete_document_rag_index(
+ documentation_id="21m00Tcm4TlvDq8ikWAM",
+ rag_index_id="21m00Tcm4TlvDq8ikWAM",
+)
```
@@ -7432,7 +7333,7 @@ client.music.compose_detailed()
-
-**output_format:** `typing.Optional[AllowedOutputFormats]` — Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
+**documentation_id:** `str` — The id of a document from the knowledge base. This is returned on document addition.
@@ -7440,7 +7341,7 @@ client.music.compose_detailed()
-
-**prompt:** `typing.Optional[str]` — A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`.
+**rag_index_id:** `str` — The id of RAG index of document from the knowledge base.
@@ -7448,39 +7349,74 @@ client.music.compose_detailed()
-
-**composition_plan:** `typing.Optional[MusicPrompt]` — A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**music_length_ms:** `typing.Optional[int]` — The length of the song to generate in milliseconds. Used only in conjunction with `prompt`. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt.
-
+client.environment_variables.list(...)
-
-**model_id:** `typing.Optional[typing.Literal["music_v1"]]` — The model to use for the generation.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+List all environment variables for the workspace with optional filtering
+
+
+#### 🔌 Usage
+
-
-**seed:** `typing.Optional[int]` — Random seed to initialize the music generation process. Providing the same seed with the same parameters can help achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used in conjunction with prompt.
-
+
+-
+
+```python
+from elevenlabs import ElevenLabs
+
+client = ElevenLabs(
+ api_key="YOUR_API_KEY",
+)
+client.environment_variables.list(
+ cursor="cursor",
+ page_size=1,
+ label="label",
+ environment="environment",
+ type="string",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**force_instrumental:** `typing.Optional[bool]` — If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the `prompt`. Can only be used with `prompt`.
+
+-
+
+**cursor:** `typing.Optional[str]` — Pagination cursor from previous response
@@ -7488,7 +7424,7 @@ client.music.compose_detailed()
-
-**respect_sections_durations:** `typing.Optional[bool]` — Controls how strictly section durations in the `composition_plan` are enforced. Only used with `composition_plan`. When set to true, the model will precisely respect each section's `duration_ms` from the plan. When set to false, the model may adjust individual section durations which will generally lead to better generation quality and improved latency, while always preserving the total song duration from the plan.
+**page_size:** `typing.Optional[int]` — Number of items to return (1-100)
@@ -7496,7 +7432,7 @@ client.music.compose_detailed()
-
-**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting feature.
+**label:** `typing.Optional[str]` — Filter by exact label match
@@ -7504,7 +7440,7 @@ client.music.compose_detailed()
-
-**with_timestamps:** `typing.Optional[bool]` — Whether to return the timestamps of the words in the generated song.
+**environment:** `typing.Optional[str]` — Filter to only return variables that have this environment. When specified, the values dict in the response will only contain this environment.
@@ -7512,7 +7448,7 @@ client.music.compose_detailed()
-
-**sign_with_c_2_pa:** `typing.Optional[bool]` — Whether to sign the generated song with C2PA. Applicable only for mp3 files.
+**type:** `typing.Optional[EnvironmentVariablesListRequestType]` — Filter by variable type
@@ -7520,7 +7456,7 @@ client.music.compose_detailed()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -7532,7 +7468,7 @@ client.music.compose_detailed()
client.music.stream(...)
+client.environment_variables.create(...)
-
@@ -7544,7 +7480,7 @@ client.music.compose_detailed()
-
-Stream a composed song from a prompt or a composition plan.
+Create a new environment variable for the workspace
@@ -7560,11 +7496,19 @@ Stream a composed song from a prompt or a composition plan.
```python
from elevenlabs import ElevenLabs
+from elevenlabs.environment_variables import (
+ EnvironmentVariablesCreateRequestBody_String,
+)
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.music.stream()
+client.environment_variables.create(
+ request=EnvironmentVariablesCreateRequestBody_String(
+ label="label",
+ values={"key": "value"},
+ ),
+)
```
@@ -7580,7 +7524,7 @@ client.music.stream()
-
-**output_format:** `typing.Optional[AllowedOutputFormats]` — Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs.
+**request:** `EnvironmentVariablesCreateRequestBody`
@@ -7588,55 +7532,69 @@ client.music.stream()
-
-**prompt:** `typing.Optional[str]` — A simple text prompt to generate a song from. Cannot be used in conjunction with `composition_plan`.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
--
-**composition_plan:** `typing.Optional[MusicPrompt]` — A detailed composition plan to guide music generation. Cannot be used in conjunction with `prompt`.
-
+client.environment_variables.get(...)
-
-**music_length_ms:** `typing.Optional[int]` — The length of the song to generate in milliseconds. Used only in conjunction with `prompt`. Must be between 3000ms and 600000ms. Optional - if not provided, the model will choose a length based on the prompt.
-
-
-
+#### 📝 Description
-
-**model_id:** `typing.Optional[typing.Literal["music_v1"]]` — The model to use for the generation.
-
-
-
-
-
-**seed:** `typing.Optional[int]` — Random seed to initialize the music generation process. Providing the same seed with the same parameters can help achieve more consistent results, but exact reproducibility is not guaranteed and outputs may change across system updates. Cannot be used in conjunction with prompt.
-
+Get a specific environment variable by ID
+
+
+#### 🔌 Usage
+
-
-**force_instrumental:** `typing.Optional[bool]` — If true, guarantees that the generated song will be instrumental. If false, the song may or may not be instrumental depending on the `prompt`. Can only be used with `prompt`.
-
+
+-
+
+```python
+from elevenlabs import ElevenLabs
+
+client = ElevenLabs(
+ api_key="YOUR_API_KEY",
+)
+client.environment_variables.get(
+ env_var_id="env_var_id",
+)
+
+```
+
+
+#### ⚙️ Parameters
+
-
-**store_for_inpainting:** `typing.Optional[bool]` — Whether to store the generated song for inpainting. Only available to enterprise clients with access to the inpainting feature.
+
+-
+
+**env_var_id:** `str`
@@ -7644,7 +7602,7 @@ client.music.stream()
-
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -7656,7 +7614,7 @@ client.music.stream()
client.music.upload(...)
+client.environment_variables.update(...)
-
@@ -7668,7 +7626,7 @@ client.music.stream()
-
-Upload a music file to be later used for inpainting. Only available to enterprise clients with access to the inpainting feature.
+Replace an environment variable's values. Use null to remove an environment (except production).
@@ -7688,7 +7646,10 @@ from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
-client.music.upload()
+client.environment_variables.update(
+ env_var_id="env_var_id",
+ values={},
+)
```
@@ -7704,9 +7665,7 @@ client.music.upload()
-
-**file:** `from __future__ import annotations
-
-core.File` — See core.File for more documentation
+**env_var_id:** `str`
@@ -7714,7 +7673,7 @@ core.File` — See core.File for more documentation
-
-**extract_composition_plan:** `typing.Optional[bool]` — Whether to generate and return the composition plan for the uploaded song. If True, the response will include the composition_plan but will increase the latency.
+**values:** `typing.Dict[str, typing.Optional[UpdateEnvironmentVariableRequestValuesValue]]` — Values to replace. Set to null to remove an environment (except 'production').
@@ -12252,6 +12211,22 @@ client.conversational_ai.batch_calls.create(
-
+**branch_id:** `typing.Optional[str]`
+
+
+
+
+
+-
+
+**environment:** `typing.Optional[str]`
+
+
+
+
+
+-
+
**telephony_call_config:** `typing.Optional[TelephonyCallConfig]`
@@ -14467,11 +14442,10 @@ Create a new draft for an agent
from elevenlabs import (
AgentWorkflowRequestModel,
AgentWorkflowRequestModelNodesValue_End,
- AstAndOperatorNodeInputChildrenItem_BooleanLiteral,
+ AstNodeInput_AndOperator,
ElevenLabs,
WorkflowEdgeModelInput,
WorkflowEdgeModelInputForwardCondition_Expression,
- WorkflowExpressionConditionModelInputExpression_AndOperator,
)
client = ElevenLabs(
@@ -14488,12 +14462,8 @@ client.conversational_ai.agents.drafts.create(
source="entry_node",
target="tool_node_a",
forward_condition=WorkflowEdgeModelInputForwardCondition_Expression(
- expression=WorkflowExpressionConditionModelInputExpression_AndOperator(
- children=[
- AstAndOperatorNodeInputChildrenItem_BooleanLiteral(
- value=True,
- )
- ],
+ expression=AstNodeInput_AndOperator(
+ children=[],
),
),
),
@@ -14501,12 +14471,8 @@ client.conversational_ai.agents.drafts.create(
source="start_node",
target="entry_node",
forward_condition=WorkflowEdgeModelInputForwardCondition_Expression(
- expression=WorkflowExpressionConditionModelInputExpression_AndOperator(
- children=[
- AstAndOperatorNodeInputChildrenItem_BooleanLiteral(
- value=True,
- )
- ],
+ expression=AstNodeInput_AndOperator(
+ children=[],
),
),
),
@@ -14514,12 +14480,8 @@ client.conversational_ai.agents.drafts.create(
source="tool_node_a",
target="failure_node",
forward_condition=WorkflowEdgeModelInputForwardCondition_Expression(
- expression=WorkflowExpressionConditionModelInputExpression_AndOperator(
- children=[
- AstAndOperatorNodeInputChildrenItem_BooleanLiteral(
- value=True,
- )
- ],
+ expression=AstNodeInput_AndOperator(
+ children=[],
),
),
),
@@ -14527,12 +14489,8 @@ client.conversational_ai.agents.drafts.create(
source="tool_node_a",
target="tool_node_b",
forward_condition=WorkflowEdgeModelInputForwardCondition_Expression(
- expression=WorkflowExpressionConditionModelInputExpression_AndOperator(
- children=[
- AstAndOperatorNodeInputChildrenItem_BooleanLiteral(
- value=True,
- )
- ],
+ expression=AstNodeInput_AndOperator(
+ children=[],
),
),
),
@@ -14540,12 +14498,8 @@ client.conversational_ai.agents.drafts.create(
source="tool_node_b",
target="success_transfer",
forward_condition=WorkflowEdgeModelInputForwardCondition_Expression(
- expression=WorkflowExpressionConditionModelInputExpression_AndOperator(
- children=[
- AstAndOperatorNodeInputChildrenItem_BooleanLiteral(
- value=True,
- )
- ],
+ expression=AstNodeInput_AndOperator(
+ children=[],
),
),
),
@@ -14553,12 +14507,8 @@ client.conversational_ai.agents.drafts.create(
source="tool_node_b",
target="success_conversation",
forward_condition=WorkflowEdgeModelInputForwardCondition_Expression(
- expression=WorkflowExpressionConditionModelInputExpression_AndOperator(
- children=[
- AstAndOperatorNodeInputChildrenItem_BooleanLiteral(
- value=True,
- )
- ],
+ expression=AstNodeInput_AndOperator(
+ children=[],
),
),
),
@@ -14566,12 +14516,8 @@ client.conversational_ai.agents.drafts.create(
source="tool_node_b",
target="success_end",
forward_condition=WorkflowEdgeModelInputForwardCondition_Expression(
- expression=WorkflowExpressionConditionModelInputExpression_AndOperator(
- children=[
- AstAndOperatorNodeInputChildrenItem_BooleanLiteral(
- value=True,
- )
- ],
+ expression=AstNodeInput_AndOperator(
+ children=[],
),
),
),
@@ -14579,12 +14525,8 @@ client.conversational_ai.agents.drafts.create(
source="tool_node_b",
target="success_phone",
forward_condition=WorkflowEdgeModelInputForwardCondition_Expression(
- expression=WorkflowExpressionConditionModelInputExpression_AndOperator(
- children=[
- AstAndOperatorNodeInputChildrenItem_BooleanLiteral(
- value=True,
- )
- ],
+ expression=AstNodeInput_AndOperator(
+ children=[],
),
),
),
@@ -15117,6 +15059,7 @@ client.conversational_ai.conversations.messages.text_search(
summary_mode="exclude",
conversation_initiation_source="unknown",
branch_id="branch_id",
+ sort_by="search_score",
cursor="cursor",
)
@@ -15302,6 +15245,14 @@ client.conversational_ai.conversations.messages.text_search(
-
+**sort_by:** `typing.Optional[MessageSearchSortBy]` — Sort order for search results. 'search_score' sorts by search score, 'created_at' sorts by conversation start time.
+
+
+
+
+
+-
+
**cursor:** `typing.Optional[str]` — Used for fetching next page. Cursor is returned in the response.
@@ -15575,6 +15526,77 @@ client.conversational_ai.conversations.files.delete(
+
+
+
client.conversational_ai.conversations.analysis.run(...)
+
+-
+
+#### 📝 Description
+
+
+-
+
+
+-
+
+Run the analysis for a conversation using the agent's current evaluation criteria and data collection settings.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from elevenlabs import ElevenLabs
+
+client = ElevenLabs(
+ api_key="YOUR_API_KEY",
+)
+client.conversational_ai.conversations.analysis.run(
+ conversation_id="conversation_id",
+)
+
+```
+
+
+
+
+
+#### ⚙️ Parameters
+
+
+-
+
+
+-
+
+**conversation_id:** `str` — ID of the conversation
+
+
+
+
+
+-
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
+
+
+
+
+