diff --git a/.fern/metadata.json b/.fern/metadata.json
index c720e2a0..d3b756e1 100644
--- a/.fern/metadata.json
+++ b/.fern/metadata.json
@@ -1,5 +1,5 @@
{
- "cliVersion": "5.51.2",
+ "cliVersion": "5.75.6",
"generatorName": "fernapi/fern-python-sdk",
"generatorVersion": "5.3.3",
"generatorConfig": {
@@ -8,6 +8,6 @@
},
"client_class_name": "Vapi"
},
- "originGitCommit": "5a015aa01196915bea6110904c69d5804f457ff5",
- "sdkVersion": "2.0.0"
+ "originGitCommit": "5bfd858800a83849a00a0db760c7cce860f37da6",
+ "sdkVersion": "2.0.1"
}
\ No newline at end of file
diff --git a/.fern/replay.lock b/.fern/replay.lock
new file mode 100644
index 00000000..b179bfef
--- /dev/null
+++ b/.fern/replay.lock
@@ -0,0 +1,16 @@
+# DO NOT EDIT MANUALLY - Managed by Fern Replay
+version: "1.0"
+generations:
+ - commit_sha: 310b866cfaea845c2d9d5181f974b95c8bb1c743
+ tree_hash: e7afccaf4f602251c64958582252e28d2e5423a5
+ timestamp: 2026-07-21T02:25:09.511Z
+ cli_version: unknown
+ generator_versions: {}
+ - commit_sha: a8ff18a64d5987bf0c7318cad34c85a9395b9714
+ tree_hash: e34a81144401b7db7be87a188dc460841a6d8f9b
+ timestamp: 2026-07-21T02:25:09.912Z
+ cli_version: unknown
+ generator_versions:
+ fernapi/fern-python-sdk: 5.3.3
+current_generation: a8ff18a64d5987bf0c7318cad34c85a9395b9714
+patches: []
diff --git a/.fernignore b/.fernignore
index cd97554f..c2fb4d46 100644
--- a/.fernignore
+++ b/.fernignore
@@ -8,3 +8,6 @@ src/vapi/types/assistant_server_messages_item.py
src/vapi/types/create_assistant_dto_server_messages_item.py
changelog.md
+.fern/replay.lock
+.fern/replay.yml
+.gitattributes
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 00000000..74928d6a
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1 @@
+.fern/replay.lock linguist-generated=true
diff --git a/changelog.md b/changelog.md
index cd672f3b..e80b5ec0 100644
--- a/changelog.md
+++ b/changelog.md
@@ -1,3 +1,5 @@
+## [2.0.1] - 2026-07-21
+
## 2.0.0 - 2026-06-24
### Breaking Changes
* **`CartesiaExperimentalControlsSpeedZero`** has been removed and replaced by **`CartesiaSpeedControlZero`**. Update any imports or type annotations referencing `CartesiaExperimentalControlsSpeedZero` to use `CartesiaSpeedControlZero` instead.
diff --git a/poetry.lock b/poetry.lock
index ad2cd021..d9f13479 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -2,141 +2,141 @@
[[package]]
name = "aiohappyeyeballs"
-version = "2.6.2"
+version = "2.7.1"
description = "Happy Eyeballs for asyncio"
optional = true
python-versions = ">=3.10"
files = [
- {file = "aiohappyeyeballs-2.6.2-py3-none-any.whl", hash = "sha256:4708045e2d7a6c6bdf8aafa8ed39649eaf926a4543b54560659129e3365953c4"},
- {file = "aiohappyeyeballs-2.6.2.tar.gz", hash = "sha256:e202810ee718bd01fc6ef49e8ea53d023d5cb6b581076d7925aa499fa55dbe64"},
+ {file = "aiohappyeyeballs-2.7.1-py3-none-any.whl", hash = "sha256:9243213661e29250eb41368e5daa826fc017156c3b8a11440826b2e3ed376472"},
+ {file = "aiohappyeyeballs-2.7.1.tar.gz", hash = "sha256:065665c041c42a5938ed220bdcd7230f22527fbec085e1853d2402c8a3615d9d"},
]
[[package]]
name = "aiohttp"
-version = "3.14.1"
+version = "3.14.2"
description = "Async http client/server framework (asyncio)"
optional = true
python-versions = ">=3.10"
files = [
- {file = "aiohttp-3.14.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:8f6bb621e5863cfe8fe5ff5468002d200ec31f30f1280b259dc505b02595099e"},
- {file = "aiohttp-3.14.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:4f7215cb3933784f79ed20e5f050e15984f390424339b22375d5a53c933a0491"},
- {file = "aiohttp-3.14.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:d9d4e294455b23a68c9b8f042d0e8e377a265bcb15332753695f6e5b6819e0ce"},
- {file = "aiohttp-3.14.1-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:b238af795833d5731d049d82bc84b768ae6f8f97f0495963b3ed9935c5901cc3"},
- {file = "aiohttp-3.14.1-cp310-cp310-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:e4e5e0ae56914ecdbf446493addefc0159053dd53962cef37d7839f37f73d505"},
- {file = "aiohttp-3.14.1-cp310-cp310-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:092e4ce3619a7c6dee52a6bdabda973d9b34b66781f840ce93c7e0cec30cf521"},
- {file = "aiohttp-3.14.1-cp310-cp310-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:bb33777ea21e8b7ecde0e6fc84f598be0a1192eab1a63bc746d75aa75d38e7bd"},
- {file = "aiohttp-3.14.1-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:23119f8fd4f5d16902ed459b63b100bcd269628075162bddac56cc7b5273b3fb"},
- {file = "aiohttp-3.14.1-cp310-cp310-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:57fc6745a4b7d0f5a9eb4f40a69718be6c0bc1b8368cc9fe89e90118719f4f42"},
- {file = "aiohttp-3.14.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:6fd35beba67c4183b09375c5fff9accb47524191a244a99f95fd4472f5402c2b"},
- {file = "aiohttp-3.14.1-cp310-cp310-musllinux_1_2_armv7l.whl", hash = "sha256:672b9d65f42eb877f5c3f234a4547e4e1a226ca8c2eed879bb34670a0ce51192"},
- {file = "aiohttp-3.14.1-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:24ba13339fed9251d9b1a1bec8c7ab84c0d1675d79d33501e11f94f8b9a84e05"},
- {file = "aiohttp-3.14.1-cp310-cp310-musllinux_1_2_riscv64.whl", hash = "sha256:94da27378da0610e341c4d30de29a191672683cc82b8f9556e8f7c7212a020fe"},
- {file = "aiohttp-3.14.1-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:52cdac9432d8b4a719f35094a818d95adcae0f0b4fe9b9b921909e0c87de9e7d"},
- {file = "aiohttp-3.14.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:672ac254412a24d0d0cf00a9e6c238877e4be5e5fa2d188832c1244f45f31966"},
- {file = "aiohttp-3.14.1-cp310-cp310-win32.whl", hash = "sha256:2fe3607e71acc6ebb0ec8e492a247bf7a291226192dc0084236dfc12478916f6"},
- {file = "aiohttp-3.14.1-cp310-cp310-win_amd64.whl", hash = "sha256:30099eda75a53c32efb0920e9c33c195314d2cc1c680fbfd30894932ac5f27df"},
- {file = "aiohttp-3.14.1-cp310-cp310-win_arm64.whl", hash = "sha256:5a837f49d901f9e368651b676912bff1104ed8c1a83b280bcd7b29adccef5c9c"},
- {file = "aiohttp-3.14.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:aa00140699487bd435fde4342d85c94cb256b7cd3a5b9c3396c67f19922afda2"},
- {file = "aiohttp-3.14.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:1c1af67559445498b502030c35c59db59966f47041ca9de5b4e707f86bd10b5f"},
- {file = "aiohttp-3.14.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:d44ec478e713ee7f29b439f7eb8dc2b9d4079e11ae114d2c2ac3d5daf30516c8"},
- {file = "aiohttp-3.14.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:d3b1a184a9a8f548a6b73f1e26b96b052193e4b3175ed7342aaf1151a1f00a04"},
- {file = "aiohttp-3.14.1-cp311-cp311-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:5f2504bc0322437c9a1ff6d3333ca56c7477b727c995f036b976ae17b98372c8"},
- {file = "aiohttp-3.14.1-cp311-cp311-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:73f05ea02013e02512c3bf42714f1208c57168c779cc6fe23516e4543089d0a6"},
- {file = "aiohttp-3.14.1-cp311-cp311-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:797457503c2d426bee06eef808d07b31ede30b65e054444e7de64cad0061b7af"},
- {file = "aiohttp-3.14.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b821a1f7dedf7e37450654e620038ac3b2e81e8fa6ea269337e97101978ec730"},
- {file = "aiohttp-3.14.1-cp311-cp311-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:4cd96b5ba05d67ed0cf00b5b405c8cd99586d8e3481e8ee0a831057591af7621"},
- {file = "aiohttp-3.14.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:1d459b98a932296c6f0e94f87511a0b1b90a8a02c30a50e60a297619cd5a58ee"},
- {file = "aiohttp-3.14.1-cp311-cp311-musllinux_1_2_armv7l.whl", hash = "sha256:764457a7be60825fb770a644852ff717bcbb5042f189f2bd16df61a81b3f6573"},
- {file = "aiohttp-3.14.1-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:f7a16ef45b081454ef844502d87a848876c490c4cb5c650c230f6ec79ed2c1e7"},
- {file = "aiohttp-3.14.1-cp311-cp311-musllinux_1_2_riscv64.whl", hash = "sha256:2fbc3ed048b3475b9f0cbcb9978e9d2d3511acd91ead203af26ed9f0056004cf"},
- {file = "aiohttp-3.14.1-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:bedb0cd073cc2dc035e30aeb99444389d3cd2113afe4ef9fcd23d439f5bade85"},
- {file = "aiohttp-3.14.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:b6feea921016eb3d4e04d65fc4e9ca402d1a3801f562aef94989f54694917af3"},
- {file = "aiohttp-3.14.1-cp311-cp311-win32.whl", hash = "sha256:313701e488100074ce99850404ee36e741abf6330179fec908a1944ecf570126"},
- {file = "aiohttp-3.14.1-cp311-cp311-win_amd64.whl", hash = "sha256:03ab4530fdcb3a543a122ba4b65ac9919da9fe9f78a03d328a6e38ff962f7aa5"},
- {file = "aiohttp-3.14.1-cp311-cp311-win_arm64.whl", hash = "sha256:486f7d16ed54c39c2cbd7ca71fd8ba2b8bb7860df65bd7b6ed640bab96a38a8b"},
- {file = "aiohttp-3.14.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:d35143e27778b4bb0fb189562d7f275bff79c62ab8e98459717c0ea617ff2480"},
- {file = "aiohttp-3.14.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:bcfb80a2cc36fba2534e5e5b5264dc7ae6fcd9bf15256da3e53d2f499e6fa29d"},
- {file = "aiohttp-3.14.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:27fd7c91e51729b4f7e1577865fa6d34c9adccbc39aabe9000285b48af9f0ec2"},
- {file = "aiohttp-3.14.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:64c567bf9eaf664280116a8688f63016e6b32db2505908e2bdaca1b6438142f2"},
- {file = "aiohttp-3.14.1-cp312-cp312-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:f5e6ff2bdbb8f4cd3fbe41f99e25bbcd58e3bf9f13d3dd31a11e7917251cc77a"},
- {file = "aiohttp-3.14.1-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:2f73e01dc37122325caf079982621262f96d74823c179038a82fddfc50359264"},
- {file = "aiohttp-3.14.1-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:bb2c0c80d431c0d03f2c7dbf125150fedd4f0de17366a7ca33f7ccb822391842"},
- {file = "aiohttp-3.14.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:3e6fc1a85fa7194a1a7d19f44e8609180f4a8eb5fa4c7ed8b4355f080fad235c"},
- {file = "aiohttp-3.14.1-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:686b6c0d3911ec387b444ddf5dc62fb7f7c0a7d5186a7861626496a5ab4aff95"},
- {file = "aiohttp-3.14.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:c6fa4dc7ad6f8109c70bb1499e589f76b0b792baf39f9b017eb92c8a81d0a199"},
- {file = "aiohttp-3.14.1-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:87a5eea1b2a5e21e1ebdbb33ad4165359189327e63fc4e4894693e7f821ac817"},
- {file = "aiohttp-3.14.1-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:1c1421eb01d4fd608d88cc8290211d177a58532b55ad94076fb349c5bf467f0a"},
- {file = "aiohttp-3.14.1-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:34b257ec41345c1e8f2df68fa908a7952f5de932723871eb633ecbbff396c9a4"},
- {file = "aiohttp-3.14.1-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:de538791a80e5d862addbc183f70f0158ac9b9bb872bb147f1fd2a683691e087"},
- {file = "aiohttp-3.14.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:6f71173be42d3241d428f760122febb748de0623f44308a6f120d0dd9ec572e3"},
- {file = "aiohttp-3.14.1-cp312-cp312-win32.whl", hash = "sha256:ec8dc383ee57ea3e883477dcca3f11b65d58199f1080acaf4cd6ad9a99698be4"},
- {file = "aiohttp-3.14.1-cp312-cp312-win_amd64.whl", hash = "sha256:2aa92c87868cd13674989f9ee83e5f9f7ea4237589b728048e1f0c8f6caa3271"},
- {file = "aiohttp-3.14.1-cp312-cp312-win_arm64.whl", hash = "sha256:2c840c90759922cb5e6dda94596e079a30fb5a5ba548e7e0dc00574703940847"},
- {file = "aiohttp-3.14.1-cp313-cp313-android_21_arm64_v8a.whl", hash = "sha256:b3a03285a7f9c7b016324574a6d92a1c895da6b978cb8f1deee3ac72bc6da178"},
- {file = "aiohttp-3.14.1-cp313-cp313-android_21_x86_64.whl", hash = "sha256:2a73f487ab8ef5abbb24b7aa9b73e98eaba9e9e031804ff2416f02eca315ccaf"},
- {file = "aiohttp-3.14.1-cp313-cp313-ios_13_0_arm64_iphoneos.whl", hash = "sha256:915fbb7b41b115192259f8c9ae58f3ddc444d2b5579917270211858e606a4afd"},
- {file = "aiohttp-3.14.1-cp313-cp313-ios_13_0_arm64_iphonesimulator.whl", hash = "sha256:7fb4bdf95b0561a79f259f9d28fbc109728c5ee7f27aff6391f0ca703a329abe"},
- {file = "aiohttp-3.14.1-cp313-cp313-ios_13_0_x86_64_iphonesimulator.whl", hash = "sha256:1b9748363260121d2927704f5d4fc498150669ca3ae93625986ee89c8f80dcd4"},
- {file = "aiohttp-3.14.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:86a6dab78b0e43e2897a3bbe15745aa60dc5423ca437b7b0b164c069bf91b876"},
- {file = "aiohttp-3.14.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:4dfd6e47d3c44c2279907607f73a4240b88c69eb8b90da7e2441a8045dfd21da"},
- {file = "aiohttp-3.14.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:317acd9f8602858dc7d59679812c376c7f0b97bcbbf16e0d6237f54141d8a8a6"},
- {file = "aiohttp-3.14.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:bd869c427324e5cb15195793de951295710db28be7d818247f3097b4ab5d4b96"},
- {file = "aiohttp-3.14.1-cp313-cp313-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:93b032b5ec3255473c143627d21a69ac74ae12f7f33974cb587c564d11b1066f"},
- {file = "aiohttp-3.14.1-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:f234b4deb12f3ad59127e037bc57c40c21e45b45282df7d3a55a0f409f595296"},
- {file = "aiohttp-3.14.1-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:9af6779bfb46abf124068327abcdf9ce95c9ef8287a3e8da76ccf2d0f16c28fa"},
- {file = "aiohttp-3.14.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:faccab372e66bc76d5731525e7f1143c922271725b9d38c9f97edcc66266b451"},
- {file = "aiohttp-3.14.1-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:f380468b09d2a81633ee863b0ec5648d364bd17bb8ecfb8c2f387f7ac1faf42c"},
- {file = "aiohttp-3.14.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:97e704dcd26271f5bda3fa07c3ce0fb76d6d3f8659f4baa1a24442cc9ba177ca"},
- {file = "aiohttp-3.14.1-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:269b76ac5394092b95bc4a098f4fc6c191c083c3bd12775d1e30e663132f6a09"},
- {file = "aiohttp-3.14.1-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:5c0b3e614340c889d575451696374c9d17affd54cd607ca0babed8f8c37b9397"},
- {file = "aiohttp-3.14.1-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:5663ee9257cfa1add7253a7da3035a02f31b6600ec48261585e1800a81533080"},
- {file = "aiohttp-3.14.1-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:603a2c834142172ffddc054067f5ec0ca65d57a0aa98a71bc81952573208e345"},
- {file = "aiohttp-3.14.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:cb21957bb8aca671c1765e32f58164cf0c50e6bf41c0bbbd16da20732ecaf588"},
- {file = "aiohttp-3.14.1-cp313-cp313-win32.whl", hash = "sha256:e509a55f681e6158c20f70f102f9cf61fb20fbc382272bc6d94b7343f2582780"},
- {file = "aiohttp-3.14.1-cp313-cp313-win_amd64.whl", hash = "sha256:1ac8531b638959718e18c2207fbfe297819875da46a740b29dfa29beba64355a"},
- {file = "aiohttp-3.14.1-cp313-cp313-win_arm64.whl", hash = "sha256:250d14af67f6b6a1a4a811049b1afa69d61d617fca6bf33149b3ab1a6dbcf7b8"},
- {file = "aiohttp-3.14.1-cp314-cp314-android_24_arm64_v8a.whl", hash = "sha256:7c106c26852ca1c2047c6b80384f17100b4e439af276f21ef3d4e2f450ae7e15"},
- {file = "aiohttp-3.14.1-cp314-cp314-android_24_x86_64.whl", hash = "sha256:20205f7f5ade7aaec9f4b500549bbc071b046453aed72f9c06dcab87896a83e8"},
- {file = "aiohttp-3.14.1-cp314-cp314-ios_13_0_arm64_iphoneos.whl", hash = "sha256:62a759436b29e677181a9e76bab8b8f689a29cb9c535f45f7c48c9c830d3f8c3"},
- {file = "aiohttp-3.14.1-cp314-cp314-ios_13_0_arm64_iphonesimulator.whl", hash = "sha256:2964cbf553df4d7a57348da44d961d871895fc1ee4e8c322b2a95612c7b17fba"},
- {file = "aiohttp-3.14.1-cp314-cp314-ios_13_0_x86_64_iphonesimulator.whl", hash = "sha256:237651caadc3a59badd39319c54642b5299e9cc98a3a194310e55d5bb9f5e397"},
- {file = "aiohttp-3.14.1-cp314-cp314-macosx_10_15_universal2.whl", hash = "sha256:896e12dfdbbab9d8f7e16d2b28c6769a60126fa92095d1ebf9473d02593a2448"},
- {file = "aiohttp-3.14.1-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:d03f281ed22579314ba00821ce20115a7c0ac430660b4cc05704a3f818b3e004"},
- {file = "aiohttp-3.14.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:07eabb979d236335fed927e137a928c9adfb7df3b9ec7aa31726f133a62be983"},
- {file = "aiohttp-3.14.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:4fe1f1087cbadb280b5e1bb054a4f00d1423c74d6626c5e48400d871d34ecefe"},
- {file = "aiohttp-3.14.1-cp314-cp314-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:367a9314fdc79dab0fac96e216cb41dd73c85bdca85306ce8999118ba7e0f333"},
- {file = "aiohttp-3.14.1-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:a24f677ebe83749039e7bdf862ff0bbb16818ae4193d4ef96505e269375bcce0"},
- {file = "aiohttp-3.14.1-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:c83afe0ba876be7e943d2e0ba645809ad441575d2840c895c21ee5de93b9377a"},
- {file = "aiohttp-3.14.1-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:634e385930fb6d2d479cf3aa66515955863b77a5e3c2b5894ca259a25b308602"},
- {file = "aiohttp-3.14.1-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:eeea07c4397bbc57719c4eed8f9c284874d4f175f9b6d57f7a1546b976d455ca"},
- {file = "aiohttp-3.14.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:335c0cc3e3545ce98dcb9cfcb836f40c3411f43fa03dab757597d80c89af8a35"},
- {file = "aiohttp-3.14.1-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:ae6be797afdef264e8a84864a85b196ca06045586481b3df8a967322fd2fa844"},
- {file = "aiohttp-3.14.1-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:8560b4d712474335d08907db7973f71912d3a9a8f1dee992ec06b5d2fe359496"},
- {file = "aiohttp-3.14.1-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:2b7edd08e0a5deb1e8564a2fcd8f4561014a3f05252334671bbf55ddd47db0e5"},
- {file = "aiohttp-3.14.1-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:b6ff7fcee63287ae57b5df3e4f5957ce032122802509246dec1a5bcc55904c95"},
- {file = "aiohttp-3.14.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:6ffbb2f4ec1ceaff7e07d43922954da26b223d188bf30658e561b98e23089444"},
- {file = "aiohttp-3.14.1-cp314-cp314-win32.whl", hash = "sha256:a9875b46d910cff3ea2f5962f9d266b465459fe634e22556ab9bd6fc1192eea0"},
- {file = "aiohttp-3.14.1-cp314-cp314-win_amd64.whl", hash = "sha256:af8b4b81a960eeaf1234971ac3cd0ba5901f3cd42eae42a46b4d089a8b492719"},
- {file = "aiohttp-3.14.1-cp314-cp314-win_arm64.whl", hash = "sha256:cf4491381b1b57425c315a56a439251b1bdac07b2275f19a8c44bc57744532ec"},
- {file = "aiohttp-3.14.1-cp314-cp314t-macosx_10_15_universal2.whl", hash = "sha256:819c054312f1af92947e6a55883d1b66feefab11531a7fc45e0fb9b63880b5c2"},
- {file = "aiohttp-3.14.1-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:10ee9c1753a8f706345b22496c79fbddb5be0599e0823f3738b1534058e25340"},
- {file = "aiohttp-3.14.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:1601cc37baf5750ccacae618ec2daf020769581695550e3b654a911f859c563d"},
- {file = "aiohttp-3.14.1-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:4d6e0ac9da31c9c04c84e1c0182ad8d6df35965a85cae29cd71d089621b3ae94"},
- {file = "aiohttp-3.14.1-cp314-cp314t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:9e8f2d660c350b3d0e259c7a7e3d9b7fc8b41210cbcc3d4a7076ff0a5e5c2fdc"},
- {file = "aiohttp-3.14.1-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:4691802dda97be727f79d86818acaad7eb8e9252626a1d6b519fedbb92d5e251"},
- {file = "aiohttp-3.14.1-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:c389c482a7e9b9dc3ee2701ac46c4125297a3818875b9c305ddb603c04828fd1"},
- {file = "aiohttp-3.14.1-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:fc0cacab7ba4e56f0f81c82a98c09bed2f39c940107b03a34b168bdf7597edd3"},
- {file = "aiohttp-3.14.1-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:979ed4717f59b8bb12e3963378fa285d93d367e15bcd66c721311826d3c44a6c"},
- {file = "aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:38e1e7daaea81df51c952e18483f323d878499a1e2bfe564790e0f9701d6f203"},
- {file = "aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:4132e72c608fe9fecb8f409113567605915b83e9bdd3ea56538d2f9cd35002f1"},
- {file = "aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:eefd9cc9b6d4a2db5f00a26bc3e4f9acf71926a6ec557cd56c9c6f27c290b665"},
- {file = "aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:b165790117eea512d7f3fb22f1f6dad3d55a7189571993eb015591c1401276d1"},
- {file = "aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:ed09c7eb1c391271c2ed0314a51903e72a3acb653d5ccfc264cdf3ef11f8269d"},
- {file = "aiohttp-3.14.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:99abd37084b82f5830c635fddd0b4993b9742a66eb746dacf433c8590e8f9e3c"},
- {file = "aiohttp-3.14.1-cp314-cp314t-win32.whl", hash = "sha256:47ddf841cdecc810749921d25606dee45857d12d2ad5ddb7b5bd7eab12e4b365"},
- {file = "aiohttp-3.14.1-cp314-cp314t-win_amd64.whl", hash = "sha256:5e78b522b7a6e27e0b25d19b247b75039ac4c94f99823e3c9e53ae1603a9f7e9"},
- {file = "aiohttp-3.14.1-cp314-cp314t-win_arm64.whl", hash = "sha256:90d53f1609c29ccc2193945ef732428382a28f78d0456ae4d3daf0d48b74f0f6"},
- {file = "aiohttp-3.14.1.tar.gz", hash = "sha256:307f2cff90a764d329e77040603fa032db89c5c24fdad50c4c15334cba744035"},
+ {file = "aiohttp-3.14.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:ceb77c159b2b4c1a179b96a26af36bcaa68eb79c393ec4f569386a69d013cbe9"},
+ {file = "aiohttp-3.14.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:3f3381f81bc1c6cbe160b2a3708d39d05014329118e6b648b95edc841eeeebd4"},
+ {file = "aiohttp-3.14.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:483b6f964bbbdaa99a0cd7def631208c44e39d243b95cff23ebc812db8a80e03"},
+ {file = "aiohttp-3.14.2-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:dc056948b7a8a40484b4bbc69923fa25cddd80cbc5f236a3a22ad2f836baeed2"},
+ {file = "aiohttp-3.14.2-cp310-cp310-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:135570f5b470c72c4988a58986f1f847ad336721f77fcc18fda8472bd3bbe3db"},
+ {file = "aiohttp-3.14.2-cp310-cp310-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:ee5bdd7933c653e43ef8d720704a4e228e4927121f2f5f598b7efe6a4c18633a"},
+ {file = "aiohttp-3.14.2-cp310-cp310-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:0baed2a2367a28456b612f4c3fd28bb86b00fadfb6454e706d8f65c21636bfd7"},
+ {file = "aiohttp-3.14.2-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ecdd6b8cab5b7c0ff2988378c11ba7192f076a1864e64dc3ff72f7ba05c71796"},
+ {file = "aiohttp-3.14.2-cp310-cp310-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:a3177e51e26e0158fb3376aebac97e0546c6f175c510f331f585e514a00a302b"},
+ {file = "aiohttp-3.14.2-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:86861a430657bc71e0f89b195de5f8fa495c0b9b5864cf2f89bd5ec1dbb6b77a"},
+ {file = "aiohttp-3.14.2-cp310-cp310-musllinux_1_2_armv7l.whl", hash = "sha256:aac1b05fc5e2ef188b6d74cf151e977db75ab281238f30c3163bbd6f797788e3"},
+ {file = "aiohttp-3.14.2-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:89120e926c68c4e60c78514d76e16fc15689d8df35843b2a6bf6c4cc0d64b11a"},
+ {file = "aiohttp-3.14.2-cp310-cp310-musllinux_1_2_riscv64.whl", hash = "sha256:82d14d66d6147441b6571833405c828980efc17bda98075a248104ffdd330c30"},
+ {file = "aiohttp-3.14.2-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:6cde463b9dd9ce4343785c5a39127b40fce059ae6fbd320f5a045a38c3d25cd0"},
+ {file = "aiohttp-3.14.2-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:2280d165ab38355144d9984cdce77ce506cee019a07390bab7fd13682248ce91"},
+ {file = "aiohttp-3.14.2-cp310-cp310-win32.whl", hash = "sha256:5e94a8c4445bfdaa30773c81f2be7f129673e0f528945e542b8bd024b2979134"},
+ {file = "aiohttp-3.14.2-cp310-cp310-win_amd64.whl", hash = "sha256:65cd3bb118f42fceceb9e8a615c735a01453d019c673f35c57b420601cc1a83a"},
+ {file = "aiohttp-3.14.2-cp310-cp310-win_arm64.whl", hash = "sha256:2a382aa6bb85347515ead043257445baeec0885d42bfedb962093b134c3b4816"},
+ {file = "aiohttp-3.14.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:56432ee8f7abe47c97717cfbf5c32430463ea8a7138e12a87b7891fa6084c8ff"},
+ {file = "aiohttp-3.14.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6c244f7a65cbec04c830a301aae443c529d4dbca5fddfd4b19e5a179d896adfd"},
+ {file = "aiohttp-3.14.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:1c05afdd28ecacce5a1f63275a2e3dce09efddd3a63d143ee9799fda83989c8d"},
+ {file = "aiohttp-3.14.2-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a57f39d6ec155932853b6b0f130cbbafab3208240fa807f29a2c96ea52b77ae1"},
+ {file = "aiohttp-3.14.2-cp311-cp311-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:1fc31339824ec922cb7424d624b5b6c11d8942d077b2585e5bd602ca1a1e27ed"},
+ {file = "aiohttp-3.14.2-cp311-cp311-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:d93854e215dcc7c88e4f530827193c1a594e2662931d8dbe7cca3abf52a7082d"},
+ {file = "aiohttp-3.14.2-cp311-cp311-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:87c9b03be0c18c3b3587be979149830381e37ac4a6ca8557dbe72e44fcad66c3"},
+ {file = "aiohttp-3.14.2-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:bc1a0793dce8fa9bb6906411e57fb18a2f1c31357b04172541b92b30337362a7"},
+ {file = "aiohttp-3.14.2-cp311-cp311-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:2f1b9540d2d0f2f95590528a1effd0ba5370f6ec189ac925e70b5eecae02dc77"},
+ {file = "aiohttp-3.14.2-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:c0a968b04fecf7c94e502015860ad1e2e112c6b761e97b6fdf65fbb374e22b73"},
+ {file = "aiohttp-3.14.2-cp311-cp311-musllinux_1_2_armv7l.whl", hash = "sha256:2d2eedae227cd5cbd0bccc5e759f71e1af2cd77b7f74ce413bb9a2b87f94a272"},
+ {file = "aiohttp-3.14.2-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:9d3f4c68b2c2cd282b65e558cebf4b27c8b440ab511f2b938a643d3598df2ddb"},
+ {file = "aiohttp-3.14.2-cp311-cp311-musllinux_1_2_riscv64.whl", hash = "sha256:d32a70b8bf8836fd80d4169d9e34eb032cd2a7cbccb0b9cf00eac1f40732467c"},
+ {file = "aiohttp-3.14.2-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:386ce4e709b4cc40f9ef9a132ad8e672d2d164a65451305672df656e7794c68e"},
+ {file = "aiohttp-3.14.2-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:bc0ed30b942c3bd755583d74bb00b90248c067d20b1f8301e4489a53a33aa65f"},
+ {file = "aiohttp-3.14.2-cp311-cp311-win32.whl", hash = "sha256:b5ed2c7dacebf4950d6b4a1b22548e4d709bb15e0287e064a7cdb32ada65893a"},
+ {file = "aiohttp-3.14.2-cp311-cp311-win_amd64.whl", hash = "sha256:bf7951959a8e89f2d4a1e719e60d3ea4e8fc26f011ee3aed09598ad786b112f7"},
+ {file = "aiohttp-3.14.2-cp311-cp311-win_arm64.whl", hash = "sha256:c167127a3b6089ef78ac2e33582c38040d51688ee28474b5053acf55f192187b"},
+ {file = "aiohttp-3.14.2-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:30e41662123806e4590a0440585122ac33c89a2465a8be81cc1b50656ca0e432"},
+ {file = "aiohttp-3.14.2-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:dbc45e2773c66d14fbd337754e9bf23932beef539bd539716a721f5b5f372034"},
+ {file = "aiohttp-3.14.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:476cf7fac10619ad6d08e1df0225d07b5a8d57c04963a171ad845d5a349d47ef"},
+ {file = "aiohttp-3.14.2-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:40bedff39ea83185f3f98a41155dd9da28b365c432e5bd90e7be140bcef0b7f3"},
+ {file = "aiohttp-3.14.2-cp312-cp312-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:a26f14006883fc7662e21041b4311eac1acbc977a5c43aacb27ff17f8a4c28b2"},
+ {file = "aiohttp-3.14.2-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:673217cbc9370ebf8cd048b0889d7cbe922b7bb48f4e4c02d31cfefa140bd946"},
+ {file = "aiohttp-3.14.2-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:b39dbdbe30a44958d63f3f8baa2af68f24ec8a631dcd18a33dd76dfa2a0eb917"},
+ {file = "aiohttp-3.14.2-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:d15f618255fcbe5f54689403aa4c2a90b6f2e6ebc96b295b1cb0e868c1c12384"},
+ {file = "aiohttp-3.14.2-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:7ae767b7dffd316cc2d0abf3e1f90132b4c1a2819a32d8bcb1ba749800ea6273"},
+ {file = "aiohttp-3.14.2-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:3ec4b6501a076b2f73844256da17d6b7acb15bb74ee0e908a67feb9412371166"},
+ {file = "aiohttp-3.14.2-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:7e328d02fb46b9a8dbfa070d98967e8b7eaa1d9ee10ae03fb664bdf30d58ccf0"},
+ {file = "aiohttp-3.14.2-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:c0c7f2e5fe10910d5ab76438f269cc41bb7e499fd48ded978e926360ab1790c8"},
+ {file = "aiohttp-3.14.2-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:66de80888db2176655f8df0b705b817f5ae3834e6566cc2caa89360871d90195"},
+ {file = "aiohttp-3.14.2-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:f2f9950b2dd0fc896ab520ea2366b7df6484d3d164a65d5e9f28f7b0e5742d8a"},
+ {file = "aiohttp-3.14.2-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:cc4435b16dc246c5dfa7f2f8ee71b10a30765018a090ee36e99f356b1e9b75cc"},
+ {file = "aiohttp-3.14.2-cp312-cp312-win32.whl", hash = "sha256:4ca802547f1128008addfc21b24959f5cbf30a8952d365e7daa078a0d884b242"},
+ {file = "aiohttp-3.14.2-cp312-cp312-win_amd64.whl", hash = "sha256:e5efff8bfd27c44ce1bfdf92ce838362d9316ed8b2ed2f89f581dbe0bbe05acf"},
+ {file = "aiohttp-3.14.2-cp312-cp312-win_arm64.whl", hash = "sha256:0eb1c9fd51f231ac8dc9d5824d5c2efc45337d429db0123fa9d4c20f570fdfc3"},
+ {file = "aiohttp-3.14.2-cp313-cp313-android_21_arm64_v8a.whl", hash = "sha256:17eecd6ee9bfc8e31b6003137d74f349f0ac3797111a2df87e23acb4a7a912ea"},
+ {file = "aiohttp-3.14.2-cp313-cp313-android_21_x86_64.whl", hash = "sha256:ce8dfb58f012f76258f29951d38935ac928b32ae24a480f30761f2ed5036fa78"},
+ {file = "aiohttp-3.14.2-cp313-cp313-ios_13_0_arm64_iphoneos.whl", hash = "sha256:4181d72e0e6d1735c1fae56381193c6ae211d584d06413980c00775b9b2a176a"},
+ {file = "aiohttp-3.14.2-cp313-cp313-ios_13_0_arm64_iphonesimulator.whl", hash = "sha256:0e56babe35076f69ec9327833b71439eeccd10f51fe56c1a533da8f24923f014"},
+ {file = "aiohttp-3.14.2-cp313-cp313-ios_13_0_x86_64_iphonesimulator.whl", hash = "sha256:6b63709e259e3b3d7922b235606564e91ed4c224e777cc0ca4cae04f5f559206"},
+ {file = "aiohttp-3.14.2-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:f7c10c4d0b33888a68c192d883d1390d4596c116a59bf689e6d352c6739b7940"},
+ {file = "aiohttp-3.14.2-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:8f7b19e27b78a3a927b1932af93af7645806153e8f541cee8fe856426142503f"},
+ {file = "aiohttp-3.14.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:18fcc3a5cc7dde1d8f7903e309055294c28894c9434588645817e374f3b83d03"},
+ {file = "aiohttp-3.14.2-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:09d1b0deec698d1198eb0b8f910dd9432d856985abbfea3f06be8b296a6619b4"},
+ {file = "aiohttp-3.14.2-cp313-cp313-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:cabaaecb4c6888bd9abafac151051377534dad4c3859a386b6325f39d3732f99"},
+ {file = "aiohttp-3.14.2-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:114299c08cce8ad4ebb21fafe766378864109e88ad8cf63cf6acb384ff844a57"},
+ {file = "aiohttp-3.14.2-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:6bea8451e26cd67645d9b2ee18232e438ddfc36cea35feecb4537f2359fc7030"},
+ {file = "aiohttp-3.14.2-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:46b8887aa303075c1e5b24123f314a1a7bbfa03d0213dff8bb70503b2148c853"},
+ {file = "aiohttp-3.14.2-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:de3b04a3f7b40ad7f1bcd3540dd447cf9bd93d57a49969bca522cbcf01290f08"},
+ {file = "aiohttp-3.14.2-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:42372e1f1a8dca0dcd5daf922849004ec1120042d0e24f14c926f97d2275ca79"},
+ {file = "aiohttp-3.14.2-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:7871c94f3400358530ac4906dd7a526c5a24099cd5c48f53ffc4b1cb5037d7d7"},
+ {file = "aiohttp-3.14.2-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:f8f371794319a8185e61e15ba5e1be8407b986ebce1ade11856c02d24e090577"},
+ {file = "aiohttp-3.14.2-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:af63ac06bad85191e6a0c4a733cb3c55adb99f8105bc7ce9913391561159a49a"},
+ {file = "aiohttp-3.14.2-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:8c2cdb684c153f377157e856257ee8535c75d8478343e4bb1e83ca73bdfa3d31"},
+ {file = "aiohttp-3.14.2-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:ceff4f84c1d928654faa6bcb0437ed095b279baae2a35fcfe5a3cbe0d8b9725d"},
+ {file = "aiohttp-3.14.2-cp313-cp313-win32.whl", hash = "sha256:15292b08ce7dd45e268fce542228894b4735102e8ee77163bd665b35fc2b5598"},
+ {file = "aiohttp-3.14.2-cp313-cp313-win_amd64.whl", hash = "sha256:fc2d8e7373ceba7e1c7e9dc00adac854c2701a6d443fd21d4af2e49342d727bd"},
+ {file = "aiohttp-3.14.2-cp313-cp313-win_arm64.whl", hash = "sha256:70570f50bda5037b416db8fcba595cf808ecf0fdce12d64e850b5ae1db7f64d4"},
+ {file = "aiohttp-3.14.2-cp314-cp314-android_24_arm64_v8a.whl", hash = "sha256:7719cef2a9dc5e10cd5f476ec1744b25c5ac4da733a9a687d91c42de7d4afe30"},
+ {file = "aiohttp-3.14.2-cp314-cp314-android_24_x86_64.whl", hash = "sha256:3523ec0cc524a413699f25ec8340f3da368484bc9d5f2a1bf87f233ac20599bf"},
+ {file = "aiohttp-3.14.2-cp314-cp314-ios_13_0_arm64_iphoneos.whl", hash = "sha256:c8ab295ee58332ef8fbd62727df90540836dfcf7a61f545d0f2771223b80bf25"},
+ {file = "aiohttp-3.14.2-cp314-cp314-ios_13_0_arm64_iphonesimulator.whl", hash = "sha256:71501bc03ede681401269c569e6f9306c761c1c7d4296675e8e78dd07147070f"},
+ {file = "aiohttp-3.14.2-cp314-cp314-ios_13_0_x86_64_iphonesimulator.whl", hash = "sha256:052478c7d01035d805302db50c2ef626b1c1ba0fe2f6d4a22ae6eaeb43bf2316"},
+ {file = "aiohttp-3.14.2-cp314-cp314-macosx_10_15_universal2.whl", hash = "sha256:b0d49be9d9a210b2c993bf32b1eda03f949f7bcda68fc4f718ae8085ae3fb4b8"},
+ {file = "aiohttp-3.14.2-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:5fe25c4c44ea5b56fd4512e2065e09384987fc8cc98e41bc8749efe12f653abb"},
+ {file = "aiohttp-3.14.2-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:7e254b0d636957174a03ca210289e867a62bb9502081e1b44a8c2bb1f6266ecd"},
+ {file = "aiohttp-3.14.2-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a6b0ce033d49dd3c6a2566b387e322a9f9029110d67902f0d64571c0fd4b73d8"},
+ {file = "aiohttp-3.14.2-cp314-cp314-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:41b5b66b1ac2c48b61e420691eb9741d17d9068f2bc23b5ee3e750faa564bc8f"},
+ {file = "aiohttp-3.14.2-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:30a5ed81f752f182961237414a3cd0af209c0f74f06d66f66f9fcb8964f4978d"},
+ {file = "aiohttp-3.14.2-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:1b9251f43d78ff675c0ddfcd53ba61abecc1f74eedc6287bb6657f6c6a033fe7"},
+ {file = "aiohttp-3.14.2-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:cf7930e83a12801b2e253d41cc8bf5553f61c0cfabef182a72ae13472cc81803"},
+ {file = "aiohttp-3.14.2-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:abb33120daba5e5643a757790ece44d638a5a11eb0598312e6e7ec2f1bd1a5a3"},
+ {file = "aiohttp-3.14.2-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:983a68048a48f35ed08aadfcc1ba55de9a121aa91be48a764965c9ec532b94b5"},
+ {file = "aiohttp-3.14.2-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:fef094bfc2f4e991a998af066fc6e3956a409ef799f5cbad2365175357181f2e"},
+ {file = "aiohttp-3.14.2-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:2f7ca81d936d820ae479971a6b6214b1b867420b5b58e54a1e7157716a943754"},
+ {file = "aiohttp-3.14.2-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:da4f142fa078fedbdb3f88d0542ad9315656224e167502ae274cbba818b90c90"},
+ {file = "aiohttp-3.14.2-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:3d4238e50a378f5ac69a1e0162715c676bd082dede2e5c4f67ca7fd0014cb09d"},
+ {file = "aiohttp-3.14.2-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:03330676d8caa28bb33fa7104b0d542d9aac93350abcd91bf68e64abd531c320"},
+ {file = "aiohttp-3.14.2-cp314-cp314-win32.whl", hash = "sha256:43387429e4f2ec4047aaf9f935db003d4aa1268ea9021164877fd6b012b6396a"},
+ {file = "aiohttp-3.14.2-cp314-cp314-win_amd64.whl", hash = "sha256:e3a6302f47518dbf2ffd3cd518f02a1fbf53f85ffeed41a224fa4a6f6a62673b"},
+ {file = "aiohttp-3.14.2-cp314-cp314-win_arm64.whl", hash = "sha256:8d1f3802887f0e0dc07387a081dca3ad0b5758e32bdf5fb619b12ac22b8e9b56"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-macosx_10_15_universal2.whl", hash = "sha256:9094262ae4f2902c7291c14ba915960db5567276690ef9195cdefe8b7cbb3acb"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:165b0dcc65960ffc9c99aa4ba1c3c76dbc7a34845c3c23a0bd3fbf33b3d12569"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:f518d75c03cd3f7f125eca1baadb56f8b94db94602278d2d0d19af6e177650a7"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:9b937d7864ca68f1e8a1c3a4eb2bac1de86a992f86d36492da10a135a482fab6"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:b155df7f572c73c6c4108b67be302c8639b96ae56fb02787eeae8cad0a1baf26"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:0bfea68a48c8071d49aabdf5cd9a6939dcb246db65730e8dc76295fe02f7c73c"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:8241ee6c7fff3ebb1e6b237bccc1d90b46d07c06cf978e9f2ecad43e29dac67a"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ec64d1c4605d689ed537ba1e572138e2d4ff603a0cb2bbbfe61d4552c73d19e1"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:0fb26fcc5ebf765095fe0c6ab7501574d3108c57fca9a0d462be15a65c9deb8d"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:ef710fbb770aefa4def5484eeddb606e70ab3492aa37390def61b35652f6820a"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:d813f54560b9e5bce170fff7b0adde54d88253928e4add447c36792f27f92125"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:1aa4f3b44563a88da4407cef8a13438e9e386967720a826a10a633493f69208f"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:4610638d3135afaefadf179bffd1bbf3434d3dc7a5d0a4c4219b99fa976e944d"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:6e30743bd3ab6ad98e9abbad6ccb39c52bcf6f11f9e3d4b6df97afffe8df53f3"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:68a6f7cd8d2c70869a2a5fe97a16e86a4e13a6ed6f0d9e6029aef7573e344cd6"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-win32.whl", hash = "sha256:205181d896f73436ac60cf6644e545544c759ab1c3ec8c34cc1e044689611361"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-win_amd64.whl", hash = "sha256:312d414c294a1e26aa12888e8fd37cd2e1131e9c48ddcf2a4c6b590290d52a49"},
+ {file = "aiohttp-3.14.2-cp314-cp314t-win_arm64.whl", hash = "sha256:63b840c03979732ec92e570f0bd6beb6311e2b5d19cacbfcd8cc7f6dd2693900"},
+ {file = "aiohttp-3.14.2.tar.gz", hash = "sha256:f96821eb2ae2f12b0dfa799eafbf221f5621a9220b457b4744a269a63a5f3a6c"},
]
[package.dependencies]
@@ -181,13 +181,13 @@ files = [
[[package]]
name = "anyio"
-version = "4.14.1"
+version = "4.14.2"
description = "High-level concurrency and networking framework on top of asyncio or Trio"
optional = false
python-versions = ">=3.10"
files = [
- {file = "anyio-4.14.1-py3-none-any.whl", hash = "sha256:4e5533c5b8ff0a24f5d7a176cbe6877129cd183893f66b537f8f227d10527d72"},
- {file = "anyio-4.14.1.tar.gz", hash = "sha256:8d648a3544c1a700e3ff78615cd679e4c5c3f149904287e73687b2596963629e"},
+ {file = "anyio-4.14.2-py3-none-any.whl", hash = "sha256:9f505dda5ac9f0c8309b5e8bd445a8c2bf7246f3ce950121e45ea15bc41d1494"},
+ {file = "anyio-4.14.2.tar.gz", hash = "sha256:cfa139f3ed1a23ee8f88a145ddb5ac7605b8bbfd8592baacd7ce3d8bb4313c7f"},
]
[package.dependencies]
@@ -1238,24 +1238,24 @@ files = [
[[package]]
name = "types-python-dateutil"
-version = "2.9.0.20260518"
+version = "2.9.0.20260716"
description = "Typing stubs for python-dateutil"
optional = false
python-versions = ">=3.10"
files = [
- {file = "types_python_dateutil-2.9.0.20260518-py3-none-any.whl", hash = "sha256:d6a9c5bd0de61460c8fdef8ab2b400f956a1a1075cce08d4e2b4434e478c50b8"},
- {file = "types_python_dateutil-2.9.0.20260518.tar.gz", hash = "sha256:51f02dc03b61c7f6a07df45797d4dfe8a1aa47f0b7db9ad89f6fd3a1a70e1b51"},
+ {file = "types_python_dateutil-2.9.0.20260716-py3-none-any.whl", hash = "sha256:1ae41d51a5c5f6bbeeb7f1f34df7086d55ff1605cf88d2ed71a7a276e1a7794e"},
+ {file = "types_python_dateutil-2.9.0.20260716.tar.gz", hash = "sha256:1d55d1c3024bdb4861bb6a6622c9ec800c433d87bdc5b16fb84cdd0eed4ef2cb"},
]
[[package]]
name = "typing-extensions"
-version = "4.15.0"
+version = "4.16.0"
description = "Backported and Experimental Type Hints for Python 3.9+"
optional = false
python-versions = ">=3.9"
files = [
- {file = "typing_extensions-4.15.0-py3-none-any.whl", hash = "sha256:f0fa19c6845758ab08074a0cfa8b7aecb71c999ca73d62883bc25cc018c4e548"},
- {file = "typing_extensions-4.15.0.tar.gz", hash = "sha256:0cea48d173cc12fa28ecabc3b837ea3cf6f38c6d1136f85cbaaf598984861466"},
+ {file = "typing_extensions-4.16.0-py3-none-any.whl", hash = "sha256:481caa481374e813c1b176ada14e97f1f67a4539ce9cfeb3f350d78d6370c2e8"},
+ {file = "typing_extensions-4.16.0.tar.gz", hash = "sha256:dc983d19a509c94dba722ee6abd33940f7c05a89e243c47e907eb4db6f1a43e5"},
]
[[package]]
@@ -1274,115 +1274,115 @@ typing-extensions = ">=4.12.0"
[[package]]
name = "yarl"
-version = "1.24.2"
+version = "1.24.5"
description = "Yet another URL library"
optional = true
python-versions = ">=3.10"
files = [
- {file = "yarl-1.24.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:5249a113065c2b7a958bc699759e359cd61cfc81e3069662208f48f191b7ed12"},
- {file = "yarl-1.24.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7f4425fa244fbf530b006d0c5f79ce920114cfff5b4f5f6056e669f8e160fdc0"},
- {file = "yarl-1.24.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:15c0b5e49d3c44e2a0b93e6a49476c5edad0a7686b92c395765a7ea775572a75"},
- {file = "yarl-1.24.2-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:246d32a53a947c8f0189f5d699cbd4c7036de45d9359e13ba238d1239678c727"},
- {file = "yarl-1.24.2-cp310-cp310-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:64480fb3e4d4ed9ed71c48a91a477384fc342a50ca30071d2f8a88d51d9c9413"},
- {file = "yarl-1.24.2-cp310-cp310-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:349de4701dc3760b6e876628423a8f147ef4f5599d10aba1e10702075d424ed9"},
- {file = "yarl-1.24.2-cp310-cp310-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:d162677af8d5d3d6ebab8394b021f4d041ac107a4b705873148a77a49dc9e1b2"},
- {file = "yarl-1.24.2-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:f5f5c6ec23a9043f2d139cc072f53dd23168d202a334b9b2fda8de4c3e890d90"},
- {file = "yarl-1.24.2-cp310-cp310-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:60de6742447fbbf697f16f070b8a443f1b5fe6ca3826fbef9fe70ecd5328e643"},
- {file = "yarl-1.24.2-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:acf93187c3710e422368eb768aee98db551ec7c85adc250207a95c16548ab7ac"},
- {file = "yarl-1.24.2-cp310-cp310-musllinux_1_2_armv7l.whl", hash = "sha256:f4b0352fd41fd34b6651934606268816afd6914d09626f9bcbbf018edb0afb3f"},
- {file = "yarl-1.24.2-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:6b208bb939099b4b297438da4e9b25357f0b1c791888669b963e45b203ea9f36"},
- {file = "yarl-1.24.2-cp310-cp310-musllinux_1_2_riscv64.whl", hash = "sha256:4b85b8825e631295ff4bc8943f7471d54c533a9360bbe15ebb38e018b555bb8a"},
- {file = "yarl-1.24.2-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:e26acf20c26cb4fefc631fdb75aca2a6b8fa8b7b5d7f204fb6a8f1e63c706f53"},
- {file = "yarl-1.24.2-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:819ca24f8eafcfb683c1bd5f44f2f488cea1274eb8944731ffd2e1f10f619342"},
- {file = "yarl-1.24.2-cp310-cp310-win_amd64.whl", hash = "sha256:5cb0f995a901c36be096ccbf4c673591c2faabbe96279598ffaec8c030f85bf4"},
- {file = "yarl-1.24.2-cp310-cp310-win_arm64.whl", hash = "sha256:f408eace7e22a68b467a0562e0d27d322f91fe3eaaa6f466b962c6cfaea9fa39"},
- {file = "yarl-1.24.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:36348bebb147b83818b9d7e673ea4debc75970afc6ffdc7e3975ad05ce5a58c1"},
- {file = "yarl-1.24.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:1a97e42c8a2233f2f279ecadd9e4a037bcb5d813b78435e8eedd4db5a9e9708c"},
- {file = "yarl-1.24.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:8d027d56f1035e339d1001ac33eceab5b2ec8e42e449787bb75e289fb9a5cd1d"},
- {file = "yarl-1.24.2-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0a6377060e7927187a42b7eb202090cbe2b34933a4eeaf90e3bd9e33432e5cae"},
- {file = "yarl-1.24.2-cp311-cp311-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:17076578bce0049a5ce57d14ad1bded391b68a3b213e9b81b0097b090244999a"},
- {file = "yarl-1.24.2-cp311-cp311-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:50713f1d4d6be6375bb178bb43d140ee1acb8abe589cd723320b7925a275be1e"},
- {file = "yarl-1.24.2-cp311-cp311-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:34263e2fa8fb5bb63a0d97706cda38edbad62fddb58c7f12d6acbc092812aa50"},
- {file = "yarl-1.24.2-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:49016d82f032b1bd1e10b01078a7d29ae71bf468eeae0ea22df8bab691e60003"},
- {file = "yarl-1.24.2-cp311-cp311-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:3f6d2c216318f8f32038ca3f72501ba08536f0fd18a36e858836b121b2deed9f"},
- {file = "yarl-1.24.2-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:08d3a33218e0c64393e7610284e770409a9c31c429b078bcb24096ed0a783b8f"},
- {file = "yarl-1.24.2-cp311-cp311-musllinux_1_2_armv7l.whl", hash = "sha256:5d699376c4ca3cba49bbfae3a05b5b70ded572937171ce1e0b8d87118e2ba294"},
- {file = "yarl-1.24.2-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:a1cab588b4fa14bea2e55ebea27478adfb05372f47573738e1acc4a36c0b05d2"},
- {file = "yarl-1.24.2-cp311-cp311-musllinux_1_2_riscv64.whl", hash = "sha256:ec87ccc31bd21db7ad009d8572c127c1000f268517618a4cc09adba3c2a7f21c"},
- {file = "yarl-1.24.2-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:d1dd47a22843b212baa8d74f37796815d43bd046b42a0f41e9da433386c3136b"},
- {file = "yarl-1.24.2-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:7b54b9c67c2b06bd7b9a77253d242124b9c95d2c02def5a1144001ee547dd9d5"},
- {file = "yarl-1.24.2-cp311-cp311-win_amd64.whl", hash = "sha256:f8fdbcff8b2c7c9284e60c196f693588598ddcee31e11c18e14949ce44519d45"},
- {file = "yarl-1.24.2-cp311-cp311-win_arm64.whl", hash = "sha256:b32c37a7a337e90822c45797bf3d79d60875cfcccd3ecc80e9f453d87026c122"},
- {file = "yarl-1.24.2-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:b975866c184564c827e0877380f0dae57dcca7e52782128381b72feff6dfceb8"},
- {file = "yarl-1.24.2-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:3b075301a2836a0e297b1b658cb6d6135df535d62efefdd60366bd589c2c82f2"},
- {file = "yarl-1.24.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8ae44649b00947634ab0dab2a374a638f52923a6e67083f2c156cd5cbd1a881d"},
- {file = "yarl-1.24.2-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:507cc19f0b45454e2d6dcd62ff7d062b9f77a2812404e62dbdaec05b50faa035"},
- {file = "yarl-1.24.2-cp312-cp312-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:c4c17bad5a530912d2111825d3f05e89bab2dd376aaa8cbc77e449e6db63e576"},
- {file = "yarl-1.24.2-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:f5f0cbb112838a4a293985b6ed73948a547dadcc1ba6d2089938e7abdedceef8"},
- {file = "yarl-1.24.2-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:5ec8356b8a6afcf81fc7aeeef13b1ff7a49dec00f313394bbb9e83830d32ccd7"},
- {file = "yarl-1.24.2-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7e7ebcdef69dec6c6451e616f32b622a6d4a2e92b445c992f7c8e5274a6bbc4c"},
- {file = "yarl-1.24.2-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:47a55d6cf6db2f401017a9e96e5288844e5051911fb4e0c8311a3980f5e59a7d"},
- {file = "yarl-1.24.2-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:3065657c80a2321225e804048597ad55658a7e76b32d6f5ee4074d04c50401db"},
- {file = "yarl-1.24.2-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:cb84b80d88e19ede158619b80813968713d8d008b0e2497a576e6a0557d50712"},
- {file = "yarl-1.24.2-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:990de4f680b1c217e77ff0d6aa0029f9eb79889c11fb3e9a3942c7eba29c1996"},
- {file = "yarl-1.24.2-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:abb8ec0323b80161e3802da3150ef660b41d0e9be2048b76a363d93eee992c2b"},
- {file = "yarl-1.24.2-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:e7977781f83638a4c73e0f88425563d70173e0dfd90ac006a45c65036293ee3c"},
- {file = "yarl-1.24.2-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:e30dd55825dc554ec5b66a94953b8eda8745926514c5089dfcacecb9c99b5bd1"},
- {file = "yarl-1.24.2-cp312-cp312-win_amd64.whl", hash = "sha256:7dafe10c12ddd4d120d528c4b5599c953bd7b12845347d507b95451195bb6cad"},
- {file = "yarl-1.24.2-cp312-cp312-win_arm64.whl", hash = "sha256:044a09d8401fcf8681977faef6d286b8ade1e2d2e9dceda175d1cfa5ca496f30"},
- {file = "yarl-1.24.2-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:491ac9141decf49ee8030199e1ee251cdff0e131f25678817ff6aa5f837a3536"},
- {file = "yarl-1.24.2-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:e89418f65eda18f99030386305bd44d7d504e328a7945db1ead514fbe03a0607"},
- {file = "yarl-1.24.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:cdfcce633b4a4bb8281913c57fcafd4b5933fbc19111a5e3930bbd299d6102f1"},
- {file = "yarl-1.24.2-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:863297ddede92ee49024e9a9b11ecb59f310ca85b60d8537f56bed9bbb5b1986"},
- {file = "yarl-1.24.2-cp313-cp313-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:374423f70754a2c96942ede36a29d37dc6b0cb8f92f8d009ddf3ed78d3da5488"},
- {file = "yarl-1.24.2-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:33a29b5d00ccbf3219bb3e351d7875739c19481e030779f48cc46a7a71681a9b"},
- {file = "yarl-1.24.2-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a9532c57211730c515341af11fef6e9b61d157487272a096d0c04da445642592"},
- {file = "yarl-1.24.2-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:91e72cf093fd833483a97ee648e0c053c7c629f51ff4a0e7edd84f806b0c5617"},
- {file = "yarl-1.24.2-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:b3177bc0a768ef3bacceb4f272632990b7bea352f1b2f1eee9d6d6ff16516f92"},
- {file = "yarl-1.24.2-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:e196952aacaf3b232e265ff02980b64d483dc0972bd49bcb061171ff22ac203a"},
- {file = "yarl-1.24.2-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:204e7a61ce99919c0de1bf904ab5d7aa188a129ea8f690a8f76cfb6e2844dc44"},
- {file = "yarl-1.24.2-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:4b156914620f0b9d78dc1adb3751141daee561cfec796088abb89ed49d220f1a"},
- {file = "yarl-1.24.2-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:8372a2b976cf70654b2be6619ab6068acabb35f724c0fda7b277fbf53d66a5cf"},
- {file = "yarl-1.24.2-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:f9a1e9b622ca284143aab5d885848686dcd85453bb1ca9abcdb7503e64dc0056"},
- {file = "yarl-1.24.2-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:810e19b685c8c3c5862f6a38160a1f4e4c0916c9390024ec347b6157a45a0992"},
- {file = "yarl-1.24.2-cp313-cp313-win_amd64.whl", hash = "sha256:7d37fb7c38f2b6edab0f845c4f85148d4c44204f52bc127021bd2bc9fdbf1656"},
- {file = "yarl-1.24.2-cp313-cp313-win_arm64.whl", hash = "sha256:1e831894be7c2954240e49791fa4b50c05a0dc881de2552cfe3ffd8631c7f461"},
- {file = "yarl-1.24.2-cp314-cp314-macosx_10_15_universal2.whl", hash = "sha256:f9312b3c02d9b3d23840f67952913c9c8721d7f1b7db305289faefa878f364c2"},
- {file = "yarl-1.24.2-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:a4f4d6cd615823bfc7fb7e9b5987c3f41666371d870d51058f77e2680fbe9630"},
- {file = "yarl-1.24.2-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:0c3063e5c0a8e8e62fae6c2596fa01da1561e4cd1da6fec5789f5cf99a8aefd8"},
- {file = "yarl-1.24.2-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:fecd17873a096036c1c87ab3486f1aef7f269ada7f23f7f856f93b1cc7744f14"},
- {file = "yarl-1.24.2-cp314-cp314-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:a46d1ab4ba4d32e6dc80daf8a28ce0bd83d08df52fbc32f3e288663427734535"},
- {file = "yarl-1.24.2-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:73e68edf6dfd5f73f9ca127d84e2a6f9213c65bdffb736bda19524c0564fcd14"},
- {file = "yarl-1.24.2-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a296ca617f2d25fbceafb962b88750d627e5984e75732c712154d058ae8d79a3"},
- {file = "yarl-1.24.2-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:e51b2cf5ec89a8b8470177641ed62a3ba22d74e1e898e06ad53aa77972487208"},
- {file = "yarl-1.24.2-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:310fc687f7b2044ec54e372c8cbe923bb88f5c37bded0d3079e5791c2fc3cf50"},
- {file = "yarl-1.24.2-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:297a2fe352ecf858b30a98f87948746ec16f001d279f84aebdbd3bd965e2f1bd"},
- {file = "yarl-1.24.2-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:2a263e76b97bc42bdcd7c5f4953dec1f7cd62a1112fa7f869e57255229390d67"},
- {file = "yarl-1.24.2-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:822519b64cf0b474f1a0aaef1dc621438ea46bb77c94df97a5b4d213a7d8a8b1"},
- {file = "yarl-1.24.2-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:b6067060d9dc594899ba83e6db6c48c68d1e494a6dab158156ed86977ca7bcb1"},
- {file = "yarl-1.24.2-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:0063adad533e57171b79db3943b229d40dfafeeee579767f96541f106bac5f1b"},
- {file = "yarl-1.24.2-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:ee8e3fb34513e8dc082b586ef4910c98335d43a6fab688cd44d4851bacfce3e8"},
- {file = "yarl-1.24.2-cp314-cp314-win_amd64.whl", hash = "sha256:afb00d7fd8e0f285ca29a44cc50df2d622ff2f7a6d933fa641577b5f9d5f3db0"},
- {file = "yarl-1.24.2-cp314-cp314-win_arm64.whl", hash = "sha256:68cf6eacd6028ef1142bc4b48376b81566385ca6f9e7dde3b0fa91be08ffcb57"},
- {file = "yarl-1.24.2-cp314-cp314t-macosx_10_15_universal2.whl", hash = "sha256:221ce1dd921ac4f603957f17d7c18c5cc0797fbb52f156941f92e04605d1d67b"},
- {file = "yarl-1.24.2-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:5f3224db28173a00d7afacdee07045cc4673dfab2b15492c7ae10deddbece761"},
- {file = "yarl-1.24.2-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c557165320d6244ebe3a02431b2a201a20080e02f41f0cfa0ccc47a183765da8"},
- {file = "yarl-1.24.2-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:904065e6e85b1fa54d0d87438bd58c14c0bad97aad654ad1077fd9d87e8478ed"},
- {file = "yarl-1.24.2-cp314-cp314t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:8cec2a38d70edc10e0e856ceda886af5327a017ccbde8e1de1bd44d300357543"},
- {file = "yarl-1.24.2-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:e7484b9361ed222ee1ca5b4337aa4cbdcc4618ce5aff57d9ef1582fd95893fc0"},
- {file = "yarl-1.24.2-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:84f9670b89f34db07f81e53aee83e0b938a3412329d51c8f922488be7fcc4024"},
- {file = "yarl-1.24.2-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:abb2759733d63a28b4956500a5dd57140f26486c92b2caedfb964ab7d9b79dbf"},
- {file = "yarl-1.24.2-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:081c2bf54efe03774d0311172bc04fedf9ca01e644d4cd8c805688e527209bdc"},
- {file = "yarl-1.24.2-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:86746bef442aa479107fe28132e1277237f9c24c2f00b0b0cf22b3ee0904f2bb"},
- {file = "yarl-1.24.2-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:2d07d21d0bc4b17558e8de0b02fbfdf1e347d3bb3699edd00bb92e7c57925420"},
- {file = "yarl-1.24.2-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:4fb1ac3fc5fecd8ae7453ea237e4d22b49befa70266dfe1629924245c21a0c7f"},
- {file = "yarl-1.24.2-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:4da31a5512ed1729ca8d8aacde3f7faeb8843cde3165d6bcf7f88f74f17bb8aa"},
- {file = "yarl-1.24.2-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:533ded4dceb5f1f3da7906244f4e82cf46cfd40d84c69a1faf5ac506aa65ecbe"},
- {file = "yarl-1.24.2-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:7b3a85525f6e7eeabcfdd372862b21ee1915db1b498a04e8bf0e389b607ff0bd"},
- {file = "yarl-1.24.2-cp314-cp314t-win_amd64.whl", hash = "sha256:a7624b1ca46ca5d7b864ef0d2f8efe3091454085ee1855b4e992314529972215"},
- {file = "yarl-1.24.2-cp314-cp314t-win_arm64.whl", hash = "sha256:e434a45ce2e7a947f951fc5a8944c8cc080b7e59f9c50ae80fd39107cf88126d"},
- {file = "yarl-1.24.2-py3-none-any.whl", hash = "sha256:2783d9226db8797636cd6896e4de81feed252d1db72265686c9558d97a4d94b9"},
- {file = "yarl-1.24.2.tar.gz", hash = "sha256:9ac374123c6fd7abf64d1fec93962b0bd4ee2c19751755a762a72dd96c0378f8"},
+ {file = "yarl-1.24.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:88f50c94e21a0a7f14042c015b0eba1881af78562e7bf007e0033e624da59750"},
+ {file = "yarl-1.24.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:6efbccc3d7f75d5b03105172a8dc86d82ba4da86817952529dd93185f4a88be2"},
+ {file = "yarl-1.24.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:0ebfaffe1a16cb72141c8e09f18cc76856dbe58639f393a4f2b26e474b96b871"},
+ {file = "yarl-1.24.5-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:8ac73abdc7ab75610f95a8fd994c6457e87752b02a63987e188f937a1fc180f0"},
+ {file = "yarl-1.24.5-cp310-cp310-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:4d97a951a81039050e45f04e96689b58b8243fa5e62aa14fe67cb6075300885e"},
+ {file = "yarl-1.24.5-cp310-cp310-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:fe7b7bb170daccbba19ad33012d2b15f1e7942296fd4d45fc1b79013da8cc0f2"},
+ {file = "yarl-1.24.5-cp310-cp310-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:89a1bbb58e0e3f7a283653d854b1e95d65e5cfd4af224dac5f02629ec1a3e621"},
+ {file = "yarl-1.24.5-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7fa5e51397466ea7e98de493fa2ff1b8193cfef8a7b0f9b4842f92d342df0dba"},
+ {file = "yarl-1.24.5-cp310-cp310-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:4103b77b8a8225e413107d2349b65eb3c1c52627b5cc5c3c4c1c6a798b218950"},
+ {file = "yarl-1.24.5-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:f9f3e9c8a9ecffa57bef8fb4fa19e5fa4d2d8307cf6bac5b1fca5e5860f4ba00"},
+ {file = "yarl-1.24.5-cp310-cp310-musllinux_1_2_armv7l.whl", hash = "sha256:c0ebc836c47a6477e182169c6a476fc691d12b518894bf7dd2572f0d59f1c7ed"},
+ {file = "yarl-1.24.5-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:96d30286dd02679e32a39aa8f0b7498fc847fcda46cfc09df5513e82ce252440"},
+ {file = "yarl-1.24.5-cp310-cp310-musllinux_1_2_riscv64.whl", hash = "sha256:fd8c81f346b58f45818d09ea11db69a8d5fd34a224b79871f6d44f12cd7977b1"},
+ {file = "yarl-1.24.5-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:5c55256dee8f4b27bfbf636c8363383c7c8db7890c7cba5217d7bd5f5f21dab6"},
+ {file = "yarl-1.24.5-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:9f4d8cf085a4c6a40fb97ea0f46938a8df43c85d31f9d45e2a8867ea9293790d"},
+ {file = "yarl-1.24.5-cp310-cp310-win_amd64.whl", hash = "sha256:240cbec09667c1fed4c6cd0060b9ec57332427d7441289a2ed8875dc9fb2b224"},
+ {file = "yarl-1.24.5-cp310-cp310-win_arm64.whl", hash = "sha256:8a6987eaad834cb32dd57d9d582225f0054a5d1af706ccfbbdba735af4927e13"},
+ {file = "yarl-1.24.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:2c1fe720934a16ea8e7146175cba2126f87f54912c8c5435e7f7c7a51ef808d3"},
+ {file = "yarl-1.24.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c687ed078e145f5fd53a14854beff320e1d2ab76df03e2009c98f39a0f68f39a"},
+ {file = "yarl-1.24.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:709f1efed56c4a145793c046cd4939f9959bcd818979a787b77d8e09c57a0840"},
+ {file = "yarl-1.24.5-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:874019bd513008b009f58657134e5d0c5e030b3559bd0553976837adf52fe966"},
+ {file = "yarl-1.24.5-cp311-cp311-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:a4582acf7ef76482f6f511ebaf1946dae7f2e85ec4728b81a678c01df63bd723"},
+ {file = "yarl-1.24.5-cp311-cp311-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:2cabe6546e41dabe439999a23fcb5246e0c3b595b4315b96ef755252be90caeb"},
+ {file = "yarl-1.24.5-cp311-cp311-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:17f57620f5475b3c69109376cc87e42a7af5db13c9398e4292772a706ff10780"},
+ {file = "yarl-1.24.5-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:570fec8fbd22b032733625f03f10b7ff023bc399213db15e72a7acaef28c2f4e"},
+ {file = "yarl-1.24.5-cp311-cp311-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:5fede79c6f73ff2c3ef822864cb1ada23196e62756df53bc6231d351a49516a2"},
+ {file = "yarl-1.24.5-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:8ccf9aca873b767977c73df497a85dbedee4ee086ae9ae49dc461333b9b79f58"},
+ {file = "yarl-1.24.5-cp311-cp311-musllinux_1_2_armv7l.whl", hash = "sha256:ad5d8201d310b031e6cd839d9bac2d4e5a01533ce5d3d5b50b7de1ef3af1de61"},
+ {file = "yarl-1.24.5-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:841f0852f48fefea3b12c9dfec00704dfa3aef5215d0e3ce564bb3d7cd8d57c6"},
+ {file = "yarl-1.24.5-cp311-cp311-musllinux_1_2_riscv64.whl", hash = "sha256:9baafc71b04f8f4bb0703b21d6fc9f0c30b346c636a532ff16ec8491a5ea4b1f"},
+ {file = "yarl-1.24.5-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:d897129df1a22b12aeed2c2c98df0785a2e8e6e0bde87b389491d0025c187077"},
+ {file = "yarl-1.24.5-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:dd625535328fd9882374356269227670189adfcc6a2d90284f323c05862eecbd"},
+ {file = "yarl-1.24.5-cp311-cp311-win_amd64.whl", hash = "sha256:f4239bbec5a3577ddb49e4b50aeb32d8e5792098262ae2f63723f916a29b1a25"},
+ {file = "yarl-1.24.5-cp311-cp311-win_arm64.whl", hash = "sha256:3ac6aff147deb9c09461b2d4bbdf6256831198f5d8a23f5d37138213090b6d8a"},
+ {file = "yarl-1.24.5-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:d693396e5aea78db03decd60aec9ece16c9b40ba00a587f089615ff4e718a81d"},
+ {file = "yarl-1.24.5-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:3363fcc96e665878946ad7a106b9a13eac0541766a690ef287c0232ac768b6ec"},
+ {file = "yarl-1.24.5-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:9d399bdcfb4a0f659b9b3788bbc89babe63d9a6a65aacdf4d4e7065ff2e6316c"},
+ {file = "yarl-1.24.5-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:90333fd89b43c0d08ac85f3f1447593fc2c66de18c3d6378d7125ea118dc7a54"},
+ {file = "yarl-1.24.5-cp312-cp312-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:665b0a2c463cc9423dd647e0bfd9f4ccc9b50f768c55304d5e9f80b177c1de12"},
+ {file = "yarl-1.24.5-cp312-cp312-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:e006d3a974c4ee19512e5f058abedb6eef36a5e553c14812bdeba1758d812e6d"},
+ {file = "yarl-1.24.5-cp312-cp312-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:e7d42c531243450ef0d4d9c172e7ed6ef052640f195629065041b5add4e058d1"},
+ {file = "yarl-1.24.5-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:f08c7513ecef5aad65687bfdf6bc601ae9fccd04a42904501f8f7141abad9eb9"},
+ {file = "yarl-1.24.5-cp312-cp312-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:6c95b17fe34ed802f17e205112e6e10db92275c34fee290aa9bdc55a9c724027"},
+ {file = "yarl-1.24.5-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:56b149b22de33b23b0c6077ab9518c6dcb538ad462e1830e68d06591ccf6e38b"},
+ {file = "yarl-1.24.5-cp312-cp312-musllinux_1_2_armv7l.whl", hash = "sha256:a8fe66b8f300da93798025a785a5b90b42f3810dc2b72283ff84a41aaaebc293"},
+ {file = "yarl-1.24.5-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:377fe3732edbaf78ee74efdf2c9f49f6e99f20e7f9d2649fda3eb4badd77d76e"},
+ {file = "yarl-1.24.5-cp312-cp312-musllinux_1_2_riscv64.whl", hash = "sha256:e8ffa78582120024f476a611d7befc123cee59e47e8309d470cf667d806e613b"},
+ {file = "yarl-1.24.5-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:daba5e594f06114e37db186efd2dd916609071e59daca901a0a2e71f02b142ce"},
+ {file = "yarl-1.24.5-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:65be18ec59496c13908f02a2472751d9ef840b4f3fb5726f129306bf6a2a7bba"},
+ {file = "yarl-1.24.5-cp312-cp312-win_amd64.whl", hash = "sha256:a929d878fec099030c292803b31e5d5540a7b6a31e6a3cc76cb4685fc2a2f51b"},
+ {file = "yarl-1.24.5-cp312-cp312-win_arm64.whl", hash = "sha256:7ce27823052e2013b597e0c738b13e7e36b8ccb9400df8959417b052ab0fd92c"},
+ {file = "yarl-1.24.5-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:79af890482fc94648e8cde4c68620378f7fef60932710fa17a66abc039244da2"},
+ {file = "yarl-1.24.5-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:46c2f213e23a04b93a392942d782eb9e413e6ef6bf7c8c53884e599a5c174dcb"},
+ {file = "yarl-1.24.5-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:92ab3e11448f2ff7bf53c5a26eff0edc086898ec8b21fb154b85839ce1d88075"},
+ {file = "yarl-1.24.5-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ebb0ec7f17803063d5aeb982f3b1bd2b2f4e4fae6751226cbd6ba1fcfe9e63ff"},
+ {file = "yarl-1.24.5-cp313-cp313-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:82632daed195dcc8ea664e8556dc9bdbd671960fb3776bd92806ce05792c2448"},
+ {file = "yarl-1.24.5-cp313-cp313-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:53e549287ef628fecba270045c9701b0c564563a9b0577d24a4ec75b8ab8040f"},
+ {file = "yarl-1.24.5-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:fcd3b77e2f17bbe4ca56ec7bcb07992647d19d0b9c05d84886dcd6f9eb810afd"},
+ {file = "yarl-1.24.5-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:d46b86567dd4e248c6c159fcbcdcce01e0a5c8a7cd2334a0fff759d0fa075b16"},
+ {file = "yarl-1.24.5-cp313-cp313-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:7f72c74aa99359e27a2ee8d6613fefa28b5f76a983c083074dfc2aaa4ab46213"},
+ {file = "yarl-1.24.5-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:3f45789ce415a7ec0820dc4f82925f9b5f7732070be1dec1f5f23ec381435a24"},
+ {file = "yarl-1.24.5-cp313-cp313-musllinux_1_2_armv7l.whl", hash = "sha256:6e73e7fe93f17a7b191f52ec9da9dd8c06a8fe735a1ecbd13b97d1c723bff385"},
+ {file = "yarl-1.24.5-cp313-cp313-musllinux_1_2_ppc64le.whl", hash = "sha256:4a36f9becdd4c5c52a20c3e9484128b070b1dcfc8944c006f3a528295a359a9c"},
+ {file = "yarl-1.24.5-cp313-cp313-musllinux_1_2_riscv64.whl", hash = "sha256:7bcbe0fcf850eae67b6b01749815a4f7161c560a844c769ad7b48fcd99f791c4"},
+ {file = "yarl-1.24.5-cp313-cp313-musllinux_1_2_s390x.whl", hash = "sha256:24e861e9630e0daddcb9191fb187f60f034e17a4426f8101279f0c475cd74144"},
+ {file = "yarl-1.24.5-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:9335a099ad87287c37fe5d1a982ff392fa5efe5d14b40a730b1ec1d6a41382b4"},
+ {file = "yarl-1.24.5-cp313-cp313-win_amd64.whl", hash = "sha256:2dbe06fc16bc91502bca713704022182e5729861ae00277c3a23354b40929740"},
+ {file = "yarl-1.24.5-cp313-cp313-win_arm64.whl", hash = "sha256:6b8536851f9f65e7f00c7a1d49ba7f2be0ffe2c11555367fc9f50d9f842410a1"},
+ {file = "yarl-1.24.5-cp314-cp314-macosx_10_15_universal2.whl", hash = "sha256:2729fcfc4f6a596fb0c50f32090400aa9367774ac296a00387e65098c0befa76"},
+ {file = "yarl-1.24.5-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:ff330d3c30db4eb6b01d79e29d2d0b407a7ecad39cfd9ec993ece57396a2ec0d"},
+ {file = "yarl-1.24.5-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:e42d75862735da90e7fc5a7b23db0c976f737113a54b3c9777a9b665e9cbff75"},
+ {file = "yarl-1.24.5-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:a3732e66413163e72508da9eff9ce9d2846fde51fae45d3605393d3e6cd303e9"},
+ {file = "yarl-1.24.5-cp314-cp314-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:5b8ee53be440a0cffc991a27be3057e0530122548dbe7c0892df08822fce5ede"},
+ {file = "yarl-1.24.5-cp314-cp314-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:af3aefa655adb5869491fa907e652290386800ae99cc50095cba71e2c6aefdca"},
+ {file = "yarl-1.24.5-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:2120b96872df4a117cde97d270bac96aea7cc52205d305cf4611df694a487027"},
+ {file = "yarl-1.24.5-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:66410eb6345d467151934b49bfa70fb32f5b35a6140baa40ad97d6436abea2e9"},
+ {file = "yarl-1.24.5-cp314-cp314-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:4af7b7e1be0a69bee8210735fe6dcfc38879adfac6d62e789d53ba432d1ffa41"},
+ {file = "yarl-1.24.5-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:fa139875ff98ab97da323cfadfaff08900d1ad42f1b5087b0b812a55c5a06373"},
+ {file = "yarl-1.24.5-cp314-cp314-musllinux_1_2_armv7l.whl", hash = "sha256:0055afc45e864b92729ac7600e2d102c17bef060647e74bca75fa84d66b9ff36"},
+ {file = "yarl-1.24.5-cp314-cp314-musllinux_1_2_ppc64le.whl", hash = "sha256:f0e466ed7511fe9d459a819edbc6c2585c0b6eabde9fa8a8947552468a7a6ef0"},
+ {file = "yarl-1.24.5-cp314-cp314-musllinux_1_2_riscv64.whl", hash = "sha256:f141474e85b7e54998ec5180530a7cda99ab29e282fa50e0756d89981a9b43c5"},
+ {file = "yarl-1.24.5-cp314-cp314-musllinux_1_2_s390x.whl", hash = "sha256:e2935f8c39e3b03e83519292d78f075189978f3f4adc15a78144c7c8e2a1cba5"},
+ {file = "yarl-1.24.5-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:9d1216a7f6f77836617dba35687c5b78a4170afc3c3f18fc788f785ba26565c4"},
+ {file = "yarl-1.24.5-cp314-cp314-win_amd64.whl", hash = "sha256:5ba4f78df2bcc19f764a4b26a8a4f5049c110090ad5825993aacb052bf8003ad"},
+ {file = "yarl-1.24.5-cp314-cp314-win_arm64.whl", hash = "sha256:9e4e16c73d717c5cf27626c524d0a2e261ad20e46932b2670f64ad5dde23e26f"},
+ {file = "yarl-1.24.5-cp314-cp314t-macosx_10_15_universal2.whl", hash = "sha256:e1ae548a9d901adca07899a4147a7c826bbcc06239d3ce9a59f57886a28a4c88"},
+ {file = "yarl-1.24.5-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:ff405d91509d88e8d44129cd87b18d70acd1f0c1aeabd7bc3c46792b1fe2acba"},
+ {file = "yarl-1.24.5-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:47e98aab9d8d82ff682e7b0b5dded33bf138a32b817fcf7fa3b27b2d7c412928"},
+ {file = "yarl-1.24.5-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:f0a658a6d3fafee5c6f63c58f3e785c8c43c93fbc02bf9f2b6663f8185e0971f"},
+ {file = "yarl-1.24.5-cp314-cp314t-manylinux2014_armv7l.manylinux_2_17_armv7l.manylinux_2_31_armv7l.whl", hash = "sha256:4377407001ca3c057773f44d8ddd6358fa5f691407c1ba92210bd3cf8d9e4c95"},
+ {file = "yarl-1.24.5-cp314-cp314t-manylinux2014_ppc64le.manylinux_2_17_ppc64le.manylinux_2_28_ppc64le.whl", hash = "sha256:7c0494a31a1ac5461a226e7947a9c9b78c44e1dc7185164fa7e9651557a5d9bc"},
+ {file = "yarl-1.24.5-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a7cff474ab7cd149765bb784cf6d78b32e18e20473fb7bda860bce98ab58e9da"},
+ {file = "yarl-1.24.5-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:cbb833ccacdb5519eff9b8b71ee618cc2801c878e77e288775d77c3a2ced858a"},
+ {file = "yarl-1.24.5-cp314-cp314t-manylinux_2_31_riscv64.manylinux_2_39_riscv64.whl", hash = "sha256:82f75e05912e84b7a0fe57075d9c59de3cb352b928330f2eb69b2e1f54c3e1f0"},
+ {file = "yarl-1.24.5-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:16a2f5010280020e90f5330257e6944bc33e73593b136cc5a241e6c1dc292498"},
+ {file = "yarl-1.24.5-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:ffcd54362564dc1a30fb74d8b8a6e5a6b11ebd5e27266adc3b7427a21a6c9104"},
+ {file = "yarl-1.24.5-cp314-cp314t-musllinux_1_2_ppc64le.whl", hash = "sha256:0465ec8cedc2349b97a6b595ace64084a50c6e839eca40aa0626f38b8350e331"},
+ {file = "yarl-1.24.5-cp314-cp314t-musllinux_1_2_riscv64.whl", hash = "sha256:4db9aecb141cb7a5447171b57aa1ed3a8fee06af40b992ffc31206c0b0121550"},
+ {file = "yarl-1.24.5-cp314-cp314t-musllinux_1_2_s390x.whl", hash = "sha256:f540c013589084679a6c7fac07096b10159737918174f5dfc5e11bf5bca4dfe6"},
+ {file = "yarl-1.24.5-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:a61834fb15d81322d872eaafd333838ae7c9cea84067f232656f75965933d047"},
+ {file = "yarl-1.24.5-cp314-cp314t-win_amd64.whl", hash = "sha256:5c88e5815a49d289e599f3513aa7fde0bc2092ff188f99c940f007f90f53d104"},
+ {file = "yarl-1.24.5-cp314-cp314t-win_arm64.whl", hash = "sha256:cf139c02f5f23ef6532040a30ff662c00a318c952334f211046b8e60b7f17688"},
+ {file = "yarl-1.24.5-py3-none-any.whl", hash = "sha256:a33700d13d9b7d84fd10947b09ff69fb9a792e519c8cb9764a3ca70baa6c23a7"},
+ {file = "yarl-1.24.5.tar.gz", hash = "sha256:e81b83143bee16329c23db3c1b2d82b29892fcbcb849186d2f6e98a5abe9a57f"},
]
[package.dependencies]
diff --git a/pyproject.toml b/pyproject.toml
index 5c898117..fccdb60c 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ dynamic = ["version"]
[tool.poetry]
name = "vapi_server_sdk"
-version = "2.0.0"
+version = "2.0.1"
description = ""
readme = "README.md"
authors = []
diff --git a/reference.md b/reference.md
index 7d924d04..5276b8c9 100644
--- a/reference.md
+++ b/reference.md
@@ -4,6 +4,20 @@
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
+
+
+
+
#### 🔌 Usage
@@ -125,6 +139,20 @@ client.assistants.list()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior.
+
+
+
+
+
#### 🔌 Usage
@@ -182,6 +210,20 @@ client.assistants.create()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the assistant identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -241,6 +283,20 @@ client.assistants.get(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the assistant identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -300,6 +356,20 @@ client.assistants.delete(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the specified fields of the assistant identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -379,7 +449,7 @@ If unspecified, assistant will wait for user to speak and use the model to respo
-
-**first_message_interruptions_enabled:** `typing.Optional[bool]`
+**first_message_interruptions_enabled:** `typing.Optional[bool]` — Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.
@@ -546,7 +616,7 @@ If unspecified, it will hang up without saying anything.
-
-**compliance_plan:** `typing.Optional[CompliancePlan]`
+**compliance_plan:** `typing.Optional[CompliancePlan]` — Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.
@@ -669,7 +739,7 @@ The order of precedence is:
-
-**keypad_input_plan:** `typing.Optional[KeypadInputPlan]`
+**keypad_input_plan:** `typing.Optional[KeypadInputPlan]` — Configuration for collecting and processing DTMF keypad input during calls.
@@ -694,6 +764,20 @@ The order of precedence is:
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
+
+
+
+
#### 🔌 Usage
@@ -815,6 +899,20 @@ client.squads.list()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a squad that coordinates multiple assistants and their handoffs during a conversation.
+
+
+
+
+
#### 🔌 Usage
@@ -876,6 +974,20 @@ client.squads.create(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the squad identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -935,6 +1047,20 @@ client.squads.get(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the squad identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -994,6 +1120,20 @@ client.squads.delete(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the specified fields of the squad identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -1089,6 +1229,20 @@ Both `membersOverrides` and `members[n].assistantOverrides` can be used together
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps.
+
+
+
+
+
#### 🔌 Usage
@@ -1238,6 +1392,20 @@ Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations.
+
+
+
+
+
#### 🔌 Usage
@@ -1488,6 +1656,20 @@ Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the call identified by its ID, including its status, configuration, and available call data.
+
+
+
+
+
#### 🔌 Usage
@@ -1547,6 +1729,20 @@ client.calls.get(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the call identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -1619,6 +1815,20 @@ It may take up to a few hours to complete the bulk delete, and will be asynchron
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the call identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -2326,6 +2536,20 @@ Cannot specify both sessionId and transport fields (phoneNumberId/customer) toge
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps.
+
+
+
+
+
#### 🔌 Usage
@@ -2479,6 +2703,20 @@ client.campaigns.campaign_controller_find_all()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates an outbound calling campaign that calls a set of customers.
+
+
+
+
+
#### 🔌 Usage
@@ -2594,6 +2832,20 @@ client.campaigns.campaign_controller_create(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the outbound calling campaign identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -2653,6 +2905,20 @@ client.campaigns.campaign_controller_find_one(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the outbound calling campaign identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -2712,7 +2978,7 @@ client.campaigns.campaign_controller_remove(
-
-#### 🔌 Usage
+#### 📝 Description
-
@@ -2720,9 +2986,23 @@ client.campaigns.campaign_controller_remove(
-
-```python
-from vapi import Vapi
-from vapi.environment import VapiEnvironment
+Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`.
+
+
+
+
+
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from vapi import Vapi
+from vapi.environment import VapiEnvironment
client = Vapi(
token="",
@@ -3514,6 +3794,20 @@ client.sessions.update(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
+
+
+
+
#### 🔌 Usage
@@ -3635,6 +3929,20 @@ client.phone_numbers.list()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider.
+
+
+
+
+
#### 🔌 Usage
@@ -3697,6 +4005,20 @@ client.phone_numbers.create(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps.
+
+
+
+
+
#### 🔌 Usage
@@ -3842,6 +4164,20 @@ client.phone_numbers.phone_number_controller_find_all_paginated()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the phone number resource identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -3901,6 +4237,20 @@ client.phone_numbers.get(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the phone number resource identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -3960,6 +4310,20 @@ client.phone_numbers.delete(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the specified fields of the phone number resource identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -4030,6 +4394,20 @@ client.phone_numbers.update(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
+
+
+
+
#### 🔌 Usage
@@ -4151,6 +4529,20 @@ client.tools.list()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a reusable tool that assistants can invoke during conversations.
+
+
+
+
+
#### 🔌 Usage
@@ -4214,6 +4606,20 @@ client.tools.create(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the tool identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -4273,6 +4679,20 @@ client.tools.get(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the tool identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -4332,6 +4752,20 @@ client.tools.delete(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the specified fields of the tool identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -4402,6 +4836,20 @@ client.tools.update(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns files uploaded to the authenticated organization.
+
+
+
+
+
#### 🔌 Usage
@@ -4451,6 +4899,20 @@ client.files.list()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Uploads a file for use with a Vapi knowledge base.
+
+
+
+
+
#### 🔌 Usage
@@ -4510,6 +4972,20 @@ client.files.create(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the uploaded file identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -4569,6 +5045,20 @@ client.files.get(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the uploaded file identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -4628,6 +5118,20 @@ client.files.delete(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the name of the uploaded file identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -4696,6 +5200,20 @@ client.files.update(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps.
+
+
+
+
+
#### 🔌 Usage
@@ -4849,6 +5367,20 @@ client.structured_outputs.structured_output_controller_find_all()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression.
+
+
+
+
+
#### 🔌 Usage
@@ -4911,7 +5443,7 @@ client.structured_outputs.structured_output_controller_create(
-
-#### 🔌 Usage
+#### 📝 Description
-
@@ -4919,11 +5451,25 @@ client.structured_outputs.structured_output_controller_create(
-
-```python
-from vapi import Vapi
-from vapi.environment import VapiEnvironment
+Returns the structured-output definition identified by its ID.
+
+
+
+
-client = Vapi(
+#### 🔌 Usage
+
+
+-
+
+
+-
+
+```python
+from vapi import Vapi
+from vapi.environment import VapiEnvironment
+
+client = Vapi(
token="",
environment=VapiEnvironment.DEFAULT,
)
@@ -4970,6 +5516,20 @@ client.structured_outputs.structured_output_controller_find_one(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the structured-output definition identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -5029,6 +5589,20 @@ client.structured_outputs.structured_output_controller_remove(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the structured-output definition identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -5221,6 +5795,20 @@ Defines the structure and validation rules for the data that will be extracted.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts.
+
+
+
+
+
#### 🔌 Usage
@@ -5319,6 +5907,20 @@ When the re-run is executed, the structured output value will be added to the ex
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps.
+
+
+
+
+
#### 🔌 Usage
@@ -5464,6 +6066,20 @@ client.insight.insight_controller_find_all()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value.
+
+
+
+
+
#### 🔌 Usage
@@ -5533,6 +6149,20 @@ client.insight.insight_controller_create(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the reporting insight identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -5592,6 +6222,20 @@ client.insight.insight_controller_find_one(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the reporting insight identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -5651,6 +6295,20 @@ client.insight.insight_controller_remove(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the reporting insight identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -5720,6 +6378,20 @@ client.insight.insight_controller_update(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Runs a saved reporting insight, optionally overriding its time range and response format.
+
+
+
+
+
#### 🔌 Usage
@@ -5763,7 +6435,7 @@ client.insight.insight_controller_run(
-
-**format_plan:** `typing.Optional[InsightRunFormatPlan]`
+**format_plan:** `typing.Optional[InsightRunFormatPlan]` — Output-formatting instructions applied to the insight run.
@@ -5803,6 +6475,20 @@ For Pie and Text Insights, step will be ignored even if provided.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Runs an insight definition without first saving it, returning a preview of the resulting chart or text value.
+
+
+
+
+
#### 🔌 Usage
@@ -5873,6 +6559,20 @@ client.insight.insight_controller_preview(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps.
+
+
+
+
+
#### 🔌 Usage
@@ -6018,6 +6718,20 @@ client.eval.eval_controller_get_paginated()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls.
+
+
+
+
+
#### 🔌 Usage
@@ -6082,6 +6796,20 @@ client.eval.eval_controller_create(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the eval definition identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -6141,6 +6869,20 @@ client.eval.eval_controller_get(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the eval definition identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -6200,6 +6942,20 @@ client.eval.eval_controller_remove(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the eval definition identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -6306,6 +7062,20 @@ Currently it is fixed to `chat.mockConversation`.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the eval run identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -6365,6 +7135,20 @@ client.eval.eval_controller_get_run(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the eval run identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -6424,6 +7208,20 @@ client.eval.eval_controller_remove_run(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps.
+
+
+
+
+
#### 🔌 Usage
@@ -6569,6 +7367,20 @@ client.eval.eval_controller_get_runs_paginated()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results.
+
+
+
+
+
#### 🔌 Usage
@@ -6658,6 +7470,20 @@ Currently it is fixed to `eval`.
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the scorecard identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -6717,6 +7543,20 @@ client.observability_scorecard.scorecard_controller_get(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the scorecard identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -6776,6 +7616,20 @@ client.observability_scorecard.scorecard_controller_remove(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the scorecard identified by its ID.
+
+
+
+
+
#### 🔌 Usage
@@ -6873,6 +7727,20 @@ When linked to assistants, this scorecard will be available for evaluation durin
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps.
+
+
+
+
+
#### 🔌 Usage
@@ -7018,6 +7886,20 @@ client.observability_scorecard.scorecard_controller_get_paginated()
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated.
+
+
+
+
+
#### 🔌 Usage
@@ -7087,6 +7969,20 @@ client.observability_scorecard.scorecard_controller_create(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps.
+
+
+
+
+
#### 🔌 Usage
@@ -7259,6 +8155,20 @@ client.provider_resources.provider_resource_controller_get_provider_resources_pa
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs.
+
+
+
+
+
#### 🔌 Usage
@@ -7327,6 +8237,20 @@ client.provider_resources.provider_resource_controller_create_provider_resource(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Returns the provider resource identified by its Vapi resource ID.
+
+
+
+
+
#### 🔌 Usage
@@ -7404,6 +8328,20 @@ client.provider_resources.provider_resource_controller_get_provider_resource(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Deletes the provider resource identified by its Vapi resource ID.
+
+
+
+
+
#### 🔌 Usage
@@ -7481,6 +8419,20 @@ client.provider_resources.provider_resource_controller_delete_provider_resource(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Updates the provider resource identified by its Vapi resource ID.
+
+
+
+
+
#### 🔌 Usage
@@ -7559,6 +8511,20 @@ client.provider_resources.provider_resource_controller_update_provider_resource(
-
+#### 📝 Description
+
+
+-
+
+
+-
+
+Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations.
+
+
+
+
+
#### 🔌 Usage
diff --git a/src/vapi/analytics/client.py b/src/vapi/analytics/client.py
index 5ef58dd4..f89a2799 100644
--- a/src/vapi/analytics/client.py
+++ b/src/vapi/analytics/client.py
@@ -31,6 +31,8 @@ def get(
self, *, queries: typing.Sequence[AnalyticsQuery], request_options: typing.Optional[RequestOptions] = None
) -> typing.List[AnalyticsQueryResult]:
"""
+ Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations.
+
Parameters
----------
queries : typing.Sequence[AnalyticsQuery]
@@ -89,6 +91,8 @@ async def get(
self, *, queries: typing.Sequence[AnalyticsQuery], request_options: typing.Optional[RequestOptions] = None
) -> typing.List[AnalyticsQueryResult]:
"""
+ Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations.
+
Parameters
----------
queries : typing.Sequence[AnalyticsQuery]
diff --git a/src/vapi/analytics/raw_client.py b/src/vapi/analytics/raw_client.py
index 448600b3..12ed44a7 100644
--- a/src/vapi/analytics/raw_client.py
+++ b/src/vapi/analytics/raw_client.py
@@ -26,6 +26,8 @@ def get(
self, *, queries: typing.Sequence[AnalyticsQuery], request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[typing.List[AnalyticsQueryResult]]:
"""
+ Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations.
+
Parameters
----------
queries : typing.Sequence[AnalyticsQuery]
@@ -81,6 +83,8 @@ async def get(
self, *, queries: typing.Sequence[AnalyticsQuery], request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[typing.List[AnalyticsQueryResult]]:
"""
+ Runs one or more metric queries against call or subscription data using the requested time range, groupings, and aggregate operations.
+
Parameters
----------
queries : typing.Sequence[AnalyticsQuery]
diff --git a/src/vapi/assistants/client.py b/src/vapi/assistants/client.py
index 6e72fd0e..641fa72a 100644
--- a/src/vapi/assistants/client.py
+++ b/src/vapi/assistants/client.py
@@ -73,6 +73,8 @@ def list(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[Assistant]:
"""
+ Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -170,6 +172,8 @@ def create(
request_options: typing.Optional[RequestOptions] = None,
) -> Assistant:
"""
+ Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior.
+
Parameters
----------
transcriber : typing.Optional[CreateAssistantDtoTranscriber]
@@ -187,6 +191,7 @@ def create(
If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
first_message_interruptions_enabled : typing.Optional[bool]
+ Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.
first_message_mode : typing.Optional[CreateAssistantDtoFirstMessageMode]
This is the mode for the first message. Default is 'assistant-speaks-first'.
@@ -255,6 +260,7 @@ def create(
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
compliance_plan : typing.Optional[CompliancePlan]
+ Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.
metadata : typing.Optional[typing.Dict[str, typing.Any]]
This is for metadata you want to store on the assistant.
@@ -317,6 +323,7 @@ def create(
3. org.serverUrl
keypad_input_plan : typing.Optional[KeypadInputPlan]
+ Configuration for collecting and processing DTMF keypad input during calls.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -373,6 +380,8 @@ def create(
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Assistant:
"""
+ Returns the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -401,6 +410,8 @@ def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = Non
def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Assistant:
"""
+ Deletes the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -465,6 +476,8 @@ def update(
request_options: typing.Optional[RequestOptions] = None,
) -> Assistant:
"""
+ Updates the specified fields of the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -484,6 +497,7 @@ def update(
If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
first_message_interruptions_enabled : typing.Optional[bool]
+ Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.
first_message_mode : typing.Optional[UpdateAssistantDtoFirstMessageMode]
This is the mode for the first message. Default is 'assistant-speaks-first'.
@@ -552,6 +566,7 @@ def update(
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
compliance_plan : typing.Optional[CompliancePlan]
+ Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.
metadata : typing.Optional[typing.Dict[str, typing.Any]]
This is for metadata you want to store on the assistant.
@@ -614,6 +629,7 @@ def update(
3. org.serverUrl
keypad_input_plan : typing.Optional[KeypadInputPlan]
+ Configuration for collecting and processing DTMF keypad input during calls.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -702,6 +718,8 @@ async def list(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[Assistant]:
"""
+ Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -807,6 +825,8 @@ async def create(
request_options: typing.Optional[RequestOptions] = None,
) -> Assistant:
"""
+ Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior.
+
Parameters
----------
transcriber : typing.Optional[CreateAssistantDtoTranscriber]
@@ -824,6 +844,7 @@ async def create(
If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
first_message_interruptions_enabled : typing.Optional[bool]
+ Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.
first_message_mode : typing.Optional[CreateAssistantDtoFirstMessageMode]
This is the mode for the first message. Default is 'assistant-speaks-first'.
@@ -892,6 +913,7 @@ async def create(
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
compliance_plan : typing.Optional[CompliancePlan]
+ Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.
metadata : typing.Optional[typing.Dict[str, typing.Any]]
This is for metadata you want to store on the assistant.
@@ -954,6 +976,7 @@ async def create(
3. org.serverUrl
keypad_input_plan : typing.Optional[KeypadInputPlan]
+ Configuration for collecting and processing DTMF keypad input during calls.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -1018,6 +1041,8 @@ async def main() -> None:
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Assistant:
"""
+ Returns the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -1054,6 +1079,8 @@ async def main() -> None:
async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Assistant:
"""
+ Deletes the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -1126,6 +1153,8 @@ async def update(
request_options: typing.Optional[RequestOptions] = None,
) -> Assistant:
"""
+ Updates the specified fields of the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -1145,6 +1174,7 @@ async def update(
If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
first_message_interruptions_enabled : typing.Optional[bool]
+ Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.
first_message_mode : typing.Optional[UpdateAssistantDtoFirstMessageMode]
This is the mode for the first message. Default is 'assistant-speaks-first'.
@@ -1213,6 +1243,7 @@ async def update(
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
compliance_plan : typing.Optional[CompliancePlan]
+ Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.
metadata : typing.Optional[typing.Dict[str, typing.Any]]
This is for metadata you want to store on the assistant.
@@ -1275,6 +1306,7 @@ async def update(
3. org.serverUrl
keypad_input_plan : typing.Optional[KeypadInputPlan]
+ Configuration for collecting and processing DTMF keypad input during calls.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
diff --git a/src/vapi/assistants/raw_client.py b/src/vapi/assistants/raw_client.py
index f71c1976..121d6c52 100644
--- a/src/vapi/assistants/raw_client.py
+++ b/src/vapi/assistants/raw_client.py
@@ -70,6 +70,8 @@ def list(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.List[Assistant]]:
"""
+ Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -179,6 +181,8 @@ def create(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Assistant]:
"""
+ Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior.
+
Parameters
----------
transcriber : typing.Optional[CreateAssistantDtoTranscriber]
@@ -196,6 +200,7 @@ def create(
If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
first_message_interruptions_enabled : typing.Optional[bool]
+ Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.
first_message_mode : typing.Optional[CreateAssistantDtoFirstMessageMode]
This is the mode for the first message. Default is 'assistant-speaks-first'.
@@ -264,6 +269,7 @@ def create(
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
compliance_plan : typing.Optional[CompliancePlan]
+ Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.
metadata : typing.Optional[typing.Dict[str, typing.Any]]
This is for metadata you want to store on the assistant.
@@ -326,6 +332,7 @@ def create(
3. org.serverUrl
keypad_input_plan : typing.Optional[KeypadInputPlan]
+ Configuration for collecting and processing DTMF keypad input during calls.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -435,6 +442,8 @@ def create(
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Assistant]:
"""
+ Returns the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -473,6 +482,8 @@ def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = Non
def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Assistant]:
"""
+ Deletes the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -547,6 +558,8 @@ def update(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Assistant]:
"""
+ Updates the specified fields of the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -566,6 +579,7 @@ def update(
If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
first_message_interruptions_enabled : typing.Optional[bool]
+ Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.
first_message_mode : typing.Optional[UpdateAssistantDtoFirstMessageMode]
This is the mode for the first message. Default is 'assistant-speaks-first'.
@@ -634,6 +648,7 @@ def update(
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
compliance_plan : typing.Optional[CompliancePlan]
+ Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.
metadata : typing.Optional[typing.Dict[str, typing.Any]]
This is for metadata you want to store on the assistant.
@@ -696,6 +711,7 @@ def update(
3. org.serverUrl
keypad_input_plan : typing.Optional[KeypadInputPlan]
+ Configuration for collecting and processing DTMF keypad input during calls.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -826,6 +842,8 @@ async def list(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.List[Assistant]]:
"""
+ Returns assistants for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -935,6 +953,8 @@ async def create(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Assistant]:
"""
+ Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior.
+
Parameters
----------
transcriber : typing.Optional[CreateAssistantDtoTranscriber]
@@ -952,6 +972,7 @@ async def create(
If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
first_message_interruptions_enabled : typing.Optional[bool]
+ Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.
first_message_mode : typing.Optional[CreateAssistantDtoFirstMessageMode]
This is the mode for the first message. Default is 'assistant-speaks-first'.
@@ -1020,6 +1041,7 @@ async def create(
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
compliance_plan : typing.Optional[CompliancePlan]
+ Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.
metadata : typing.Optional[typing.Dict[str, typing.Any]]
This is for metadata you want to store on the assistant.
@@ -1082,6 +1104,7 @@ async def create(
3. org.serverUrl
keypad_input_plan : typing.Optional[KeypadInputPlan]
+ Configuration for collecting and processing DTMF keypad input during calls.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -1193,6 +1216,8 @@ async def get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Assistant]:
"""
+ Returns the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -1233,6 +1258,8 @@ async def delete(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Assistant]:
"""
+ Deletes the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -1307,6 +1334,8 @@ async def update(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Assistant]:
"""
+ Updates the specified fields of the assistant identified by its ID.
+
Parameters
----------
id : str
@@ -1326,6 +1355,7 @@ async def update(
If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
first_message_interruptions_enabled : typing.Optional[bool]
+ Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.
first_message_mode : typing.Optional[UpdateAssistantDtoFirstMessageMode]
This is the mode for the first message. Default is 'assistant-speaks-first'.
@@ -1394,6 +1424,7 @@ async def update(
This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.
compliance_plan : typing.Optional[CompliancePlan]
+ Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.
metadata : typing.Optional[typing.Dict[str, typing.Any]]
This is for metadata you want to store on the assistant.
@@ -1456,6 +1487,7 @@ async def update(
3. org.serverUrl
keypad_input_plan : typing.Optional[KeypadInputPlan]
+ Configuration for collecting and processing DTMF keypad input during calls.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
diff --git a/src/vapi/calls/client.py b/src/vapi/calls/client.py
index 187aa41c..8cb6c2e9 100644
--- a/src/vapi/calls/client.py
+++ b/src/vapi/calls/client.py
@@ -54,6 +54,8 @@ def list(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[Call]:
"""
+ Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -151,6 +153,8 @@ def create(
request_options: typing.Optional[RequestOptions] = None,
) -> CreateCallsResponse:
"""
+ Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations.
+
Parameters
----------
customers : typing.Optional[typing.Sequence[CreateCustomerDto]]
@@ -286,6 +290,8 @@ def create(
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Call:
"""
+ Returns the call identified by its ID, including its status, configuration, and available call data.
+
Parameters
----------
id : str
@@ -320,6 +326,8 @@ def delete(
request_options: typing.Optional[RequestOptions] = None,
) -> Call:
"""
+ Deletes the call identified by its ID.
+
Parameters
----------
id : str
@@ -356,6 +364,8 @@ def update(
self, id: str, *, name: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> Call:
"""
+ Updates the call identified by its ID.
+
Parameters
----------
id : str
@@ -419,6 +429,8 @@ async def list(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[Call]:
"""
+ Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -524,6 +536,8 @@ async def create(
request_options: typing.Optional[RequestOptions] = None,
) -> CreateCallsResponse:
"""
+ Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations.
+
Parameters
----------
customers : typing.Optional[typing.Sequence[CreateCustomerDto]]
@@ -667,6 +681,8 @@ async def main() -> None:
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Call:
"""
+ Returns the call identified by its ID, including its status, configuration, and available call data.
+
Parameters
----------
id : str
@@ -709,6 +725,8 @@ async def delete(
request_options: typing.Optional[RequestOptions] = None,
) -> Call:
"""
+ Deletes the call identified by its ID.
+
Parameters
----------
id : str
@@ -753,6 +771,8 @@ async def update(
self, id: str, *, name: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> Call:
"""
+ Updates the call identified by its ID.
+
Parameters
----------
id : str
diff --git a/src/vapi/calls/raw_client.py b/src/vapi/calls/raw_client.py
index e3e58891..068db9be 100644
--- a/src/vapi/calls/raw_client.py
+++ b/src/vapi/calls/raw_client.py
@@ -51,6 +51,8 @@ def list(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.List[Call]]:
"""
+ Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -160,6 +162,8 @@ def create(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[CreateCallsResponse]:
"""
+ Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations.
+
Parameters
----------
customers : typing.Optional[typing.Sequence[CreateCustomerDto]]
@@ -331,6 +335,8 @@ def create(
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Call]:
"""
+ Returns the call identified by its ID, including its status, configuration, and available call data.
+
Parameters
----------
id : str
@@ -375,6 +381,8 @@ def delete(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Call]:
"""
+ Deletes the call identified by its ID.
+
Parameters
----------
id : str
@@ -428,6 +436,8 @@ def update(
self, id: str, *, name: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[Call]:
"""
+ Updates the call identified by its ID.
+
Parameters
----------
id : str
@@ -497,6 +507,8 @@ async def list(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.List[Call]]:
"""
+ Returns calls for the authenticated organization. Filter results by call ID, assistant ID, phone number ID, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -606,6 +618,8 @@ async def create(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[CreateCallsResponse]:
"""
+ Creates a call using an assistant or squad. The request can reference saved resources or include transient configurations.
+
Parameters
----------
customers : typing.Optional[typing.Sequence[CreateCustomerDto]]
@@ -777,6 +791,8 @@ async def create(
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> AsyncHttpResponse[Call]:
"""
+ Returns the call identified by its ID, including its status, configuration, and available call data.
+
Parameters
----------
id : str
@@ -821,6 +837,8 @@ async def delete(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Call]:
"""
+ Deletes the call identified by its ID.
+
Parameters
----------
id : str
@@ -874,6 +892,8 @@ async def update(
self, id: str, *, name: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Call]:
"""
+ Updates the call identified by its ID.
+
Parameters
----------
id : str
diff --git a/src/vapi/campaigns/client.py b/src/vapi/campaigns/client.py
index 2d3527fd..2bf6ead9 100644
--- a/src/vapi/campaigns/client.py
+++ b/src/vapi/campaigns/client.py
@@ -53,6 +53,8 @@ def campaign_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> CampaignPaginatedResponse:
"""
+ Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -141,6 +143,8 @@ def campaign_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> Campaign:
"""
+ Creates an outbound calling campaign that calls a set of customers.
+
Parameters
----------
name : str
@@ -203,6 +207,8 @@ def campaign_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> Campaign:
"""
+ Returns the outbound calling campaign identified by its ID.
+
Parameters
----------
id : str
@@ -233,6 +239,8 @@ def campaign_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> Campaign:
"""
+ Deletes the outbound calling campaign identified by its ID.
+
Parameters
----------
id : str
@@ -274,6 +282,8 @@ def campaign_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> Campaign:
"""
+ Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`.
+
Parameters
----------
id : str
@@ -378,6 +388,8 @@ async def campaign_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> CampaignPaginatedResponse:
"""
+ Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -474,6 +486,8 @@ async def campaign_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> Campaign:
"""
+ Creates an outbound calling campaign that calls a set of customers.
+
Parameters
----------
name : str
@@ -544,6 +558,8 @@ async def campaign_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> Campaign:
"""
+ Returns the outbound calling campaign identified by its ID.
+
Parameters
----------
id : str
@@ -582,6 +598,8 @@ async def campaign_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> Campaign:
"""
+ Deletes the outbound calling campaign identified by its ID.
+
Parameters
----------
id : str
@@ -631,6 +649,8 @@ async def campaign_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> Campaign:
"""
+ Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`.
+
Parameters
----------
id : str
diff --git a/src/vapi/campaigns/raw_client.py b/src/vapi/campaigns/raw_client.py
index 32b92212..ff73cb62 100644
--- a/src/vapi/campaigns/raw_client.py
+++ b/src/vapi/campaigns/raw_client.py
@@ -50,6 +50,8 @@ def campaign_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[CampaignPaginatedResponse]:
"""
+ Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -150,6 +152,8 @@ def campaign_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Campaign]:
"""
+ Creates an outbound calling campaign that calls a set of customers.
+
Parameters
----------
name : str
@@ -232,6 +236,8 @@ def campaign_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[Campaign]:
"""
+ Returns the outbound calling campaign identified by its ID.
+
Parameters
----------
id : str
@@ -272,6 +278,8 @@ def campaign_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[Campaign]:
"""
+ Deletes the outbound calling campaign identified by its ID.
+
Parameters
----------
id : str
@@ -323,6 +331,8 @@ def campaign_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Campaign]:
"""
+ Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`.
+
Parameters
----------
id : str
@@ -433,6 +443,8 @@ async def campaign_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[CampaignPaginatedResponse]:
"""
+ Returns outbound calling campaigns for the authenticated organization. Filter results by campaign ID, status, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -533,6 +545,8 @@ async def campaign_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Campaign]:
"""
+ Creates an outbound calling campaign that calls a set of customers.
+
Parameters
----------
name : str
@@ -615,6 +629,8 @@ async def campaign_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Campaign]:
"""
+ Returns the outbound calling campaign identified by its ID.
+
Parameters
----------
id : str
@@ -655,6 +671,8 @@ async def campaign_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Campaign]:
"""
+ Deletes the outbound calling campaign identified by its ID.
+
Parameters
----------
id : str
@@ -706,6 +724,8 @@ async def campaign_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Campaign]:
"""
+ Updates the outbound calling campaign identified by its ID. Campaigns can be ended by updating their status to `ended`.
+
Parameters
----------
id : str
diff --git a/src/vapi/core/client_wrapper.py b/src/vapi/core/client_wrapper.py
index f0001ffb..a2abed4c 100644
--- a/src/vapi/core/client_wrapper.py
+++ b/src/vapi/core/client_wrapper.py
@@ -27,12 +27,12 @@ def get_headers(self) -> typing.Dict[str, str]:
import platform
headers: typing.Dict[str, str] = {
- "User-Agent": "vapi_server_sdk/2.0.0",
+ "User-Agent": "vapi_server_sdk/0.0.0-fern-placeholder",
"X-Fern-Language": "Python",
"X-Fern-Runtime": f"python/{platform.python_version()}",
"X-Fern-Platform": f"{platform.system().lower()}/{platform.release()}",
"X-Fern-SDK-Name": "vapi_server_sdk",
- "X-Fern-SDK-Version": "2.0.0",
+ "X-Fern-SDK-Version": "2.0.1",
**(self.get_custom_headers() or {}),
}
headers["Authorization"] = f"Bearer {self._get_token()}"
diff --git a/src/vapi/eval/client.py b/src/vapi/eval/client.py
index a51db659..fd2267a6 100644
--- a/src/vapi/eval/client.py
+++ b/src/vapi/eval/client.py
@@ -57,6 +57,8 @@ def eval_controller_get_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> EvalPaginatedResponse:
"""
+ Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -138,6 +140,8 @@ def eval_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> Eval:
"""
+ Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls.
+
Parameters
----------
messages : typing.Sequence[CreateEvalDtoMessagesItem]
@@ -190,6 +194,8 @@ def eval_controller_create(
def eval_controller_get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Eval:
"""
+ Returns the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -218,6 +224,8 @@ def eval_controller_get(self, id: str, *, request_options: typing.Optional[Reque
def eval_controller_remove(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Eval:
"""
+ Deletes the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -255,6 +263,8 @@ def eval_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> Eval:
"""
+ Updates the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -304,6 +314,8 @@ def eval_controller_update(
def eval_controller_get_run(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> EvalRun:
"""
+ Returns the eval run identified by its ID.
+
Parameters
----------
id : str
@@ -334,6 +346,8 @@ def eval_controller_remove_run(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> EvalRun:
"""
+ Deletes the eval run identified by its ID.
+
Parameters
----------
id : str
@@ -378,6 +392,8 @@ def eval_controller_get_runs_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> EvalRunPaginatedResponse:
"""
+ Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -459,6 +475,8 @@ def eval_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.Dict[str, typing.Any]:
"""
+ Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results.
+
Parameters
----------
target : CreateEvalRunDtoTarget
@@ -534,6 +552,8 @@ async def eval_controller_get_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> EvalPaginatedResponse:
"""
+ Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -623,6 +643,8 @@ async def eval_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> Eval:
"""
+ Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls.
+
Parameters
----------
messages : typing.Sequence[CreateEvalDtoMessagesItem]
@@ -683,6 +705,8 @@ async def main() -> None:
async def eval_controller_get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Eval:
"""
+ Returns the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -719,6 +743,8 @@ async def main() -> None:
async def eval_controller_remove(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Eval:
"""
+ Deletes the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -764,6 +790,8 @@ async def eval_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> Eval:
"""
+ Updates the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -823,6 +851,8 @@ async def eval_controller_get_run(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> EvalRun:
"""
+ Returns the eval run identified by its ID.
+
Parameters
----------
id : str
@@ -861,6 +891,8 @@ async def eval_controller_remove_run(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> EvalRun:
"""
+ Deletes the eval run identified by its ID.
+
Parameters
----------
id : str
@@ -913,6 +945,8 @@ async def eval_controller_get_runs_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> EvalRunPaginatedResponse:
"""
+ Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -1002,6 +1036,8 @@ async def eval_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.Dict[str, typing.Any]:
"""
+ Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results.
+
Parameters
----------
target : CreateEvalRunDtoTarget
diff --git a/src/vapi/eval/raw_client.py b/src/vapi/eval/raw_client.py
index 9c11348f..00adcf0a 100644
--- a/src/vapi/eval/raw_client.py
+++ b/src/vapi/eval/raw_client.py
@@ -54,6 +54,8 @@ def eval_controller_get_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[EvalPaginatedResponse]:
"""
+ Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -147,6 +149,8 @@ def eval_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Eval]:
"""
+ Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls.
+
Parameters
----------
messages : typing.Sequence[CreateEvalDtoMessagesItem]
@@ -213,6 +217,8 @@ def eval_controller_get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[Eval]:
"""
+ Returns the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -253,6 +259,8 @@ def eval_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[Eval]:
"""
+ Deletes the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -300,6 +308,8 @@ def eval_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Eval]:
"""
+ Updates the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -371,6 +381,8 @@ def eval_controller_get_run(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[EvalRun]:
"""
+ Returns the eval run identified by its ID.
+
Parameters
----------
id : str
@@ -411,6 +423,8 @@ def eval_controller_remove_run(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[EvalRun]:
"""
+ Deletes the eval run identified by its ID.
+
Parameters
----------
id : str
@@ -465,6 +479,8 @@ def eval_controller_get_runs_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[EvalRunPaginatedResponse]:
"""
+ Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -558,6 +574,8 @@ def eval_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.Dict[str, typing.Any]]:
"""
+ Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results.
+
Parameters
----------
target : CreateEvalRunDtoTarget
@@ -642,6 +660,8 @@ async def eval_controller_get_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[EvalPaginatedResponse]:
"""
+ Returns eval definitions for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -735,6 +755,8 @@ async def eval_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Eval]:
"""
+ Creates a reusable eval that defines a mock conversation and checkpoints for evaluating assistant responses and tool calls.
+
Parameters
----------
messages : typing.Sequence[CreateEvalDtoMessagesItem]
@@ -801,6 +823,8 @@ async def eval_controller_get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Eval]:
"""
+ Returns the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -841,6 +865,8 @@ async def eval_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Eval]:
"""
+ Deletes the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -888,6 +914,8 @@ async def eval_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Eval]:
"""
+ Updates the eval definition identified by its ID.
+
Parameters
----------
id : str
@@ -959,6 +987,8 @@ async def eval_controller_get_run(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[EvalRun]:
"""
+ Returns the eval run identified by its ID.
+
Parameters
----------
id : str
@@ -999,6 +1029,8 @@ async def eval_controller_remove_run(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[EvalRun]:
"""
+ Deletes the eval run identified by its ID.
+
Parameters
----------
id : str
@@ -1053,6 +1085,8 @@ async def eval_controller_get_runs_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[EvalRunPaginatedResponse]:
"""
+ Returns eval runs for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -1146,6 +1180,8 @@ async def eval_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.Dict[str, typing.Any]]:
"""
+ Runs a saved or transient eval against an assistant or squad and creates an eval-run record containing the results.
+
Parameters
----------
target : CreateEvalRunDtoTarget
diff --git a/src/vapi/files/client.py b/src/vapi/files/client.py
index 8c718029..ff7f0ac9 100644
--- a/src/vapi/files/client.py
+++ b/src/vapi/files/client.py
@@ -29,6 +29,8 @@ def with_raw_response(self) -> RawFilesClient:
def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[File]:
"""
+ Returns files uploaded to the authenticated organization.
+
Parameters
----------
request_options : typing.Optional[RequestOptions]
@@ -53,6 +55,8 @@ def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> ty
def create(self, *, file: core.File, request_options: typing.Optional[RequestOptions] = None) -> File:
"""
+ Uploads a file for use with a Vapi knowledge base.
+
Parameters
----------
file : core.File
@@ -80,6 +84,8 @@ def create(self, *, file: core.File, request_options: typing.Optional[RequestOpt
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> File:
"""
+ Returns the uploaded file identified by its ID.
+
Parameters
----------
id : str
@@ -108,6 +114,8 @@ def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = Non
def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> File:
"""
+ Deletes the uploaded file identified by its ID.
+
Parameters
----------
id : str
@@ -138,6 +146,8 @@ def update(
self, id: str, *, name: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> File:
"""
+ Updates the name of the uploaded file identified by its ID.
+
Parameters
----------
id : str
@@ -185,6 +195,8 @@ def with_raw_response(self) -> AsyncRawFilesClient:
async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[File]:
"""
+ Returns files uploaded to the authenticated organization.
+
Parameters
----------
request_options : typing.Optional[RequestOptions]
@@ -217,6 +229,8 @@ async def main() -> None:
async def create(self, *, file: core.File, request_options: typing.Optional[RequestOptions] = None) -> File:
"""
+ Uploads a file for use with a Vapi knowledge base.
+
Parameters
----------
file : core.File
@@ -252,6 +266,8 @@ async def main() -> None:
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> File:
"""
+ Returns the uploaded file identified by its ID.
+
Parameters
----------
id : str
@@ -288,6 +304,8 @@ async def main() -> None:
async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> File:
"""
+ Deletes the uploaded file identified by its ID.
+
Parameters
----------
id : str
@@ -326,6 +344,8 @@ async def update(
self, id: str, *, name: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> File:
"""
+ Updates the name of the uploaded file identified by its ID.
+
Parameters
----------
id : str
diff --git a/src/vapi/files/raw_client.py b/src/vapi/files/raw_client.py
index 2fb53d63..947fce8e 100644
--- a/src/vapi/files/raw_client.py
+++ b/src/vapi/files/raw_client.py
@@ -25,6 +25,8 @@ def __init__(self, *, client_wrapper: SyncClientWrapper):
def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[typing.List[File]]:
"""
+ Returns files uploaded to the authenticated organization.
+
Parameters
----------
request_options : typing.Optional[RequestOptions]
@@ -61,6 +63,8 @@ def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> Ht
def create(self, *, file: core.File, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[File]:
"""
+ Uploads a file for use with a Vapi knowledge base.
+
Parameters
----------
file : core.File
@@ -117,6 +121,8 @@ def create(self, *, file: core.File, request_options: typing.Optional[RequestOpt
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[File]:
"""
+ Returns the uploaded file identified by its ID.
+
Parameters
----------
id : str
@@ -155,6 +161,8 @@ def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = Non
def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[File]:
"""
+ Deletes the uploaded file identified by its ID.
+
Parameters
----------
id : str
@@ -195,6 +203,8 @@ def update(
self, id: str, *, name: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[File]:
"""
+ Updates the name of the uploaded file identified by its ID.
+
Parameters
----------
id : str
@@ -250,6 +260,8 @@ async def list(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[typing.List[File]]:
"""
+ Returns files uploaded to the authenticated organization.
+
Parameters
----------
request_options : typing.Optional[RequestOptions]
@@ -288,6 +300,8 @@ async def create(
self, *, file: core.File, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[File]:
"""
+ Uploads a file for use with a Vapi knowledge base.
+
Parameters
----------
file : core.File
@@ -344,6 +358,8 @@ async def create(
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> AsyncHttpResponse[File]:
"""
+ Returns the uploaded file identified by its ID.
+
Parameters
----------
id : str
@@ -384,6 +400,8 @@ async def delete(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[File]:
"""
+ Deletes the uploaded file identified by its ID.
+
Parameters
----------
id : str
@@ -424,6 +442,8 @@ async def update(
self, id: str, *, name: typing.Optional[str] = OMIT, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[File]:
"""
+ Updates the name of the uploaded file identified by its ID.
+
Parameters
----------
id : str
diff --git a/src/vapi/insight/client.py b/src/vapi/insight/client.py
index 62086d9c..d9ab23d2 100644
--- a/src/vapi/insight/client.py
+++ b/src/vapi/insight/client.py
@@ -56,6 +56,8 @@ def insight_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> InsightPaginatedResponse:
"""
+ Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -131,6 +133,8 @@ def insight_controller_create(
self, *, request: InsightControllerCreateRequest, request_options: typing.Optional[RequestOptions] = None
) -> InsightControllerCreateResponse:
"""
+ Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value.
+
Parameters
----------
request : InsightControllerCreateRequest
@@ -171,6 +175,8 @@ def insight_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> InsightControllerFindOneResponse:
"""
+ Returns the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -201,6 +207,8 @@ def insight_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> InsightControllerRemoveResponse:
"""
+ Deletes the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -235,6 +243,8 @@ def insight_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> InsightControllerUpdateResponse:
"""
+ Updates the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -274,11 +284,14 @@ def insight_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> InsightRunResponse:
"""
+ Runs a saved reporting insight, optionally overriding its time range and response format.
+
Parameters
----------
id : str
format_plan : typing.Optional[InsightRunFormatPlan]
+ Output-formatting instructions applied to the insight run.
time_range_override : typing.Optional[InsightTimeRangeWithStep]
This is the optional time range override for the insight.
@@ -317,6 +330,8 @@ def insight_controller_preview(
self, *, request: InsightControllerPreviewRequest, request_options: typing.Optional[RequestOptions] = None
) -> InsightRunResponse:
"""
+ Runs an insight definition without first saving it, returning a preview of the resulting chart or text value.
+
Parameters
----------
request : InsightControllerPreviewRequest
@@ -387,6 +402,8 @@ async def insight_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> InsightPaginatedResponse:
"""
+ Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -470,6 +487,8 @@ async def insight_controller_create(
self, *, request: InsightControllerCreateRequest, request_options: typing.Optional[RequestOptions] = None
) -> InsightControllerCreateResponse:
"""
+ Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value.
+
Parameters
----------
request : InsightControllerCreateRequest
@@ -518,6 +537,8 @@ async def insight_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> InsightControllerFindOneResponse:
"""
+ Returns the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -556,6 +577,8 @@ async def insight_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> InsightControllerRemoveResponse:
"""
+ Deletes the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -598,6 +621,8 @@ async def insight_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> InsightControllerUpdateResponse:
"""
+ Updates the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -647,11 +672,14 @@ async def insight_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> InsightRunResponse:
"""
+ Runs a saved reporting insight, optionally overriding its time range and response format.
+
Parameters
----------
id : str
format_plan : typing.Optional[InsightRunFormatPlan]
+ Output-formatting instructions applied to the insight run.
time_range_override : typing.Optional[InsightTimeRangeWithStep]
This is the optional time range override for the insight.
@@ -698,6 +726,8 @@ async def insight_controller_preview(
self, *, request: InsightControllerPreviewRequest, request_options: typing.Optional[RequestOptions] = None
) -> InsightRunResponse:
"""
+ Runs an insight definition without first saving it, returning a preview of the resulting chart or text value.
+
Parameters
----------
request : InsightControllerPreviewRequest
diff --git a/src/vapi/insight/raw_client.py b/src/vapi/insight/raw_client.py
index 9f77dc93..da5f3a9b 100644
--- a/src/vapi/insight/raw_client.py
+++ b/src/vapi/insight/raw_client.py
@@ -53,6 +53,8 @@ def insight_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[InsightPaginatedResponse]:
"""
+ Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -140,6 +142,8 @@ def insight_controller_create(
self, *, request: InsightControllerCreateRequest, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[InsightControllerCreateResponse]:
"""
+ Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value.
+
Parameters
----------
request : InsightControllerCreateRequest
@@ -184,6 +188,8 @@ def insight_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[InsightControllerFindOneResponse]:
"""
+ Returns the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -224,6 +230,8 @@ def insight_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[InsightControllerRemoveResponse]:
"""
+ Deletes the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -268,6 +276,8 @@ def insight_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[InsightControllerUpdateResponse]:
"""
+ Updates the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -322,11 +332,14 @@ def insight_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[InsightRunResponse]:
"""
+ Runs a saved reporting insight, optionally overriding its time range and response format.
+
Parameters
----------
id : str
format_plan : typing.Optional[InsightRunFormatPlan]
+ Output-formatting instructions applied to the insight run.
time_range_override : typing.Optional[InsightTimeRangeWithStep]
This is the optional time range override for the insight.
@@ -385,6 +398,8 @@ def insight_controller_preview(
self, *, request: InsightControllerPreviewRequest, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[InsightRunResponse]:
"""
+ Runs an insight definition without first saving it, returning a preview of the resulting chart or text value.
+
Parameters
----------
request : InsightControllerPreviewRequest
@@ -448,6 +463,8 @@ async def insight_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[InsightPaginatedResponse]:
"""
+ Returns saved reporting insights for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -535,6 +552,8 @@ async def insight_controller_create(
self, *, request: InsightControllerCreateRequest, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[InsightControllerCreateResponse]:
"""
+ Creates a saved reporting insight that queries call data and presents the results as a bar chart, pie chart, line chart, or text value.
+
Parameters
----------
request : InsightControllerCreateRequest
@@ -579,6 +598,8 @@ async def insight_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[InsightControllerFindOneResponse]:
"""
+ Returns the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -619,6 +640,8 @@ async def insight_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[InsightControllerRemoveResponse]:
"""
+ Deletes the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -663,6 +686,8 @@ async def insight_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[InsightControllerUpdateResponse]:
"""
+ Updates the reporting insight identified by its ID.
+
Parameters
----------
id : str
@@ -717,11 +742,14 @@ async def insight_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[InsightRunResponse]:
"""
+ Runs a saved reporting insight, optionally overriding its time range and response format.
+
Parameters
----------
id : str
format_plan : typing.Optional[InsightRunFormatPlan]
+ Output-formatting instructions applied to the insight run.
time_range_override : typing.Optional[InsightTimeRangeWithStep]
This is the optional time range override for the insight.
@@ -780,6 +808,8 @@ async def insight_controller_preview(
self, *, request: InsightControllerPreviewRequest, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[InsightRunResponse]:
"""
+ Runs an insight definition without first saving it, returning a preview of the resulting chart or text value.
+
Parameters
----------
request : InsightControllerPreviewRequest
diff --git a/src/vapi/observability_scorecard/client.py b/src/vapi/observability_scorecard/client.py
index 158ada23..c87d9eaa 100644
--- a/src/vapi/observability_scorecard/client.py
+++ b/src/vapi/observability_scorecard/client.py
@@ -34,6 +34,8 @@ def scorecard_controller_get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> Scorecard:
"""
+ Returns the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -64,6 +66,8 @@ def scorecard_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> Scorecard:
"""
+ Deletes the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -101,6 +105,8 @@ def scorecard_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> Scorecard:
"""
+ Updates the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -166,6 +172,8 @@ def scorecard_controller_get_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> ScorecardPaginatedResponse:
"""
+ Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -247,6 +255,8 @@ def scorecard_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> Scorecard:
"""
+ Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated.
+
Parameters
----------
metrics : typing.Sequence[ScorecardMetric]
@@ -316,6 +326,8 @@ async def scorecard_controller_get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> Scorecard:
"""
+ Returns the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -354,6 +366,8 @@ async def scorecard_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> Scorecard:
"""
+ Deletes the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -399,6 +413,8 @@ async def scorecard_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> Scorecard:
"""
+ Updates the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -472,6 +488,8 @@ async def scorecard_controller_get_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> ScorecardPaginatedResponse:
"""
+ Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -561,6 +579,8 @@ async def scorecard_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> Scorecard:
"""
+ Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated.
+
Parameters
----------
metrics : typing.Sequence[ScorecardMetric]
diff --git a/src/vapi/observability_scorecard/raw_client.py b/src/vapi/observability_scorecard/raw_client.py
index 46eddd6c..d73a9325 100644
--- a/src/vapi/observability_scorecard/raw_client.py
+++ b/src/vapi/observability_scorecard/raw_client.py
@@ -31,6 +31,8 @@ def scorecard_controller_get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[Scorecard]:
"""
+ Returns the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -71,6 +73,8 @@ def scorecard_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[Scorecard]:
"""
+ Deletes the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -118,6 +122,8 @@ def scorecard_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Scorecard]:
"""
+ Updates the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -198,6 +204,8 @@ def scorecard_controller_get_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[ScorecardPaginatedResponse]:
"""
+ Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -291,6 +299,8 @@ def scorecard_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Scorecard]:
"""
+ Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated.
+
Parameters
----------
metrics : typing.Sequence[ScorecardMetric]
@@ -357,6 +367,8 @@ async def scorecard_controller_get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Scorecard]:
"""
+ Returns the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -397,6 +409,8 @@ async def scorecard_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Scorecard]:
"""
+ Deletes the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -444,6 +458,8 @@ async def scorecard_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Scorecard]:
"""
+ Updates the scorecard identified by its ID.
+
Parameters
----------
id : str
@@ -524,6 +540,8 @@ async def scorecard_controller_get_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[ScorecardPaginatedResponse]:
"""
+ Returns scorecards for the authenticated organization. Filter results by ID or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -617,6 +635,8 @@ async def scorecard_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Scorecard]:
"""
+ Creates a scorecard containing metrics, scoring conditions, and optional links to assistants whose calls should be evaluated.
+
Parameters
----------
metrics : typing.Sequence[ScorecardMetric]
diff --git a/src/vapi/phone_numbers/client.py b/src/vapi/phone_numbers/client.py
index 8745d92d..bbfd0c6f 100644
--- a/src/vapi/phone_numbers/client.py
+++ b/src/vapi/phone_numbers/client.py
@@ -52,6 +52,8 @@ def list(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[ListPhoneNumbersResponseItem]:
"""
+ Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -116,6 +118,8 @@ def create(
self, *, request: CreatePhoneNumbersRequest, request_options: typing.Optional[RequestOptions] = None
) -> CreatePhoneNumbersResponse:
"""
+ Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider.
+
Parameters
----------
request : CreatePhoneNumbersRequest
@@ -163,6 +167,8 @@ def phone_number_controller_find_all_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> PhoneNumberPaginatedResponse:
"""
+ Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps.
+
Parameters
----------
search : typing.Optional[str]
@@ -237,6 +243,8 @@ def phone_number_controller_find_all_paginated(
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetPhoneNumbersResponse:
"""
+ Returns the phone number resource identified by its ID.
+
Parameters
----------
id : str
@@ -265,6 +273,8 @@ def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = Non
def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DeletePhoneNumbersResponse:
"""
+ Deletes the phone number resource identified by its ID.
+
Parameters
----------
id : str
@@ -299,6 +309,8 @@ def update(
request_options: typing.Optional[RequestOptions] = None,
) -> UpdatePhoneNumbersResponse:
"""
+ Updates the specified fields of the phone number resource identified by its ID.
+
Parameters
----------
id : str
@@ -360,6 +372,8 @@ async def list(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[ListPhoneNumbersResponseItem]:
"""
+ Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -432,6 +446,8 @@ async def create(
self, *, request: CreatePhoneNumbersRequest, request_options: typing.Optional[RequestOptions] = None
) -> CreatePhoneNumbersResponse:
"""
+ Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider.
+
Parameters
----------
request : CreatePhoneNumbersRequest
@@ -487,6 +503,8 @@ async def phone_number_controller_find_all_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> PhoneNumberPaginatedResponse:
"""
+ Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps.
+
Parameters
----------
search : typing.Optional[str]
@@ -569,6 +587,8 @@ async def main() -> None:
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetPhoneNumbersResponse:
"""
+ Returns the phone number resource identified by its ID.
+
Parameters
----------
id : str
@@ -607,6 +627,8 @@ async def delete(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> DeletePhoneNumbersResponse:
"""
+ Deletes the phone number resource identified by its ID.
+
Parameters
----------
id : str
@@ -649,6 +671,8 @@ async def update(
request_options: typing.Optional[RequestOptions] = None,
) -> UpdatePhoneNumbersResponse:
"""
+ Updates the specified fields of the phone number resource identified by its ID.
+
Parameters
----------
id : str
diff --git a/src/vapi/phone_numbers/raw_client.py b/src/vapi/phone_numbers/raw_client.py
index 2ac523c3..a1e517a4 100644
--- a/src/vapi/phone_numbers/raw_client.py
+++ b/src/vapi/phone_numbers/raw_client.py
@@ -49,6 +49,8 @@ def list(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.List[ListPhoneNumbersResponseItem]]:
"""
+ Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -125,6 +127,8 @@ def create(
self, *, request: CreatePhoneNumbersRequest, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[CreatePhoneNumbersResponse]:
"""
+ Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider.
+
Parameters
----------
request : CreatePhoneNumbersRequest
@@ -183,6 +187,8 @@ def phone_number_controller_find_all_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[PhoneNumberPaginatedResponse]:
"""
+ Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps.
+
Parameters
----------
search : typing.Optional[str]
@@ -271,6 +277,8 @@ def get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[GetPhoneNumbersResponse]:
"""
+ Returns the phone number resource identified by its ID.
+
Parameters
----------
id : str
@@ -311,6 +319,8 @@ def delete(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[DeletePhoneNumbersResponse]:
"""
+ Deletes the phone number resource identified by its ID.
+
Parameters
----------
id : str
@@ -355,6 +365,8 @@ def update(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[UpdatePhoneNumbersResponse]:
"""
+ Updates the specified fields of the phone number resource identified by its ID.
+
Parameters
----------
id : str
@@ -420,6 +432,8 @@ async def list(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.List[ListPhoneNumbersResponseItem]]:
"""
+ Returns phone numbers for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -496,6 +510,8 @@ async def create(
self, *, request: CreatePhoneNumbersRequest, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[CreatePhoneNumbersResponse]:
"""
+ Creates a Vapi phone number or imports a phone number from a supported provider, including Twilio, Vonage, Telnyx, or a bring-your-own provider.
+
Parameters
----------
request : CreatePhoneNumbersRequest
@@ -554,6 +570,8 @@ async def phone_number_controller_find_all_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[PhoneNumberPaginatedResponse]:
"""
+ Returns a paginated list of phone numbers for the authenticated organization. Search by name, number, or SIP URI using a partial, case-insensitive match, and filter by creation or update timestamps.
+
Parameters
----------
search : typing.Optional[str]
@@ -642,6 +660,8 @@ async def get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[GetPhoneNumbersResponse]:
"""
+ Returns the phone number resource identified by its ID.
+
Parameters
----------
id : str
@@ -682,6 +702,8 @@ async def delete(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[DeletePhoneNumbersResponse]:
"""
+ Deletes the phone number resource identified by its ID.
+
Parameters
----------
id : str
@@ -726,6 +748,8 @@ async def update(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[UpdatePhoneNumbersResponse]:
"""
+ Updates the specified fields of the phone number resource identified by its ID.
+
Parameters
----------
id : str
diff --git a/src/vapi/provider_resources/client.py b/src/vapi/provider_resources/client.py
index eaf876ce..0955b081 100644
--- a/src/vapi/provider_resources/client.py
+++ b/src/vapi/provider_resources/client.py
@@ -79,6 +79,8 @@ def provider_resource_controller_get_provider_resources_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> ProviderResourcePaginatedResponse:
"""
+ Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps.
+
Parameters
----------
provider : ProviderResourceControllerGetProviderResourcesPaginatedRequestProvider
@@ -172,6 +174,8 @@ def provider_resource_controller_create_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> ProviderResource:
"""
+ Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs.
+
Parameters
----------
provider : ProviderResourceControllerCreateProviderResourceRequestProvider
@@ -214,6 +218,8 @@ def provider_resource_controller_get_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> ProviderResource:
"""
+ Returns the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerGetProviderResourceRequestProvider
@@ -259,6 +265,8 @@ def provider_resource_controller_delete_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> ProviderResource:
"""
+ Deletes the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerDeleteProviderResourceRequestProvider
@@ -304,6 +312,8 @@ def provider_resource_controller_update_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> ProviderResource:
"""
+ Updates the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerUpdateProviderResourceRequestProvider
@@ -377,6 +387,8 @@ async def provider_resource_controller_get_provider_resources_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> ProviderResourcePaginatedResponse:
"""
+ Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps.
+
Parameters
----------
provider : ProviderResourceControllerGetProviderResourcesPaginatedRequestProvider
@@ -478,6 +490,8 @@ async def provider_resource_controller_create_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> ProviderResource:
"""
+ Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs.
+
Parameters
----------
provider : ProviderResourceControllerCreateProviderResourceRequestProvider
@@ -528,6 +542,8 @@ async def provider_resource_controller_get_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> ProviderResource:
"""
+ Returns the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerGetProviderResourceRequestProvider
@@ -581,6 +597,8 @@ async def provider_resource_controller_delete_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> ProviderResource:
"""
+ Deletes the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerDeleteProviderResourceRequestProvider
@@ -634,6 +652,8 @@ async def provider_resource_controller_update_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> ProviderResource:
"""
+ Updates the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerUpdateProviderResourceRequestProvider
diff --git a/src/vapi/provider_resources/raw_client.py b/src/vapi/provider_resources/raw_client.py
index f4771b55..2a83ad1f 100644
--- a/src/vapi/provider_resources/raw_client.py
+++ b/src/vapi/provider_resources/raw_client.py
@@ -76,6 +76,8 @@ def provider_resource_controller_get_provider_resources_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[ProviderResourcePaginatedResponse]:
"""
+ Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps.
+
Parameters
----------
provider : ProviderResourceControllerGetProviderResourcesPaginatedRequestProvider
@@ -176,6 +178,8 @@ def provider_resource_controller_create_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[ProviderResource]:
"""
+ Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs.
+
Parameters
----------
provider : ProviderResourceControllerCreateProviderResourceRequestProvider
@@ -225,6 +229,8 @@ def provider_resource_controller_get_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[ProviderResource]:
"""
+ Returns the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerGetProviderResourceRequestProvider
@@ -287,6 +293,8 @@ def provider_resource_controller_delete_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[ProviderResource]:
"""
+ Deletes the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerDeleteProviderResourceRequestProvider
@@ -349,6 +357,8 @@ def provider_resource_controller_update_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[ProviderResource]:
"""
+ Updates the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerUpdateProviderResourceRequestProvider
@@ -428,6 +438,8 @@ async def provider_resource_controller_get_provider_resources_paginated(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[ProviderResourcePaginatedResponse]:
"""
+ Returns a paginated list of provider resources for the authenticated organization. Filter pronunciation dictionaries by provider, resource ID, or creation and update timestamps.
+
Parameters
----------
provider : ProviderResourceControllerGetProviderResourcesPaginatedRequestProvider
@@ -528,6 +540,8 @@ async def provider_resource_controller_create_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[ProviderResource]:
"""
+ Creates a pronunciation-dictionary resource for a supported provider, currently Cartesia or ElevenLabs.
+
Parameters
----------
provider : ProviderResourceControllerCreateProviderResourceRequestProvider
@@ -577,6 +591,8 @@ async def provider_resource_controller_get_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[ProviderResource]:
"""
+ Returns the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerGetProviderResourceRequestProvider
@@ -639,6 +655,8 @@ async def provider_resource_controller_delete_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[ProviderResource]:
"""
+ Deletes the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerDeleteProviderResourceRequestProvider
@@ -701,6 +719,8 @@ async def provider_resource_controller_update_provider_resource(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[ProviderResource]:
"""
+ Updates the provider resource identified by its Vapi resource ID.
+
Parameters
----------
provider : ProviderResourceControllerUpdateProviderResourceRequestProvider
diff --git a/src/vapi/squads/client.py b/src/vapi/squads/client.py
index 206efd37..4613803a 100644
--- a/src/vapi/squads/client.py
+++ b/src/vapi/squads/client.py
@@ -44,6 +44,8 @@ def list(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[Squad]:
"""
+ Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -113,6 +115,8 @@ def create(
request_options: typing.Optional[RequestOptions] = None,
) -> Squad:
"""
+ Creates a squad that coordinates multiple assistants and their handoffs during a conversation.
+
Parameters
----------
members : typing.Sequence[SquadMemberDto]
@@ -154,6 +158,8 @@ def create(
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Squad:
"""
+ Returns the squad identified by its ID.
+
Parameters
----------
id : str
@@ -182,6 +188,8 @@ def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = Non
def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Squad:
"""
+ Deletes the squad identified by its ID.
+
Parameters
----------
id : str
@@ -218,6 +226,8 @@ def update(
request_options: typing.Optional[RequestOptions] = None,
) -> Squad:
"""
+ Updates the specified fields of the squad identified by its ID.
+
Parameters
----------
id : str
@@ -291,6 +301,8 @@ async def list(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[Squad]:
"""
+ Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -368,6 +380,8 @@ async def create(
request_options: typing.Optional[RequestOptions] = None,
) -> Squad:
"""
+ Creates a squad that coordinates multiple assistants and their handoffs during a conversation.
+
Parameters
----------
members : typing.Sequence[SquadMemberDto]
@@ -417,6 +431,8 @@ async def main() -> None:
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Squad:
"""
+ Returns the squad identified by its ID.
+
Parameters
----------
id : str
@@ -453,6 +469,8 @@ async def main() -> None:
async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Squad:
"""
+ Deletes the squad identified by its ID.
+
Parameters
----------
id : str
@@ -497,6 +515,8 @@ async def update(
request_options: typing.Optional[RequestOptions] = None,
) -> Squad:
"""
+ Updates the specified fields of the squad identified by its ID.
+
Parameters
----------
id : str
diff --git a/src/vapi/squads/raw_client.py b/src/vapi/squads/raw_client.py
index 85e0a6a5..ea961c52 100644
--- a/src/vapi/squads/raw_client.py
+++ b/src/vapi/squads/raw_client.py
@@ -41,6 +41,8 @@ def list(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.List[Squad]]:
"""
+ Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -122,6 +124,8 @@ def create(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Squad]:
"""
+ Creates a squad that coordinates multiple assistants and their handoffs during a conversation.
+
Parameters
----------
members : typing.Sequence[SquadMemberDto]
@@ -181,6 +185,8 @@ def create(
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Squad]:
"""
+ Returns the squad identified by its ID.
+
Parameters
----------
id : str
@@ -219,6 +225,8 @@ def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = Non
def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Squad]:
"""
+ Deletes the squad identified by its ID.
+
Parameters
----------
id : str
@@ -265,6 +273,8 @@ def update(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[Squad]:
"""
+ Updates the specified fields of the squad identified by its ID.
+
Parameters
----------
id : str
@@ -347,6 +357,8 @@ async def list(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.List[Squad]]:
"""
+ Returns squads for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -428,6 +440,8 @@ async def create(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Squad]:
"""
+ Creates a squad that coordinates multiple assistants and their handoffs during a conversation.
+
Parameters
----------
members : typing.Sequence[SquadMemberDto]
@@ -489,6 +503,8 @@ async def get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Squad]:
"""
+ Returns the squad identified by its ID.
+
Parameters
----------
id : str
@@ -529,6 +545,8 @@ async def delete(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[Squad]:
"""
+ Deletes the squad identified by its ID.
+
Parameters
----------
id : str
@@ -575,6 +593,8 @@ async def update(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[Squad]:
"""
+ Updates the specified fields of the squad identified by its ID.
+
Parameters
----------
id : str
diff --git a/src/vapi/structured_outputs/client.py b/src/vapi/structured_outputs/client.py
index b6f98b3a..db7fed7e 100644
--- a/src/vapi/structured_outputs/client.py
+++ b/src/vapi/structured_outputs/client.py
@@ -57,6 +57,8 @@ def structured_output_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> StructuredOutputPaginatedResponse:
"""
+ Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -148,6 +150,8 @@ def structured_output_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> StructuredOutput:
"""
+ Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression.
+
Parameters
----------
name : str
@@ -257,6 +261,8 @@ def structured_output_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> StructuredOutput:
"""
+ Returns the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -287,6 +293,8 @@ def structured_output_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> StructuredOutput:
"""
+ Deletes the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -330,6 +338,8 @@ def structured_output_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> StructuredOutput:
"""
+ Updates the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -447,6 +457,8 @@ def structured_output_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> StructuredOutput:
"""
+ Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts.
+
Parameters
----------
call_ids : typing.Sequence[str]
@@ -528,6 +540,8 @@ async def structured_output_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> StructuredOutputPaginatedResponse:
"""
+ Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -627,6 +641,8 @@ async def structured_output_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> StructuredOutput:
"""
+ Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression.
+
Parameters
----------
name : str
@@ -744,6 +760,8 @@ async def structured_output_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> StructuredOutput:
"""
+ Returns the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -782,6 +800,8 @@ async def structured_output_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> StructuredOutput:
"""
+ Deletes the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -833,6 +853,8 @@ async def structured_output_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> StructuredOutput:
"""
+ Updates the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -958,6 +980,8 @@ async def structured_output_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> StructuredOutput:
"""
+ Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts.
+
Parameters
----------
call_ids : typing.Sequence[str]
diff --git a/src/vapi/structured_outputs/raw_client.py b/src/vapi/structured_outputs/raw_client.py
index 40871697..9ae3097d 100644
--- a/src/vapi/structured_outputs/raw_client.py
+++ b/src/vapi/structured_outputs/raw_client.py
@@ -54,6 +54,8 @@ def structured_output_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[StructuredOutputPaginatedResponse]:
"""
+ Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -157,6 +159,8 @@ def structured_output_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[StructuredOutput]:
"""
+ Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression.
+
Parameters
----------
name : str
@@ -280,6 +284,8 @@ def structured_output_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[StructuredOutput]:
"""
+ Returns the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -320,6 +326,8 @@ def structured_output_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[StructuredOutput]:
"""
+ Deletes the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -373,6 +381,8 @@ def structured_output_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[StructuredOutput]:
"""
+ Updates the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -510,6 +520,8 @@ def structured_output_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[StructuredOutput]:
"""
+ Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts.
+
Parameters
----------
call_ids : typing.Sequence[str]
@@ -596,6 +608,8 @@ async def structured_output_controller_find_all(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[StructuredOutputPaginatedResponse]:
"""
+ Returns structured-output definitions for the authenticated organization. Filter results by ID, name, or creation and update timestamps.
+
Parameters
----------
id : typing.Optional[str]
@@ -699,6 +713,8 @@ async def structured_output_controller_create(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[StructuredOutput]:
"""
+ Creates a reusable definition for extracting validated data from conversations using an AI model or regular expression.
+
Parameters
----------
name : str
@@ -822,6 +838,8 @@ async def structured_output_controller_find_one(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[StructuredOutput]:
"""
+ Returns the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -862,6 +880,8 @@ async def structured_output_controller_remove(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[StructuredOutput]:
"""
+ Deletes the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -915,6 +935,8 @@ async def structured_output_controller_update(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[StructuredOutput]:
"""
+ Updates the structured-output definition identified by its ID.
+
Parameters
----------
id : str
@@ -1052,6 +1074,8 @@ async def structured_output_controller_run(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[StructuredOutput]:
"""
+ Runs a saved or transient structured-output definition against one or more calls, optionally returning a preview without updating call artifacts.
+
Parameters
----------
call_ids : typing.Sequence[str]
diff --git a/src/vapi/tools/client.py b/src/vapi/tools/client.py
index 208314a1..6089ef84 100644
--- a/src/vapi/tools/client.py
+++ b/src/vapi/tools/client.py
@@ -48,6 +48,8 @@ def list(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[ListToolsResponseItem]:
"""
+ Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -112,6 +114,8 @@ def create(
self, *, request: CreateToolsRequest, request_options: typing.Optional[RequestOptions] = None
) -> CreateToolsResponse:
"""
+ Creates a reusable tool that assistants can invoke during conversations.
+
Parameters
----------
request : CreateToolsRequest
@@ -144,6 +148,8 @@ def create(
def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetToolsResponse:
"""
+ Returns the tool identified by its ID.
+
Parameters
----------
id : str
@@ -172,6 +178,8 @@ def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = Non
def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DeleteToolsResponse:
"""
+ Deletes the tool identified by its ID.
+
Parameters
----------
id : str
@@ -202,6 +210,8 @@ def update(
self, id: str, *, request: UpdateToolsRequestBody, request_options: typing.Optional[RequestOptions] = None
) -> UpdateToolsResponse:
"""
+ Updates the specified fields of the tool identified by its ID.
+
Parameters
----------
id : str
@@ -263,6 +273,8 @@ async def list(
request_options: typing.Optional[RequestOptions] = None,
) -> typing.List[ListToolsResponseItem]:
"""
+ Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -335,6 +347,8 @@ async def create(
self, *, request: CreateToolsRequest, request_options: typing.Optional[RequestOptions] = None
) -> CreateToolsResponse:
"""
+ Creates a reusable tool that assistants can invoke during conversations.
+
Parameters
----------
request : CreateToolsRequest
@@ -375,6 +389,8 @@ async def main() -> None:
async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetToolsResponse:
"""
+ Returns the tool identified by its ID.
+
Parameters
----------
id : str
@@ -411,6 +427,8 @@ async def main() -> None:
async def delete(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> DeleteToolsResponse:
"""
+ Deletes the tool identified by its ID.
+
Parameters
----------
id : str
@@ -449,6 +467,8 @@ async def update(
self, id: str, *, request: UpdateToolsRequestBody, request_options: typing.Optional[RequestOptions] = None
) -> UpdateToolsResponse:
"""
+ Updates the specified fields of the tool identified by its ID.
+
Parameters
----------
id : str
diff --git a/src/vapi/tools/raw_client.py b/src/vapi/tools/raw_client.py
index 7c3cc896..a3064644 100644
--- a/src/vapi/tools/raw_client.py
+++ b/src/vapi/tools/raw_client.py
@@ -45,6 +45,8 @@ def list(
request_options: typing.Optional[RequestOptions] = None,
) -> HttpResponse[typing.List[ListToolsResponseItem]]:
"""
+ Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -121,6 +123,8 @@ def create(
self, *, request: CreateToolsRequest, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[CreateToolsResponse]:
"""
+ Creates a reusable tool that assistants can invoke during conversations.
+
Parameters
----------
request : CreateToolsRequest
@@ -165,6 +169,8 @@ def get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[GetToolsResponse]:
"""
+ Returns the tool identified by its ID.
+
Parameters
----------
id : str
@@ -205,6 +211,8 @@ def delete(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[DeleteToolsResponse]:
"""
+ Deletes the tool identified by its ID.
+
Parameters
----------
id : str
@@ -245,6 +253,8 @@ def update(
self, id: str, *, request: UpdateToolsRequestBody, request_options: typing.Optional[RequestOptions] = None
) -> HttpResponse[UpdateToolsResponse]:
"""
+ Updates the specified fields of the tool identified by its ID.
+
Parameters
----------
id : str
@@ -310,6 +320,8 @@ async def list(
request_options: typing.Optional[RequestOptions] = None,
) -> AsyncHttpResponse[typing.List[ListToolsResponseItem]]:
"""
+ Returns reusable tools for the authenticated organization. Filter results by creation or update timestamps and limit the number returned.
+
Parameters
----------
limit : typing.Optional[float]
@@ -386,6 +398,8 @@ async def create(
self, *, request: CreateToolsRequest, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[CreateToolsResponse]:
"""
+ Creates a reusable tool that assistants can invoke during conversations.
+
Parameters
----------
request : CreateToolsRequest
@@ -430,6 +444,8 @@ async def get(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[GetToolsResponse]:
"""
+ Returns the tool identified by its ID.
+
Parameters
----------
id : str
@@ -470,6 +486,8 @@ async def delete(
self, id: str, *, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[DeleteToolsResponse]:
"""
+ Deletes the tool identified by its ID.
+
Parameters
----------
id : str
@@ -510,6 +528,8 @@ async def update(
self, id: str, *, request: UpdateToolsRequestBody, request_options: typing.Optional[RequestOptions] = None
) -> AsyncHttpResponse[UpdateToolsResponse]:
"""
+ Updates the specified fields of the tool identified by its ID.
+
Parameters
----------
id : str
diff --git a/src/vapi/types/ai_edge_condition.py b/src/vapi/types/ai_edge_condition.py
index 6cb27d6c..a18e9ea3 100644
--- a/src/vapi/types/ai_edge_condition.py
+++ b/src/vapi/types/ai_edge_condition.py
@@ -9,7 +9,15 @@
class AiEdgeCondition(UncheckedBaseModel):
- type: AiEdgeConditionType
+ """
+ An AI-evaluated boolean condition that determines whether a workflow follows an edge.
+ """
+
+ type: AiEdgeConditionType = pydantic.Field()
+ """
+ Selects an AI-evaluated workflow edge condition.
+ """
+
prompt: str = pydantic.Field()
"""
This is the prompt for the AI edge condition. It should evaluate to a boolean.
diff --git a/src/vapi/types/analysis.py b/src/vapi/types/analysis.py
index c821a7ad..e32cebee 100644
--- a/src/vapi/types/analysis.py
+++ b/src/vapi/types/analysis.py
@@ -10,6 +10,10 @@
class Analysis(UncheckedBaseModel):
+ """
+ Post-call analysis results, including summary, structured data, and success evaluation outputs.
+ """
+
summary: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the summary of the call. Customize by setting `assistant.analysisPlan.summaryPrompt`.
diff --git a/src/vapi/types/analysis_cost.py b/src/vapi/types/analysis_cost.py
index 979b8b1d..82fc0a91 100644
--- a/src/vapi/types/analysis_cost.py
+++ b/src/vapi/types/analysis_cost.py
@@ -11,6 +11,10 @@
class AnalysisCost(UncheckedBaseModel):
+ """
+ Cost for an individual analysis request, including analysis type, model, token usage, and amount.
+ """
+
analysis_type: typing_extensions.Annotated[
AnalysisCostAnalysisType,
FieldMetadata(alias="analysisType"),
diff --git a/src/vapi/types/analysis_cost_breakdown.py b/src/vapi/types/analysis_cost_breakdown.py
index 0d1d1c8b..45fefe89 100644
--- a/src/vapi/types/analysis_cost_breakdown.py
+++ b/src/vapi/types/analysis_cost_breakdown.py
@@ -10,6 +10,10 @@
class AnalysisCostBreakdown(UncheckedBaseModel):
+ """
+ Analysis costs and token usage grouped by summary, structured data, success evaluation, and structured-output generation.
+ """
+
summary: typing.Optional[float] = pydantic.Field(default=None)
"""
This is the cost to summarize the call.
diff --git a/src/vapi/types/analysis_plan.py b/src/vapi/types/analysis_plan.py
index c7fc8bf7..c94b571a 100644
--- a/src/vapi/types/analysis_plan.py
+++ b/src/vapi/types/analysis_plan.py
@@ -16,6 +16,10 @@
class AnalysisPlan(UncheckedBaseModel):
+ """
+ Configuration for post-call analysis of summaries, structured-data extraction, success evaluation, and outcomes.
+ """
+
min_messages_threshold: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="minMessagesThreshold"),
diff --git a/src/vapi/types/analytics_operation.py b/src/vapi/types/analytics_operation.py
index f12006ba..fe51f50a 100644
--- a/src/vapi/types/analytics_operation.py
+++ b/src/vapi/types/analytics_operation.py
@@ -10,6 +10,10 @@
class AnalyticsOperation(UncheckedBaseModel):
+ """
+ An aggregation or history operation applied to an analytics column, with an optional response alias.
+ """
+
operation: AnalyticsOperationOperation = pydantic.Field()
"""
This is the aggregation operation you want to perform.
diff --git a/src/vapi/types/analytics_query.py b/src/vapi/types/analytics_query.py
index a2533aa2..ecc022cd 100644
--- a/src/vapi/types/analytics_query.py
+++ b/src/vapi/types/analytics_query.py
@@ -15,6 +15,10 @@
class AnalyticsQuery(UncheckedBaseModel):
+ """
+ A named analytics query against call or subscription data, including grouping, time range, and aggregation operations.
+ """
+
table: AnalyticsQueryTable = pydantic.Field()
"""
This is the table you want to query.
diff --git a/src/vapi/types/analytics_query_result.py b/src/vapi/types/analytics_query_result.py
index 15ad372c..851f3dec 100644
--- a/src/vapi/types/analytics_query_result.py
+++ b/src/vapi/types/analytics_query_result.py
@@ -11,6 +11,10 @@
class AnalyticsQueryResult(UncheckedBaseModel):
+ """
+ The result of a named analytics query, including the evaluated time range and returned metric data.
+ """
+
name: str = pydantic.Field()
"""
This is the unique key for the query.
diff --git a/src/vapi/types/anthropic_bedrock_model.py b/src/vapi/types/anthropic_bedrock_model.py
index af4ae613..09dd5d8b 100644
--- a/src/vapi/types/anthropic_bedrock_model.py
+++ b/src/vapi/types/anthropic_bedrock_model.py
@@ -16,6 +16,10 @@
class AnthropicBedrockModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with Anthropic models through Amazon Bedrock, including model, prompts, tools, knowledge-base access, reasoning, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/anthropic_model.py b/src/vapi/types/anthropic_model.py
index 567a437d..41a4412f 100644
--- a/src/vapi/types/anthropic_model.py
+++ b/src/vapi/types/anthropic_model.py
@@ -16,6 +16,10 @@
class AnthropicModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with Anthropic, including model, prompts, tools, knowledge-base access, reasoning, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/anthropic_thinking_config.py b/src/vapi/types/anthropic_thinking_config.py
index 1a9b8290..504e4b4e 100644
--- a/src/vapi/types/anthropic_thinking_config.py
+++ b/src/vapi/types/anthropic_thinking_config.py
@@ -11,7 +11,15 @@
class AnthropicThinkingConfig(UncheckedBaseModel):
- type: AnthropicThinkingConfigType
+ """
+ Enables Anthropic extended thinking with a maximum thinking-token budget.
+ """
+
+ type: AnthropicThinkingConfigType = pydantic.Field()
+ """
+ Enables Anthropic extended thinking.
+ """
+
budget_tokens: typing_extensions.Annotated[
float,
FieldMetadata(alias="budgetTokens"),
diff --git a/src/vapi/types/anyscale_model.py b/src/vapi/types/anyscale_model.py
index 74a19b90..e286b93b 100644
--- a/src/vapi/types/anyscale_model.py
+++ b/src/vapi/types/anyscale_model.py
@@ -14,6 +14,10 @@
class AnyscaleModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with Anyscale, including model, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/api_request_tool.py b/src/vapi/types/api_request_tool.py
index 2cf79a59..57a62e19 100644
--- a/src/vapi/types/api_request_tool.py
+++ b/src/vapi/types/api_request_tool.py
@@ -19,6 +19,10 @@
class ApiRequestTool(UncheckedBaseModel):
+ """
+ A reusable tool that sends HTTP requests to a configured API and can authenticate, retry failures, and extract variables from responses.
+ """
+
messages: typing.Optional[typing.List[ApiRequestToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
@@ -26,7 +30,11 @@ class ApiRequestTool(UncheckedBaseModel):
For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.
"""
- method: ApiRequestToolMethod
+ method: ApiRequestToolMethod = pydantic.Field()
+ """
+ The HTTP method used for the API request.
+ """
+
timeout_seconds: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="timeoutSeconds"),
diff --git a/src/vapi/types/artifact.py b/src/vapi/types/artifact.py
index 784d86ce..e221bc05 100644
--- a/src/vapi/types/artifact.py
+++ b/src/vapi/types/artifact.py
@@ -17,6 +17,10 @@
class Artifact(UncheckedBaseModel):
+ """
+ Artifacts generated during a call, including messages, recordings, transcript, logs, packet capture, workflow-node data, variables, performance metrics, structured outputs, scorecards, and transfers.
+ """
+
messages: typing.Optional[typing.List[ArtifactMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that were spoken during the call.
diff --git a/src/vapi/types/artifact_plan.py b/src/vapi/types/artifact_plan.py
index faae07b5..c8a26c05 100644
--- a/src/vapi/types/artifact_plan.py
+++ b/src/vapi/types/artifact_plan.py
@@ -16,6 +16,10 @@
class ArtifactPlan(UncheckedBaseModel):
+ """
+ Controls artifacts generated and stored for calls, including recordings, packet captures, logs, transcripts, structured outputs, scorecards, and custom storage paths.
+ """
+
recording_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="recordingEnabled"),
diff --git a/src/vapi/types/assembly_ai_transcriber.py b/src/vapi/types/assembly_ai_transcriber.py
index f105f49e..8cc79960 100644
--- a/src/vapi/types/assembly_ai_transcriber.py
+++ b/src/vapi/types/assembly_ai_transcriber.py
@@ -13,6 +13,10 @@
class AssemblyAiTranscriber(UncheckedBaseModel):
+ """
+ Configuration for transcribing speech during assistant conversations with AssemblyAI, including language, streaming model, endpointing, vocabulary, and fallback settings.
+ """
+
language: typing.Optional[AssemblyAiTranscriberLanguage] = pydantic.Field(default=None)
"""
This is the language that will be set for the transcription.
diff --git a/src/vapi/types/assistant.py b/src/vapi/types/assistant.py
index 896bc9af..0bab4f4d 100644
--- a/src/vapi/types/assistant.py
+++ b/src/vapi/types/assistant.py
@@ -34,6 +34,10 @@
class Assistant(UncheckedBaseModel):
+ """
+ A saved assistant configuration returned by the Vapi API. It defines how the assistant listens, reasons, speaks, handles conversations, sends events, and produces artifacts and analysis.
+ """
+
transcriber: typing.Optional[AssistantTranscriber] = pydantic.Field(default=None)
"""
These are the options for the assistant's transcriber.
@@ -60,7 +64,10 @@ class Assistant(UncheckedBaseModel):
first_message_interruptions_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="firstMessageInterruptionsEnabled"),
- pydantic.Field(alias="firstMessageInterruptionsEnabled"),
+ pydantic.Field(
+ alias="firstMessageInterruptionsEnabled",
+ description="Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.",
+ ),
] = None
first_message_mode: typing_extensions.Annotated[
typing.Optional[AssistantFirstMessageMode],
@@ -176,7 +183,12 @@ class Assistant(UncheckedBaseModel):
),
] = None
compliance_plan: typing_extensions.Annotated[
- typing.Optional[CompliancePlan], FieldMetadata(alias="compliancePlan"), pydantic.Field(alias="compliancePlan")
+ typing.Optional[CompliancePlan],
+ FieldMetadata(alias="compliancePlan"),
+ pydantic.Field(
+ alias="compliancePlan",
+ description="Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.",
+ ),
] = None
metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
"""
@@ -253,7 +265,10 @@ class Assistant(UncheckedBaseModel):
keypad_input_plan: typing_extensions.Annotated[
typing.Optional[KeypadInputPlan],
FieldMetadata(alias="keypadInputPlan"),
- pydantic.Field(alias="keypadInputPlan"),
+ pydantic.Field(
+ alias="keypadInputPlan",
+ description="Configuration for collecting and processing DTMF keypad input during calls.",
+ ),
] = None
id: str = pydantic.Field()
"""
diff --git a/src/vapi/types/assistant_activation.py b/src/vapi/types/assistant_activation.py
index ed28a94f..aa819bc5 100644
--- a/src/vapi/types/assistant_activation.py
+++ b/src/vapi/types/assistant_activation.py
@@ -10,6 +10,10 @@
class AssistantActivation(UncheckedBaseModel):
+ """
+ Identifies an assistant that became active during a call.
+ """
+
assistant_name: typing_extensions.Annotated[
str,
FieldMetadata(alias="assistantName"),
diff --git a/src/vapi/types/assistant_custom_endpointing_rule.py b/src/vapi/types/assistant_custom_endpointing_rule.py
index 11acb762..9959a210 100644
--- a/src/vapi/types/assistant_custom_endpointing_rule.py
+++ b/src/vapi/types/assistant_custom_endpointing_rule.py
@@ -11,6 +11,10 @@
class AssistantCustomEndpointingRule(UncheckedBaseModel):
+ """
+ A custom endpointing rule that matches the assistant's last message and applies a configured timeout.
+ """
+
regex: str = pydantic.Field()
"""
This is the regex pattern to match.
diff --git a/src/vapi/types/assistant_message.py b/src/vapi/types/assistant_message.py
index d1e29293..4f333363 100644
--- a/src/vapi/types/assistant_message.py
+++ b/src/vapi/types/assistant_message.py
@@ -10,6 +10,10 @@
class AssistantMessage(UncheckedBaseModel):
+ """
+ An assistant-authored message, including content, refusal text, tool calls, participant name, and metadata.
+ """
+
role: AssistantMessageRole = pydantic.Field()
"""
This is the role of the message author
diff --git a/src/vapi/types/assistant_message_evaluation_continue_plan.py b/src/vapi/types/assistant_message_evaluation_continue_plan.py
index 722a3359..9ecaeebe 100644
--- a/src/vapi/types/assistant_message_evaluation_continue_plan.py
+++ b/src/vapi/types/assistant_message_evaluation_continue_plan.py
@@ -11,6 +11,10 @@
class AssistantMessageEvaluationContinuePlan(UncheckedBaseModel):
+ """
+ Controls how an evaluation proceeds after judging an assistant message, including failure handling and optional message overrides.
+ """
+
exit_on_failure_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="exitOnFailureEnabled"),
diff --git a/src/vapi/types/assistant_message_judge_plan_ai.py b/src/vapi/types/assistant_message_judge_plan_ai.py
index 0d5bdb8a..d0265fd3 100644
--- a/src/vapi/types/assistant_message_judge_plan_ai.py
+++ b/src/vapi/types/assistant_message_judge_plan_ai.py
@@ -12,6 +12,10 @@
class AssistantMessageJudgePlanAi(UncheckedBaseModel):
+ """
+ Evaluates an assistant message with an LLM judge and a configured evaluation model.
+ """
+
model: AssistantMessageJudgePlanAiModel = pydantic.Field()
"""
This is the model to use for the LLM-as-a-judge.
diff --git a/src/vapi/types/assistant_message_judge_plan_exact.py b/src/vapi/types/assistant_message_judge_plan_exact.py
index 74fd1e17..9ebe315c 100644
--- a/src/vapi/types/assistant_message_judge_plan_exact.py
+++ b/src/vapi/types/assistant_message_judge_plan_exact.py
@@ -11,6 +11,10 @@
class AssistantMessageJudgePlanExact(UncheckedBaseModel):
+ """
+ Evaluates an assistant message using case-insensitive exact content matching and expected tool calls.
+ """
+
content: str = pydantic.Field()
"""
This is what that will be used to evaluate the model's message content.
diff --git a/src/vapi/types/assistant_message_judge_plan_regex.py b/src/vapi/types/assistant_message_judge_plan_regex.py
index ac23243a..9f6b48ce 100644
--- a/src/vapi/types/assistant_message_judge_plan_regex.py
+++ b/src/vapi/types/assistant_message_judge_plan_regex.py
@@ -11,6 +11,10 @@
class AssistantMessageJudgePlanRegex(UncheckedBaseModel):
+ """
+ Evaluates assistant-message content and tool-call arguments using regular-expression patterns.
+ """
+
content: str = pydantic.Field()
"""
This is what that will be used to evaluate the model's message content.
diff --git a/src/vapi/types/assistant_overrides.py b/src/vapi/types/assistant_overrides.py
index f575189f..f33f4106 100644
--- a/src/vapi/types/assistant_overrides.py
+++ b/src/vapi/types/assistant_overrides.py
@@ -31,6 +31,10 @@
class AssistantOverrides(UncheckedBaseModel):
+ """
+ Per-call or handoff overrides for an assistant's providers, messages, tools, credentials, call behavior, and server configuration.
+ """
+
transcriber: typing.Optional[AssistantOverridesTranscriber] = pydantic.Field(default=None)
"""
These are the options for the assistant's transcriber.
@@ -57,7 +61,10 @@ class AssistantOverrides(UncheckedBaseModel):
first_message_interruptions_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="firstMessageInterruptionsEnabled"),
- pydantic.Field(alias="firstMessageInterruptionsEnabled"),
+ pydantic.Field(
+ alias="firstMessageInterruptionsEnabled",
+ description="Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.",
+ ),
] = None
first_message_mode: typing_extensions.Annotated[
typing.Optional[AssistantOverridesFirstMessageMode],
@@ -144,7 +151,9 @@ class AssistantOverrides(UncheckedBaseModel):
tools_append: typing_extensions.Annotated[
typing.Optional[typing.List["AssistantOverridesToolsAppendItem"]],
FieldMetadata(alias="tools:append"),
- pydantic.Field(alias="tools:append"),
+ pydantic.Field(
+ alias="tools:append", description="Tools to append to the assistant's existing tool configuration."
+ ),
] = None
variable_values: typing_extensions.Annotated[
typing.Optional[typing.Dict[str, typing.Any]],
@@ -186,7 +195,12 @@ class AssistantOverrides(UncheckedBaseModel):
),
] = None
compliance_plan: typing_extensions.Annotated[
- typing.Optional[CompliancePlan], FieldMetadata(alias="compliancePlan"), pydantic.Field(alias="compliancePlan")
+ typing.Optional[CompliancePlan],
+ FieldMetadata(alias="compliancePlan"),
+ pydantic.Field(
+ alias="compliancePlan",
+ description="Compliance settings to apply, including HIPAA and PCI behavior, security filtering, and recording consent.",
+ ),
] = None
metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
"""
@@ -263,7 +277,9 @@ class AssistantOverrides(UncheckedBaseModel):
keypad_input_plan: typing_extensions.Annotated[
typing.Optional[KeypadInputPlan],
FieldMetadata(alias="keypadInputPlan"),
- pydantic.Field(alias="keypadInputPlan"),
+ pydantic.Field(
+ alias="keypadInputPlan", description="Configuration for collecting and processing DTMF keypad input."
+ ),
] = None
if IS_PYDANTIC_V2:
diff --git a/src/vapi/types/aws_sts_authentication_plan.py b/src/vapi/types/aws_sts_authentication_plan.py
index ed4d0648..08d7837f 100644
--- a/src/vapi/types/aws_sts_authentication_plan.py
+++ b/src/vapi/types/aws_sts_authentication_plan.py
@@ -10,6 +10,10 @@
class AwsStsAuthenticationPlan(UncheckedBaseModel):
+ """
+ AWS Security Token Service role-assumption configuration used to authenticate requests.
+ """
+
role_arn: typing_extensions.Annotated[
str,
FieldMetadata(alias="roleArn"),
diff --git a/src/vapi/types/awsiam_credentials_authentication_plan.py b/src/vapi/types/awsiam_credentials_authentication_plan.py
index 27430cc4..243d8e22 100644
--- a/src/vapi/types/awsiam_credentials_authentication_plan.py
+++ b/src/vapi/types/awsiam_credentials_authentication_plan.py
@@ -10,6 +10,10 @@
class AwsiamCredentialsAuthenticationPlan(UncheckedBaseModel):
+ """
+ Direct AWS IAM credentials used to authenticate requests.
+ """
+
aws_access_key_id: typing_extensions.Annotated[
str,
FieldMetadata(alias="awsAccessKeyId"),
diff --git a/src/vapi/types/azure_blob_storage_bucket_plan.py b/src/vapi/types/azure_blob_storage_bucket_plan.py
index 70ce8f98..46b697f7 100644
--- a/src/vapi/types/azure_blob_storage_bucket_plan.py
+++ b/src/vapi/types/azure_blob_storage_bucket_plan.py
@@ -10,6 +10,10 @@
class AzureBlobStorageBucketPlan(UncheckedBaseModel):
+ """
+ Azure Blob Storage container configuration for call artifacts, including its connection string, container name, and storage path.
+ """
+
connection_string: typing_extensions.Annotated[
str,
FieldMetadata(alias="connectionString"),
diff --git a/src/vapi/types/azure_speech_transcriber.py b/src/vapi/types/azure_speech_transcriber.py
index 0593f9d6..9fbb3e87 100644
--- a/src/vapi/types/azure_speech_transcriber.py
+++ b/src/vapi/types/azure_speech_transcriber.py
@@ -13,6 +13,10 @@
class AzureSpeechTranscriber(UncheckedBaseModel):
+ """
+ Configuration for transcribing speech during assistant conversations with Azure Speech, including language, segmentation, and fallback settings.
+ """
+
language: typing.Optional[AzureSpeechTranscriberLanguage] = pydantic.Field(default=None)
"""
This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt
diff --git a/src/vapi/types/azure_voice.py b/src/vapi/types/azure_voice.py
index 9ad031db..fb98c2f8 100644
--- a/src/vapi/types/azure_voice.py
+++ b/src/vapi/types/azure_voice.py
@@ -13,6 +13,10 @@
class AzureVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/background_speech_denoising_plan.py b/src/vapi/types/background_speech_denoising_plan.py
index 32956773..953b4d7a 100644
--- a/src/vapi/types/background_speech_denoising_plan.py
+++ b/src/vapi/types/background_speech_denoising_plan.py
@@ -12,6 +12,10 @@
class BackgroundSpeechDenoisingPlan(UncheckedBaseModel):
+ """
+ Controls smart and Fourier denoising applied to customer audio before transcription.
+ """
+
smart_denoising_plan: typing_extensions.Annotated[
typing.Optional[SmartDenoisingPlan],
FieldMetadata(alias="smartDenoisingPlan"),
diff --git a/src/vapi/types/backoff_plan.py b/src/vapi/types/backoff_plan.py
index 55faa4f0..a9398bf3 100644
--- a/src/vapi/types/backoff_plan.py
+++ b/src/vapi/types/backoff_plan.py
@@ -10,6 +10,10 @@
class BackoffPlan(UncheckedBaseModel):
+ """
+ Controls retry behavior for failed server requests, including strategy, maximum retries, base delay, and status codes excluded from retries.
+ """
+
type: typing.Dict[str, typing.Any] = pydantic.Field()
"""
This is the type of backoff plan to use. Defaults to fixed.
@@ -30,7 +34,7 @@ class BackoffPlan(UncheckedBaseModel):
FieldMetadata(alias="baseDelaySeconds"),
pydantic.Field(
alias="baseDelaySeconds",
- description="This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.",
+ description="Base delay in seconds. For fixed backoff, this is the delay between retries. For exponential backoff, this is the initial delay.",
),
]
excluded_status_codes: typing_extensions.Annotated[
@@ -38,7 +42,7 @@ class BackoffPlan(UncheckedBaseModel):
FieldMetadata(alias="excludedStatusCodes"),
pydantic.Field(
alias="excludedStatusCodes",
- description="This is the excluded status codes. If the response status code is in this list, the request will not be retried.\nBy default, the request will be retried for any non-2xx status code.",
+ description="HTTP status codes that should not trigger a retry. By default, any non-2xx status code not listed here can be retried.",
),
] = None
diff --git a/src/vapi/types/bar_insight.py b/src/vapi/types/bar_insight.py
index 26ce9e24..2ab94870 100644
--- a/src/vapi/types/bar_insight.py
+++ b/src/vapi/types/bar_insight.py
@@ -16,6 +16,10 @@
class BarInsight(UncheckedBaseModel):
+ """
+ A saved bar-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -46,7 +50,11 @@ class BarInsight(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRangeWithStep], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRangeWithStep],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(
+ alias="timeRange", description="The time range and interval used to aggregate the bar-chart data."
+ ),
] = None
group_by: typing_extensions.Annotated[
typing.Optional[BarInsightGroupBy],
diff --git a/src/vapi/types/bar_insight_metadata.py b/src/vapi/types/bar_insight_metadata.py
index ce11229e..1b8a5f45 100644
--- a/src/vapi/types/bar_insight_metadata.py
+++ b/src/vapi/types/bar_insight_metadata.py
@@ -10,19 +10,34 @@
class BarInsightMetadata(UncheckedBaseModel):
+ """
+ Display settings for a bar insight, including chart name, axis labels, and optional y-axis bounds.
+ """
+
x_axis_label: typing_extensions.Annotated[
- typing.Optional[str], FieldMetadata(alias="xAxisLabel"), pydantic.Field(alias="xAxisLabel")
+ typing.Optional[str],
+ FieldMetadata(alias="xAxisLabel"),
+ pydantic.Field(alias="xAxisLabel", description="Label displayed on the chart's x-axis."),
] = None
y_axis_label: typing_extensions.Annotated[
- typing.Optional[str], FieldMetadata(alias="yAxisLabel"), pydantic.Field(alias="yAxisLabel")
+ typing.Optional[str],
+ FieldMetadata(alias="yAxisLabel"),
+ pydantic.Field(alias="yAxisLabel", description="Label displayed on the chart's y-axis."),
] = None
y_axis_min: typing_extensions.Annotated[
- typing.Optional[float], FieldMetadata(alias="yAxisMin"), pydantic.Field(alias="yAxisMin")
+ typing.Optional[float],
+ FieldMetadata(alias="yAxisMin"),
+ pydantic.Field(alias="yAxisMin", description="Minimum value displayed on the chart's y-axis."),
] = None
y_axis_max: typing_extensions.Annotated[
- typing.Optional[float], FieldMetadata(alias="yAxisMax"), pydantic.Field(alias="yAxisMax")
+ typing.Optional[float],
+ FieldMetadata(alias="yAxisMax"),
+ pydantic.Field(alias="yAxisMax", description="Maximum value displayed on the chart's y-axis."),
] = None
- name: typing.Optional[str] = None
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Display name for the insight chart.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/bash_tool.py b/src/vapi/types/bash_tool.py
index 2f476bc7..b1839be5 100644
--- a/src/vapi/types/bash_tool.py
+++ b/src/vapi/types/bash_tool.py
@@ -18,6 +18,10 @@
class BashTool(UncheckedBaseModel):
+ """
+ A reusable tool that executes shell commands in a configured environment.
+ """
+
messages: typing.Optional[typing.List[BashToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/bearer_authentication_plan.py b/src/vapi/types/bearer_authentication_plan.py
index d7fec9b1..6d016539 100644
--- a/src/vapi/types/bearer_authentication_plan.py
+++ b/src/vapi/types/bearer_authentication_plan.py
@@ -10,6 +10,10 @@
class BearerAuthenticationPlan(UncheckedBaseModel):
+ """
+ Configuration for authenticating outbound requests with a bearer token, including header name and optional `Bearer` prefix.
+ """
+
token: str = pydantic.Field()
"""
This is the bearer token value.
diff --git a/src/vapi/types/bot_message.py b/src/vapi/types/bot_message.py
index 68c810a5..025b61ae 100644
--- a/src/vapi/types/bot_message.py
+++ b/src/vapi/types/bot_message.py
@@ -10,6 +10,10 @@
class BotMessage(UncheckedBaseModel):
+ """
+ An assistant-authored entry in the call message history, including content, timing, source, and duration.
+ """
+
role: str = pydantic.Field()
"""
The role of the bot in the conversation.
diff --git a/src/vapi/types/both_custom_endpointing_rule.py b/src/vapi/types/both_custom_endpointing_rule.py
index 1a09a4e0..5472dcf4 100644
--- a/src/vapi/types/both_custom_endpointing_rule.py
+++ b/src/vapi/types/both_custom_endpointing_rule.py
@@ -11,6 +11,10 @@
class BothCustomEndpointingRule(UncheckedBaseModel):
+ """
+ A custom endpointing rule that matches both the assistant's last message and the customer's current speech before applying a configured timeout.
+ """
+
assistant_regex: typing_extensions.Annotated[
str,
FieldMetadata(alias="assistantRegex"),
@@ -28,7 +32,11 @@ class BothCustomEndpointingRule(UncheckedBaseModel):
),
] = None
customer_regex: typing_extensions.Annotated[
- str, FieldMetadata(alias="customerRegex"), pydantic.Field(alias="customerRegex")
+ str,
+ FieldMetadata(alias="customerRegex"),
+ pydantic.Field(
+ alias="customerRegex", description="The regular expression pattern matched against the customer's speech."
+ ),
]
customer_regex_options: typing_extensions.Annotated[
typing.Optional[typing.List[RegexOption]],
diff --git a/src/vapi/types/bucket_plan.py b/src/vapi/types/bucket_plan.py
index 0a668671..9d667974 100644
--- a/src/vapi/types/bucket_plan.py
+++ b/src/vapi/types/bucket_plan.py
@@ -10,6 +10,10 @@
class BucketPlan(UncheckedBaseModel):
+ """
+ Google Cloud Storage bucket configuration for call artifacts, including bucket name, region, path, and optional HMAC credentials.
+ """
+
name: str = pydantic.Field()
"""
This is the name of the bucket.
diff --git a/src/vapi/types/byo_phone_number.py b/src/vapi/types/byo_phone_number.py
index b64d9b8f..0c62f839 100644
--- a/src/vapi/types/byo_phone_number.py
+++ b/src/vapi/types/byo_phone_number.py
@@ -15,6 +15,10 @@
class ByoPhoneNumber(UncheckedBaseModel):
+ """
+ A phone number connected to Vapi through a bring-your-own telephony provider, including its credential, routing, hooks, server settings, and lifecycle metadata.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[ByoPhoneNumberFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/call.py b/src/vapi/types/call.py
index af2283a1..b39fc539 100644
--- a/src/vapi/types/call.py
+++ b/src/vapi/types/call.py
@@ -33,6 +33,10 @@
class Call(UncheckedBaseModel):
+ """
+ A call record returned by Vapi. It contains the configuration and resources used for the call, its lifecycle status and timestamps, conversation messages, artifacts, analysis, and costs.
+ """
+
type: typing.Optional[CallType] = pydantic.Field(default=None)
"""
This is the type of call.
@@ -43,7 +47,11 @@ class Call(UncheckedBaseModel):
These are the costs of individual components of the call in USD.
"""
- messages: typing.Optional[typing.List[CallMessagesItem]] = None
+ messages: typing.Optional[typing.List[CallMessagesItem]] = pydantic.Field(default=None)
+ """
+ Messages exchanged during the call, including user, assistant, system, tool-call, and tool-result messages.
+ """
+
phone_call_provider: typing_extensions.Annotated[
typing.Optional[CallPhoneCallProvider],
FieldMetadata(alias="phoneCallProvider"),
diff --git a/src/vapi/types/call_batch_error.py b/src/vapi/types/call_batch_error.py
index 024a5a58..24d7797b 100644
--- a/src/vapi/types/call_batch_error.py
+++ b/src/vapi/types/call_batch_error.py
@@ -11,8 +11,19 @@
class CallBatchError(UncheckedBaseModel):
- customer: CreateCustomerDto
- error: str
+ """
+ Error returned for one customer entry in a batch call request.
+ """
+
+ customer: CreateCustomerDto = pydantic.Field()
+ """
+ Customer configuration associated with the failed call.
+ """
+
+ error: str = pydantic.Field()
+ """
+ Error message explaining why the call could not be created.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/call_batch_response.py b/src/vapi/types/call_batch_response.py
index 985f1285..39f61a59 100644
--- a/src/vapi/types/call_batch_response.py
+++ b/src/vapi/types/call_batch_response.py
@@ -15,6 +15,10 @@
class CallBatchResponse(UncheckedBaseModel):
+ """
+ The result of a batch call creation request, containing successfully created calls, per-call failures, and subscription limits recorded at the end of the batch.
+ """
+
subscription_limits: typing_extensions.Annotated[
typing.Optional[SubscriptionLimits],
FieldMetadata(alias="subscriptionLimits"),
diff --git a/src/vapi/types/call_hook_assistant_speech_interrupted.py b/src/vapi/types/call_hook_assistant_speech_interrupted.py
index b54f6135..abd4fa18 100644
--- a/src/vapi/types/call_hook_assistant_speech_interrupted.py
+++ b/src/vapi/types/call_hook_assistant_speech_interrupted.py
@@ -11,6 +11,10 @@
class CallHookAssistantSpeechInterrupted(UncheckedBaseModel):
+ """
+ Runs configured actions when the customer's speech interrupts the assistant.
+ """
+
on: CallHookAssistantSpeechInterruptedOn = pydantic.Field()
"""
This is the event that triggers this hook
diff --git a/src/vapi/types/call_hook_call_ending.py b/src/vapi/types/call_hook_call_ending.py
index 41dfca4a..d5e92f76 100644
--- a/src/vapi/types/call_hook_call_ending.py
+++ b/src/vapi/types/call_hook_call_ending.py
@@ -12,6 +12,10 @@
class CallHookCallEnding(UncheckedBaseModel):
+ """
+ Runs configured actions when a call is ending, optionally only when its filters match.
+ """
+
on: CallHookCallEndingOn = pydantic.Field()
"""
This is the event that triggers this hook
diff --git a/src/vapi/types/call_hook_customer_speech_interrupted.py b/src/vapi/types/call_hook_customer_speech_interrupted.py
index 7a8e50f8..1181f047 100644
--- a/src/vapi/types/call_hook_customer_speech_interrupted.py
+++ b/src/vapi/types/call_hook_customer_speech_interrupted.py
@@ -11,6 +11,10 @@
class CallHookCustomerSpeechInterrupted(UncheckedBaseModel):
+ """
+ Runs configured actions when the assistant interrupts the customer's speech.
+ """
+
on: CallHookCustomerSpeechInterruptedOn = pydantic.Field()
"""
This is the event that triggers this hook
diff --git a/src/vapi/types/call_hook_customer_speech_timeout.py b/src/vapi/types/call_hook_customer_speech_timeout.py
index 6aa0557e..28e0872c 100644
--- a/src/vapi/types/call_hook_customer_speech_timeout.py
+++ b/src/vapi/types/call_hook_customer_speech_timeout.py
@@ -11,6 +11,10 @@
class CallHookCustomerSpeechTimeout(UncheckedBaseModel):
+ """
+ Runs configured actions when the customer does not speak before the configured timeout, with support for trigger limits and named instances.
+ """
+
on: str = pydantic.Field()
"""
Must be either "customer.speech.timeout" or match the pattern "customer.speech.timeout[property=value]"
@@ -23,7 +27,7 @@ class CallHookCustomerSpeechTimeout(UncheckedBaseModel):
options: typing.Optional[CustomerSpeechTimeoutOptions] = pydantic.Field(default=None)
"""
- This is the set of filters that must match for the hook to trigger
+ Controls the speech timeout, maximum trigger count, and counter reset behavior for this hook.
"""
name: typing.Optional[str] = pydantic.Field(default=None)
diff --git a/src/vapi/types/call_hook_filter.py b/src/vapi/types/call_hook_filter.py
index 247e25b1..e1e3471a 100644
--- a/src/vapi/types/call_hook_filter.py
+++ b/src/vapi/types/call_hook_filter.py
@@ -11,6 +11,10 @@
class CallHookFilter(UncheckedBaseModel):
+ """
+ Matches a call field against one or more allowed values to determine whether a hook runs.
+ """
+
type: CallHookFilterType = pydantic.Field()
"""
This is the type of filter - currently only "oneOf" is supported
diff --git a/src/vapi/types/call_hook_model_response_timeout.py b/src/vapi/types/call_hook_model_response_timeout.py
index cddf5520..1d11e322 100644
--- a/src/vapi/types/call_hook_model_response_timeout.py
+++ b/src/vapi/types/call_hook_model_response_timeout.py
@@ -12,6 +12,10 @@
class CallHookModelResponseTimeout(UncheckedBaseModel):
+ """
+ Runs configured actions when the language model does not respond before its timeout.
+ """
+
on: CallHookModelResponseTimeoutOn = pydantic.Field()
"""
This is the event that triggers this hook
diff --git a/src/vapi/types/campaign.py b/src/vapi/types/campaign.py
index 53ce458f..92b2e303 100644
--- a/src/vapi/types/campaign.py
+++ b/src/vapi/types/campaign.py
@@ -18,6 +18,10 @@
class Campaign(UncheckedBaseModel):
+ """
+ A saved outbound calling campaign, including its calling configuration, schedule, status, customers, calls, and call-progress counters.
+ """
+
status: CampaignStatus = pydantic.Field()
"""
This is the status of the campaign.
diff --git a/src/vapi/types/campaign_paginated_response.py b/src/vapi/types/campaign_paginated_response.py
index 86f02d0a..74caaba0 100644
--- a/src/vapi/types/campaign_paginated_response.py
+++ b/src/vapi/types/campaign_paginated_response.py
@@ -12,8 +12,19 @@
class CampaignPaginatedResponse(UncheckedBaseModel):
- results: typing.List[Campaign]
- metadata: PaginationMeta
+ """
+ A paginated collection of outbound calling campaigns and metadata describing the result set.
+ """
+
+ results: typing.List[Campaign] = pydantic.Field()
+ """
+ The campaigns returned for the current page.
+ """
+
+ metadata: PaginationMeta = pydantic.Field()
+ """
+ Pagination metadata for the campaign result set.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/cartesia_experimental_controls.py b/src/vapi/types/cartesia_experimental_controls.py
index 4f47b795..300b8d12 100644
--- a/src/vapi/types/cartesia_experimental_controls.py
+++ b/src/vapi/types/cartesia_experimental_controls.py
@@ -10,8 +10,19 @@
class CartesiaExperimentalControls(UncheckedBaseModel):
- speed: typing.Optional[CartesiaSpeedControl] = None
- emotion: typing.Optional[CartesiaExperimentalControlsEmotion] = None
+ """
+ Cartesia voice controls for speed and emotion.
+ """
+
+ speed: typing.Optional[CartesiaSpeedControl] = pydantic.Field(default=None)
+ """
+ Speaking-speed control expressed as a preset or a value from -1 to 1.
+ """
+
+ emotion: typing.Optional[CartesiaExperimentalControlsEmotion] = pydantic.Field(default=None)
+ """
+ Emotion and intensity applied to the Cartesia voice.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/cartesia_generation_config.py b/src/vapi/types/cartesia_generation_config.py
index f030824f..73945525 100644
--- a/src/vapi/types/cartesia_generation_config.py
+++ b/src/vapi/types/cartesia_generation_config.py
@@ -9,6 +9,10 @@
class CartesiaGenerationConfig(UncheckedBaseModel):
+ """
+ Generation controls for Cartesia Sonic 3 voices, including speed, volume, and accent localization.
+ """
+
speed: typing.Optional[float] = pydantic.Field(default=None)
"""
Fine-grained speed control for sonic-3. Only available for sonic-3 model.
diff --git a/src/vapi/types/cartesia_generation_config_experimental.py b/src/vapi/types/cartesia_generation_config_experimental.py
index c07f2086..7155011b 100644
--- a/src/vapi/types/cartesia_generation_config_experimental.py
+++ b/src/vapi/types/cartesia_generation_config_experimental.py
@@ -10,6 +10,10 @@
class CartesiaGenerationConfigExperimental(UncheckedBaseModel):
+ """
+ Cartesia Sonic 3 generation controls, including accent localization.
+ """
+
accent_localization: typing_extensions.Annotated[
typing.Optional[int],
FieldMetadata(alias="accentLocalization"),
diff --git a/src/vapi/types/cartesia_transcriber.py b/src/vapi/types/cartesia_transcriber.py
index e58ca77c..8feba54a 100644
--- a/src/vapi/types/cartesia_transcriber.py
+++ b/src/vapi/types/cartesia_transcriber.py
@@ -13,8 +13,20 @@
class CartesiaTranscriber(UncheckedBaseModel):
- model: typing.Optional[CartesiaTranscriberModel] = None
- language: typing.Optional[CartesiaTranscriberLanguage] = None
+ """
+ Configuration for transcribing speech during assistant conversations with Cartesia, including model, language, and fallback settings.
+ """
+
+ model: typing.Optional[CartesiaTranscriberModel] = pydantic.Field(default=None)
+ """
+ The Cartesia speech-to-text model used for transcription.
+ """
+
+ language: typing.Optional[CartesiaTranscriberLanguage] = pydantic.Field(default=None)
+ """
+ The language code used for transcription.
+ """
+
fallback_plan: typing_extensions.Annotated[
typing.Optional[FallbackTranscriberPlan],
FieldMetadata(alias="fallbackPlan"),
diff --git a/src/vapi/types/cartesia_voice.py b/src/vapi/types/cartesia_voice.py
index 2e0f9a6a..0917a84e 100644
--- a/src/vapi/types/cartesia_voice.py
+++ b/src/vapi/types/cartesia_voice.py
@@ -16,6 +16,10 @@
class CartesiaVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, generation controls, pronunciation dictionaries, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/cerebras_model.py b/src/vapi/types/cerebras_model.py
index 363d20ef..292a2361 100644
--- a/src/vapi/types/cerebras_model.py
+++ b/src/vapi/types/cerebras_model.py
@@ -15,6 +15,10 @@
class CerebrasModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with Cerebras, including model, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/chat_eval_assistant_message_evaluation.py b/src/vapi/types/chat_eval_assistant_message_evaluation.py
index fedf57ff..30915a0b 100644
--- a/src/vapi/types/chat_eval_assistant_message_evaluation.py
+++ b/src/vapi/types/chat_eval_assistant_message_evaluation.py
@@ -13,6 +13,10 @@
class ChatEvalAssistantMessageEvaluation(UncheckedBaseModel):
+ """
+ An expected assistant turn in an evaluation, including the judge plan and how the evaluation should continue afterward.
+ """
+
role: ChatEvalAssistantMessageEvaluationRole = pydantic.Field()
"""
This is the role of the message author.
diff --git a/src/vapi/types/chat_eval_assistant_message_mock.py b/src/vapi/types/chat_eval_assistant_message_mock.py
index ab77e789..f7887d88 100644
--- a/src/vapi/types/chat_eval_assistant_message_mock.py
+++ b/src/vapi/types/chat_eval_assistant_message_mock.py
@@ -12,6 +12,10 @@
class ChatEvalAssistantMessageMock(UncheckedBaseModel):
+ """
+ A simulated assistant turn in an evaluation conversation, with optional message content and tool calls.
+ """
+
role: ChatEvalAssistantMessageMockRole = pydantic.Field()
"""
This is the role of the message author.
diff --git a/src/vapi/types/chat_eval_assistant_message_mock_tool_call.py b/src/vapi/types/chat_eval_assistant_message_mock_tool_call.py
index b37c18ad..5876436b 100644
--- a/src/vapi/types/chat_eval_assistant_message_mock_tool_call.py
+++ b/src/vapi/types/chat_eval_assistant_message_mock_tool_call.py
@@ -8,6 +8,10 @@
class ChatEvalAssistantMessageMockToolCall(UncheckedBaseModel):
+ """
+ A simulated assistant tool call with the tool name and optional arguments.
+ """
+
name: str = pydantic.Field()
"""
This is the name of the tool that will be called.
diff --git a/src/vapi/types/chat_eval_system_message_mock.py b/src/vapi/types/chat_eval_system_message_mock.py
index 24f07060..1e25816f 100644
--- a/src/vapi/types/chat_eval_system_message_mock.py
+++ b/src/vapi/types/chat_eval_system_message_mock.py
@@ -9,6 +9,10 @@
class ChatEvalSystemMessageMock(UncheckedBaseModel):
+ """
+ A simulated system message in an evaluation conversation.
+ """
+
role: ChatEvalSystemMessageMockRole = pydantic.Field()
"""
This is the role of the message author.
diff --git a/src/vapi/types/chat_eval_tool_response_message_evaluation.py b/src/vapi/types/chat_eval_tool_response_message_evaluation.py
index fb3db59d..b68d8e97 100644
--- a/src/vapi/types/chat_eval_tool_response_message_evaluation.py
+++ b/src/vapi/types/chat_eval_tool_response_message_evaluation.py
@@ -12,6 +12,10 @@
class ChatEvalToolResponseMessageEvaluation(UncheckedBaseModel):
+ """
+ An expected tool-response turn evaluated by a configured LLM judge.
+ """
+
role: ChatEvalToolResponseMessageEvaluationRole = pydantic.Field()
"""
This is the role of the message author.
diff --git a/src/vapi/types/chat_eval_tool_response_message_mock.py b/src/vapi/types/chat_eval_tool_response_message_mock.py
index 0c9d8029..cc99208d 100644
--- a/src/vapi/types/chat_eval_tool_response_message_mock.py
+++ b/src/vapi/types/chat_eval_tool_response_message_mock.py
@@ -9,6 +9,10 @@
class ChatEvalToolResponseMessageMock(UncheckedBaseModel):
+ """
+ A simulated tool response in an evaluation conversation.
+ """
+
role: ChatEvalToolResponseMessageMockRole = pydantic.Field()
"""
This is the role of the message author.
diff --git a/src/vapi/types/chat_eval_user_message_mock.py b/src/vapi/types/chat_eval_user_message_mock.py
index 2026894f..3865ace1 100644
--- a/src/vapi/types/chat_eval_user_message_mock.py
+++ b/src/vapi/types/chat_eval_user_message_mock.py
@@ -9,6 +9,10 @@
class ChatEvalUserMessageMock(UncheckedBaseModel):
+ """
+ A simulated user message in an evaluation conversation.
+ """
+
role: ChatEvalUserMessageMockRole = pydantic.Field()
"""
This is the role of the message author.
diff --git a/src/vapi/types/chunk_plan.py b/src/vapi/types/chunk_plan.py
index f2eed292..5f28ea55 100644
--- a/src/vapi/types/chunk_plan.py
+++ b/src/vapi/types/chunk_plan.py
@@ -12,6 +12,10 @@
class ChunkPlan(UncheckedBaseModel):
+ """
+ Controls how model output is split into chunks before voice synthesis, including minimum length, punctuation boundaries, and formatting.
+ """
+
enabled: typing.Optional[bool] = pydantic.Field(default=None)
"""
This determines whether the model output is chunked before being sent to the voice provider. Default `true`.
diff --git a/src/vapi/types/cloudflare_r_2_bucket_plan.py b/src/vapi/types/cloudflare_r_2_bucket_plan.py
index d59f3003..88c20ba3 100644
--- a/src/vapi/types/cloudflare_r_2_bucket_plan.py
+++ b/src/vapi/types/cloudflare_r_2_bucket_plan.py
@@ -10,6 +10,10 @@
class CloudflareR2BucketPlan(UncheckedBaseModel):
+ """
+ Cloudflare R2 bucket configuration for call-artifact storage, including access keys, base URL, bucket name, and path.
+ """
+
access_key_id: typing_extensions.Annotated[
typing.Optional[str],
FieldMetadata(alias="accessKeyId"),
diff --git a/src/vapi/types/code_tool.py b/src/vapi/types/code_tool.py
index 16ec741c..021ba6da 100644
--- a/src/vapi/types/code_tool.py
+++ b/src/vapi/types/code_tool.py
@@ -19,6 +19,10 @@
class CodeTool(UncheckedBaseModel):
+ """
+ A reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout.
+ """
+
messages: typing.Optional[typing.List[CodeToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/code_tool_environment_variable.py b/src/vapi/types/code_tool_environment_variable.py
index 92d91b7e..c3939367 100644
--- a/src/vapi/types/code_tool_environment_variable.py
+++ b/src/vapi/types/code_tool_environment_variable.py
@@ -8,6 +8,10 @@
class CodeToolEnvironmentVariable(UncheckedBaseModel):
+ """
+ An environment variable supplied to code-tool execution, with support for Liquid templates in its value.
+ """
+
name: str = pydantic.Field()
"""
Name of the environment variable
diff --git a/src/vapi/types/compliance.py b/src/vapi/types/compliance.py
index 04f76356..8896c551 100644
--- a/src/vapi/types/compliance.py
+++ b/src/vapi/types/compliance.py
@@ -11,6 +11,10 @@
class Compliance(UncheckedBaseModel):
+ """
+ Compliance information captured for a call, including recording consent.
+ """
+
recording_consent: typing_extensions.Annotated[
typing.Optional[RecordingConsent],
FieldMetadata(alias="recordingConsent"),
diff --git a/src/vapi/types/compliance_override.py b/src/vapi/types/compliance_override.py
index 373a1c98..dbfe2387 100644
--- a/src/vapi/types/compliance_override.py
+++ b/src/vapi/types/compliance_override.py
@@ -10,6 +10,10 @@
class ComplianceOverride(UncheckedBaseModel):
+ """
+ Overrides storage behavior for an output when HIPAA compliance is enabled.
+ """
+
force_store_on_hipaa_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="forceStoreOnHipaaEnabled"),
diff --git a/src/vapi/types/compliance_plan.py b/src/vapi/types/compliance_plan.py
index ad3dfb53..1ad84fd9 100644
--- a/src/vapi/types/compliance_plan.py
+++ b/src/vapi/types/compliance_plan.py
@@ -12,6 +12,10 @@
class CompliancePlan(UncheckedBaseModel):
+ """
+ Controls HIPAA and PCI requirements, transcript security filtering, and recording-consent handling for assistant calls.
+ """
+
hipaa_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="hipaaEnabled"),
@@ -39,7 +43,10 @@ class CompliancePlan(UncheckedBaseModel):
recording_consent_plan: typing_extensions.Annotated[
typing.Optional[CompliancePlanRecordingConsentPlan],
FieldMetadata(alias="recordingConsentPlan"),
- pydantic.Field(alias="recordingConsentPlan"),
+ pydantic.Field(
+ alias="recordingConsentPlan",
+ description="Controls how recording consent is requested before the assistant joins the call.",
+ ),
] = None
if IS_PYDANTIC_V2:
diff --git a/src/vapi/types/compliance_plan_recording_consent_plan.py b/src/vapi/types/compliance_plan_recording_consent_plan.py
index 5227faf1..551fcbb9 100644
--- a/src/vapi/types/compliance_plan_recording_consent_plan.py
+++ b/src/vapi/types/compliance_plan_recording_consent_plan.py
@@ -14,6 +14,10 @@
class CompliancePlanRecordingConsentPlan_StayOnLine(UncheckedBaseModel):
+ """
+ Controls how recording consent is requested before the assistant joins the call.
+ """
+
type: typing.Literal["stay-on-line"] = "stay-on-line"
message: str
voice: typing.Optional[RecordingConsentPlanStayOnLineVoice] = None
@@ -32,6 +36,10 @@ class Config:
class CompliancePlanRecordingConsentPlan_Verbal(UncheckedBaseModel):
+ """
+ Controls how recording consent is requested before the assistant joins the call.
+ """
+
type: typing.Literal["verbal"] = "verbal"
message: str
voice: typing.Optional[RecordingConsentPlanVerbalVoice] = None
diff --git a/src/vapi/types/computer_tool.py b/src/vapi/types/computer_tool.py
index 6cfa96a1..828e0ba7 100644
--- a/src/vapi/types/computer_tool.py
+++ b/src/vapi/types/computer_tool.py
@@ -18,6 +18,10 @@
class ComputerTool(UncheckedBaseModel):
+ """
+ A reusable tool that lets the model interact with a computer display through screen, pointer, and keyboard actions.
+ """
+
messages: typing.Optional[typing.List[ComputerToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/condition.py b/src/vapi/types/condition.py
index 930ea4ac..c2affcda 100644
--- a/src/vapi/types/condition.py
+++ b/src/vapi/types/condition.py
@@ -9,6 +9,10 @@
class Condition(UncheckedBaseModel):
+ """
+ Compares a named parameter with a value using the selected comparison operator.
+ """
+
operator: ConditionOperator = pydantic.Field()
"""
This is the operator you want to use to compare the parameter and value.
diff --git a/src/vapi/types/context_engineering_plan_all.py b/src/vapi/types/context_engineering_plan_all.py
index 317136bd..d1ca878f 100644
--- a/src/vapi/types/context_engineering_plan_all.py
+++ b/src/vapi/types/context_engineering_plan_all.py
@@ -8,6 +8,10 @@
class ContextEngineeringPlanAll(UncheckedBaseModel):
+ """
+ Includes all available messages when constructing context for a handoff.
+ """
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/vapi/types/context_engineering_plan_last_n_messages.py b/src/vapi/types/context_engineering_plan_last_n_messages.py
index c82ee92f..738bc3f6 100644
--- a/src/vapi/types/context_engineering_plan_last_n_messages.py
+++ b/src/vapi/types/context_engineering_plan_last_n_messages.py
@@ -10,6 +10,10 @@
class ContextEngineeringPlanLastNMessages(UncheckedBaseModel):
+ """
+ Includes a configured number of the most recent messages when constructing context for a handoff.
+ """
+
max_messages: typing_extensions.Annotated[
float,
FieldMetadata(alias="maxMessages"),
diff --git a/src/vapi/types/context_engineering_plan_none.py b/src/vapi/types/context_engineering_plan_none.py
index 79cc8c20..2f1f7d82 100644
--- a/src/vapi/types/context_engineering_plan_none.py
+++ b/src/vapi/types/context_engineering_plan_none.py
@@ -8,6 +8,10 @@
class ContextEngineeringPlanNone(UncheckedBaseModel):
+ """
+ Excludes prior conversation messages when constructing context for a handoff.
+ """
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/vapi/types/context_engineering_plan_user_and_assistant_messages.py b/src/vapi/types/context_engineering_plan_user_and_assistant_messages.py
index 8110f585..62fbb37b 100644
--- a/src/vapi/types/context_engineering_plan_user_and_assistant_messages.py
+++ b/src/vapi/types/context_engineering_plan_user_and_assistant_messages.py
@@ -8,6 +8,10 @@
class ContextEngineeringPlanUserAndAssistantMessages(UncheckedBaseModel):
+ """
+ Includes only user and assistant messages when constructing context for a handoff.
+ """
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/vapi/types/conversation_node.py b/src/vapi/types/conversation_node.py
index 511f8946..35865f40 100644
--- a/src/vapi/types/conversation_node.py
+++ b/src/vapi/types/conversation_node.py
@@ -18,6 +18,10 @@
class ConversationNode(UncheckedBaseModel):
+ """
+ A workflow node where the assistant conducts a conversation using optional node-specific providers, tools, prompt, and variable extraction.
+ """
+
model: typing.Optional[ConversationNodeModel] = pydantic.Field(default=None)
"""
This is the model for the node.
@@ -54,7 +58,11 @@ class ConversationNode(UncheckedBaseModel):
description="These are the tools that the conversation node can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.",
),
] = None
- prompt: typing.Optional[str] = None
+ prompt: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Prompt that guides the assistant while this node is active.
+ """
+
global_node_plan: typing_extensions.Annotated[
typing.Optional[GlobalNodePlan],
FieldMetadata(alias="globalNodePlan"),
@@ -68,7 +76,11 @@ class ConversationNode(UncheckedBaseModel):
description='This is the plan that controls the variable extraction from the user\'s responses.\n\nUsage:\nUse `schema` to specify what you want to extract from the user\'s responses.\n```json\n{\n "schema": {\n "type": "object",\n "properties": {\n "user": {\n "type": "object",\n "properties": {\n "name": {\n "type": "string"\n },\n "age": {\n "type": "number"\n }\n }\n }\n }\n }\n}\n```\n\nThis will be extracted as `{{ user.name }}` and `{{ user.age }}` respectively.\n\n(Optional) Use `aliases` to create new variables.\n\n```json\n{\n "aliases": [\n {\n "key": "userAge",\n "value": "{{user.age}}"\n },\n {\n "key": "userName",\n "value": "{{user.name}}"\n }\n ]\n}\n```\n\nThis will be extracted as `{{ userAge }}` and `{{ userName }}` respectively.\n\nNote: The `schema` field is required for Conversation nodes if you want to extract variables from the user\'s responses. `aliases` is just a convenience.',
),
] = None
- name: str
+ name: str = pydantic.Field()
+ """
+ Unique name used to identify this workflow node.
+ """
+
is_start: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="isStart"),
diff --git a/src/vapi/types/cost_breakdown.py b/src/vapi/types/cost_breakdown.py
index 3b6b04c7..ec1a4592 100644
--- a/src/vapi/types/cost_breakdown.py
+++ b/src/vapi/types/cost_breakdown.py
@@ -11,6 +11,10 @@
class CostBreakdown(UncheckedBaseModel):
+ """
+ Aggregated call costs and usage, including transport, transcription, model, voice, Vapi, analysis, token, and character totals.
+ """
+
transport: typing.Optional[float] = pydantic.Field(default=None)
"""
This is the cost of the transport provider, like Twilio or Vonage.
diff --git a/src/vapi/types/create_anthropic_bedrock_credential_dto.py b/src/vapi/types/create_anthropic_bedrock_credential_dto.py
index cdaf6232..141ab2e0 100644
--- a/src/vapi/types/create_anthropic_bedrock_credential_dto.py
+++ b/src/vapi/types/create_anthropic_bedrock_credential_dto.py
@@ -14,6 +14,10 @@
class CreateAnthropicBedrockCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating Anthropic model requests through Amazon Bedrock, including AWS region and authentication method.
+ """
+
region: CreateAnthropicBedrockCredentialDtoRegion = pydantic.Field()
"""
AWS region where Bedrock is configured.
diff --git a/src/vapi/types/create_anthropic_credential_dto.py b/src/vapi/types/create_anthropic_credential_dto.py
index 26546982..0827fb6d 100644
--- a/src/vapi/types/create_anthropic_credential_dto.py
+++ b/src/vapi/types/create_anthropic_credential_dto.py
@@ -10,6 +10,10 @@
class CreateAnthropicCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with Anthropic.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_anyscale_credential_dto.py b/src/vapi/types/create_anyscale_credential_dto.py
index 6dd35cbc..bda686bd 100644
--- a/src/vapi/types/create_anyscale_credential_dto.py
+++ b/src/vapi/types/create_anyscale_credential_dto.py
@@ -10,6 +10,10 @@
class CreateAnyscaleCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with Anyscale.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_api_request_tool_dto.py b/src/vapi/types/create_api_request_tool_dto.py
index 69909fd6..b4bbcf66 100644
--- a/src/vapi/types/create_api_request_tool_dto.py
+++ b/src/vapi/types/create_api_request_tool_dto.py
@@ -18,6 +18,10 @@
class CreateApiRequestToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a reusable tool that sends HTTP requests to a configured API and can authenticate, retry failures, and extract variables from responses.
+ """
+
messages: typing.Optional[typing.List[CreateApiRequestToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
@@ -25,7 +29,11 @@ class CreateApiRequestToolDto(UncheckedBaseModel):
For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.
"""
- method: CreateApiRequestToolDtoMethod
+ method: CreateApiRequestToolDtoMethod = pydantic.Field()
+ """
+ The HTTP method used for the API request.
+ """
+
timeout_seconds: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="timeoutSeconds"),
diff --git a/src/vapi/types/create_assembly_ai_credential_dto.py b/src/vapi/types/create_assembly_ai_credential_dto.py
index 0f72f23b..12fafd4c 100644
--- a/src/vapi/types/create_assembly_ai_credential_dto.py
+++ b/src/vapi/types/create_assembly_ai_credential_dto.py
@@ -10,6 +10,10 @@
class CreateAssemblyAiCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating transcription requests with AssemblyAI.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_assistant_dto.py b/src/vapi/types/create_assistant_dto.py
index 45076aed..4925e514 100644
--- a/src/vapi/types/create_assistant_dto.py
+++ b/src/vapi/types/create_assistant_dto.py
@@ -31,6 +31,10 @@
class CreateAssistantDto(UncheckedBaseModel):
+ """
+ Configuration used to create an assistant, including its model, voice, transcriber, prompts, tools, messaging, and conversation behavior.
+ """
+
transcriber: typing.Optional[CreateAssistantDtoTranscriber] = pydantic.Field(default=None)
"""
These are the options for the assistant's transcriber.
@@ -57,7 +61,10 @@ class CreateAssistantDto(UncheckedBaseModel):
first_message_interruptions_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="firstMessageInterruptionsEnabled"),
- pydantic.Field(alias="firstMessageInterruptionsEnabled"),
+ pydantic.Field(
+ alias="firstMessageInterruptionsEnabled",
+ description="Set to `true` to allow the user to interrupt the assistant while it speaks the first message. Default is `false`.",
+ ),
] = None
first_message_mode: typing_extensions.Annotated[
typing.Optional[CreateAssistantDtoFirstMessageMode],
@@ -173,7 +180,12 @@ class CreateAssistantDto(UncheckedBaseModel):
),
] = None
compliance_plan: typing_extensions.Annotated[
- typing.Optional[CompliancePlan], FieldMetadata(alias="compliancePlan"), pydantic.Field(alias="compliancePlan")
+ typing.Optional[CompliancePlan],
+ FieldMetadata(alias="compliancePlan"),
+ pydantic.Field(
+ alias="compliancePlan",
+ description="Compliance settings for the assistant, including HIPAA and PCI behavior, security filtering, and recording consent.",
+ ),
] = None
metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
"""
@@ -250,7 +262,10 @@ class CreateAssistantDto(UncheckedBaseModel):
keypad_input_plan: typing_extensions.Annotated[
typing.Optional[KeypadInputPlan],
FieldMetadata(alias="keypadInputPlan"),
- pydantic.Field(alias="keypadInputPlan"),
+ pydantic.Field(
+ alias="keypadInputPlan",
+ description="Configuration for collecting and processing DTMF keypad input during calls.",
+ ),
] = None
if IS_PYDANTIC_V2:
diff --git a/src/vapi/types/create_azure_credential_dto.py b/src/vapi/types/create_azure_credential_dto.py
index ef98c5aa..5b36b670 100644
--- a/src/vapi/types/create_azure_credential_dto.py
+++ b/src/vapi/types/create_azure_credential_dto.py
@@ -13,6 +13,10 @@
class CreateAzureCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for Azure Speech or Blob Storage, including service, region, and optional storage bucket settings.
+ """
+
service: CreateAzureCredentialDtoService = pydantic.Field()
"""
This is the service being used in Azure.
diff --git a/src/vapi/types/create_azure_open_ai_credential_dto.py b/src/vapi/types/create_azure_open_ai_credential_dto.py
index 25355ab3..d7ce5289 100644
--- a/src/vapi/types/create_azure_open_ai_credential_dto.py
+++ b/src/vapi/types/create_azure_open_ai_credential_dto.py
@@ -12,8 +12,20 @@
class CreateAzureOpenAiCredentialDto(UncheckedBaseModel):
- region: CreateAzureOpenAiCredentialDtoRegion
- models: typing.List[CreateAzureOpenAiCredentialDtoModelsItem]
+ """
+ Credentials for authenticating assistant model requests with Azure OpenAI, including region, endpoint, and available models.
+ """
+
+ region: CreateAzureOpenAiCredentialDtoRegion = pydantic.Field()
+ """
+ Azure region that hosts the OpenAI resource.
+ """
+
+ models: typing.List[CreateAzureOpenAiCredentialDtoModelsItem] = pydantic.Field()
+ """
+ Azure OpenAI models available through this credential.
+ """
+
open_ai_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="openAIKey"),
@@ -25,7 +37,9 @@ class CreateAzureOpenAiCredentialDto(UncheckedBaseModel):
pydantic.Field(alias="ocpApimSubscriptionKey", description="This is not returned in the API."),
] = None
open_ai_endpoint: typing_extensions.Annotated[
- str, FieldMetadata(alias="openAIEndpoint"), pydantic.Field(alias="openAIEndpoint")
+ str,
+ FieldMetadata(alias="openAIEndpoint"),
+ pydantic.Field(alias="openAIEndpoint", description="Endpoint URL for the Azure OpenAI resource."),
]
name: typing.Optional[str] = pydantic.Field(default=None)
"""
diff --git a/src/vapi/types/create_bar_insight_from_call_table_dto.py b/src/vapi/types/create_bar_insight_from_call_table_dto.py
index 398c1c73..8fb94bae 100644
--- a/src/vapi/types/create_bar_insight_from_call_table_dto.py
+++ b/src/vapi/types/create_bar_insight_from_call_table_dto.py
@@ -15,6 +15,10 @@
class CreateBarInsightFromCallTableDto(UncheckedBaseModel):
+ """
+ Configuration used to create a bar-chart insight from call data using metric queries, formulas, grouping, and a stepped time range.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -45,7 +49,11 @@ class CreateBarInsightFromCallTableDto(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRangeWithStep], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRangeWithStep],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(
+ alias="timeRange", description="The time range and interval used to aggregate the bar-chart data."
+ ),
] = None
group_by: typing_extensions.Annotated[
typing.Optional[CreateBarInsightFromCallTableDtoGroupBy],
diff --git a/src/vapi/types/create_bash_tool_dto.py b/src/vapi/types/create_bash_tool_dto.py
index 8ee12163..c72b6c0f 100644
--- a/src/vapi/types/create_bash_tool_dto.py
+++ b/src/vapi/types/create_bash_tool_dto.py
@@ -17,6 +17,10 @@
class CreateBashToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that executes shell commands in a configured environment.
+ """
+
messages: typing.Optional[typing.List[CreateBashToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_byo_phone_number_dto.py b/src/vapi/types/create_byo_phone_number_dto.py
index fda1fb3d..bb8e8f35 100644
--- a/src/vapi/types/create_byo_phone_number_dto.py
+++ b/src/vapi/types/create_byo_phone_number_dto.py
@@ -13,6 +13,10 @@
class CreateByoPhoneNumberDto(UncheckedBaseModel):
+ """
+ Configuration used to connect a bring-your-own phone number to Vapi with a stored telephony credential and routing settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[CreateByoPhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/create_byo_sip_trunk_credential_dto.py b/src/vapi/types/create_byo_sip_trunk_credential_dto.py
index fc5ab245..d92a225d 100644
--- a/src/vapi/types/create_byo_sip_trunk_credential_dto.py
+++ b/src/vapi/types/create_byo_sip_trunk_credential_dto.py
@@ -13,6 +13,10 @@
class CreateByoSipTrunkCredentialDto(UncheckedBaseModel):
+ """
+ Configuration for connecting Vapi to a bring-your-own SIP trunk or carrier, including gateways, outbound authentication, number handling, and optional session border controller routing.
+ """
+
gateways: typing.List[SipTrunkGateway] = pydantic.Field()
"""
This is the list of SIP trunk's gateways.
diff --git a/src/vapi/types/create_cartesia_credential_dto.py b/src/vapi/types/create_cartesia_credential_dto.py
index 64c92c12..d6ba8233 100644
--- a/src/vapi/types/create_cartesia_credential_dto.py
+++ b/src/vapi/types/create_cartesia_credential_dto.py
@@ -10,6 +10,10 @@
class CreateCartesiaCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating speech recognition and voice synthesis requests with Cartesia.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_cerebras_credential_dto.py b/src/vapi/types/create_cerebras_credential_dto.py
index be5e49d4..9390b81b 100644
--- a/src/vapi/types/create_cerebras_credential_dto.py
+++ b/src/vapi/types/create_cerebras_credential_dto.py
@@ -10,6 +10,10 @@
class CreateCerebrasCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with Cerebras.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_cloudflare_credential_dto.py b/src/vapi/types/create_cloudflare_credential_dto.py
index 9c4ef265..84dccfc5 100644
--- a/src/vapi/types/create_cloudflare_credential_dto.py
+++ b/src/vapi/types/create_cloudflare_credential_dto.py
@@ -11,6 +11,10 @@
class CreateCloudflareCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for storing call artifacts in Cloudflare R2, including account details, bucket configuration, and upload fallback order.
+ """
+
account_id: typing_extensions.Annotated[
typing.Optional[str],
FieldMetadata(alias="accountId"),
diff --git a/src/vapi/types/create_code_tool_dto.py b/src/vapi/types/create_code_tool_dto.py
index fda5eb66..dafd5c25 100644
--- a/src/vapi/types/create_code_tool_dto.py
+++ b/src/vapi/types/create_code_tool_dto.py
@@ -18,6 +18,10 @@
class CreateCodeToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a reusable tool that executes TypeScript code with configured credentials, environment variables, and timeout.
+ """
+
messages: typing.Optional[typing.List[CreateCodeToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_computer_tool_dto.py b/src/vapi/types/create_computer_tool_dto.py
index fcc30798..7cb78962 100644
--- a/src/vapi/types/create_computer_tool_dto.py
+++ b/src/vapi/types/create_computer_tool_dto.py
@@ -17,6 +17,10 @@
class CreateComputerToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that lets the model interact with a computer display through screen, pointer, and keyboard actions.
+ """
+
messages: typing.Optional[typing.List[CreateComputerToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_custom_credential_dto.py b/src/vapi/types/create_custom_credential_dto.py
index e6d386d7..b65682b2 100644
--- a/src/vapi/types/create_custom_credential_dto.py
+++ b/src/vapi/types/create_custom_credential_dto.py
@@ -12,6 +12,10 @@
class CreateCustomCredentialDto(UncheckedBaseModel):
+ """
+ Reusable custom credentials for authenticating outbound requests, with optional public-key encryption for sensitive request data.
+ """
+
authentication_plan: typing_extensions.Annotated[
CreateCustomCredentialDtoAuthenticationPlan,
FieldMetadata(alias="authenticationPlan"),
diff --git a/src/vapi/types/create_custom_knowledge_base_dto.py b/src/vapi/types/create_custom_knowledge_base_dto.py
index 8617f8e3..179c25d4 100644
--- a/src/vapi/types/create_custom_knowledge_base_dto.py
+++ b/src/vapi/types/create_custom_knowledge_base_dto.py
@@ -10,6 +10,10 @@
class CreateCustomKnowledgeBaseDto(UncheckedBaseModel):
+ """
+ Configuration for connecting a custom knowledge-base implementation through a customer-hosted server.
+ """
+
provider: CreateCustomKnowledgeBaseDtoProvider = pydantic.Field()
"""
This knowledge base is bring your own knowledge base implementation.
diff --git a/src/vapi/types/create_custom_llm_credential_dto.py b/src/vapi/types/create_custom_llm_credential_dto.py
index ce7847c0..77bea85a 100644
--- a/src/vapi/types/create_custom_llm_credential_dto.py
+++ b/src/vapi/types/create_custom_llm_credential_dto.py
@@ -11,6 +11,10 @@
class CreateCustomLlmCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating requests to a custom language model with an API key or OAuth 2.0 authentication plan.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_customer_dto.py b/src/vapi/types/create_customer_dto.py
index 4ae74d04..9fcbc5d5 100644
--- a/src/vapi/types/create_customer_dto.py
+++ b/src/vapi/types/create_customer_dto.py
@@ -12,6 +12,10 @@
class CreateCustomerDto(UncheckedBaseModel):
+ """
+ Customer details used for call delivery and assistant personalization, including phone or SIP destination, contact identifiers, extension, and assistant overrides.
+ """
+
number_e_164_check_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="numberE164CheckEnabled"),
diff --git a/src/vapi/types/create_deep_infra_credential_dto.py b/src/vapi/types/create_deep_infra_credential_dto.py
index d672fd6d..5f5ebbef 100644
--- a/src/vapi/types/create_deep_infra_credential_dto.py
+++ b/src/vapi/types/create_deep_infra_credential_dto.py
@@ -10,6 +10,10 @@
class CreateDeepInfraCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with DeepInfra.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_deep_seek_credential_dto.py b/src/vapi/types/create_deep_seek_credential_dto.py
index 40aa70ab..a657953b 100644
--- a/src/vapi/types/create_deep_seek_credential_dto.py
+++ b/src/vapi/types/create_deep_seek_credential_dto.py
@@ -10,6 +10,10 @@
class CreateDeepSeekCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with DeepSeek.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_deepgram_credential_dto.py b/src/vapi/types/create_deepgram_credential_dto.py
index 7e8a9200..553793a3 100644
--- a/src/vapi/types/create_deepgram_credential_dto.py
+++ b/src/vapi/types/create_deepgram_credential_dto.py
@@ -10,6 +10,10 @@
class CreateDeepgramCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating speech recognition and voice synthesis requests with Deepgram, with an optional API URL for an on-premises instance.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_dtmf_tool_dto.py b/src/vapi/types/create_dtmf_tool_dto.py
index f5de8980..c72c2000 100644
--- a/src/vapi/types/create_dtmf_tool_dto.py
+++ b/src/vapi/types/create_dtmf_tool_dto.py
@@ -14,6 +14,10 @@
class CreateDtmfToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that lets an assistant send DTMF keypad tones during a call.
+ """
+
messages: typing.Optional[typing.List[CreateDtmfToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_eleven_labs_credential_dto.py b/src/vapi/types/create_eleven_labs_credential_dto.py
index 838be877..3b62e35f 100644
--- a/src/vapi/types/create_eleven_labs_credential_dto.py
+++ b/src/vapi/types/create_eleven_labs_credential_dto.py
@@ -10,6 +10,10 @@
class CreateElevenLabsCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating speech recognition and voice synthesis requests with ElevenLabs.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_email_credential_dto.py b/src/vapi/types/create_email_credential_dto.py
index c0c4843d..63612b24 100644
--- a/src/vapi/types/create_email_credential_dto.py
+++ b/src/vapi/types/create_email_credential_dto.py
@@ -8,6 +8,10 @@
class CreateEmailCredentialDto(UncheckedBaseModel):
+ """
+ Destination configuration for sending Vapi alerts to an email address.
+ """
+
email: str = pydantic.Field()
"""
The recipient email address for alerts
diff --git a/src/vapi/types/create_end_call_tool_dto.py b/src/vapi/types/create_end_call_tool_dto.py
index d1492cdf..1f5f63b4 100644
--- a/src/vapi/types/create_end_call_tool_dto.py
+++ b/src/vapi/types/create_end_call_tool_dto.py
@@ -14,6 +14,10 @@
class CreateEndCallToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that lets an assistant end the active call.
+ """
+
messages: typing.Optional[typing.List[CreateEndCallToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_eval_dto.py b/src/vapi/types/create_eval_dto.py
index 9b5d1eab..f15447d6 100644
--- a/src/vapi/types/create_eval_dto.py
+++ b/src/vapi/types/create_eval_dto.py
@@ -10,6 +10,10 @@
class CreateEvalDto(UncheckedBaseModel):
+ """
+ Configuration used to create a reusable eval containing a mock conversation and checkpoints for assessing assistant responses and tool calls.
+ """
+
messages: typing.List[CreateEvalDtoMessagesItem] = pydantic.Field()
"""
This is the mock conversation that will be used to evaluate the flow of the conversation.
diff --git a/src/vapi/types/create_function_tool_dto.py b/src/vapi/types/create_function_tool_dto.py
index 0561b3ee..1f6f574b 100644
--- a/src/vapi/types/create_function_tool_dto.py
+++ b/src/vapi/types/create_function_tool_dto.py
@@ -18,6 +18,10 @@
class CreateFunctionToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a custom function tool that sends model-generated arguments to a server and returns the result to the assistant.
+ """
+
messages: typing.Optional[typing.List[CreateFunctionToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_gcp_credential_dto.py b/src/vapi/types/create_gcp_credential_dto.py
index c489e885..a1a816ef 100644
--- a/src/vapi/types/create_gcp_credential_dto.py
+++ b/src/vapi/types/create_gcp_credential_dto.py
@@ -12,6 +12,10 @@
class CreateGcpCredentialDto(UncheckedBaseModel):
+ """
+ Service-account credentials for Google Cloud resources and optional call-artifact storage, including region, bucket configuration, and upload fallback order.
+ """
+
fallback_index: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="fallbackIndex"),
@@ -34,7 +38,11 @@ class CreateGcpCredentialDto(UncheckedBaseModel):
"""
bucket_plan: typing_extensions.Annotated[
- typing.Optional[BucketPlan], FieldMetadata(alias="bucketPlan"), pydantic.Field(alias="bucketPlan")
+ typing.Optional[BucketPlan],
+ FieldMetadata(alias="bucketPlan"),
+ pydantic.Field(
+ alias="bucketPlan", description="Bucket configuration used to store call artifacts in Google Cloud Storage."
+ ),
] = None
name: typing.Optional[str] = pydantic.Field(default=None)
"""
diff --git a/src/vapi/types/create_gladia_credential_dto.py b/src/vapi/types/create_gladia_credential_dto.py
index c445e83a..3265400b 100644
--- a/src/vapi/types/create_gladia_credential_dto.py
+++ b/src/vapi/types/create_gladia_credential_dto.py
@@ -10,6 +10,10 @@
class CreateGladiaCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating transcription requests with Gladia.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_go_high_level_calendar_availability_tool_dto.py b/src/vapi/types/create_go_high_level_calendar_availability_tool_dto.py
index a693d3f8..419c93fb 100644
--- a/src/vapi/types/create_go_high_level_calendar_availability_tool_dto.py
+++ b/src/vapi/types/create_go_high_level_calendar_availability_tool_dto.py
@@ -16,6 +16,10 @@
class CreateGoHighLevelCalendarAvailabilityToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that checks calendar availability in a connected GoHighLevel account.
+ """
+
messages: typing.Optional[typing.List[CreateGoHighLevelCalendarAvailabilityToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/create_go_high_level_calendar_event_create_tool_dto.py b/src/vapi/types/create_go_high_level_calendar_event_create_tool_dto.py
index 4b4351f0..fa208774 100644
--- a/src/vapi/types/create_go_high_level_calendar_event_create_tool_dto.py
+++ b/src/vapi/types/create_go_high_level_calendar_event_create_tool_dto.py
@@ -16,6 +16,10 @@
class CreateGoHighLevelCalendarEventCreateToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that adds calendar events to a connected GoHighLevel account.
+ """
+
messages: typing.Optional[typing.List[CreateGoHighLevelCalendarEventCreateToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/create_go_high_level_contact_create_tool_dto.py b/src/vapi/types/create_go_high_level_contact_create_tool_dto.py
index 1e69f2ad..890f8f48 100644
--- a/src/vapi/types/create_go_high_level_contact_create_tool_dto.py
+++ b/src/vapi/types/create_go_high_level_contact_create_tool_dto.py
@@ -16,6 +16,10 @@
class CreateGoHighLevelContactCreateToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that adds contacts to a connected GoHighLevel account.
+ """
+
messages: typing.Optional[typing.List[CreateGoHighLevelContactCreateToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/create_go_high_level_contact_get_tool_dto.py b/src/vapi/types/create_go_high_level_contact_get_tool_dto.py
index 506250ec..bf453b18 100644
--- a/src/vapi/types/create_go_high_level_contact_get_tool_dto.py
+++ b/src/vapi/types/create_go_high_level_contact_get_tool_dto.py
@@ -14,6 +14,10 @@
class CreateGoHighLevelContactGetToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that retrieves contacts from a connected GoHighLevel account.
+ """
+
messages: typing.Optional[typing.List[CreateGoHighLevelContactGetToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/create_go_high_level_credential_dto.py b/src/vapi/types/create_go_high_level_credential_dto.py
index 02f0c970..b28bac91 100644
--- a/src/vapi/types/create_go_high_level_credential_dto.py
+++ b/src/vapi/types/create_go_high_level_credential_dto.py
@@ -10,6 +10,10 @@
class CreateGoHighLevelCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating Vapi integrations with GoHighLevel.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_go_high_level_mcp_credential_dto.py b/src/vapi/types/create_go_high_level_mcp_credential_dto.py
index d68307d2..fc866bf2 100644
--- a/src/vapi/types/create_go_high_level_mcp_credential_dto.py
+++ b/src/vapi/types/create_go_high_level_mcp_credential_dto.py
@@ -11,6 +11,10 @@
class CreateGoHighLevelMcpCredentialDto(UncheckedBaseModel):
+ """
+ OAuth 2.0 session credentials for authenticating GoHighLevel MCP requests.
+ """
+
authentication_session: typing_extensions.Annotated[
Oauth2AuthenticationSession,
FieldMetadata(alias="authenticationSession"),
diff --git a/src/vapi/types/create_google_calendar_check_availability_tool_dto.py b/src/vapi/types/create_google_calendar_check_availability_tool_dto.py
index d7e06af2..d3633544 100644
--- a/src/vapi/types/create_google_calendar_check_availability_tool_dto.py
+++ b/src/vapi/types/create_google_calendar_check_availability_tool_dto.py
@@ -16,6 +16,10 @@
class CreateGoogleCalendarCheckAvailabilityToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that checks availability in a connected Google Calendar.
+ """
+
messages: typing.Optional[typing.List[CreateGoogleCalendarCheckAvailabilityToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/create_google_calendar_create_event_tool_dto.py b/src/vapi/types/create_google_calendar_create_event_tool_dto.py
index 82baf381..7b627075 100644
--- a/src/vapi/types/create_google_calendar_create_event_tool_dto.py
+++ b/src/vapi/types/create_google_calendar_create_event_tool_dto.py
@@ -16,6 +16,10 @@
class CreateGoogleCalendarCreateEventToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that adds events to a connected Google Calendar.
+ """
+
messages: typing.Optional[typing.List[CreateGoogleCalendarCreateEventToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/create_google_calendar_o_auth_2_authorization_credential_dto.py b/src/vapi/types/create_google_calendar_o_auth_2_authorization_credential_dto.py
index fd9d35cb..fc46bc87 100644
--- a/src/vapi/types/create_google_calendar_o_auth_2_authorization_credential_dto.py
+++ b/src/vapi/types/create_google_calendar_o_auth_2_authorization_credential_dto.py
@@ -10,6 +10,10 @@
class CreateGoogleCalendarOAuth2AuthorizationCredentialDto(UncheckedBaseModel):
+ """
+ Stored OAuth 2.0 authorization for Google Calendar operations.
+ """
+
authorization_id: typing_extensions.Annotated[
str,
FieldMetadata(alias="authorizationId"),
diff --git a/src/vapi/types/create_google_calendar_o_auth_2_client_credential_dto.py b/src/vapi/types/create_google_calendar_o_auth_2_client_credential_dto.py
index e01d67ad..e8b6c0d2 100644
--- a/src/vapi/types/create_google_calendar_o_auth_2_client_credential_dto.py
+++ b/src/vapi/types/create_google_calendar_o_auth_2_client_credential_dto.py
@@ -8,6 +8,10 @@
class CreateGoogleCalendarOAuth2ClientCredentialDto(UncheckedBaseModel):
+ """
+ OAuth 2.0 client credential for Google Calendar integrations.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of credential. This is just for your reference.
diff --git a/src/vapi/types/create_google_credential_dto.py b/src/vapi/types/create_google_credential_dto.py
index 5851939b..16c33abf 100644
--- a/src/vapi/types/create_google_credential_dto.py
+++ b/src/vapi/types/create_google_credential_dto.py
@@ -10,6 +10,10 @@
class CreateGoogleCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with Google AI.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_google_sheets_o_auth_2_authorization_credential_dto.py b/src/vapi/types/create_google_sheets_o_auth_2_authorization_credential_dto.py
index cb89677c..6a342ae5 100644
--- a/src/vapi/types/create_google_sheets_o_auth_2_authorization_credential_dto.py
+++ b/src/vapi/types/create_google_sheets_o_auth_2_authorization_credential_dto.py
@@ -10,6 +10,10 @@
class CreateGoogleSheetsOAuth2AuthorizationCredentialDto(UncheckedBaseModel):
+ """
+ Stored OAuth 2.0 authorization for Google Sheets operations.
+ """
+
authorization_id: typing_extensions.Annotated[
str,
FieldMetadata(alias="authorizationId"),
diff --git a/src/vapi/types/create_google_sheets_row_append_tool_dto.py b/src/vapi/types/create_google_sheets_row_append_tool_dto.py
index ffbf6551..019d93b1 100644
--- a/src/vapi/types/create_google_sheets_row_append_tool_dto.py
+++ b/src/vapi/types/create_google_sheets_row_append_tool_dto.py
@@ -14,6 +14,10 @@
class CreateGoogleSheetsRowAppendToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that appends rows to a connected Google Sheet.
+ """
+
messages: typing.Optional[typing.List[CreateGoogleSheetsRowAppendToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/create_groq_credential_dto.py b/src/vapi/types/create_groq_credential_dto.py
index eb951766..49dcd99b 100644
--- a/src/vapi/types/create_groq_credential_dto.py
+++ b/src/vapi/types/create_groq_credential_dto.py
@@ -10,6 +10,10 @@
class CreateGroqCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with Groq.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_handoff_tool_dto.py b/src/vapi/types/create_handoff_tool_dto.py
index 2b5ba862..daf341d4 100644
--- a/src/vapi/types/create_handoff_tool_dto.py
+++ b/src/vapi/types/create_handoff_tool_dto.py
@@ -15,6 +15,10 @@
class CreateHandoffToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that hands a conversation to another assistant, squad, or dynamically selected destination.
+ """
+
messages: typing.Optional[typing.List[CreateHandoffToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_hume_credential_dto.py b/src/vapi/types/create_hume_credential_dto.py
index 1aad6a61..325e6b87 100644
--- a/src/vapi/types/create_hume_credential_dto.py
+++ b/src/vapi/types/create_hume_credential_dto.py
@@ -10,6 +10,10 @@
class CreateHumeCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating voice synthesis requests with Hume.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_inflection_ai_credential_dto.py b/src/vapi/types/create_inflection_ai_credential_dto.py
index 12378154..7d76ec15 100644
--- a/src/vapi/types/create_inflection_ai_credential_dto.py
+++ b/src/vapi/types/create_inflection_ai_credential_dto.py
@@ -10,6 +10,10 @@
class CreateInflectionAiCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with Inflection AI.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_inworld_credential_dto.py b/src/vapi/types/create_inworld_credential_dto.py
index 37bc7f47..20ee8e2a 100644
--- a/src/vapi/types/create_inworld_credential_dto.py
+++ b/src/vapi/types/create_inworld_credential_dto.py
@@ -10,6 +10,10 @@
class CreateInworldCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating voice synthesis requests with Inworld.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_langfuse_credential_dto.py b/src/vapi/types/create_langfuse_credential_dto.py
index 969407c6..57028294 100644
--- a/src/vapi/types/create_langfuse_credential_dto.py
+++ b/src/vapi/types/create_langfuse_credential_dto.py
@@ -10,6 +10,10 @@
class CreateLangfuseCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for sending assistant call traces to a Langfuse project, including its public key, secret key, and host URL.
+ """
+
public_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="publicKey"),
diff --git a/src/vapi/types/create_line_insight_from_call_table_dto.py b/src/vapi/types/create_line_insight_from_call_table_dto.py
index eb9104f1..ebbbf0fb 100644
--- a/src/vapi/types/create_line_insight_from_call_table_dto.py
+++ b/src/vapi/types/create_line_insight_from_call_table_dto.py
@@ -15,6 +15,10 @@
class CreateLineInsightFromCallTableDto(UncheckedBaseModel):
+ """
+ Configuration used to create a line-chart insight from call data using metric queries, formulas, grouping, and a stepped time range.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -45,7 +49,11 @@ class CreateLineInsightFromCallTableDto(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRangeWithStep], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRangeWithStep],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(
+ alias="timeRange", description="The time range and interval used to aggregate the line-chart data."
+ ),
] = None
group_by: typing_extensions.Annotated[
typing.Optional[CreateLineInsightFromCallTableDtoGroupBy],
diff --git a/src/vapi/types/create_lmnt_credential_dto.py b/src/vapi/types/create_lmnt_credential_dto.py
index 5c09af82..d13fc4af 100644
--- a/src/vapi/types/create_lmnt_credential_dto.py
+++ b/src/vapi/types/create_lmnt_credential_dto.py
@@ -10,6 +10,10 @@
class CreateLmntCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating voice synthesis requests with LMNT.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_make_credential_dto.py b/src/vapi/types/create_make_credential_dto.py
index fdb7061c..efd7ab4b 100644
--- a/src/vapi/types/create_make_credential_dto.py
+++ b/src/vapi/types/create_make_credential_dto.py
@@ -10,6 +10,10 @@
class CreateMakeCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating Vapi integrations with Make, including team, region, and API key.
+ """
+
team_id: typing_extensions.Annotated[
str, FieldMetadata(alias="teamId"), pydantic.Field(alias="teamId", description="Team ID")
]
diff --git a/src/vapi/types/create_mcp_tool_dto.py b/src/vapi/types/create_mcp_tool_dto.py
index 6ac92cfb..d2a4abed 100644
--- a/src/vapi/types/create_mcp_tool_dto.py
+++ b/src/vapi/types/create_mcp_tool_dto.py
@@ -17,6 +17,10 @@
class CreateMcpToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that connects an assistant to a Model Context Protocol server and exposes its available tools.
+ """
+
messages: typing.Optional[typing.List[CreateMcpToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
@@ -45,7 +49,11 @@ class CreateMcpToolDto(UncheckedBaseModel):
description="Per-tool message overrides for individual tools loaded from the MCP server. Set messages to an empty array to suppress messages for a specific tool. Tools not listed here will use the default messages from the parent tool.",
),
] = None
- metadata: typing.Optional[McpToolMetadata] = None
+ metadata: typing.Optional[McpToolMetadata] = pydantic.Field(default=None)
+ """
+ Connection metadata for the MCP server, including its communication protocol.
+ """
+
rejection_plan: typing_extensions.Annotated[
typing.Optional[ToolRejectionPlan],
FieldMetadata(alias="rejectionPlan"),
diff --git a/src/vapi/types/create_minimax_credential_dto.py b/src/vapi/types/create_minimax_credential_dto.py
index 01a1b6e0..94a8bb8f 100644
--- a/src/vapi/types/create_minimax_credential_dto.py
+++ b/src/vapi/types/create_minimax_credential_dto.py
@@ -10,6 +10,10 @@
class CreateMinimaxCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model and voice synthesis requests with MiniMax, including the MiniMax group identifier.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_mistral_credential_dto.py b/src/vapi/types/create_mistral_credential_dto.py
index 560b2d92..5ae465c8 100644
--- a/src/vapi/types/create_mistral_credential_dto.py
+++ b/src/vapi/types/create_mistral_credential_dto.py
@@ -10,6 +10,10 @@
class CreateMistralCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with Mistral.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_neuphonic_credential_dto.py b/src/vapi/types/create_neuphonic_credential_dto.py
index 1777609e..5440726a 100644
--- a/src/vapi/types/create_neuphonic_credential_dto.py
+++ b/src/vapi/types/create_neuphonic_credential_dto.py
@@ -10,6 +10,10 @@
class CreateNeuphonicCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating voice synthesis requests with Neuphonic.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_open_ai_credential_dto.py b/src/vapi/types/create_open_ai_credential_dto.py
index 4721ea8f..5f890b2c 100644
--- a/src/vapi/types/create_open_ai_credential_dto.py
+++ b/src/vapi/types/create_open_ai_credential_dto.py
@@ -10,6 +10,10 @@
class CreateOpenAiCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model, transcription, and voice synthesis requests with OpenAI.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_open_router_credential_dto.py b/src/vapi/types/create_open_router_credential_dto.py
index f7fcb77e..8062872c 100644
--- a/src/vapi/types/create_open_router_credential_dto.py
+++ b/src/vapi/types/create_open_router_credential_dto.py
@@ -10,6 +10,10 @@
class CreateOpenRouterCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with OpenRouter.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_perplexity_ai_credential_dto.py b/src/vapi/types/create_perplexity_ai_credential_dto.py
index a541e0be..be16c8f1 100644
--- a/src/vapi/types/create_perplexity_ai_credential_dto.py
+++ b/src/vapi/types/create_perplexity_ai_credential_dto.py
@@ -10,6 +10,10 @@
class CreatePerplexityAiCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with Perplexity AI.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_pie_insight_from_call_table_dto.py b/src/vapi/types/create_pie_insight_from_call_table_dto.py
index fbcb9b30..795103a7 100644
--- a/src/vapi/types/create_pie_insight_from_call_table_dto.py
+++ b/src/vapi/types/create_pie_insight_from_call_table_dto.py
@@ -14,6 +14,10 @@
class CreatePieInsightFromCallTableDto(UncheckedBaseModel):
+ """
+ Configuration used to create a pie-chart insight from call data using metric queries, formulas, grouping, and a time range.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -39,7 +43,9 @@ class CreatePieInsightFromCallTableDto(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRange], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRange],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(alias="timeRange", description="The time range used to query the pie-chart data."),
] = None
group_by: typing_extensions.Annotated[
typing.Optional[CreatePieInsightFromCallTableDtoGroupBy],
diff --git a/src/vapi/types/create_play_ht_credential_dto.py b/src/vapi/types/create_play_ht_credential_dto.py
index 8ee9d10a..41135302 100644
--- a/src/vapi/types/create_play_ht_credential_dto.py
+++ b/src/vapi/types/create_play_ht_credential_dto.py
@@ -10,12 +10,20 @@
class CreatePlayHtCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating voice synthesis requests with PlayHT, including the PlayHT user identifier.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
pydantic.Field(alias="apiKey", description="This is not returned in the API."),
]
- user_id: typing_extensions.Annotated[str, FieldMetadata(alias="userId"), pydantic.Field(alias="userId")]
+ user_id: typing_extensions.Annotated[
+ str,
+ FieldMetadata(alias="userId"),
+ pydantic.Field(alias="userId", description="PlayHT user identifier associated with the API key."),
+ ]
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of credential. This is just for your reference.
diff --git a/src/vapi/types/create_query_tool_dto.py b/src/vapi/types/create_query_tool_dto.py
index 31c6a7d9..2889e62b 100644
--- a/src/vapi/types/create_query_tool_dto.py
+++ b/src/vapi/types/create_query_tool_dto.py
@@ -15,6 +15,10 @@
class CreateQueryToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that searches configured knowledge bases and returns relevant content to the assistant.
+ """
+
messages: typing.Optional[typing.List[CreateQueryToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_rime_ai_credential_dto.py b/src/vapi/types/create_rime_ai_credential_dto.py
index b7e180ca..4bd233c3 100644
--- a/src/vapi/types/create_rime_ai_credential_dto.py
+++ b/src/vapi/types/create_rime_ai_credential_dto.py
@@ -10,6 +10,10 @@
class CreateRimeAiCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating voice synthesis requests with Rime AI.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_runpod_credential_dto.py b/src/vapi/types/create_runpod_credential_dto.py
index 54d4f669..3ae92375 100644
--- a/src/vapi/types/create_runpod_credential_dto.py
+++ b/src/vapi/types/create_runpod_credential_dto.py
@@ -10,6 +10,10 @@
class CreateRunpodCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests through Runpod.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_s_3_credential_dto.py b/src/vapi/types/create_s_3_credential_dto.py
index 532e8ad6..3abdbd8d 100644
--- a/src/vapi/types/create_s_3_credential_dto.py
+++ b/src/vapi/types/create_s_3_credential_dto.py
@@ -10,6 +10,10 @@
class CreateS3CredentialDto(UncheckedBaseModel):
+ """
+ Credentials for storing call artifacts in Amazon S3, including access keys, region, bucket, path prefix, and upload fallback order.
+ """
+
aws_access_key_id: typing_extensions.Annotated[
str,
FieldMetadata(alias="awsAccessKeyId"),
diff --git a/src/vapi/types/create_scorecard_dto.py b/src/vapi/types/create_scorecard_dto.py
index 36becc72..b6350cb7 100644
--- a/src/vapi/types/create_scorecard_dto.py
+++ b/src/vapi/types/create_scorecard_dto.py
@@ -11,6 +11,10 @@
class CreateScorecardDto(UncheckedBaseModel):
+ """
+ Configuration used to create a scorecard containing evaluation metrics, scoring conditions, and optional assistant associations.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the scorecard. It is only for user reference and will not be used for any evaluation.
diff --git a/src/vapi/types/create_sip_request_tool_dto.py b/src/vapi/types/create_sip_request_tool_dto.py
index cd9c1db5..48398872 100644
--- a/src/vapi/types/create_sip_request_tool_dto.py
+++ b/src/vapi/types/create_sip_request_tool_dto.py
@@ -16,6 +16,10 @@
class CreateSipRequestToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body.
+ """
+
messages: typing.Optional[typing.List[CreateSipRequestToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_slack_o_auth_2_authorization_credential_dto.py b/src/vapi/types/create_slack_o_auth_2_authorization_credential_dto.py
index 7393ca35..6211a6b8 100644
--- a/src/vapi/types/create_slack_o_auth_2_authorization_credential_dto.py
+++ b/src/vapi/types/create_slack_o_auth_2_authorization_credential_dto.py
@@ -10,6 +10,10 @@
class CreateSlackOAuth2AuthorizationCredentialDto(UncheckedBaseModel):
+ """
+ Stored OAuth 2.0 authorization for Slack operations.
+ """
+
authorization_id: typing_extensions.Annotated[
str,
FieldMetadata(alias="authorizationId"),
diff --git a/src/vapi/types/create_slack_send_message_tool_dto.py b/src/vapi/types/create_slack_send_message_tool_dto.py
index bb3d6c57..594684e2 100644
--- a/src/vapi/types/create_slack_send_message_tool_dto.py
+++ b/src/vapi/types/create_slack_send_message_tool_dto.py
@@ -14,6 +14,10 @@
class CreateSlackSendMessageToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that lets an assistant send a message to Slack.
+ """
+
messages: typing.Optional[typing.List[CreateSlackSendMessageToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_slack_webhook_credential_dto.py b/src/vapi/types/create_slack_webhook_credential_dto.py
index 36f8a9df..492ad4ae 100644
--- a/src/vapi/types/create_slack_webhook_credential_dto.py
+++ b/src/vapi/types/create_slack_webhook_credential_dto.py
@@ -10,6 +10,10 @@
class CreateSlackWebhookCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for sending Vapi alerts through a Slack incoming webhook.
+ """
+
webhook_url: typing_extensions.Annotated[
str,
FieldMetadata(alias="webhookUrl"),
diff --git a/src/vapi/types/create_smallest_ai_credential_dto.py b/src/vapi/types/create_smallest_ai_credential_dto.py
index e55d7ebf..037e18c8 100644
--- a/src/vapi/types/create_smallest_ai_credential_dto.py
+++ b/src/vapi/types/create_smallest_ai_credential_dto.py
@@ -10,6 +10,10 @@
class CreateSmallestAiCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating voice synthesis requests with Smallest AI.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_sms_tool_dto.py b/src/vapi/types/create_sms_tool_dto.py
index ca68db5c..3ce44817 100644
--- a/src/vapi/types/create_sms_tool_dto.py
+++ b/src/vapi/types/create_sms_tool_dto.py
@@ -14,6 +14,10 @@
class CreateSmsToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that lets an assistant send an SMS message during a call.
+ """
+
messages: typing.Optional[typing.List[CreateSmsToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_soniox_credential_dto.py b/src/vapi/types/create_soniox_credential_dto.py
index ac5d79dd..4fd3722e 100644
--- a/src/vapi/types/create_soniox_credential_dto.py
+++ b/src/vapi/types/create_soniox_credential_dto.py
@@ -10,6 +10,10 @@
class CreateSonioxCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating transcription requests with Soniox.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_speechmatics_credential_dto.py b/src/vapi/types/create_speechmatics_credential_dto.py
index 89279ca5..d8511608 100644
--- a/src/vapi/types/create_speechmatics_credential_dto.py
+++ b/src/vapi/types/create_speechmatics_credential_dto.py
@@ -10,6 +10,10 @@
class CreateSpeechmaticsCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating transcription requests with Speechmatics.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_squad_dto.py b/src/vapi/types/create_squad_dto.py
index 3ee99012..3f12e9c1 100644
--- a/src/vapi/types/create_squad_dto.py
+++ b/src/vapi/types/create_squad_dto.py
@@ -12,6 +12,10 @@
class CreateSquadDto(UncheckedBaseModel):
+ """
+ Configuration used to create a squad. Provide an ordered list of assistant members and optional overrides that control how the squad handles a conversation and transfers between assistants.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the squad.
diff --git a/src/vapi/types/create_structured_output_dto.py b/src/vapi/types/create_structured_output_dto.py
index 7617a878..e939eebc 100644
--- a/src/vapi/types/create_structured_output_dto.py
+++ b/src/vapi/types/create_structured_output_dto.py
@@ -15,6 +15,10 @@
class CreateStructuredOutputDto(UncheckedBaseModel):
+ """
+ Configuration used to create a structured-output definition that extracts validated data from calls using an AI model or regular expression.
+ """
+
type: typing.Optional[CreateStructuredOutputDtoType] = pydantic.Field(default=None)
"""
This is the type of structured output.
diff --git a/src/vapi/types/create_supabase_credential_dto.py b/src/vapi/types/create_supabase_credential_dto.py
index e5f0cda8..680310a6 100644
--- a/src/vapi/types/create_supabase_credential_dto.py
+++ b/src/vapi/types/create_supabase_credential_dto.py
@@ -11,6 +11,10 @@
class CreateSupabaseCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for storing call artifacts in Supabase's S3-compatible storage, including bucket configuration and upload fallback order.
+ """
+
fallback_index: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="fallbackIndex"),
@@ -20,7 +24,11 @@ class CreateSupabaseCredentialDto(UncheckedBaseModel):
),
] = None
bucket_plan: typing_extensions.Annotated[
- typing.Optional[SupabaseBucketPlan], FieldMetadata(alias="bucketPlan"), pydantic.Field(alias="bucketPlan")
+ typing.Optional[SupabaseBucketPlan],
+ FieldMetadata(alias="bucketPlan"),
+ pydantic.Field(
+ alias="bucketPlan", description="Supabase S3-compatible bucket configuration used to store call artifacts."
+ ),
] = None
name: typing.Optional[str] = pydantic.Field(default=None)
"""
diff --git a/src/vapi/types/create_tavus_credential_dto.py b/src/vapi/types/create_tavus_credential_dto.py
index 152268ab..186ebd25 100644
--- a/src/vapi/types/create_tavus_credential_dto.py
+++ b/src/vapi/types/create_tavus_credential_dto.py
@@ -10,6 +10,10 @@
class CreateTavusCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating voice synthesis requests with Tavus.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_telnyx_phone_number_dto.py b/src/vapi/types/create_telnyx_phone_number_dto.py
index 8815bd6e..3cf89d86 100644
--- a/src/vapi/types/create_telnyx_phone_number_dto.py
+++ b/src/vapi/types/create_telnyx_phone_number_dto.py
@@ -13,6 +13,10 @@
class CreateTelnyxPhoneNumberDto(UncheckedBaseModel):
+ """
+ Configuration used to import a Telnyx phone number into Vapi with a stored credential and routing settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[CreateTelnyxPhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/create_text_editor_tool_dto.py b/src/vapi/types/create_text_editor_tool_dto.py
index 39ee8ec5..55a3216d 100644
--- a/src/vapi/types/create_text_editor_tool_dto.py
+++ b/src/vapi/types/create_text_editor_tool_dto.py
@@ -17,6 +17,10 @@
class CreateTextEditorToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that reads and edits text files in a configured environment.
+ """
+
messages: typing.Optional[typing.List[CreateTextEditorToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_text_insight_from_call_table_dto.py b/src/vapi/types/create_text_insight_from_call_table_dto.py
index 3be58a20..6c7276ca 100644
--- a/src/vapi/types/create_text_insight_from_call_table_dto.py
+++ b/src/vapi/types/create_text_insight_from_call_table_dto.py
@@ -12,6 +12,10 @@
class CreateTextInsightFromCallTableDto(UncheckedBaseModel):
+ """
+ Configuration used to create a text-value insight from call data using metric queries, a formula, and a time range.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -37,7 +41,9 @@ class CreateTextInsightFromCallTableDto(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRange], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRange],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(alias="timeRange", description="The time range used to query the text-value data."),
] = None
queries: typing.List[CreateTextInsightFromCallTableDtoQueriesItem] = pydantic.Field()
"""
diff --git a/src/vapi/types/create_together_ai_credential_dto.py b/src/vapi/types/create_together_ai_credential_dto.py
index da5c2797..d495c195 100644
--- a/src/vapi/types/create_together_ai_credential_dto.py
+++ b/src/vapi/types/create_together_ai_credential_dto.py
@@ -10,6 +10,10 @@
class CreateTogetherAiCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with Together AI.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_transfer_call_tool_dto.py b/src/vapi/types/create_transfer_call_tool_dto.py
index 8c1caa44..aa7aa4df 100644
--- a/src/vapi/types/create_transfer_call_tool_dto.py
+++ b/src/vapi/types/create_transfer_call_tool_dto.py
@@ -15,6 +15,10 @@
class CreateTransferCallToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a tool that transfers the active call to one of its configured destinations.
+ """
+
messages: typing.Optional[typing.List[CreateTransferCallToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_trieve_credential_dto.py b/src/vapi/types/create_trieve_credential_dto.py
index 009d1912..831fb450 100644
--- a/src/vapi/types/create_trieve_credential_dto.py
+++ b/src/vapi/types/create_trieve_credential_dto.py
@@ -10,6 +10,10 @@
class CreateTrieveCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating knowledge-base requests with Trieve.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_twilio_credential_dto.py b/src/vapi/types/create_twilio_credential_dto.py
index cdc97641..064925d7 100644
--- a/src/vapi/types/create_twilio_credential_dto.py
+++ b/src/vapi/types/create_twilio_credential_dto.py
@@ -10,6 +10,10 @@
class CreateTwilioCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating telephony requests with Twilio using an account SID and either an auth token or API key credentials.
+ """
+
auth_token: typing_extensions.Annotated[
typing.Optional[str],
FieldMetadata(alias="authToken"),
@@ -25,7 +29,11 @@ class CreateTwilioCredentialDto(UncheckedBaseModel):
FieldMetadata(alias="apiSecret"),
pydantic.Field(alias="apiSecret", description="This is not returned in the API."),
] = None
- account_sid: typing_extensions.Annotated[str, FieldMetadata(alias="accountSid"), pydantic.Field(alias="accountSid")]
+ account_sid: typing_extensions.Annotated[
+ str,
+ FieldMetadata(alias="accountSid"),
+ pydantic.Field(alias="accountSid", description="Twilio Account SID associated with the credential."),
+ ]
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of credential. This is just for your reference.
diff --git a/src/vapi/types/create_twilio_phone_number_dto.py b/src/vapi/types/create_twilio_phone_number_dto.py
index ccc99ff1..a66644d7 100644
--- a/src/vapi/types/create_twilio_phone_number_dto.py
+++ b/src/vapi/types/create_twilio_phone_number_dto.py
@@ -13,6 +13,10 @@
class CreateTwilioPhoneNumberDto(UncheckedBaseModel):
+ """
+ Configuration used to import a Twilio phone number into Vapi with its account credentials and routing settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[CreateTwilioPhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/create_vapi_phone_number_dto.py b/src/vapi/types/create_vapi_phone_number_dto.py
index 07436061..424a15f0 100644
--- a/src/vapi/types/create_vapi_phone_number_dto.py
+++ b/src/vapi/types/create_vapi_phone_number_dto.py
@@ -14,6 +14,10 @@
class CreateVapiPhoneNumberDto(UncheckedBaseModel):
+ """
+ Configuration used to provision a Vapi-managed phone number or connect a SIP URI, with optional routing and authentication settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[CreateVapiPhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/create_voicemail_tool_dto.py b/src/vapi/types/create_voicemail_tool_dto.py
index 33d3e113..1794d763 100644
--- a/src/vapi/types/create_voicemail_tool_dto.py
+++ b/src/vapi/types/create_voicemail_tool_dto.py
@@ -14,6 +14,10 @@
class CreateVoicemailToolDto(UncheckedBaseModel):
+ """
+ Configuration used to create a voicemail-detection tool with optional beep detection for supported calls.
+ """
+
messages: typing.Optional[typing.List[CreateVoicemailToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/create_vonage_credential_dto.py b/src/vapi/types/create_vonage_credential_dto.py
index 23e1d481..f8162cf3 100644
--- a/src/vapi/types/create_vonage_credential_dto.py
+++ b/src/vapi/types/create_vonage_credential_dto.py
@@ -10,12 +10,20 @@
class CreateVonageCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating telephony requests with Vonage.
+ """
+
api_secret: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiSecret"),
pydantic.Field(alias="apiSecret", description="This is not returned in the API."),
]
- api_key: typing_extensions.Annotated[str, FieldMetadata(alias="apiKey"), pydantic.Field(alias="apiKey")]
+ api_key: typing_extensions.Annotated[
+ str,
+ FieldMetadata(alias="apiKey"),
+ pydantic.Field(alias="apiKey", description="Vonage API key associated with the credential."),
+ ]
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of credential. This is just for your reference.
diff --git a/src/vapi/types/create_vonage_phone_number_dto.py b/src/vapi/types/create_vonage_phone_number_dto.py
index 166577a1..006f3919 100644
--- a/src/vapi/types/create_vonage_phone_number_dto.py
+++ b/src/vapi/types/create_vonage_phone_number_dto.py
@@ -13,6 +13,10 @@
class CreateVonagePhoneNumberDto(UncheckedBaseModel):
+ """
+ Configuration used to import a Vonage phone number into Vapi with a stored credential and routing settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[CreateVonagePhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/create_well_said_credential_dto.py b/src/vapi/types/create_well_said_credential_dto.py
index e58a0859..cfe78e28 100644
--- a/src/vapi/types/create_well_said_credential_dto.py
+++ b/src/vapi/types/create_well_said_credential_dto.py
@@ -10,6 +10,10 @@
class CreateWellSaidCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating voice synthesis requests with WellSaid.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/create_workflow_dto.py b/src/vapi/types/create_workflow_dto.py
index 8d0d6a6d..d42a3dcd 100644
--- a/src/vapi/types/create_workflow_dto.py
+++ b/src/vapi/types/create_workflow_dto.py
@@ -31,7 +31,15 @@
class CreateWorkflowDto(UncheckedBaseModel):
- nodes: typing.List[CreateWorkflowDtoNodesItem]
+ """
+ Configuration for creating a graph-based workflow, including conversation and tool nodes, directed edges, global prompts, shared providers, hooks, credentials, and call behavior.
+ """
+
+ nodes: typing.List[CreateWorkflowDtoNodesItem] = pydantic.Field()
+ """
+ Nodes that make up the workflow graph. Conversation nodes interact with the customer, while tool nodes invoke configured tools.
+ """
+
model: typing.Optional[CreateWorkflowDtoModel] = pydantic.Field(default=None)
"""
This is the model for the workflow.
@@ -94,10 +102,20 @@ class CreateWorkflowDto(UncheckedBaseModel):
description="This is the maximum duration of the call in seconds.\n\nAfter this duration, the call will automatically end.\n\nDefault is 1800 (30 minutes), max is 43200 (12 hours), and min is 10 seconds.",
),
] = None
- name: str
- edges: typing.List[Edge]
+ name: str = pydantic.Field()
+ """
+ Name used to identify the workflow.
+ """
+
+ edges: typing.List[Edge] = pydantic.Field()
+ """
+ Directed connections that determine transitions between nodes.
+ """
+
global_prompt: typing_extensions.Annotated[
- typing.Optional[str], FieldMetadata(alias="globalPrompt"), pydantic.Field(alias="globalPrompt")
+ typing.Optional[str],
+ FieldMetadata(alias="globalPrompt"),
+ pydantic.Field(alias="globalPrompt", description="Prompt applied across the workflow's conversation nodes."),
] = None
server: typing.Optional[Server] = pydantic.Field(default=None)
"""
diff --git a/src/vapi/types/create_x_ai_credential_dto.py b/src/vapi/types/create_x_ai_credential_dto.py
index 7ee391b9..63245f21 100644
--- a/src/vapi/types/create_x_ai_credential_dto.py
+++ b/src/vapi/types/create_x_ai_credential_dto.py
@@ -10,6 +10,10 @@
class CreateXAiCredentialDto(UncheckedBaseModel):
+ """
+ Credentials for authenticating assistant model requests with xAI.
+ """
+
api_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="apiKey"),
diff --git a/src/vapi/types/custom_endpointing_model_smart_endpointing_plan.py b/src/vapi/types/custom_endpointing_model_smart_endpointing_plan.py
index 730ad9c7..d17bada5 100644
--- a/src/vapi/types/custom_endpointing_model_smart_endpointing_plan.py
+++ b/src/vapi/types/custom_endpointing_model_smart_endpointing_plan.py
@@ -10,6 +10,10 @@
class CustomEndpointingModelSmartEndpointingPlan(UncheckedBaseModel):
+ """
+ Configuration for using a custom endpointing model, including its provider identifier and server connection.
+ """
+
provider: CustomEndpointingModelSmartEndpointingPlanProvider = pydantic.Field()
"""
This is the provider for the smart endpointing plan. Use `custom-endpointing-model` for custom endpointing providers that are not natively supported.
diff --git a/src/vapi/types/custom_llm_model.py b/src/vapi/types/custom_llm_model.py
index 04176e19..05c9a983 100644
--- a/src/vapi/types/custom_llm_model.py
+++ b/src/vapi/types/custom_llm_model.py
@@ -15,6 +15,10 @@
class CustomLlmModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses through a custom language model endpoint, including server URL, headers, metadata, prompts, tools, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/custom_message.py b/src/vapi/types/custom_message.py
index 8668d547..6edd6d39 100644
--- a/src/vapi/types/custom_message.py
+++ b/src/vapi/types/custom_message.py
@@ -10,6 +10,10 @@
class CustomMessage(UncheckedBaseModel):
+ """
+ A message spoken by the assistant with optional language-specific content variants.
+ """
+
contents: typing.Optional[typing.List[TextContent]] = pydantic.Field(default=None)
"""
This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.
diff --git a/src/vapi/types/custom_transcriber.py b/src/vapi/types/custom_transcriber.py
index a0b86096..8636b22b 100644
--- a/src/vapi/types/custom_transcriber.py
+++ b/src/vapi/types/custom_transcriber.py
@@ -12,6 +12,10 @@
class CustomTranscriber(UncheckedBaseModel):
+ """
+ Configuration for sending conversation audio to a custom WebSocket transcription server.
+ """
+
server: Server = pydantic.Field()
"""
This is where the transcription request will be sent.
diff --git a/src/vapi/types/custom_voice.py b/src/vapi/types/custom_voice.py
index ba9eef7f..cbc39d29 100644
--- a/src/vapi/types/custom_voice.py
+++ b/src/vapi/types/custom_voice.py
@@ -13,6 +13,10 @@
class CustomVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech through a custom server, including voice selection, server connection, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/customer_custom_endpointing_rule.py b/src/vapi/types/customer_custom_endpointing_rule.py
index 79aa7ceb..f6b29362 100644
--- a/src/vapi/types/customer_custom_endpointing_rule.py
+++ b/src/vapi/types/customer_custom_endpointing_rule.py
@@ -11,6 +11,10 @@
class CustomerCustomEndpointingRule(UncheckedBaseModel):
+ """
+ A custom endpointing rule that matches the customer's current speech and applies a configured timeout.
+ """
+
regex: str = pydantic.Field()
"""
This is the regex pattern to match.
diff --git a/src/vapi/types/customer_speech_timeout_options.py b/src/vapi/types/customer_speech_timeout_options.py
index 4c4b3d89..3e9d1378 100644
--- a/src/vapi/types/customer_speech_timeout_options.py
+++ b/src/vapi/types/customer_speech_timeout_options.py
@@ -10,6 +10,10 @@
class CustomerSpeechTimeoutOptions(UncheckedBaseModel):
+ """
+ Controls how long a hook waits for customer speech, how often it can trigger, and when its trigger counter resets.
+ """
+
timeout_seconds: typing_extensions.Annotated[
float,
FieldMetadata(alias="timeoutSeconds"),
@@ -31,7 +35,7 @@ class CustomerSpeechTimeoutOptions(UncheckedBaseModel):
FieldMetadata(alias="triggerResetMode"),
pydantic.Field(
alias="triggerResetMode",
- description="This is whether the counter for hook trigger resets the user speaks.\n\n@default never",
+ description="Controls whether the hook's trigger counter resets after the customer speaks. Defaults to `never`.",
),
] = None
diff --git a/src/vapi/types/deep_infra_model.py b/src/vapi/types/deep_infra_model.py
index 98ee2064..a2296b15 100644
--- a/src/vapi/types/deep_infra_model.py
+++ b/src/vapi/types/deep_infra_model.py
@@ -14,6 +14,10 @@
class DeepInfraModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with DeepInfra, including model, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/deep_seek_model.py b/src/vapi/types/deep_seek_model.py
index c44da98f..7d9672ee 100644
--- a/src/vapi/types/deep_seek_model.py
+++ b/src/vapi/types/deep_seek_model.py
@@ -15,6 +15,10 @@
class DeepSeekModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with DeepSeek, including model, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/deepgram_transcriber.py b/src/vapi/types/deepgram_transcriber.py
index f0501e5b..462e252a 100644
--- a/src/vapi/types/deepgram_transcriber.py
+++ b/src/vapi/types/deepgram_transcriber.py
@@ -13,6 +13,10 @@
class DeepgramTranscriber(UncheckedBaseModel):
+ """
+ Configuration for transcribing speech during assistant conversations with Deepgram, including model, language, formatting, endpointing, vocabulary, and fallback settings.
+ """
+
model: typing.Optional[DeepgramTranscriberModel] = pydantic.Field(default=None)
"""
This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview
diff --git a/src/vapi/types/deepgram_voice.py b/src/vapi/types/deepgram_voice.py
index b44489d7..a3c0cf68 100644
--- a/src/vapi/types/deepgram_voice.py
+++ b/src/vapi/types/deepgram_voice.py
@@ -14,6 +14,10 @@
class DeepgramVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with Deepgram, including voice and model selection, model-improvement preferences, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/developer_message.py b/src/vapi/types/developer_message.py
index ab5ca480..38d2e915 100644
--- a/src/vapi/types/developer_message.py
+++ b/src/vapi/types/developer_message.py
@@ -9,6 +9,10 @@
class DeveloperMessage(UncheckedBaseModel):
+ """
+ A developer-authored instruction message supplied to the language model.
+ """
+
role: DeveloperMessageRole = pydantic.Field()
"""
This is the role of the message author
diff --git a/src/vapi/types/dial_plan_entry.py b/src/vapi/types/dial_plan_entry.py
index 6ab312e5..ad8d7452 100644
--- a/src/vapi/types/dial_plan_entry.py
+++ b/src/vapi/types/dial_plan_entry.py
@@ -13,6 +13,10 @@
class DialPlanEntry(UncheckedBaseModel):
+ """
+ Associates a phone number with the customers to dial through that number in a batch call plan.
+ """
+
phone_number_id: typing_extensions.Annotated[
str,
FieldMetadata(alias="phoneNumberId"),
diff --git a/src/vapi/types/dtmf_tool.py b/src/vapi/types/dtmf_tool.py
index 5a86c146..66b044d3 100644
--- a/src/vapi/types/dtmf_tool.py
+++ b/src/vapi/types/dtmf_tool.py
@@ -15,6 +15,10 @@
class DtmfTool(UncheckedBaseModel):
+ """
+ A reusable tool that lets an assistant send DTMF keypad tones during a call.
+ """
+
messages: typing.Optional[typing.List[DtmfToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/edge.py b/src/vapi/types/edge.py
index 87364adb..ee3fb847 100644
--- a/src/vapi/types/edge.py
+++ b/src/vapi/types/edge.py
@@ -11,9 +11,23 @@
class Edge(UncheckedBaseModel):
- condition: typing.Optional[AiEdgeCondition] = None
- from_: typing_extensions.Annotated[str, FieldMetadata(alias="from"), pydantic.Field(alias="from")]
- to: str
+ """
+ A directed connection between two workflow nodes, with an optional AI-evaluated transition condition.
+ """
+
+ condition: typing.Optional[AiEdgeCondition] = pydantic.Field(default=None)
+ """
+ Condition that must evaluate to true to follow this edge.
+ """
+
+ from_: typing_extensions.Annotated[
+ str, FieldMetadata(alias="from"), pydantic.Field(alias="from", description="Name of the source workflow node.")
+ ]
+ to: str = pydantic.Field()
+ """
+ Name of the destination workflow node.
+ """
+
metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
"""
This is for metadata you want to store on the edge.
diff --git a/src/vapi/types/eleven_labs_pronunciation_dictionary_locator.py b/src/vapi/types/eleven_labs_pronunciation_dictionary_locator.py
index 4cceab2a..8e66f2f7 100644
--- a/src/vapi/types/eleven_labs_pronunciation_dictionary_locator.py
+++ b/src/vapi/types/eleven_labs_pronunciation_dictionary_locator.py
@@ -10,6 +10,10 @@
class ElevenLabsPronunciationDictionaryLocator(UncheckedBaseModel):
+ """
+ Identifies a specific version of an ElevenLabs pronunciation dictionary.
+ """
+
pronunciation_dictionary_id: typing_extensions.Annotated[
str,
FieldMetadata(alias="pronunciationDictionaryId"),
diff --git a/src/vapi/types/eleven_labs_transcriber.py b/src/vapi/types/eleven_labs_transcriber.py
index 7f51440c..5062bd50 100644
--- a/src/vapi/types/eleven_labs_transcriber.py
+++ b/src/vapi/types/eleven_labs_transcriber.py
@@ -13,6 +13,10 @@
class ElevenLabsTranscriber(UncheckedBaseModel):
+ """
+ Configuration for transcribing speech during assistant conversations with ElevenLabs, including model, language, speech thresholds, and fallback settings.
+ """
+
model: typing.Optional[ElevenLabsTranscriberModel] = pydantic.Field(default=None)
"""
This is the model that will be used for the transcription.
diff --git a/src/vapi/types/eleven_labs_voice.py b/src/vapi/types/eleven_labs_voice.py
index e7fb8a50..ad8aeef3 100644
--- a/src/vapi/types/eleven_labs_voice.py
+++ b/src/vapi/types/eleven_labs_voice.py
@@ -15,6 +15,10 @@
class ElevenLabsVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with ElevenLabs, including voice and model selection, language, voice tuning, streaming, Speech Synthesis Markup Language parsing, pronunciation dictionaries, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/end_call_tool.py b/src/vapi/types/end_call_tool.py
index 5135c00c..389133ed 100644
--- a/src/vapi/types/end_call_tool.py
+++ b/src/vapi/types/end_call_tool.py
@@ -15,6 +15,10 @@
class EndCallTool(UncheckedBaseModel):
+ """
+ A reusable tool that lets an assistant end the active call.
+ """
+
messages: typing.Optional[typing.List[EndCallToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/eval.py b/src/vapi/types/eval.py
index 723830d3..23d72e51 100644
--- a/src/vapi/types/eval.py
+++ b/src/vapi/types/eval.py
@@ -13,6 +13,10 @@
class Eval(UncheckedBaseModel):
+ """
+ A saved eval definition containing its mock conversation, checkpoints, descriptive metadata, type, and lifecycle information.
+ """
+
messages: typing.List[EvalMessagesItem] = pydantic.Field()
"""
This is the mock conversation that will be used to evaluate the flow of the conversation.
@@ -22,13 +26,25 @@ class Eval(UncheckedBaseModel):
Evaluation Messages are used as checkpoints in the flow where the model's response to previous conversation needs to be evaluated to check the content and tool calls
"""
- id: str
- org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId"), pydantic.Field(alias="orgId")]
+ id: str = pydantic.Field()
+ """
+ The unique identifier for the eval.
+ """
+
+ org_id: typing_extensions.Annotated[
+ str,
+ FieldMetadata(alias="orgId"),
+ pydantic.Field(alias="orgId", description="The unique identifier for the organization that owns the eval."),
+ ]
created_at: typing_extensions.Annotated[
- dt.datetime, FieldMetadata(alias="createdAt"), pydantic.Field(alias="createdAt")
+ dt.datetime,
+ FieldMetadata(alias="createdAt"),
+ pydantic.Field(alias="createdAt", description="The ISO 8601 timestamp when the eval was created."),
]
updated_at: typing_extensions.Annotated[
- dt.datetime, FieldMetadata(alias="updatedAt"), pydantic.Field(alias="updatedAt")
+ dt.datetime,
+ FieldMetadata(alias="updatedAt"),
+ pydantic.Field(alias="updatedAt", description="The ISO 8601 timestamp when the eval was last updated."),
]
name: typing.Optional[str] = pydantic.Field(default=None)
"""
diff --git a/src/vapi/types/eval_anthropic_model.py b/src/vapi/types/eval_anthropic_model.py
index 9a4866d6..7f22a090 100644
--- a/src/vapi/types/eval_anthropic_model.py
+++ b/src/vapi/types/eval_anthropic_model.py
@@ -12,6 +12,10 @@
class EvalAnthropicModel(UncheckedBaseModel):
+ """
+ Anthropic model configuration for an LLM judge, including its messages, generation settings, and optional extended thinking.
+ """
+
model: EvalAnthropicModelModel = pydantic.Field()
"""
This is the specific model that will be used.
diff --git a/src/vapi/types/eval_custom_model.py b/src/vapi/types/eval_custom_model.py
index 38f6edd0..39e87374 100644
--- a/src/vapi/types/eval_custom_model.py
+++ b/src/vapi/types/eval_custom_model.py
@@ -10,6 +10,10 @@
class EvalCustomModel(UncheckedBaseModel):
+ """
+ OpenAI-compatible custom model configuration for an LLM judge, including its endpoint, headers, messages, and generation settings.
+ """
+
url: str = pydantic.Field()
"""
These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1
diff --git a/src/vapi/types/eval_google_model.py b/src/vapi/types/eval_google_model.py
index f4d4e6bf..34aea33a 100644
--- a/src/vapi/types/eval_google_model.py
+++ b/src/vapi/types/eval_google_model.py
@@ -11,6 +11,10 @@
class EvalGoogleModel(UncheckedBaseModel):
+ """
+ Google model configuration for an LLM judge, including its messages and generation settings.
+ """
+
model: EvalGoogleModelModel = pydantic.Field()
"""
This is the name of the model. Ex. gpt-4o
diff --git a/src/vapi/types/eval_open_ai_model.py b/src/vapi/types/eval_open_ai_model.py
index 5ecb8eed..489535a8 100644
--- a/src/vapi/types/eval_open_ai_model.py
+++ b/src/vapi/types/eval_open_ai_model.py
@@ -11,6 +11,10 @@
class EvalOpenAiModel(UncheckedBaseModel):
+ """
+ OpenAI model configuration for an LLM judge, including its messages and generation settings.
+ """
+
model: EvalOpenAiModelModel = pydantic.Field()
"""
This is the OpenAI model that will be used.
diff --git a/src/vapi/types/eval_paginated_response.py b/src/vapi/types/eval_paginated_response.py
index 9581f12e..ea4afa81 100644
--- a/src/vapi/types/eval_paginated_response.py
+++ b/src/vapi/types/eval_paginated_response.py
@@ -10,8 +10,19 @@
class EvalPaginatedResponse(UncheckedBaseModel):
- results: typing.List[Eval]
- metadata: PaginationMeta
+ """
+ A paginated collection of saved eval definitions and metadata describing the result set.
+ """
+
+ results: typing.List[Eval] = pydantic.Field()
+ """
+ The eval definitions returned for the current page.
+ """
+
+ metadata: PaginationMeta = pydantic.Field()
+ """
+ Pagination metadata for the eval result set.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/eval_run.py b/src/vapi/types/eval_run.py
index c37e75ca..e21cc256 100644
--- a/src/vapi/types/eval_run.py
+++ b/src/vapi/types/eval_run.py
@@ -19,6 +19,10 @@
class EvalRun(UncheckedBaseModel):
+ """
+ A record of an eval execution, including its target, status, results, costs, completion details, and lifecycle timestamps.
+ """
+
status: EvalRunStatus = pydantic.Field()
"""
This is the status of the eval run. When an eval run is created, the status is 'running'.
@@ -43,15 +47,31 @@ class EvalRun(UncheckedBaseModel):
This is the target that will be run against the eval
"""
- id: str
- org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId"), pydantic.Field(alias="orgId")]
+ id: str = pydantic.Field()
+ """
+ The unique identifier for the eval run.
+ """
+
+ org_id: typing_extensions.Annotated[
+ str,
+ FieldMetadata(alias="orgId"),
+ pydantic.Field(alias="orgId", description="The unique identifier for the organization that owns the run."),
+ ]
created_at: typing_extensions.Annotated[
- dt.datetime, FieldMetadata(alias="createdAt"), pydantic.Field(alias="createdAt")
+ dt.datetime,
+ FieldMetadata(alias="createdAt"),
+ pydantic.Field(alias="createdAt", description="The ISO 8601 timestamp when the eval run was created."),
]
started_at: typing_extensions.Annotated[
- dt.datetime, FieldMetadata(alias="startedAt"), pydantic.Field(alias="startedAt")
+ dt.datetime,
+ FieldMetadata(alias="startedAt"),
+ pydantic.Field(alias="startedAt", description="The ISO 8601 timestamp when the eval run started."),
+ ]
+ ended_at: typing_extensions.Annotated[
+ dt.datetime,
+ FieldMetadata(alias="endedAt"),
+ pydantic.Field(alias="endedAt", description="The ISO 8601 timestamp when the eval run ended."),
]
- ended_at: typing_extensions.Annotated[dt.datetime, FieldMetadata(alias="endedAt"), pydantic.Field(alias="endedAt")]
ended_message: typing_extensions.Annotated[
typing.Optional[str],
FieldMetadata(alias="endedMessage"),
diff --git a/src/vapi/types/eval_run_paginated_response.py b/src/vapi/types/eval_run_paginated_response.py
index cde254a0..f66c58fd 100644
--- a/src/vapi/types/eval_run_paginated_response.py
+++ b/src/vapi/types/eval_run_paginated_response.py
@@ -12,8 +12,19 @@
class EvalRunPaginatedResponse(UncheckedBaseModel):
- results: typing.List[EvalRun]
- metadata: PaginationMeta
+ """
+ A paginated collection of eval runs and metadata describing the result set.
+ """
+
+ results: typing.List[EvalRun] = pydantic.Field()
+ """
+ The eval runs returned for the current page.
+ """
+
+ metadata: PaginationMeta = pydantic.Field()
+ """
+ Pagination metadata for the eval-run result set.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/eval_run_result.py b/src/vapi/types/eval_run_result.py
index 5841a3e0..bf92de1b 100644
--- a/src/vapi/types/eval_run_result.py
+++ b/src/vapi/types/eval_run_result.py
@@ -13,6 +13,10 @@
class EvalRunResult(UncheckedBaseModel):
+ """
+ The pass or fail result of an evaluation run, including its conversation messages and timing.
+ """
+
status: EvalRunResultStatus = pydantic.Field()
"""
This is the status of the eval run result.
diff --git a/src/vapi/types/eval_run_target_assistant.py b/src/vapi/types/eval_run_target_assistant.py
index 1ada44b1..42231b0c 100644
--- a/src/vapi/types/eval_run_target_assistant.py
+++ b/src/vapi/types/eval_run_target_assistant.py
@@ -12,6 +12,10 @@
class EvalRunTargetAssistant(UncheckedBaseModel):
+ """
+ An assistant evaluation target provided as a saved assistant ID or a transient assistant, with optional assistant overrides.
+ """
+
assistant: typing.Optional["CreateAssistantDto"] = pydantic.Field(default=None)
"""
This is the transient assistant that will be run against the eval
diff --git a/src/vapi/types/eval_run_target_squad.py b/src/vapi/types/eval_run_target_squad.py
index c954ae89..9c74d99b 100644
--- a/src/vapi/types/eval_run_target_squad.py
+++ b/src/vapi/types/eval_run_target_squad.py
@@ -12,6 +12,10 @@
class EvalRunTargetSquad(UncheckedBaseModel):
+ """
+ A squad evaluation target provided as a saved squad ID or a transient squad, with optional assistant overrides.
+ """
+
squad: typing.Optional["CreateSquadDto"] = pydantic.Field(default=None)
"""
This is the transient squad that will be run against the eval
diff --git a/src/vapi/types/events_table_boolean_condition.py b/src/vapi/types/events_table_boolean_condition.py
index 7f0d3438..42003580 100644
--- a/src/vapi/types/events_table_boolean_condition.py
+++ b/src/vapi/types/events_table_boolean_condition.py
@@ -9,6 +9,10 @@
class EventsTableBooleanCondition(UncheckedBaseModel):
+ """
+ Filters event data by comparing a boolean field with an expected value.
+ """
+
column: str = pydantic.Field()
"""
The boolean field name from the event data
diff --git a/src/vapi/types/events_table_number_condition.py b/src/vapi/types/events_table_number_condition.py
index 24b05a12..e98faa8b 100644
--- a/src/vapi/types/events_table_number_condition.py
+++ b/src/vapi/types/events_table_number_condition.py
@@ -9,6 +9,10 @@
class EventsTableNumberCondition(UncheckedBaseModel):
+ """
+ Filters event data by comparing a numeric field with a value.
+ """
+
column: str = pydantic.Field()
"""
The number field name from the event data
diff --git a/src/vapi/types/events_table_string_condition.py b/src/vapi/types/events_table_string_condition.py
index 6c1fd905..eb2d40ff 100644
--- a/src/vapi/types/events_table_string_condition.py
+++ b/src/vapi/types/events_table_string_condition.py
@@ -9,6 +9,10 @@
class EventsTableStringCondition(UncheckedBaseModel):
+ """
+ Filters event data by comparing or searching a string field.
+ """
+
column: str = pydantic.Field()
"""
The string field name from the event data
diff --git a/src/vapi/types/exact_replacement.py b/src/vapi/types/exact_replacement.py
index 3b706e16..dc5ef61a 100644
--- a/src/vapi/types/exact_replacement.py
+++ b/src/vapi/types/exact_replacement.py
@@ -10,6 +10,10 @@
class ExactReplacement(UncheckedBaseModel):
+ """
+ Replaces an exact word or phrase before text is sent to a voice provider.
+ """
+
replace_all_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="replaceAllEnabled"),
diff --git a/src/vapi/types/fallback_assembly_ai_transcriber.py b/src/vapi/types/fallback_assembly_ai_transcriber.py
index 142e796a..39edff05 100644
--- a/src/vapi/types/fallback_assembly_ai_transcriber.py
+++ b/src/vapi/types/fallback_assembly_ai_transcriber.py
@@ -12,6 +12,10 @@
class FallbackAssemblyAiTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for transcribing speech with AssemblyAI, including language, streaming model, endpointing, and vocabulary.
+ """
+
language: typing.Optional[FallbackAssemblyAiTranscriberLanguage] = pydantic.Field(default=None)
"""
This is the language that will be set for the transcription.
diff --git a/src/vapi/types/fallback_azure_speech_transcriber.py b/src/vapi/types/fallback_azure_speech_transcriber.py
index a44904af..75f93b68 100644
--- a/src/vapi/types/fallback_azure_speech_transcriber.py
+++ b/src/vapi/types/fallback_azure_speech_transcriber.py
@@ -12,6 +12,10 @@
class FallbackAzureSpeechTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for transcribing speech with Azure Speech, including language and segmentation.
+ """
+
language: typing.Optional[FallbackAzureSpeechTranscriberLanguage] = pydantic.Field(default=None)
"""
This is the language that will be set for the transcription. The list of languages Azure supports can be found here: https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=stt
diff --git a/src/vapi/types/fallback_azure_voice.py b/src/vapi/types/fallback_azure_voice.py
index 2fc1907d..a85398ad 100644
--- a/src/vapi/types/fallback_azure_voice.py
+++ b/src/vapi/types/fallback_azure_voice.py
@@ -12,6 +12,10 @@
class FallbackAzureVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with Azure, including voice selection, speed, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_cartesia_transcriber.py b/src/vapi/types/fallback_cartesia_transcriber.py
index ea8a3e4d..1ea33eeb 100644
--- a/src/vapi/types/fallback_cartesia_transcriber.py
+++ b/src/vapi/types/fallback_cartesia_transcriber.py
@@ -10,8 +10,19 @@
class FallbackCartesiaTranscriber(UncheckedBaseModel):
- model: typing.Optional[FallbackCartesiaTranscriberModel] = None
- language: typing.Optional[FallbackCartesiaTranscriberLanguage] = None
+ """
+ Fallback configuration for transcribing speech with Cartesia, including model and language.
+ """
+
+ model: typing.Optional[FallbackCartesiaTranscriberModel] = pydantic.Field(default=None)
+ """
+ The Cartesia speech-to-text model used for transcription.
+ """
+
+ language: typing.Optional[FallbackCartesiaTranscriberLanguage] = pydantic.Field(default=None)
+ """
+ The language code used for transcription.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/fallback_cartesia_voice.py b/src/vapi/types/fallback_cartesia_voice.py
index 64c4f18d..6271cd4f 100644
--- a/src/vapi/types/fallback_cartesia_voice.py
+++ b/src/vapi/types/fallback_cartesia_voice.py
@@ -15,6 +15,10 @@
class FallbackCartesiaVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with Cartesia, including voice and model selection, language, generation controls, pronunciation dictionaries, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_custom_transcriber.py b/src/vapi/types/fallback_custom_transcriber.py
index 1fd3b583..0258c13f 100644
--- a/src/vapi/types/fallback_custom_transcriber.py
+++ b/src/vapi/types/fallback_custom_transcriber.py
@@ -9,6 +9,10 @@
class FallbackCustomTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for sending conversation audio to a custom WebSocket transcription server.
+ """
+
server: Server = pydantic.Field()
"""
This is where the transcription request will be sent.
diff --git a/src/vapi/types/fallback_custom_voice.py b/src/vapi/types/fallback_custom_voice.py
index 08efb6c9..b81a2c17 100644
--- a/src/vapi/types/fallback_custom_voice.py
+++ b/src/vapi/types/fallback_custom_voice.py
@@ -12,6 +12,10 @@
class FallbackCustomVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech through a custom server, including voice selection, server connection, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_deepgram_transcriber.py b/src/vapi/types/fallback_deepgram_transcriber.py
index 969a3f1a..b95b8dd9 100644
--- a/src/vapi/types/fallback_deepgram_transcriber.py
+++ b/src/vapi/types/fallback_deepgram_transcriber.py
@@ -12,6 +12,10 @@
class FallbackDeepgramTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for transcribing speech with Deepgram, including model, language, formatting, endpointing, and vocabulary.
+ """
+
model: typing.Optional[DeepgramTranscriberModel] = pydantic.Field(default=None)
"""
This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview
diff --git a/src/vapi/types/fallback_deepgram_voice.py b/src/vapi/types/fallback_deepgram_voice.py
index 95c44fbf..9ee7d811 100644
--- a/src/vapi/types/fallback_deepgram_voice.py
+++ b/src/vapi/types/fallback_deepgram_voice.py
@@ -13,6 +13,10 @@
class FallbackDeepgramVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with Deepgram, including voice and model selection, model-improvement preferences, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_eleven_labs_transcriber.py b/src/vapi/types/fallback_eleven_labs_transcriber.py
index 451db34e..66c9eea4 100644
--- a/src/vapi/types/fallback_eleven_labs_transcriber.py
+++ b/src/vapi/types/fallback_eleven_labs_transcriber.py
@@ -12,6 +12,10 @@
class FallbackElevenLabsTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for transcribing speech with ElevenLabs, including model, language, and speech thresholds.
+ """
+
model: typing.Optional[FallbackElevenLabsTranscriberModel] = pydantic.Field(default=None)
"""
This is the model that will be used for the transcription.
diff --git a/src/vapi/types/fallback_eleven_labs_voice.py b/src/vapi/types/fallback_eleven_labs_voice.py
index 8a6c9d13..75a7a9b4 100644
--- a/src/vapi/types/fallback_eleven_labs_voice.py
+++ b/src/vapi/types/fallback_eleven_labs_voice.py
@@ -14,6 +14,10 @@
class FallbackElevenLabsVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with ElevenLabs, including voice and model selection, language, voice tuning, streaming, Speech Synthesis Markup Language parsing, pronunciation dictionaries, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_gladia_transcriber.py b/src/vapi/types/fallback_gladia_transcriber.py
index 69e608a5..4bb2cd27 100644
--- a/src/vapi/types/fallback_gladia_transcriber.py
+++ b/src/vapi/types/fallback_gladia_transcriber.py
@@ -16,6 +16,10 @@
class FallbackGladiaTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for transcribing speech with Gladia, including language behavior, audio processing, endpointing, vocabulary, and region.
+ """
+
model: typing.Optional[FallbackGladiaTranscriberModel] = pydantic.Field(default=None)
"""
This is the Gladia model that will be used. Default is 'fast'
diff --git a/src/vapi/types/fallback_google_transcriber.py b/src/vapi/types/fallback_google_transcriber.py
index dbb53c41..21add710 100644
--- a/src/vapi/types/fallback_google_transcriber.py
+++ b/src/vapi/types/fallback_google_transcriber.py
@@ -10,6 +10,10 @@
class FallbackGoogleTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for transcribing speech with Google, including model and language.
+ """
+
model: typing.Optional[FallbackGoogleTranscriberModel] = pydantic.Field(default=None)
"""
This is the model that will be used for the transcription.
diff --git a/src/vapi/types/fallback_hume_voice.py b/src/vapi/types/fallback_hume_voice.py
index a5fe4279..ea7a980b 100644
--- a/src/vapi/types/fallback_hume_voice.py
+++ b/src/vapi/types/fallback_hume_voice.py
@@ -12,6 +12,10 @@
class FallbackHumeVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice metadata, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_inworld_voice.py b/src/vapi/types/fallback_inworld_voice.py
index 6e05a5d9..ee60a963 100644
--- a/src/vapi/types/fallback_inworld_voice.py
+++ b/src/vapi/types/fallback_inworld_voice.py
@@ -14,6 +14,10 @@
class FallbackInworldVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, temperature, speaking rate, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_lmnt_voice.py b/src/vapi/types/fallback_lmnt_voice.py
index 72a1b8e0..0b2318ab 100644
--- a/src/vapi/types/fallback_lmnt_voice.py
+++ b/src/vapi/types/fallback_lmnt_voice.py
@@ -13,6 +13,10 @@
class FallbackLmntVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_neuphonic_voice.py b/src/vapi/types/fallback_neuphonic_voice.py
index eb5bd169..6638592f 100644
--- a/src/vapi/types/fallback_neuphonic_voice.py
+++ b/src/vapi/types/fallback_neuphonic_voice.py
@@ -12,6 +12,10 @@
class FallbackNeuphonicVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, speed, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_open_ai_transcriber.py b/src/vapi/types/fallback_open_ai_transcriber.py
index 382b2658..181c8849 100644
--- a/src/vapi/types/fallback_open_ai_transcriber.py
+++ b/src/vapi/types/fallback_open_ai_transcriber.py
@@ -10,6 +10,10 @@
class FallbackOpenAiTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for transcribing speech with OpenAI, including model and language.
+ """
+
model: FallbackOpenAiTranscriberModel = pydantic.Field()
"""
This is the model that will be used for the transcription.
diff --git a/src/vapi/types/fallback_open_ai_voice.py b/src/vapi/types/fallback_open_ai_voice.py
index 29d6833d..9d3e15cf 100644
--- a/src/vapi/types/fallback_open_ai_voice.py
+++ b/src/vapi/types/fallback_open_ai_voice.py
@@ -13,6 +13,10 @@
class FallbackOpenAiVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery instructions, speed, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_plan.py b/src/vapi/types/fallback_plan.py
index 01bd7393..8eaef544 100644
--- a/src/vapi/types/fallback_plan.py
+++ b/src/vapi/types/fallback_plan.py
@@ -9,6 +9,10 @@
class FallbackPlan(UncheckedBaseModel):
+ """
+ Lists backup voice configurations that can be used if the primary voice provider fails.
+ """
+
voices: typing.List[FallbackPlanVoicesItem] = pydantic.Field()
"""
This is the list of voices to fallback to in the event that the primary voice provider fails.
diff --git a/src/vapi/types/fallback_play_ht_voice.py b/src/vapi/types/fallback_play_ht_voice.py
index a3493d74..64315d72 100644
--- a/src/vapi/types/fallback_play_ht_voice.py
+++ b/src/vapi/types/fallback_play_ht_voice.py
@@ -15,6 +15,10 @@
class FallbackPlayHtVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, emotion and style guidance, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_rime_ai_voice.py b/src/vapi/types/fallback_rime_ai_voice.py
index 34013dc0..0197714c 100644
--- a/src/vapi/types/fallback_rime_ai_voice.py
+++ b/src/vapi/types/fallback_rime_ai_voice.py
@@ -14,6 +14,10 @@
class FallbackRimeAiVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with Rime AI, including voice and model selection, language, speed, pauses, phonemization, latency, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_sesame_voice.py b/src/vapi/types/fallback_sesame_voice.py
index 3ebd8d5e..41e834ff 100644
--- a/src/vapi/types/fallback_sesame_voice.py
+++ b/src/vapi/types/fallback_sesame_voice.py
@@ -12,6 +12,10 @@
class FallbackSesameVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_smallest_ai_voice.py b/src/vapi/types/fallback_smallest_ai_voice.py
index 4c982e34..578f0cce 100644
--- a/src/vapi/types/fallback_smallest_ai_voice.py
+++ b/src/vapi/types/fallback_smallest_ai_voice.py
@@ -13,6 +13,10 @@
class FallbackSmallestAiVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_soniox_transcriber.py b/src/vapi/types/fallback_soniox_transcriber.py
index 36583c94..b5c2c481 100644
--- a/src/vapi/types/fallback_soniox_transcriber.py
+++ b/src/vapi/types/fallback_soniox_transcriber.py
@@ -12,6 +12,10 @@
class FallbackSonioxTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for transcribing speech with Soniox, including model, language detection, endpointing, and vocabulary.
+ """
+
model: typing.Optional[FallbackSonioxTranscriberModel] = pydantic.Field(default=None)
"""
The Soniox model to use for transcription.
diff --git a/src/vapi/types/fallback_speechmatics_transcriber.py b/src/vapi/types/fallback_speechmatics_transcriber.py
index e8e5952d..a248e114 100644
--- a/src/vapi/types/fallback_speechmatics_transcriber.py
+++ b/src/vapi/types/fallback_speechmatics_transcriber.py
@@ -16,12 +16,20 @@
class FallbackSpeechmaticsTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for transcribing speech with Speechmatics, including language, region, diarization, vocabulary, endpointing, and formatting.
+ """
+
model: typing.Optional[FallbackSpeechmaticsTranscriberModel] = pydantic.Field(default=None)
"""
This is the model that will be used for the transcription.
"""
- language: typing.Optional[FallbackSpeechmaticsTranscriberLanguage] = None
+ language: typing.Optional[FallbackSpeechmaticsTranscriberLanguage] = pydantic.Field(default=None)
+ """
+ Language used for transcription. Set to `auto` to detect the language automatically.
+ """
+
operating_point: typing_extensions.Annotated[
typing.Optional[FallbackSpeechmaticsTranscriberOperatingPoint],
FieldMetadata(alias="operatingPoint"),
@@ -56,7 +64,10 @@ class FallbackSpeechmaticsTranscriber(UncheckedBaseModel):
custom_vocabulary: typing_extensions.Annotated[
typing.List[SpeechmaticsCustomVocabularyItem],
FieldMetadata(alias="customVocabulary"),
- pydantic.Field(alias="customVocabulary"),
+ pydantic.Field(
+ alias="customVocabulary",
+ description="Words and phrases that Speechmatics should recognize more accurately, with optional phonetic alternatives.",
+ ),
]
numeral_style: typing_extensions.Annotated[
typing.Optional[FallbackSpeechmaticsTranscriberNumeralStyle],
diff --git a/src/vapi/types/fallback_talkscriber_transcriber.py b/src/vapi/types/fallback_talkscriber_transcriber.py
index 097497c9..3a6c93d9 100644
--- a/src/vapi/types/fallback_talkscriber_transcriber.py
+++ b/src/vapi/types/fallback_talkscriber_transcriber.py
@@ -10,6 +10,10 @@
class FallbackTalkscriberTranscriber(UncheckedBaseModel):
+ """
+ Fallback configuration for transcribing speech with Talkscriber, including model and language.
+ """
+
model: typing.Optional[FallbackTalkscriberTranscriberModel] = pydantic.Field(default=None)
"""
This is the model that will be used for the transcription.
diff --git a/src/vapi/types/fallback_tavus_voice.py b/src/vapi/types/fallback_tavus_voice.py
index aaa81155..bf0ac9e5 100644
--- a/src/vapi/types/fallback_tavus_voice.py
+++ b/src/vapi/types/fallback_tavus_voice.py
@@ -13,6 +13,10 @@
class FallbackTavusVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, conversation properties, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_transcriber_plan.py b/src/vapi/types/fallback_transcriber_plan.py
index f5143a01..99dc7013 100644
--- a/src/vapi/types/fallback_transcriber_plan.py
+++ b/src/vapi/types/fallback_transcriber_plan.py
@@ -9,7 +9,14 @@
class FallbackTranscriberPlan(UncheckedBaseModel):
- transcribers: typing.List[FallbackTranscriberPlanTranscribersItem]
+ """
+ Lists backup transcriber configurations that can be used if the primary transcriber fails.
+ """
+
+ transcribers: typing.List[FallbackTranscriberPlanTranscribersItem] = pydantic.Field()
+ """
+ Transcriber configurations available when the primary transcriber fails.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/fallback_vapi_voice.py b/src/vapi/types/fallback_vapi_voice.py
index 63f97402..6febbfe5 100644
--- a/src/vapi/types/fallback_vapi_voice.py
+++ b/src/vapi/types/fallback_vapi_voice.py
@@ -13,6 +13,10 @@
class FallbackVapiVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation dictionary, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/fallback_well_said_voice.py b/src/vapi/types/fallback_well_said_voice.py
index 299a3d8d..07097b17 100644
--- a/src/vapi/types/fallback_well_said_voice.py
+++ b/src/vapi/types/fallback_well_said_voice.py
@@ -12,6 +12,10 @@
class FallbackWellSaidVoice(UncheckedBaseModel):
+ """
+ Fallback configuration for synthesizing assistant speech with WellSaid, including voice and model selection, Speech Synthesis Markup Language support, voice libraries, chunking, and caching.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/file.py b/src/vapi/types/file.py
index b97971c1..3b7bef5c 100644
--- a/src/vapi/types/file.py
+++ b/src/vapi/types/file.py
@@ -13,30 +13,80 @@
class File(UncheckedBaseModel):
- object: typing.Optional[FileObject] = None
- status: typing.Optional[FileStatus] = None
+ """
+ An uploaded file record, including its processing status, storage details, extracted-text location, metadata, and lifecycle timestamps.
+ """
+
+ object: typing.Optional[FileObject] = pydantic.Field(default=None)
+ """
+ The object type. This is always `file`.
+ """
+
+ status: typing.Optional[FileStatus] = pydantic.Field(default=None)
+ """
+ The current processing status of the uploaded file.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the file. This is just for your own reference.
"""
original_name: typing_extensions.Annotated[
- typing.Optional[str], FieldMetadata(alias="originalName"), pydantic.Field(alias="originalName")
+ typing.Optional[str],
+ FieldMetadata(alias="originalName"),
+ pydantic.Field(alias="originalName", description="The original name of the uploaded file."),
] = None
- bytes: typing.Optional[float] = None
- purpose: typing.Optional[str] = None
- mimetype: typing.Optional[str] = None
- key: typing.Optional[str] = None
- path: typing.Optional[str] = None
- bucket: typing.Optional[str] = None
- url: typing.Optional[str] = None
+ bytes: typing.Optional[float] = pydantic.Field(default=None)
+ """
+ The size of the uploaded file in bytes.
+ """
+
+ purpose: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The intended use assigned to the uploaded file.
+ """
+
+ mimetype: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The MIME type of the uploaded file.
+ """
+
+ key: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The object-storage key for the uploaded file.
+ """
+
+ path: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The object-storage path for the uploaded file.
+ """
+
+ bucket: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The object-storage bucket containing the uploaded file.
+ """
+
+ url: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ The URL used to access the uploaded file.
+ """
+
parsed_text_url: typing_extensions.Annotated[
- typing.Optional[str], FieldMetadata(alias="parsedTextUrl"), pydantic.Field(alias="parsedTextUrl")
+ typing.Optional[str],
+ FieldMetadata(alias="parsedTextUrl"),
+ pydantic.Field(alias="parsedTextUrl", description="The URL used to access text extracted from the file."),
] = None
parsed_text_bytes: typing_extensions.Annotated[
- typing.Optional[float], FieldMetadata(alias="parsedTextBytes"), pydantic.Field(alias="parsedTextBytes")
+ typing.Optional[float],
+ FieldMetadata(alias="parsedTextBytes"),
+ pydantic.Field(alias="parsedTextBytes", description="The size of the extracted text in bytes."),
] = None
- metadata: typing.Optional[typing.Dict[str, typing.Any]] = None
+ metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+ """
+ Additional metadata associated with the uploaded file.
+ """
+
id: str = pydantic.Field()
"""
This is the unique identifier for the file.
diff --git a/src/vapi/types/filter_date_type_column_on_call_table.py b/src/vapi/types/filter_date_type_column_on_call_table.py
index ee66f6a5..78cedd92 100644
--- a/src/vapi/types/filter_date_type_column_on_call_table.py
+++ b/src/vapi/types/filter_date_type_column_on_call_table.py
@@ -10,6 +10,10 @@
class FilterDateTypeColumnOnCallTable(UncheckedBaseModel):
+ """
+ Filters call records by comparing a start or end timestamp with a date.
+ """
+
column: FilterDateTypeColumnOnCallTableColumn = pydantic.Field()
"""
This is the column in the call table that will be filtered on.
diff --git a/src/vapi/types/filter_number_array_type_column_on_call_table.py b/src/vapi/types/filter_number_array_type_column_on_call_table.py
index 5014fdfe..b4fd4b44 100644
--- a/src/vapi/types/filter_number_array_type_column_on_call_table.py
+++ b/src/vapi/types/filter_number_array_type_column_on_call_table.py
@@ -10,6 +10,10 @@
class FilterNumberArrayTypeColumnOnCallTable(UncheckedBaseModel):
+ """
+ Filters numeric call fields using a list of values or an emptiness test.
+ """
+
column: FilterNumberArrayTypeColumnOnCallTableColumn = pydantic.Field()
"""
This is the column in the call table that will be filtered on.
diff --git a/src/vapi/types/filter_number_type_column_on_call_table.py b/src/vapi/types/filter_number_type_column_on_call_table.py
index 1d4990b4..293b49f4 100644
--- a/src/vapi/types/filter_number_type_column_on_call_table.py
+++ b/src/vapi/types/filter_number_type_column_on_call_table.py
@@ -10,6 +10,10 @@
class FilterNumberTypeColumnOnCallTable(UncheckedBaseModel):
+ """
+ Filters call records by comparing a numeric field with a value.
+ """
+
column: FilterNumberTypeColumnOnCallTableColumn = pydantic.Field()
"""
This is the column in the call table that will be filtered on.
diff --git a/src/vapi/types/filter_string_array_type_column_on_call_table.py b/src/vapi/types/filter_string_array_type_column_on_call_table.py
index 5e788dcb..f0d5cb9f 100644
--- a/src/vapi/types/filter_string_array_type_column_on_call_table.py
+++ b/src/vapi/types/filter_string_array_type_column_on_call_table.py
@@ -10,6 +10,10 @@
class FilterStringArrayTypeColumnOnCallTable(UncheckedBaseModel):
+ """
+ Filters string-valued call fields using a list of values or an emptiness test.
+ """
+
column: FilterStringArrayTypeColumnOnCallTableColumn = pydantic.Field()
"""
This is the column in the call table that will be filtered on.
diff --git a/src/vapi/types/filter_string_type_column_on_call_table.py b/src/vapi/types/filter_string_type_column_on_call_table.py
index 67541d8c..d760d7a8 100644
--- a/src/vapi/types/filter_string_type_column_on_call_table.py
+++ b/src/vapi/types/filter_string_type_column_on_call_table.py
@@ -10,6 +10,10 @@
class FilterStringTypeColumnOnCallTable(UncheckedBaseModel):
+ """
+ Filters call records by comparing or searching a string-valued field.
+ """
+
column: FilterStringTypeColumnOnCallTableColumn = pydantic.Field()
"""
This is the column in the call table that will be filtered on.
diff --git a/src/vapi/types/filter_structured_output_column_on_call_table.py b/src/vapi/types/filter_structured_output_column_on_call_table.py
index 914a31d2..a49744d0 100644
--- a/src/vapi/types/filter_structured_output_column_on_call_table.py
+++ b/src/vapi/types/filter_structured_output_column_on_call_table.py
@@ -10,6 +10,10 @@
class FilterStructuredOutputColumnOnCallTable(UncheckedBaseModel):
+ """
+ Filters a structured-output value stored on a call using comparison, membership, containment, or emptiness operators.
+ """
+
column: FilterStructuredOutputColumnOnCallTableColumn = pydantic.Field()
"""
This is the column in the call table that will be filtered on.
diff --git a/src/vapi/types/format_plan.py b/src/vapi/types/format_plan.py
index 25374c8e..da26b168 100644
--- a/src/vapi/types/format_plan.py
+++ b/src/vapi/types/format_plan.py
@@ -12,6 +12,10 @@
class FormatPlan(UncheckedBaseModel):
+ """
+ Controls text normalization before voice synthesis, including built-in formatters, number handling, and custom replacements.
+ """
+
enabled: typing.Optional[bool] = pydantic.Field(default=None)
"""
This determines whether the chunk is formatted before being sent to the voice provider. This helps with enunciation. This includes phone numbers, emails and addresses. Default `true`.
diff --git a/src/vapi/types/fourier_denoising_plan.py b/src/vapi/types/fourier_denoising_plan.py
index 96331093..d2c25039 100644
--- a/src/vapi/types/fourier_denoising_plan.py
+++ b/src/vapi/types/fourier_denoising_plan.py
@@ -10,6 +10,10 @@
class FourierDenoisingPlan(UncheckedBaseModel):
+ """
+ Configuration for Fourier denoising, including media detection, thresholds, baseline calculation, and analysis window.
+ """
+
enabled: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether Fourier denoising is enabled. Note that this is experimental and may not work as expected.
diff --git a/src/vapi/types/function_tool.py b/src/vapi/types/function_tool.py
index b80d9f39..75bb6796 100644
--- a/src/vapi/types/function_tool.py
+++ b/src/vapi/types/function_tool.py
@@ -19,6 +19,10 @@
class FunctionTool(UncheckedBaseModel):
+ """
+ A reusable custom function tool that sends model-generated arguments to a configured server and returns the result to the assistant.
+ """
+
messages: typing.Optional[typing.List[FunctionToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/gcp_key.py b/src/vapi/types/gcp_key.py
index 13f4043e..4ad5e143 100644
--- a/src/vapi/types/gcp_key.py
+++ b/src/vapi/types/gcp_key.py
@@ -10,6 +10,10 @@
class GcpKey(UncheckedBaseModel):
+ """
+ Google Cloud service-account key used to authenticate access to Google Cloud resources.
+ """
+
type: str = pydantic.Field()
"""
This is the type of the key. Most likely, this is "service_account".
diff --git a/src/vapi/types/gemini_multimodal_live_prebuilt_voice_config.py b/src/vapi/types/gemini_multimodal_live_prebuilt_voice_config.py
index 236a71ae..947ee124 100644
--- a/src/vapi/types/gemini_multimodal_live_prebuilt_voice_config.py
+++ b/src/vapi/types/gemini_multimodal_live_prebuilt_voice_config.py
@@ -11,10 +11,14 @@
class GeminiMultimodalLivePrebuiltVoiceConfig(UncheckedBaseModel):
+ """
+ Selects a prebuilt voice for Gemini Multimodal Live audio output.
+ """
+
voice_name: typing_extensions.Annotated[
GeminiMultimodalLivePrebuiltVoiceConfigVoiceName,
FieldMetadata(alias="voiceName"),
- pydantic.Field(alias="voiceName"),
+ pydantic.Field(alias="voiceName", description="Prebuilt Gemini voice used for audio output."),
]
if IS_PYDANTIC_V2:
diff --git a/src/vapi/types/gemini_multimodal_live_speech_config.py b/src/vapi/types/gemini_multimodal_live_speech_config.py
index 3cfbc912..66853814 100644
--- a/src/vapi/types/gemini_multimodal_live_speech_config.py
+++ b/src/vapi/types/gemini_multimodal_live_speech_config.py
@@ -11,8 +11,16 @@
class GeminiMultimodalLiveSpeechConfig(UncheckedBaseModel):
+ """
+ Speech-output configuration for Gemini Multimodal Live.
+ """
+
voice_config: typing_extensions.Annotated[
- GeminiMultimodalLiveVoiceConfig, FieldMetadata(alias="voiceConfig"), pydantic.Field(alias="voiceConfig")
+ GeminiMultimodalLiveVoiceConfig,
+ FieldMetadata(alias="voiceConfig"),
+ pydantic.Field(
+ alias="voiceConfig", description="Voice configuration used for Gemini Multimodal Live speech output."
+ ),
]
if IS_PYDANTIC_V2:
diff --git a/src/vapi/types/gemini_multimodal_live_voice_config.py b/src/vapi/types/gemini_multimodal_live_voice_config.py
index 44a28f07..24f8118a 100644
--- a/src/vapi/types/gemini_multimodal_live_voice_config.py
+++ b/src/vapi/types/gemini_multimodal_live_voice_config.py
@@ -11,10 +11,16 @@
class GeminiMultimodalLiveVoiceConfig(UncheckedBaseModel):
+ """
+ Voice selection configuration for Gemini Multimodal Live.
+ """
+
prebuilt_voice_config: typing_extensions.Annotated[
GeminiMultimodalLivePrebuiltVoiceConfig,
FieldMetadata(alias="prebuiltVoiceConfig"),
- pydantic.Field(alias="prebuiltVoiceConfig"),
+ pydantic.Field(
+ alias="prebuiltVoiceConfig", description="Prebuilt voice used for Gemini Multimodal Live speech output."
+ ),
]
if IS_PYDANTIC_V2:
diff --git a/src/vapi/types/ghl_tool_metadata.py b/src/vapi/types/ghl_tool_metadata.py
index 2b88aa13..383ad1c9 100644
--- a/src/vapi/types/ghl_tool_metadata.py
+++ b/src/vapi/types/ghl_tool_metadata.py
@@ -10,11 +10,19 @@
class GhlToolMetadata(UncheckedBaseModel):
+ """
+ GHL workflow and location identifiers attached to a tool.
+ """
+
workflow_id: typing_extensions.Annotated[
- typing.Optional[str], FieldMetadata(alias="workflowId"), pydantic.Field(alias="workflowId")
+ typing.Optional[str],
+ FieldMetadata(alias="workflowId"),
+ pydantic.Field(alias="workflowId", description="GHL workflow identifier associated with the tool."),
] = None
location_id: typing_extensions.Annotated[
- typing.Optional[str], FieldMetadata(alias="locationId"), pydantic.Field(alias="locationId")
+ typing.Optional[str],
+ FieldMetadata(alias="locationId"),
+ pydantic.Field(alias="locationId", description="GHL location identifier associated with the tool."),
] = None
if IS_PYDANTIC_V2:
diff --git a/src/vapi/types/gladia_custom_vocabulary_config_dto.py b/src/vapi/types/gladia_custom_vocabulary_config_dto.py
index 06f5d160..554b08b5 100644
--- a/src/vapi/types/gladia_custom_vocabulary_config_dto.py
+++ b/src/vapi/types/gladia_custom_vocabulary_config_dto.py
@@ -11,6 +11,10 @@
class GladiaCustomVocabularyConfigDto(UncheckedBaseModel):
+ """
+ Custom vocabulary configuration for Gladia transcription, including vocabulary items and default recognition intensity.
+ """
+
vocabulary: typing.List[GladiaCustomVocabularyConfigDtoVocabularyItem] = pydantic.Field()
"""
Array of vocabulary items (strings or objects with value, pronunciations, intensity, language)
diff --git a/src/vapi/types/gladia_transcriber.py b/src/vapi/types/gladia_transcriber.py
index 14566ae4..dda19510 100644
--- a/src/vapi/types/gladia_transcriber.py
+++ b/src/vapi/types/gladia_transcriber.py
@@ -17,6 +17,10 @@
class GladiaTranscriber(UncheckedBaseModel):
+ """
+ Configuration for transcribing speech during assistant conversations with Gladia, including language behavior, audio processing, endpointing, vocabulary, region, and fallback settings.
+ """
+
model: typing.Optional[GladiaTranscriberModel] = pydantic.Field(default=None)
"""
This is the Gladia model that will be used. Default is 'fast'
diff --git a/src/vapi/types/gladia_vocabulary_item_dto.py b/src/vapi/types/gladia_vocabulary_item_dto.py
index b39a742f..798f422d 100644
--- a/src/vapi/types/gladia_vocabulary_item_dto.py
+++ b/src/vapi/types/gladia_vocabulary_item_dto.py
@@ -8,6 +8,10 @@
class GladiaVocabularyItemDto(UncheckedBaseModel):
+ """
+ A Gladia custom vocabulary word or phrase with optional pronunciations, intensity, and language.
+ """
+
value: str = pydantic.Field()
"""
The vocabulary word or phrase
diff --git a/src/vapi/types/global_node_plan.py b/src/vapi/types/global_node_plan.py
index 1b146813..b1cc3381 100644
--- a/src/vapi/types/global_node_plan.py
+++ b/src/vapi/types/global_node_plan.py
@@ -10,6 +10,10 @@
class GlobalNodePlan(UncheckedBaseModel):
+ """
+ Controls whether a conversation node can be entered globally and the condition evaluated before that node runs.
+ """
+
enabled: typing.Optional[bool] = pydantic.Field(default=None)
"""
This is the flag to determine if this node is a global node
diff --git a/src/vapi/types/go_high_level_calendar_availability_tool.py b/src/vapi/types/go_high_level_calendar_availability_tool.py
index 4402c2ce..550a8b37 100644
--- a/src/vapi/types/go_high_level_calendar_availability_tool.py
+++ b/src/vapi/types/go_high_level_calendar_availability_tool.py
@@ -15,6 +15,10 @@
class GoHighLevelCalendarAvailabilityTool(UncheckedBaseModel):
+ """
+ A reusable tool that checks calendar availability in a connected GoHighLevel account.
+ """
+
messages: typing.Optional[typing.List[GoHighLevelCalendarAvailabilityToolMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/go_high_level_calendar_event_create_tool.py b/src/vapi/types/go_high_level_calendar_event_create_tool.py
index bd9ee32a..996c64a0 100644
--- a/src/vapi/types/go_high_level_calendar_event_create_tool.py
+++ b/src/vapi/types/go_high_level_calendar_event_create_tool.py
@@ -15,6 +15,10 @@
class GoHighLevelCalendarEventCreateTool(UncheckedBaseModel):
+ """
+ A reusable tool that adds calendar events to a connected GoHighLevel account.
+ """
+
messages: typing.Optional[typing.List[GoHighLevelCalendarEventCreateToolMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/go_high_level_contact_create_tool.py b/src/vapi/types/go_high_level_contact_create_tool.py
index 6bfa0939..bee814aa 100644
--- a/src/vapi/types/go_high_level_contact_create_tool.py
+++ b/src/vapi/types/go_high_level_contact_create_tool.py
@@ -15,6 +15,10 @@
class GoHighLevelContactCreateTool(UncheckedBaseModel):
+ """
+ A reusable tool that adds contacts to a connected GoHighLevel account.
+ """
+
messages: typing.Optional[typing.List[GoHighLevelContactCreateToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/go_high_level_contact_get_tool.py b/src/vapi/types/go_high_level_contact_get_tool.py
index b0105260..ed3efa9f 100644
--- a/src/vapi/types/go_high_level_contact_get_tool.py
+++ b/src/vapi/types/go_high_level_contact_get_tool.py
@@ -15,6 +15,10 @@
class GoHighLevelContactGetTool(UncheckedBaseModel):
+ """
+ A reusable tool that retrieves contacts from a connected GoHighLevel account.
+ """
+
messages: typing.Optional[typing.List[GoHighLevelContactGetToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/google_calendar_check_availability_tool.py b/src/vapi/types/google_calendar_check_availability_tool.py
index c3fbc722..4bae67ed 100644
--- a/src/vapi/types/google_calendar_check_availability_tool.py
+++ b/src/vapi/types/google_calendar_check_availability_tool.py
@@ -15,6 +15,10 @@
class GoogleCalendarCheckAvailabilityTool(UncheckedBaseModel):
+ """
+ A reusable tool that checks availability in a connected Google Calendar.
+ """
+
messages: typing.Optional[typing.List[GoogleCalendarCheckAvailabilityToolMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/google_calendar_create_event_tool.py b/src/vapi/types/google_calendar_create_event_tool.py
index ecc09e7a..a37ac09f 100644
--- a/src/vapi/types/google_calendar_create_event_tool.py
+++ b/src/vapi/types/google_calendar_create_event_tool.py
@@ -15,6 +15,10 @@
class GoogleCalendarCreateEventTool(UncheckedBaseModel):
+ """
+ A reusable tool that adds events to a connected Google Calendar.
+ """
+
messages: typing.Optional[typing.List[GoogleCalendarCreateEventToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/google_model.py b/src/vapi/types/google_model.py
index c1f075e8..67355816 100644
--- a/src/vapi/types/google_model.py
+++ b/src/vapi/types/google_model.py
@@ -16,6 +16,10 @@
class GoogleModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with Google, including model, prompts, tools, knowledge-base access, realtime settings, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/google_realtime_config.py b/src/vapi/types/google_realtime_config.py
index 18818a3f..947cd528 100644
--- a/src/vapi/types/google_realtime_config.py
+++ b/src/vapi/types/google_realtime_config.py
@@ -11,6 +11,10 @@
class GoogleRealtimeConfig(UncheckedBaseModel):
+ """
+ Realtime Gemini generation and speech-output settings, including sampling, repetition penalties, and voice configuration.
+ """
+
top_p: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="topP"),
diff --git a/src/vapi/types/google_sheets_row_append_tool.py b/src/vapi/types/google_sheets_row_append_tool.py
index fc56b24b..e8629390 100644
--- a/src/vapi/types/google_sheets_row_append_tool.py
+++ b/src/vapi/types/google_sheets_row_append_tool.py
@@ -15,6 +15,10 @@
class GoogleSheetsRowAppendTool(UncheckedBaseModel):
+ """
+ A reusable tool that appends rows to a connected Google Sheet.
+ """
+
messages: typing.Optional[typing.List[GoogleSheetsRowAppendToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/google_transcriber.py b/src/vapi/types/google_transcriber.py
index 092cb05c..c816f20a 100644
--- a/src/vapi/types/google_transcriber.py
+++ b/src/vapi/types/google_transcriber.py
@@ -13,6 +13,10 @@
class GoogleTranscriber(UncheckedBaseModel):
+ """
+ Configuration for transcribing speech during assistant conversations with Google, including model, language, and fallback settings.
+ """
+
model: typing.Optional[GoogleTranscriberModel] = pydantic.Field(default=None)
"""
This is the model that will be used for the transcription.
diff --git a/src/vapi/types/google_voicemail_detection_plan.py b/src/vapi/types/google_voicemail_detection_plan.py
index 73420d06..00956253 100644
--- a/src/vapi/types/google_voicemail_detection_plan.py
+++ b/src/vapi/types/google_voicemail_detection_plan.py
@@ -13,6 +13,10 @@
class GoogleVoicemailDetectionPlan(UncheckedBaseModel):
+ """
+ Configuration for detecting voicemail with Google, including detection type, maximum beep wait, and retry backoff.
+ """
+
beep_max_await_seconds: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="beepMaxAwaitSeconds"),
diff --git a/src/vapi/types/groq_model.py b/src/vapi/types/groq_model.py
index 6f6c6172..3977154d 100644
--- a/src/vapi/types/groq_model.py
+++ b/src/vapi/types/groq_model.py
@@ -15,6 +15,10 @@
class GroqModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with Groq, including model, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/group_condition.py b/src/vapi/types/group_condition.py
index 9e55b704..a96cbae5 100644
--- a/src/vapi/types/group_condition.py
+++ b/src/vapi/types/group_condition.py
@@ -11,6 +11,10 @@
class GroupCondition(UncheckedBaseModel):
+ """
+ Combines nested regular-expression, Liquid, or grouped conditions with an `AND` or `OR` operator.
+ """
+
operator: GroupConditionOperator = pydantic.Field()
"""
This is the logical operator for combining conditions in this group
diff --git a/src/vapi/types/handoff_destination_assistant.py b/src/vapi/types/handoff_destination_assistant.py
index 3c413154..39f849b5 100644
--- a/src/vapi/types/handoff_destination_assistant.py
+++ b/src/vapi/types/handoff_destination_assistant.py
@@ -15,7 +15,15 @@
class HandoffDestinationAssistant(UncheckedBaseModel):
- type: HandoffDestinationAssistantType
+ """
+ Routes a handoff to a saved or transient assistant, with optional context engineering, variable extraction, and assistant overrides.
+ """
+
+ type: HandoffDestinationAssistantType = pydantic.Field()
+ """
+ Selects an assistant as the handoff destination.
+ """
+
context_engineering_plan: typing_extensions.Annotated[
typing.Optional[HandoffDestinationAssistantContextEngineeringPlan],
FieldMetadata(alias="contextEngineeringPlan"),
diff --git a/src/vapi/types/handoff_destination_dynamic.py b/src/vapi/types/handoff_destination_dynamic.py
index 520c8750..0ffa54b8 100644
--- a/src/vapi/types/handoff_destination_dynamic.py
+++ b/src/vapi/types/handoff_destination_dynamic.py
@@ -9,6 +9,10 @@
class HandoffDestinationDynamic(UncheckedBaseModel):
+ """
+ Uses a webhook response to select the handoff destination at runtime.
+ """
+
server: typing.Optional[Server] = pydantic.Field(default=None)
"""
This is where Vapi will send the handoff-destination-request webhook in a dynamic handoff.
diff --git a/src/vapi/types/handoff_destination_squad.py b/src/vapi/types/handoff_destination_squad.py
index c7be3f6b..f66d916f 100644
--- a/src/vapi/types/handoff_destination_squad.py
+++ b/src/vapi/types/handoff_destination_squad.py
@@ -14,6 +14,10 @@
class HandoffDestinationSquad(UncheckedBaseModel):
+ """
+ Routes a handoff to a saved or transient squad, with optional entry assistant, context engineering, variable extraction, and overrides.
+ """
+
context_engineering_plan: typing_extensions.Annotated[
typing.Optional[HandoffDestinationSquadContextEngineeringPlan],
FieldMetadata(alias="contextEngineeringPlan"),
diff --git a/src/vapi/types/handoff_tool.py b/src/vapi/types/handoff_tool.py
index 5fe21b45..c93ef0d5 100644
--- a/src/vapi/types/handoff_tool.py
+++ b/src/vapi/types/handoff_tool.py
@@ -17,6 +17,10 @@
class HandoffTool(UncheckedBaseModel):
+ """
+ A reusable tool that hands a conversation to another assistant, squad, or dynamically selected destination.
+ """
+
messages: typing.Optional[typing.List[HandoffToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/hmac_authentication_plan.py b/src/vapi/types/hmac_authentication_plan.py
index 667165a9..a105a059 100644
--- a/src/vapi/types/hmac_authentication_plan.py
+++ b/src/vapi/types/hmac_authentication_plan.py
@@ -12,6 +12,10 @@
class HmacAuthenticationPlan(UncheckedBaseModel):
+ """
+ Configuration for signing outbound requests with an HMAC secret, including algorithm, headers, payload format, and signature encoding.
+ """
+
secret_key: typing_extensions.Annotated[
str,
FieldMetadata(alias="secretKey"),
diff --git a/src/vapi/types/hume_voice.py b/src/vapi/types/hume_voice.py
index 2a032dc7..ecb1c488 100644
--- a/src/vapi/types/hume_voice.py
+++ b/src/vapi/types/hume_voice.py
@@ -13,6 +13,10 @@
class HumeVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with Hume, including model and voice selection, custom voice metadata, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/import_twilio_phone_number_dto.py b/src/vapi/types/import_twilio_phone_number_dto.py
index a49c8127..408a0233 100644
--- a/src/vapi/types/import_twilio_phone_number_dto.py
+++ b/src/vapi/types/import_twilio_phone_number_dto.py
@@ -13,6 +13,10 @@
class ImportTwilioPhoneNumberDto(UncheckedBaseModel):
+ """
+ Configuration for importing a Twilio phone number into Vapi, including Twilio credentials, routing target, fallback destination, hooks, SMS, and server settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[ImportTwilioPhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/inflection_ai_model.py b/src/vapi/types/inflection_ai_model.py
index 27bac9c8..c6facfab 100644
--- a/src/vapi/types/inflection_ai_model.py
+++ b/src/vapi/types/inflection_ai_model.py
@@ -15,6 +15,10 @@
class InflectionAiModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with Inflection AI, including model, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/insight.py b/src/vapi/types/insight.py
index 0a19b662..b3172df6 100644
--- a/src/vapi/types/insight.py
+++ b/src/vapi/types/insight.py
@@ -12,6 +12,10 @@
class Insight(UncheckedBaseModel):
+ """
+ A saved insight returned by the API, including its visualization type, identity, organization, and lifecycle timestamps.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
diff --git a/src/vapi/types/insight_formula.py b/src/vapi/types/insight_formula.py
index 3c371cf2..b3ae5166 100644
--- a/src/vapi/types/insight_formula.py
+++ b/src/vapi/types/insight_formula.py
@@ -8,6 +8,10 @@
class InsightFormula(UncheckedBaseModel):
+ """
+ A formula used to calculate an insight from its query results, with an optional display name.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the formula.
diff --git a/src/vapi/types/insight_paginated_response.py b/src/vapi/types/insight_paginated_response.py
index cbd1d6c6..e4eef830 100644
--- a/src/vapi/types/insight_paginated_response.py
+++ b/src/vapi/types/insight_paginated_response.py
@@ -10,8 +10,19 @@
class InsightPaginatedResponse(UncheckedBaseModel):
- results: typing.List[Insight]
- metadata: PaginationMeta
+ """
+ A paginated collection of saved reporting insights and metadata describing the result set.
+ """
+
+ results: typing.List[Insight] = pydantic.Field()
+ """
+ The reporting insights returned for the current page.
+ """
+
+ metadata: PaginationMeta = pydantic.Field()
+ """
+ Pagination metadata for the insight result set.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/insight_run_format_plan.py b/src/vapi/types/insight_run_format_plan.py
index 78de707d..70c31d96 100644
--- a/src/vapi/types/insight_run_format_plan.py
+++ b/src/vapi/types/insight_run_format_plan.py
@@ -9,6 +9,10 @@
class InsightRunFormatPlan(UncheckedBaseModel):
+ """
+ Selects whether an insight run returns raw data or Recharts-formatted data.
+ """
+
format: typing.Optional[InsightRunFormatPlanFormat] = pydantic.Field(default=None)
"""
This is the format of the data to return.
diff --git a/src/vapi/types/insight_run_response.py b/src/vapi/types/insight_run_response.py
index 91446dee..9bf0ad12 100644
--- a/src/vapi/types/insight_run_response.py
+++ b/src/vapi/types/insight_run_response.py
@@ -11,14 +11,34 @@
class InsightRunResponse(UncheckedBaseModel):
- id: str
- insight_id: typing_extensions.Annotated[str, FieldMetadata(alias="insightId"), pydantic.Field(alias="insightId")]
- org_id: typing_extensions.Annotated[str, FieldMetadata(alias="orgId"), pydantic.Field(alias="orgId")]
+ """
+ Metadata identifying a saved insight run and its lifecycle timestamps.
+ """
+
+ id: str = pydantic.Field()
+ """
+ The unique identifier for the insight run.
+ """
+
+ insight_id: typing_extensions.Annotated[
+ str,
+ FieldMetadata(alias="insightId"),
+ pydantic.Field(alias="insightId", description="The unique identifier for the insight that was run."),
+ ]
+ org_id: typing_extensions.Annotated[
+ str,
+ FieldMetadata(alias="orgId"),
+ pydantic.Field(alias="orgId", description="The unique identifier for the organization that owns the run."),
+ ]
created_at: typing_extensions.Annotated[
- dt.datetime, FieldMetadata(alias="createdAt"), pydantic.Field(alias="createdAt")
+ dt.datetime,
+ FieldMetadata(alias="createdAt"),
+ pydantic.Field(alias="createdAt", description="The ISO 8601 timestamp when the insight run was created."),
]
updated_at: typing_extensions.Annotated[
- dt.datetime, FieldMetadata(alias="updatedAt"), pydantic.Field(alias="updatedAt")
+ dt.datetime,
+ FieldMetadata(alias="updatedAt"),
+ pydantic.Field(alias="updatedAt", description="The ISO 8601 timestamp when the insight run was last updated."),
]
if IS_PYDANTIC_V2:
diff --git a/src/vapi/types/insight_time_range.py b/src/vapi/types/insight_time_range.py
index 73cafe69..03dfdc06 100644
--- a/src/vapi/types/insight_time_range.py
+++ b/src/vapi/types/insight_time_range.py
@@ -8,6 +8,10 @@
class InsightTimeRange(UncheckedBaseModel):
+ """
+ Start, end, and timezone used to limit an insight query by time.
+ """
+
start: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
"""
This is the start date for the time range.
diff --git a/src/vapi/types/insight_time_range_with_step.py b/src/vapi/types/insight_time_range_with_step.py
index c3958c11..e48d0258 100644
--- a/src/vapi/types/insight_time_range_with_step.py
+++ b/src/vapi/types/insight_time_range_with_step.py
@@ -9,6 +9,10 @@
class InsightTimeRangeWithStep(UncheckedBaseModel):
+ """
+ Start, end, timezone, and aggregation step used for a time-series insight query.
+ """
+
step: typing.Optional[InsightTimeRangeWithStepStep] = pydantic.Field(default=None)
"""
This is the group by step for aggregation.
diff --git a/src/vapi/types/inworld_voice.py b/src/vapi/types/inworld_voice.py
index 73218f4a..6934d773 100644
--- a/src/vapi/types/inworld_voice.py
+++ b/src/vapi/types/inworld_voice.py
@@ -15,6 +15,10 @@
class InworldVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with Inworld, including voice and model selection, language, temperature, speaking rate, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/json_query_on_call_table_with_number_type_column.py b/src/vapi/types/json_query_on_call_table_with_number_type_column.py
index b939a57e..307db56a 100644
--- a/src/vapi/types/json_query_on_call_table_with_number_type_column.py
+++ b/src/vapi/types/json_query_on_call_table_with_number_type_column.py
@@ -17,6 +17,10 @@
class JsonQueryOnCallTableWithNumberTypeColumn(UncheckedBaseModel):
+ """
+ VapiQL JSON query that aggregates a numeric call-table column with optional call filters.
+ """
+
type: JsonQueryOnCallTableWithNumberTypeColumnType = pydantic.Field()
"""
This is the type of query. Only allowed type is "vapiql-json".
diff --git a/src/vapi/types/json_query_on_call_table_with_string_type_column.py b/src/vapi/types/json_query_on_call_table_with_string_type_column.py
index a37bda9b..1c68c2be 100644
--- a/src/vapi/types/json_query_on_call_table_with_string_type_column.py
+++ b/src/vapi/types/json_query_on_call_table_with_string_type_column.py
@@ -17,6 +17,10 @@
class JsonQueryOnCallTableWithStringTypeColumn(UncheckedBaseModel):
+ """
+ VapiQL JSON query that counts values from a string-valued call-table column with optional call filters.
+ """
+
type: JsonQueryOnCallTableWithStringTypeColumnType = pydantic.Field()
"""
This is the type of query. Only allowed type is "vapiql-json".
diff --git a/src/vapi/types/json_query_on_call_table_with_structured_output_column.py b/src/vapi/types/json_query_on_call_table_with_structured_output_column.py
index 7cdd242b..b9bb3146 100644
--- a/src/vapi/types/json_query_on_call_table_with_structured_output_column.py
+++ b/src/vapi/types/json_query_on_call_table_with_structured_output_column.py
@@ -23,6 +23,10 @@
class JsonQueryOnCallTableWithStructuredOutputColumn(UncheckedBaseModel):
+ """
+ VapiQL JSON query that aggregates or counts a structured-output value stored on call records.
+ """
+
type: JsonQueryOnCallTableWithStructuredOutputColumnType = pydantic.Field()
"""
This is the type of query. Only allowed type is "vapiql-json".
diff --git a/src/vapi/types/json_query_on_events_table.py b/src/vapi/types/json_query_on_events_table.py
index 05e9289c..9368744a 100644
--- a/src/vapi/types/json_query_on_events_table.py
+++ b/src/vapi/types/json_query_on_events_table.py
@@ -13,6 +13,10 @@
class JsonQueryOnEventsTable(UncheckedBaseModel):
+ """
+ VapiQL JSON query that counts or calculates the percentage of matching events using optional typed event-data filters.
+ """
+
type: JsonQueryOnEventsTableType = pydantic.Field()
"""
This is the type of query. Only allowed type is "vapiql-json".
diff --git a/src/vapi/types/json_schema.py b/src/vapi/types/json_schema.py
index b6f68529..21fb2b7b 100644
--- a/src/vapi/types/json_schema.py
+++ b/src/vapi/types/json_schema.py
@@ -12,6 +12,10 @@
class JsonSchema(UncheckedBaseModel):
+ """
+ JSON Schema definition used to describe structured data for extraction, validation, or model output.
+ """
+
type: JsonSchemaType = pydantic.Field()
"""
This is the type of output you'd like.
diff --git a/src/vapi/types/keypad_input_plan.py b/src/vapi/types/keypad_input_plan.py
index a934a7ca..98a8bc4f 100644
--- a/src/vapi/types/keypad_input_plan.py
+++ b/src/vapi/types/keypad_input_plan.py
@@ -11,6 +11,10 @@
class KeypadInputPlan(UncheckedBaseModel):
+ """
+ Controls collection of dual-tone multi-frequency (DTMF) keypad input, including enablement, processing timeout, and delimiters.
+ """
+
enabled: typing.Optional[bool] = pydantic.Field(default=None)
"""
This keeps track of whether the user has enabled keypad input.
diff --git a/src/vapi/types/knowledge_base.py b/src/vapi/types/knowledge_base.py
index 0f09119d..51ffd1ee 100644
--- a/src/vapi/types/knowledge_base.py
+++ b/src/vapi/types/knowledge_base.py
@@ -12,6 +12,10 @@
class KnowledgeBase(UncheckedBaseModel):
+ """
+ A knowledge-base configuration, including its provider, model, description, and associated files.
+ """
+
name: str = pydantic.Field()
"""
The name of the knowledge base
diff --git a/src/vapi/types/knowledge_base_cost.py b/src/vapi/types/knowledge_base_cost.py
index 69c07475..69be3c7b 100644
--- a/src/vapi/types/knowledge_base_cost.py
+++ b/src/vapi/types/knowledge_base_cost.py
@@ -10,6 +10,10 @@
class KnowledgeBaseCost(UncheckedBaseModel):
+ """
+ Knowledge-base model cost, including model, token usage, and amount.
+ """
+
model: typing.Dict[str, typing.Any] = pydantic.Field()
"""
This is the model that was used for processing the knowledge base.
diff --git a/src/vapi/types/langfuse_observability_plan.py b/src/vapi/types/langfuse_observability_plan.py
index 203fc559..0876c68b 100644
--- a/src/vapi/types/langfuse_observability_plan.py
+++ b/src/vapi/types/langfuse_observability_plan.py
@@ -11,7 +11,15 @@
class LangfuseObservabilityPlan(UncheckedBaseModel):
- provider: LangfuseObservabilityPlanProvider
+ """
+ Configuration for sending assistant call traces to Langfuse, including prompt version linkage, trace naming, tags, and metadata.
+ """
+
+ provider: LangfuseObservabilityPlanProvider = pydantic.Field()
+ """
+ Routes assistant call observability data to Langfuse.
+ """
+
prompt_name: typing_extensions.Annotated[
typing.Optional[str],
FieldMetadata(alias="promptName"),
diff --git a/src/vapi/types/line_insight.py b/src/vapi/types/line_insight.py
index baf5328f..6306a4d9 100644
--- a/src/vapi/types/line_insight.py
+++ b/src/vapi/types/line_insight.py
@@ -16,6 +16,10 @@
class LineInsight(UncheckedBaseModel):
+ """
+ A saved line-chart insight containing its call-data queries, formulas, grouping, stepped time range, metadata, and lifecycle information.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -46,7 +50,11 @@ class LineInsight(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRangeWithStep], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRangeWithStep],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(
+ alias="timeRange", description="The time range and interval used to aggregate the line-chart data."
+ ),
] = None
group_by: typing_extensions.Annotated[
typing.Optional[LineInsightGroupBy],
diff --git a/src/vapi/types/line_insight_metadata.py b/src/vapi/types/line_insight_metadata.py
index 72b1ad03..7a3646ed 100644
--- a/src/vapi/types/line_insight_metadata.py
+++ b/src/vapi/types/line_insight_metadata.py
@@ -10,19 +10,34 @@
class LineInsightMetadata(UncheckedBaseModel):
+ """
+ Display settings for a line insight, including chart name, axis labels, and optional y-axis bounds.
+ """
+
x_axis_label: typing_extensions.Annotated[
- typing.Optional[str], FieldMetadata(alias="xAxisLabel"), pydantic.Field(alias="xAxisLabel")
+ typing.Optional[str],
+ FieldMetadata(alias="xAxisLabel"),
+ pydantic.Field(alias="xAxisLabel", description="Label displayed on the chart's x-axis."),
] = None
y_axis_label: typing_extensions.Annotated[
- typing.Optional[str], FieldMetadata(alias="yAxisLabel"), pydantic.Field(alias="yAxisLabel")
+ typing.Optional[str],
+ FieldMetadata(alias="yAxisLabel"),
+ pydantic.Field(alias="yAxisLabel", description="Label displayed on the chart's y-axis."),
] = None
y_axis_min: typing_extensions.Annotated[
- typing.Optional[float], FieldMetadata(alias="yAxisMin"), pydantic.Field(alias="yAxisMin")
+ typing.Optional[float],
+ FieldMetadata(alias="yAxisMin"),
+ pydantic.Field(alias="yAxisMin", description="Minimum value displayed on the chart's y-axis."),
] = None
y_axis_max: typing_extensions.Annotated[
- typing.Optional[float], FieldMetadata(alias="yAxisMax"), pydantic.Field(alias="yAxisMax")
+ typing.Optional[float],
+ FieldMetadata(alias="yAxisMax"),
+ pydantic.Field(alias="yAxisMax", description="Maximum value displayed on the chart's y-axis."),
] = None
- name: typing.Optional[str] = None
+ name: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Display name for the insight chart.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/liquid_condition.py b/src/vapi/types/liquid_condition.py
index 92be88f4..3bd74b24 100644
--- a/src/vapi/types/liquid_condition.py
+++ b/src/vapi/types/liquid_condition.py
@@ -8,6 +8,10 @@
class LiquidCondition(UncheckedBaseModel):
+ """
+ Evaluates a Liquid template that must return `true` or `false`.
+ """
+
liquid: str = pydantic.Field()
"""
This is the Liquid template that must return exactly "true" or "false" as a string.
diff --git a/src/vapi/types/livekit_smart_endpointing_plan.py b/src/vapi/types/livekit_smart_endpointing_plan.py
index d99834e2..25f7e13c 100644
--- a/src/vapi/types/livekit_smart_endpointing_plan.py
+++ b/src/vapi/types/livekit_smart_endpointing_plan.py
@@ -11,6 +11,10 @@
class LivekitSmartEndpointingPlan(UncheckedBaseModel):
+ """
+ Configuration for using LiveKit smart endpointing, including provider selection and wait-function behavior.
+ """
+
provider: LivekitSmartEndpointingPlanProvider = pydantic.Field()
"""
This is the provider for the smart endpointing plan.
diff --git a/src/vapi/types/lmnt_voice.py b/src/vapi/types/lmnt_voice.py
index f25a6e30..b31a57e4 100644
--- a/src/vapi/types/lmnt_voice.py
+++ b/src/vapi/types/lmnt_voice.py
@@ -14,6 +14,10 @@
class LmntVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with LMNT, including voice selection, language, speed, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/mcp_tool.py b/src/vapi/types/mcp_tool.py
index e4b3f9a8..c92da966 100644
--- a/src/vapi/types/mcp_tool.py
+++ b/src/vapi/types/mcp_tool.py
@@ -18,6 +18,10 @@
class McpTool(UncheckedBaseModel):
+ """
+ A reusable tool that connects an assistant to a Model Context Protocol server and exposes its available tools.
+ """
+
messages: typing.Optional[typing.List[McpToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
@@ -80,7 +84,10 @@ class McpTool(UncheckedBaseModel):
description="This is the plan to reject a tool call based on the conversation state.\n\n// Example 1: Reject endCall if user didn't say goodbye\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '(?i)\\\\b(bye|goodbye|farewell|see you later|take care)\\\\b',\n target: { position: -1, role: 'user' },\n negate: true // Reject if pattern does NOT match\n }]\n}\n```\n\n// Example 2: Reject transfer if user is actually asking a question\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '\\\\?',\n target: { position: -1, role: 'user' }\n }]\n}\n```\n\n// Example 3: Reject transfer if user didn't mention transfer recently\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 5 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' %}\n{% assign mentioned = false %}\n{% for msg in userMessages %}\n {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %}\n {% assign mentioned = true %}\n {% break %}\n {% endif %}\n{% endfor %}\n{% if mentioned %}\n false\n{% else %}\n true\n{% endif %}`\n }]\n}\n```\n\n// Example 4: Reject endCall if the bot is looping and trying to exit\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 6 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' | reverse %}\n{% if userMessages.size < 3 %}\n false\n{% else %}\n {% assign msg1 = userMessages[0].content | downcase %}\n {% assign msg2 = userMessages[1].content | downcase %}\n {% assign msg3 = userMessages[2].content | downcase %}\n {% comment %} Check for repetitive messages {% endcomment %}\n {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %}\n true\n {% comment %} Check for common loop phrases {% endcomment %}\n {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %}\n true\n {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %}\n true\n {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %}\n true\n {% else %}\n false\n {% endif %}\n{% endif %}`\n }]\n}\n```",
),
] = None
- metadata: typing.Optional[McpToolMetadata] = None
+ metadata: typing.Optional[McpToolMetadata] = pydantic.Field(default=None)
+ """
+ Connection metadata for the MCP server, including its communication protocol.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/mcp_tool_messages.py b/src/vapi/types/mcp_tool_messages.py
index 4d210cb6..b1effd6f 100644
--- a/src/vapi/types/mcp_tool_messages.py
+++ b/src/vapi/types/mcp_tool_messages.py
@@ -9,6 +9,10 @@
class McpToolMessages(UncheckedBaseModel):
+ """
+ Per-tool message overrides for a tool discovered through an MCP server.
+ """
+
name: str = pydantic.Field()
"""
The name of the tool from the MCP server.
diff --git a/src/vapi/types/mcp_tool_metadata.py b/src/vapi/types/mcp_tool_metadata.py
index c9e7c1db..a95b0d3a 100644
--- a/src/vapi/types/mcp_tool_metadata.py
+++ b/src/vapi/types/mcp_tool_metadata.py
@@ -9,6 +9,10 @@
class McpToolMetadata(UncheckedBaseModel):
+ """
+ Protocol metadata used to communicate with an MCP server.
+ """
+
protocol: typing.Optional[McpToolMetadataProtocol] = pydantic.Field(default=None)
"""
This is the protocol used for MCP communication. Defaults to Streamable HTTP.
diff --git a/src/vapi/types/message_add_hook_action.py b/src/vapi/types/message_add_hook_action.py
index 823ec0f7..09081885 100644
--- a/src/vapi/types/message_add_hook_action.py
+++ b/src/vapi/types/message_add_hook_action.py
@@ -11,6 +11,10 @@
class MessageAddHookAction(UncheckedBaseModel):
+ """
+ A hook action that adds an OpenAI-format message to the conversation and can trigger an assistant response.
+ """
+
message: OpenAiMessage = pydantic.Field()
"""
The message to add to the conversation in OpenAI format
diff --git a/src/vapi/types/message_target.py b/src/vapi/types/message_target.py
index b063231b..a6cfff0d 100644
--- a/src/vapi/types/message_target.py
+++ b/src/vapi/types/message_target.py
@@ -9,6 +9,10 @@
class MessageTarget(UncheckedBaseModel):
+ """
+ Selects a conversation message by participant role and position for condition evaluation.
+ """
+
role: typing.Optional[MessageTargetRole] = pydantic.Field(default=None)
"""
This is the role of the message to target.
diff --git a/src/vapi/types/minimax_llm_model.py b/src/vapi/types/minimax_llm_model.py
index 0b651809..4273360a 100644
--- a/src/vapi/types/minimax_llm_model.py
+++ b/src/vapi/types/minimax_llm_model.py
@@ -15,6 +15,10 @@
class MinimaxLlmModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with MiniMax, including model, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/minimax_voice.py b/src/vapi/types/minimax_voice.py
index 7668934d..3899a75a 100644
--- a/src/vapi/types/minimax_voice.py
+++ b/src/vapi/types/minimax_voice.py
@@ -16,6 +16,10 @@
class MinimaxVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with MiniMax, including voice and model selection, emotion, pitch, speed, volume, region, language, text normalization, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/model_cost.py b/src/vapi/types/model_cost.py
index 200d9484..1f8978b1 100644
--- a/src/vapi/types/model_cost.py
+++ b/src/vapi/types/model_cost.py
@@ -10,6 +10,10 @@
class ModelCost(UncheckedBaseModel):
+ """
+ Language-model cost for a call, including model, token usage, and amount.
+ """
+
model: typing.Dict[str, typing.Any] = pydantic.Field()
"""
This is the model that was used during the call.
diff --git a/src/vapi/types/monitor.py b/src/vapi/types/monitor.py
index 016d1ef6..dd23f619 100644
--- a/src/vapi/types/monitor.py
+++ b/src/vapi/types/monitor.py
@@ -11,7 +11,15 @@
class Monitor(UncheckedBaseModel):
- monitors: typing.Optional[typing.List[MonitorResult]] = None
+ """
+ Live monitoring data for a call, including attached monitor results and listening and control URLs.
+ """
+
+ monitors: typing.Optional[typing.List[MonitorResult]] = pydantic.Field(default=None)
+ """
+ Results produced by monitors attached to the call.
+ """
+
listen_url: typing_extensions.Annotated[
typing.Optional[str],
FieldMetadata(alias="listenUrl"),
diff --git a/src/vapi/types/monitor_plan.py b/src/vapi/types/monitor_plan.py
index 4aaa9f1d..c4598d9b 100644
--- a/src/vapi/types/monitor_plan.py
+++ b/src/vapi/types/monitor_plan.py
@@ -10,6 +10,10 @@
class MonitorPlan(UncheckedBaseModel):
+ """
+ Controls real-time listening and control for assistant calls, authentication requirements for monitor URLs, and attached monitors.
+ """
+
listen_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="listenEnabled"),
@@ -47,7 +51,7 @@ class MonitorPlan(UncheckedBaseModel):
FieldMetadata(alias="monitorIds"),
pydantic.Field(
alias="monitorIds",
- description="This the set of monitor ids that are attached to the assistant.\nThe source of truth for the monitor ids is the assistant_monitor join table.\nThis field can be used for transient assistants and to update assistants with new monitor ids.\n\n@default []",
+ description="IDs of the monitors attached to the assistant. Use this field for transient assistants or to update the monitors attached to an existing assistant. Defaults to an empty array.",
),
] = None
diff --git a/src/vapi/types/monitor_result.py b/src/vapi/types/monitor_result.py
index 85906a14..729f9953 100644
--- a/src/vapi/types/monitor_result.py
+++ b/src/vapi/types/monitor_result.py
@@ -10,9 +10,19 @@
class MonitorResult(UncheckedBaseModel):
- monitor_id: typing_extensions.Annotated[str, FieldMetadata(alias="monitorId"), pydantic.Field(alias="monitorId")]
+ """
+ Result of evaluating an attached monitor's filter for a call.
+ """
+
+ monitor_id: typing_extensions.Annotated[
+ str,
+ FieldMetadata(alias="monitorId"),
+ pydantic.Field(alias="monitorId", description="Unique identifier of the monitor that produced this result."),
+ ]
filter_passed: typing_extensions.Annotated[
- bool, FieldMetadata(alias="filterPassed"), pydantic.Field(alias="filterPassed")
+ bool,
+ FieldMetadata(alias="filterPassed"),
+ pydantic.Field(alias="filterPassed", description="Whether the monitor's filter matched the call."),
]
if IS_PYDANTIC_V2:
diff --git a/src/vapi/types/mono.py b/src/vapi/types/mono.py
index 0bba6562..53c39871 100644
--- a/src/vapi/types/mono.py
+++ b/src/vapi/types/mono.py
@@ -10,6 +10,10 @@
class Mono(UncheckedBaseModel):
+ """
+ Mono recording URLs for the combined call and isolated assistant and customer audio.
+ """
+
combined_url: typing_extensions.Annotated[
typing.Optional[str],
FieldMetadata(alias="combinedUrl"),
diff --git a/src/vapi/types/neuphonic_voice.py b/src/vapi/types/neuphonic_voice.py
index 0a12a4ce..6d074fce 100644
--- a/src/vapi/types/neuphonic_voice.py
+++ b/src/vapi/types/neuphonic_voice.py
@@ -13,6 +13,10 @@
class NeuphonicVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with Neuphonic, including voice and model selection, language, speed, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/node_artifact.py b/src/vapi/types/node_artifact.py
index b0563165..c3806e7f 100644
--- a/src/vapi/types/node_artifact.py
+++ b/src/vapi/types/node_artifact.py
@@ -11,6 +11,10 @@
class NodeArtifact(UncheckedBaseModel):
+ """
+ Messages and variable values captured while a workflow node was active.
+ """
+
messages: typing.Optional[typing.List[NodeArtifactMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that were spoken during the node.
diff --git a/src/vapi/types/o_auth_2_authentication_plan.py b/src/vapi/types/o_auth_2_authentication_plan.py
index 2c02aecf..154e543f 100644
--- a/src/vapi/types/o_auth_2_authentication_plan.py
+++ b/src/vapi/types/o_auth_2_authentication_plan.py
@@ -11,7 +11,15 @@
class OAuth2AuthenticationPlan(UncheckedBaseModel):
- type: OAuth2AuthenticationPlanType
+ """
+ Client-credentials configuration for obtaining an OAuth 2.0 access token used to authenticate outbound requests.
+ """
+
+ type: OAuth2AuthenticationPlanType = pydantic.Field()
+ """
+ Selects OAuth 2.0 authentication.
+ """
+
url: str = pydantic.Field()
"""
This is the OAuth2 URL.
diff --git a/src/vapi/types/oauth_2_authentication_session.py b/src/vapi/types/oauth_2_authentication_session.py
index b81f7247..eef6ba72 100644
--- a/src/vapi/types/oauth_2_authentication_session.py
+++ b/src/vapi/types/oauth_2_authentication_session.py
@@ -11,6 +11,10 @@
class Oauth2AuthenticationSession(UncheckedBaseModel):
+ """
+ OAuth 2.0 session tokens and expiration used to authenticate integration requests.
+ """
+
access_token: typing_extensions.Annotated[
typing.Optional[str],
FieldMetadata(alias="accessToken"),
diff --git a/src/vapi/types/open_ai_function.py b/src/vapi/types/open_ai_function.py
index 4cd13861..92632344 100644
--- a/src/vapi/types/open_ai_function.py
+++ b/src/vapi/types/open_ai_function.py
@@ -11,6 +11,10 @@
class OpenAiFunction(UncheckedBaseModel):
+ """
+ Function definition exposed to a language model, including its name, purpose, parameter schema, and strict-schema behavior.
+ """
+
strict: typing.Optional[bool] = pydantic.Field(default=None)
"""
This is a boolean that controls whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the [OpenAI guide](https://openai.com/index/introducing-structured-outputs-in-the-api/).
diff --git a/src/vapi/types/open_ai_function_parameters.py b/src/vapi/types/open_ai_function_parameters.py
index e711cfc2..6818667c 100644
--- a/src/vapi/types/open_ai_function_parameters.py
+++ b/src/vapi/types/open_ai_function_parameters.py
@@ -11,6 +11,10 @@
class OpenAiFunctionParameters(UncheckedBaseModel):
+ """
+ JSON object schema defining the properties accepted by a function and which properties are required.
+ """
+
type: OpenAiFunctionParametersType = pydantic.Field()
"""
This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.
diff --git a/src/vapi/types/open_ai_message.py b/src/vapi/types/open_ai_message.py
index ded0058f..a55c1806 100644
--- a/src/vapi/types/open_ai_message.py
+++ b/src/vapi/types/open_ai_message.py
@@ -9,8 +9,19 @@
class OpenAiMessage(UncheckedBaseModel):
- content: typing.Optional[str] = None
- role: OpenAiMessageRole
+ """
+ A conversation message represented in OpenAI chat format.
+ """
+
+ content: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Content of the conversation message.
+ """
+
+ role: OpenAiMessageRole = pydantic.Field()
+ """
+ Role associated with the conversation message.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/open_ai_model.py b/src/vapi/types/open_ai_model.py
index c25efd0d..5edcf213 100644
--- a/src/vapi/types/open_ai_model.py
+++ b/src/vapi/types/open_ai_model.py
@@ -18,6 +18,10 @@
class OpenAiModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with OpenAI, including model selection, fallback models, prompts, tools, prompt caching, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/open_ai_transcriber.py b/src/vapi/types/open_ai_transcriber.py
index 82b52c22..a0d99b56 100644
--- a/src/vapi/types/open_ai_transcriber.py
+++ b/src/vapi/types/open_ai_transcriber.py
@@ -13,6 +13,10 @@
class OpenAiTranscriber(UncheckedBaseModel):
+ """
+ Configuration for transcribing speech during assistant conversations with OpenAI, including model, language, and fallback settings.
+ """
+
model: OpenAiTranscriberModel = pydantic.Field()
"""
This is the model that will be used for the transcription.
diff --git a/src/vapi/types/open_ai_voice.py b/src/vapi/types/open_ai_voice.py
index eca89c95..4ae4e2c5 100644
--- a/src/vapi/types/open_ai_voice.py
+++ b/src/vapi/types/open_ai_voice.py
@@ -14,6 +14,10 @@
class OpenAiVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with OpenAI, including voice and model selection, delivery instructions, speed, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/open_ai_voicemail_detection_plan.py b/src/vapi/types/open_ai_voicemail_detection_plan.py
index cdc9f248..b100d3e6 100644
--- a/src/vapi/types/open_ai_voicemail_detection_plan.py
+++ b/src/vapi/types/open_ai_voicemail_detection_plan.py
@@ -13,6 +13,10 @@
class OpenAiVoicemailDetectionPlan(UncheckedBaseModel):
+ """
+ Configuration for detecting voicemail with OpenAI, including detection type, maximum beep wait, and retry backoff.
+ """
+
beep_max_await_seconds: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="beepMaxAwaitSeconds"),
diff --git a/src/vapi/types/open_router_model.py b/src/vapi/types/open_router_model.py
index 3f4faaf5..fc4dc060 100644
--- a/src/vapi/types/open_router_model.py
+++ b/src/vapi/types/open_router_model.py
@@ -14,6 +14,10 @@
class OpenRouterModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses through OpenRouter, including routed model selection, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/pagination_meta.py b/src/vapi/types/pagination_meta.py
index 8edfc7e0..aa430dc6 100644
--- a/src/vapi/types/pagination_meta.py
+++ b/src/vapi/types/pagination_meta.py
@@ -11,23 +11,46 @@
class PaginationMeta(UncheckedBaseModel):
+ """
+ Pagination and retention metadata returned with a paginated list of phone numbers.
+ """
+
items_per_page: typing_extensions.Annotated[
- float, FieldMetadata(alias="itemsPerPage"), pydantic.Field(alias="itemsPerPage")
+ float,
+ FieldMetadata(alias="itemsPerPage"),
+ pydantic.Field(alias="itemsPerPage", description="The number of phone numbers returned per page."),
]
total_items: typing_extensions.Annotated[
- float, FieldMetadata(alias="totalItems"), pydantic.Field(alias="totalItems")
+ float,
+ FieldMetadata(alias="totalItems"),
+ pydantic.Field(alias="totalItems", description="The total number of phone numbers matching the request."),
]
current_page: typing_extensions.Annotated[
- float, FieldMetadata(alias="currentPage"), pydantic.Field(alias="currentPage")
+ float,
+ FieldMetadata(alias="currentPage"),
+ pydantic.Field(alias="currentPage", description="The current page number."),
]
items_beyond_retention: typing_extensions.Annotated[
- typing.Optional[bool], FieldMetadata(alias="itemsBeyondRetention"), pydantic.Field(alias="itemsBeyondRetention")
+ typing.Optional[bool],
+ FieldMetadata(alias="itemsBeyondRetention"),
+ pydantic.Field(
+ alias="itemsBeyondRetention",
+ description="Whether additional matching phone numbers exist beyond the organization's data-retention window.",
+ ),
] = None
created_at_le: typing_extensions.Annotated[
- typing.Optional[dt.datetime], FieldMetadata(alias="createdAtLe"), pydantic.Field(alias="createdAtLe")
+ typing.Optional[dt.datetime],
+ FieldMetadata(alias="createdAtLe"),
+ pydantic.Field(
+ alias="createdAtLe", description="The inclusive upper creation-time boundary applied to the result set."
+ ),
] = None
created_at_ge: typing_extensions.Annotated[
- typing.Optional[dt.datetime], FieldMetadata(alias="createdAtGe"), pydantic.Field(alias="createdAtGe")
+ typing.Optional[dt.datetime],
+ FieldMetadata(alias="createdAtGe"),
+ pydantic.Field(
+ alias="createdAtGe", description="The inclusive lower creation-time boundary applied to the result set."
+ ),
] = None
if IS_PYDANTIC_V2:
diff --git a/src/vapi/types/performance_metrics.py b/src/vapi/types/performance_metrics.py
index df7a3bb4..530d3f5d 100644
--- a/src/vapi/types/performance_metrics.py
+++ b/src/vapi/types/performance_metrics.py
@@ -11,6 +11,10 @@
class PerformanceMetrics(UncheckedBaseModel):
+ """
+ Call performance measurements, including per-turn and average provider, endpointing, transport, and interruption metrics.
+ """
+
turn_latencies: typing_extensions.Annotated[
typing.Optional[typing.List[TurnLatency]],
FieldMetadata(alias="turnLatencies"),
diff --git a/src/vapi/types/perplexity_ai_model.py b/src/vapi/types/perplexity_ai_model.py
index 3daa3043..ab915b0c 100644
--- a/src/vapi/types/perplexity_ai_model.py
+++ b/src/vapi/types/perplexity_ai_model.py
@@ -14,6 +14,10 @@
class PerplexityAiModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with Perplexity AI, including model, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/phone_number_call_ending_hook_filter.py b/src/vapi/types/phone_number_call_ending_hook_filter.py
index 99fa4420..bd58b62e 100644
--- a/src/vapi/types/phone_number_call_ending_hook_filter.py
+++ b/src/vapi/types/phone_number_call_ending_hook_filter.py
@@ -13,6 +13,10 @@
class PhoneNumberCallEndingHookFilter(UncheckedBaseModel):
+ """
+ Matches the call's ended reason against configured assistant-request failure reasons before an ending hook runs.
+ """
+
type: PhoneNumberCallEndingHookFilterType = pydantic.Field()
"""
This is the type of filter - currently only "oneOf" is supported
diff --git a/src/vapi/types/phone_number_call_ringing_hook_filter.py b/src/vapi/types/phone_number_call_ringing_hook_filter.py
index 4b2150db..b53d9760 100644
--- a/src/vapi/types/phone_number_call_ringing_hook_filter.py
+++ b/src/vapi/types/phone_number_call_ringing_hook_filter.py
@@ -12,6 +12,10 @@
class PhoneNumberCallRingingHookFilter(UncheckedBaseModel):
+ """
+ Matches an incoming caller's phone number against one or more prefixes before a ringing hook runs.
+ """
+
type: PhoneNumberCallRingingHookFilterType = pydantic.Field()
"""
This is the type of filter - matches when the specified field starts with any of the given prefixes
diff --git a/src/vapi/types/phone_number_hook_call_ending.py b/src/vapi/types/phone_number_hook_call_ending.py
index 6e3a24e0..574741d4 100644
--- a/src/vapi/types/phone_number_hook_call_ending.py
+++ b/src/vapi/types/phone_number_hook_call_ending.py
@@ -10,6 +10,10 @@
class PhoneNumberHookCallEnding(UncheckedBaseModel):
+ """
+ Runs configured transfer or message actions when a call ends with a matching assistant-request failure reason.
+ """
+
filters: typing.Optional[typing.List[PhoneNumberCallEndingHookFilter]] = pydantic.Field(default=None)
"""
Optional filters to decide when to trigger - restricted to assistant-request related ended reasons
diff --git a/src/vapi/types/phone_number_hook_call_ringing.py b/src/vapi/types/phone_number_hook_call_ringing.py
index 012380c7..038724e7 100644
--- a/src/vapi/types/phone_number_hook_call_ringing.py
+++ b/src/vapi/types/phone_number_hook_call_ringing.py
@@ -10,6 +10,10 @@
class PhoneNumberHookCallRinging(UncheckedBaseModel):
+ """
+ Runs configured transfer or message actions when an incoming call rings and its caller-number prefix filters match.
+ """
+
filters: typing.Optional[typing.List[PhoneNumberCallRingingHookFilter]] = pydantic.Field(default=None)
"""
Optional filters to decide when to trigger the hook. Currently supports filtering by caller country code.
diff --git a/src/vapi/types/phone_number_paginated_response.py b/src/vapi/types/phone_number_paginated_response.py
index c84f786d..3c6cc2f6 100644
--- a/src/vapi/types/phone_number_paginated_response.py
+++ b/src/vapi/types/phone_number_paginated_response.py
@@ -10,6 +10,10 @@
class PhoneNumberPaginatedResponse(UncheckedBaseModel):
+ """
+ A paginated collection of phone numbers and metadata describing the result set.
+ """
+
results: typing.List[PhoneNumberPaginatedResponseResultsItem] = pydantic.Field()
"""
A list of phone numbers, which can be of any provider type.
diff --git a/src/vapi/types/pie_insight.py b/src/vapi/types/pie_insight.py
index 68f6171b..a638367f 100644
--- a/src/vapi/types/pie_insight.py
+++ b/src/vapi/types/pie_insight.py
@@ -15,6 +15,10 @@
class PieInsight(UncheckedBaseModel):
+ """
+ A saved pie-chart insight containing its call-data queries, formulas, grouping, time range, and lifecycle information.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -40,7 +44,9 @@ class PieInsight(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRange], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRange],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(alias="timeRange", description="The time range used to query the pie-chart data."),
] = None
group_by: typing_extensions.Annotated[
typing.Optional[PieInsightGroupBy],
diff --git a/src/vapi/types/play_ht_voice.py b/src/vapi/types/play_ht_voice.py
index b01b5f85..2544d984 100644
--- a/src/vapi/types/play_ht_voice.py
+++ b/src/vapi/types/play_ht_voice.py
@@ -16,6 +16,10 @@
class PlayHtVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with PlayHT, including voice and model selection, language, emotion and style guidance, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/prompt_injection_security_filter.py b/src/vapi/types/prompt_injection_security_filter.py
index 05fd3f7f..fbf6733f 100644
--- a/src/vapi/types/prompt_injection_security_filter.py
+++ b/src/vapi/types/prompt_injection_security_filter.py
@@ -9,6 +9,10 @@
class PromptInjectionSecurityFilter(UncheckedBaseModel):
+ """
+ Filters potential prompt-injection patterns from transcripts.
+ """
+
type: PromptInjectionSecurityFilterType = pydantic.Field()
"""
The type of security threat to filter.
diff --git a/src/vapi/types/provider_resource.py b/src/vapi/types/provider_resource.py
index 641ff34d..ec2a4929 100644
--- a/src/vapi/types/provider_resource.py
+++ b/src/vapi/types/provider_resource.py
@@ -13,6 +13,10 @@
class ProviderResource(UncheckedBaseModel):
+ """
+ A provider-managed pronunciation-dictionary resource mirrored in Vapi, including its provider identifiers, resource data, and lifecycle information.
+ """
+
id: str = pydantic.Field()
"""
This is the unique identifier for the provider resource.
diff --git a/src/vapi/types/provider_resource_paginated_response.py b/src/vapi/types/provider_resource_paginated_response.py
index 93965a08..a86528d2 100644
--- a/src/vapi/types/provider_resource_paginated_response.py
+++ b/src/vapi/types/provider_resource_paginated_response.py
@@ -10,8 +10,19 @@
class ProviderResourcePaginatedResponse(UncheckedBaseModel):
- results: typing.List[ProviderResource]
- metadata: PaginationMeta
+ """
+ A paginated collection of provider resources and metadata describing the result set.
+ """
+
+ results: typing.List[ProviderResource] = pydantic.Field()
+ """
+ The provider resources returned for the current page.
+ """
+
+ metadata: PaginationMeta = pydantic.Field()
+ """
+ Pagination metadata for the provider-resource result set.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/public_key_encryption_plan.py b/src/vapi/types/public_key_encryption_plan.py
index abdac7fb..fc0960f6 100644
--- a/src/vapi/types/public_key_encryption_plan.py
+++ b/src/vapi/types/public_key_encryption_plan.py
@@ -12,6 +12,10 @@
class PublicKeyEncryptionPlan(UncheckedBaseModel):
+ """
+ Configuration for encrypting sensitive outbound request data with a public key.
+ """
+
algorithm: PublicKeyEncryptionPlanAlgorithm = pydantic.Field()
"""
The encryption algorithm to use.
diff --git a/src/vapi/types/query_tool.py b/src/vapi/types/query_tool.py
index e7a98610..6f6b994c 100644
--- a/src/vapi/types/query_tool.py
+++ b/src/vapi/types/query_tool.py
@@ -16,6 +16,10 @@
class QueryTool(UncheckedBaseModel):
+ """
+ A reusable tool that searches configured knowledge bases and returns relevant content to the assistant.
+ """
+
messages: typing.Optional[typing.List[QueryToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/rce_security_filter.py b/src/vapi/types/rce_security_filter.py
index d39f9de6..85dcb91a 100644
--- a/src/vapi/types/rce_security_filter.py
+++ b/src/vapi/types/rce_security_filter.py
@@ -9,6 +9,10 @@
class RceSecurityFilter(UncheckedBaseModel):
+ """
+ Filters potential remote code execution (RCE) patterns from transcripts.
+ """
+
type: RceSecurityFilterType = pydantic.Field()
"""
The type of security threat to filter.
diff --git a/src/vapi/types/recording.py b/src/vapi/types/recording.py
index 16d98e6d..bf748b92 100644
--- a/src/vapi/types/recording.py
+++ b/src/vapi/types/recording.py
@@ -11,6 +11,10 @@
class Recording(UncheckedBaseModel):
+ """
+ Call recording locations, including stereo, video, and separated mono recording URLs.
+ """
+
stereo_url: typing_extensions.Annotated[
typing.Optional[str],
FieldMetadata(alias="stereoUrl"),
diff --git a/src/vapi/types/recording_consent.py b/src/vapi/types/recording_consent.py
index 138dde69..5a4d0b9f 100644
--- a/src/vapi/types/recording_consent.py
+++ b/src/vapi/types/recording_consent.py
@@ -11,6 +11,10 @@
class RecordingConsent(UncheckedBaseModel):
+ """
+ Result of the recording-consent flow, including consent type and the time consent was granted.
+ """
+
type: typing.Dict[str, typing.Any] = pydantic.Field()
"""
This is the type of recording consent.
diff --git a/src/vapi/types/recording_consent_plan_stay_on_line.py b/src/vapi/types/recording_consent_plan_stay_on_line.py
index 8290702e..1066cb5a 100644
--- a/src/vapi/types/recording_consent_plan_stay_on_line.py
+++ b/src/vapi/types/recording_consent_plan_stay_on_line.py
@@ -11,6 +11,10 @@
class RecordingConsentPlanStayOnLine(UncheckedBaseModel):
+ """
+ Configuration for requesting recording consent by treating continued presence on the call as consent, including the announcement voice and wait time.
+ """
+
message: str = pydantic.Field()
"""
This is the message asking for consent to record the call.
diff --git a/src/vapi/types/recording_consent_plan_verbal.py b/src/vapi/types/recording_consent_plan_verbal.py
index ce1a491a..de4d1c61 100644
--- a/src/vapi/types/recording_consent_plan_verbal.py
+++ b/src/vapi/types/recording_consent_plan_verbal.py
@@ -11,6 +11,10 @@
class RecordingConsentPlanVerbal(UncheckedBaseModel):
+ """
+ Configuration for requesting explicit verbal recording consent, including the announcement voice and action to take when the customer declines.
+ """
+
message: str = pydantic.Field()
"""
This is the message asking for consent to record the call.
diff --git a/src/vapi/types/regex_condition.py b/src/vapi/types/regex_condition.py
index d8dd2658..81e5db67 100644
--- a/src/vapi/types/regex_condition.py
+++ b/src/vapi/types/regex_condition.py
@@ -9,6 +9,10 @@
class RegexCondition(UncheckedBaseModel):
+ """
+ Evaluates whether targeted conversation-message content matches a regular expression.
+ """
+
regex: str = pydantic.Field()
"""
This is the regular expression pattern to match against message content.
diff --git a/src/vapi/types/regex_option.py b/src/vapi/types/regex_option.py
index b2821094..c824ade2 100644
--- a/src/vapi/types/regex_option.py
+++ b/src/vapi/types/regex_option.py
@@ -9,6 +9,10 @@
class RegexOption(UncheckedBaseModel):
+ """
+ Enables or disables one regular-expression matching option for a text replacement.
+ """
+
type: RegexOptionType = pydantic.Field()
"""
This is the type of the regex option. Options are:
diff --git a/src/vapi/types/regex_replacement.py b/src/vapi/types/regex_replacement.py
index 486e8353..8577a545 100644
--- a/src/vapi/types/regex_replacement.py
+++ b/src/vapi/types/regex_replacement.py
@@ -9,6 +9,10 @@
class RegexReplacement(UncheckedBaseModel):
+ """
+ Replaces text matching a regular expression before it is sent to a voice provider.
+ """
+
regex: str = pydantic.Field()
"""
This is the regex pattern to replace.
diff --git a/src/vapi/types/regex_security_filter.py b/src/vapi/types/regex_security_filter.py
index f59f43a3..c9496b73 100644
--- a/src/vapi/types/regex_security_filter.py
+++ b/src/vapi/types/regex_security_filter.py
@@ -9,6 +9,10 @@
class RegexSecurityFilter(UncheckedBaseModel):
+ """
+ Filters transcript content that matches a custom regular expression.
+ """
+
type: RegexSecurityFilterType = pydantic.Field()
"""
The type of security threat to filter.
diff --git a/src/vapi/types/rime_ai_voice.py b/src/vapi/types/rime_ai_voice.py
index 129146ac..cc6d8e85 100644
--- a/src/vapi/types/rime_ai_voice.py
+++ b/src/vapi/types/rime_ai_voice.py
@@ -15,6 +15,10 @@
class RimeAiVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with Rime AI, including voice and model selection, language, speed, pauses, phonemization, latency, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/say_hook_action.py b/src/vapi/types/say_hook_action.py
index e6f7f301..5eda5a60 100644
--- a/src/vapi/types/say_hook_action.py
+++ b/src/vapi/types/say_hook_action.py
@@ -9,6 +9,10 @@
class SayHookAction(UncheckedBaseModel):
+ """
+ A hook action that makes the assistant speak exact text or generate a response from a prompt.
+ """
+
prompt: typing.Optional[SayHookActionPrompt] = pydantic.Field(default=None)
"""
This is the prompt for the assistant to generate a response based on existing conversation.
diff --git a/src/vapi/types/say_phone_number_hook_action.py b/src/vapi/types/say_phone_number_hook_action.py
index 0a3c3143..30a4cf73 100644
--- a/src/vapi/types/say_phone_number_hook_action.py
+++ b/src/vapi/types/say_phone_number_hook_action.py
@@ -8,6 +8,10 @@
class SayPhoneNumberHookAction(UncheckedBaseModel):
+ """
+ A phone-number hook action that speaks an exact message to the caller.
+ """
+
exact: str = pydantic.Field()
"""
This is the message to say
diff --git a/src/vapi/types/sbc_configuration.py b/src/vapi/types/sbc_configuration.py
index b51f1414..b23c6d08 100644
--- a/src/vapi/types/sbc_configuration.py
+++ b/src/vapi/types/sbc_configuration.py
@@ -8,6 +8,10 @@
class SbcConfiguration(UncheckedBaseModel):
+ """
+ Routes bring-your-own SIP traffic through an on-premises session border controller instead of Vapi's managed controller.
+ """
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/vapi/types/schedule_plan.py b/src/vapi/types/schedule_plan.py
index 83865a49..563e2aa3 100644
--- a/src/vapi/types/schedule_plan.py
+++ b/src/vapi/types/schedule_plan.py
@@ -11,6 +11,10 @@
class SchedulePlan(UncheckedBaseModel):
+ """
+ Time window that controls the earliest and latest time a call may begin.
+ """
+
earliest_at: typing_extensions.Annotated[
dt.datetime,
FieldMetadata(alias="earliestAt"),
diff --git a/src/vapi/types/scorecard.py b/src/vapi/types/scorecard.py
index bef6baf9..e0f88f39 100644
--- a/src/vapi/types/scorecard.py
+++ b/src/vapi/types/scorecard.py
@@ -12,6 +12,10 @@
class Scorecard(UncheckedBaseModel):
+ """
+ A saved scorecard containing its evaluation metrics, scoring conditions, assistant associations, descriptive metadata, and lifecycle information.
+ """
+
id: str = pydantic.Field()
"""
This is the unique identifier for the scorecard.
diff --git a/src/vapi/types/scorecard_metric.py b/src/vapi/types/scorecard_metric.py
index e8292be0..c84d0a2a 100644
--- a/src/vapi/types/scorecard_metric.py
+++ b/src/vapi/types/scorecard_metric.py
@@ -10,6 +10,10 @@
class ScorecardMetric(UncheckedBaseModel):
+ """
+ A scorecard metric that awards points when a structured output meets its configured conditions.
+ """
+
structured_output_id: typing_extensions.Annotated[
str,
FieldMetadata(alias="structuredOutputId"),
diff --git a/src/vapi/types/scorecard_paginated_response.py b/src/vapi/types/scorecard_paginated_response.py
index 5556be83..e552a737 100644
--- a/src/vapi/types/scorecard_paginated_response.py
+++ b/src/vapi/types/scorecard_paginated_response.py
@@ -10,8 +10,19 @@
class ScorecardPaginatedResponse(UncheckedBaseModel):
- results: typing.List[Scorecard]
- metadata: PaginationMeta
+ """
+ A paginated collection of scorecards and metadata describing the result set.
+ """
+
+ results: typing.List[Scorecard] = pydantic.Field()
+ """
+ The scorecards returned for the current page.
+ """
+
+ metadata: PaginationMeta = pydantic.Field()
+ """
+ Pagination metadata for the scorecard result set.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/security_filter_base.py b/src/vapi/types/security_filter_base.py
index 08d4b5dd..79ef0e35 100644
--- a/src/vapi/types/security_filter_base.py
+++ b/src/vapi/types/security_filter_base.py
@@ -8,6 +8,10 @@
class SecurityFilterBase(UncheckedBaseModel):
+ """
+ Base configuration for a security filter applied to transcripts before model processing.
+ """
+
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
else:
diff --git a/src/vapi/types/security_filter_plan.py b/src/vapi/types/security_filter_plan.py
index c0ad975a..19ffc22a 100644
--- a/src/vapi/types/security_filter_plan.py
+++ b/src/vapi/types/security_filter_plan.py
@@ -12,6 +12,10 @@
class SecurityFilterPlan(UncheckedBaseModel):
+ """
+ Controls filtering of transcripts for security threats before content is sent to the assistant's language model, including filter selection, handling mode, and replacement text.
+ """
+
enabled: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether the security filter is enabled.
diff --git a/src/vapi/types/server.py b/src/vapi/types/server.py
index 50977758..6d793edf 100644
--- a/src/vapi/types/server.py
+++ b/src/vapi/types/server.py
@@ -11,6 +11,10 @@
class Server(UncheckedBaseModel):
+ """
+ Configuration for requests Vapi sends to a customer server, including URL, authentication, headers, timeout, encryption, static IP addresses, and retry behavior.
+ """
+
timeout_seconds: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="timeoutSeconds"),
diff --git a/src/vapi/types/sesame_voice.py b/src/vapi/types/sesame_voice.py
index aa7b6981..d54714ad 100644
--- a/src/vapi/types/sesame_voice.py
+++ b/src/vapi/types/sesame_voice.py
@@ -13,6 +13,10 @@
class SesameVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with Sesame, including voice and model selection, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/sip_authentication.py b/src/vapi/types/sip_authentication.py
index 75651cfc..262fdf82 100644
--- a/src/vapi/types/sip_authentication.py
+++ b/src/vapi/types/sip_authentication.py
@@ -8,6 +8,10 @@
class SipAuthentication(UncheckedBaseModel):
+ """
+ Realm, username, and password used to authenticate SIP requests.
+ """
+
realm: typing.Optional[str] = pydantic.Field(default=None)
"""
This will be expected in the `realm` field of the `authorization` header of the SIP INVITE. Defaults to sip.vapi.ai.
diff --git a/src/vapi/types/sip_request_tool.py b/src/vapi/types/sip_request_tool.py
index 3fab1c16..c94de54c 100644
--- a/src/vapi/types/sip_request_tool.py
+++ b/src/vapi/types/sip_request_tool.py
@@ -17,6 +17,10 @@
class SipRequestTool(UncheckedBaseModel):
+ """
+ A reusable tool that sends SIP `INFO`, `MESSAGE`, or `NOTIFY` requests with configured headers and body.
+ """
+
messages: typing.Optional[typing.List[SipRequestToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/sip_trunk_gateway.py b/src/vapi/types/sip_trunk_gateway.py
index fac6d213..757eecb0 100644
--- a/src/vapi/types/sip_trunk_gateway.py
+++ b/src/vapi/types/sip_trunk_gateway.py
@@ -11,6 +11,10 @@
class SipTrunkGateway(UncheckedBaseModel):
+ """
+ Network and routing settings for a SIP trunk gateway, including address, port, netmask, inbound and outbound use, signaling protocol, and OPTIONS health checks.
+ """
+
ip: str = pydantic.Field()
"""
This is the address of the gateway. It can be an IPv4 address like 1.1.1.1 or a fully qualified domain name like my-sip-trunk.pstn.twilio.com.
diff --git a/src/vapi/types/sip_trunk_outbound_authentication_plan.py b/src/vapi/types/sip_trunk_outbound_authentication_plan.py
index c799190c..457ff23d 100644
--- a/src/vapi/types/sip_trunk_outbound_authentication_plan.py
+++ b/src/vapi/types/sip_trunk_outbound_authentication_plan.py
@@ -11,13 +11,19 @@
class SipTrunkOutboundAuthenticationPlan(UncheckedBaseModel):
+ """
+ Credentials and optional SIP REGISTER settings used to authenticate outbound calls with a SIP trunk.
+ """
+
auth_password: typing_extensions.Annotated[
typing.Optional[str],
FieldMetadata(alias="authPassword"),
pydantic.Field(alias="authPassword", description="This is not returned in the API."),
] = None
auth_username: typing_extensions.Annotated[
- typing.Optional[str], FieldMetadata(alias="authUsername"), pydantic.Field(alias="authUsername")
+ typing.Optional[str],
+ FieldMetadata(alias="authUsername"),
+ pydantic.Field(alias="authUsername", description="Username used to authenticate outbound SIP requests."),
] = None
sip_register_plan: typing_extensions.Annotated[
typing.Optional[SipTrunkOutboundSipRegisterPlan],
diff --git a/src/vapi/types/sip_trunk_outbound_sip_register_plan.py b/src/vapi/types/sip_trunk_outbound_sip_register_plan.py
index b70dfadb..14a96b78 100644
--- a/src/vapi/types/sip_trunk_outbound_sip_register_plan.py
+++ b/src/vapi/types/sip_trunk_outbound_sip_register_plan.py
@@ -8,9 +8,24 @@
class SipTrunkOutboundSipRegisterPlan(UncheckedBaseModel):
- domain: typing.Optional[str] = None
- username: typing.Optional[str] = None
- realm: typing.Optional[str] = None
+ """
+ Registration settings used when the SIP trunk requires SIP REGISTER.
+ """
+
+ domain: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ SIP registrar domain used for registration.
+ """
+
+ username: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Username sent with the SIP REGISTER request.
+ """
+
+ realm: typing.Optional[str] = pydantic.Field(default=None)
+ """
+ Authentication realm used for SIP registration.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/slack_send_message_tool.py b/src/vapi/types/slack_send_message_tool.py
index 3bc76825..8881511c 100644
--- a/src/vapi/types/slack_send_message_tool.py
+++ b/src/vapi/types/slack_send_message_tool.py
@@ -15,6 +15,10 @@
class SlackSendMessageTool(UncheckedBaseModel):
+ """
+ A reusable tool that lets an assistant send a message to Slack.
+ """
+
messages: typing.Optional[typing.List[SlackSendMessageToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/smallest_ai_voice.py b/src/vapi/types/smallest_ai_voice.py
index e8257f2f..f5ecf11c 100644
--- a/src/vapi/types/smallest_ai_voice.py
+++ b/src/vapi/types/smallest_ai_voice.py
@@ -14,6 +14,10 @@
class SmallestAiVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with Smallest AI, including voice and model selection, speed, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/smart_denoising_plan.py b/src/vapi/types/smart_denoising_plan.py
index 189018f7..baa13d81 100644
--- a/src/vapi/types/smart_denoising_plan.py
+++ b/src/vapi/types/smart_denoising_plan.py
@@ -8,6 +8,10 @@
class SmartDenoisingPlan(UncheckedBaseModel):
+ """
+ Controls whether Krisp smart denoising filters background speech and noise.
+ """
+
enabled: typing.Optional[bool] = pydantic.Field(default=None)
"""
Whether smart denoising using Krisp is enabled.
diff --git a/src/vapi/types/sms_tool.py b/src/vapi/types/sms_tool.py
index 00c4e550..2fd5e760 100644
--- a/src/vapi/types/sms_tool.py
+++ b/src/vapi/types/sms_tool.py
@@ -15,6 +15,10 @@
class SmsTool(UncheckedBaseModel):
+ """
+ A reusable tool that lets an assistant send an SMS message during a call.
+ """
+
messages: typing.Optional[typing.List[SmsToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/soniox_transcriber.py b/src/vapi/types/soniox_transcriber.py
index a5b89f62..0fbcb8f2 100644
--- a/src/vapi/types/soniox_transcriber.py
+++ b/src/vapi/types/soniox_transcriber.py
@@ -13,6 +13,10 @@
class SonioxTranscriber(UncheckedBaseModel):
+ """
+ Configuration for transcribing speech during assistant conversations with Soniox, including model, language detection, endpointing, vocabulary, and fallback settings.
+ """
+
model: typing.Optional[SonioxTranscriberModel] = pydantic.Field(default=None)
"""
The Soniox model to use for transcription.
diff --git a/src/vapi/types/speechmatics_custom_vocabulary_item.py b/src/vapi/types/speechmatics_custom_vocabulary_item.py
index b7b7fbdc..b29c4647 100644
--- a/src/vapi/types/speechmatics_custom_vocabulary_item.py
+++ b/src/vapi/types/speechmatics_custom_vocabulary_item.py
@@ -10,6 +10,10 @@
class SpeechmaticsCustomVocabularyItem(UncheckedBaseModel):
+ """
+ A word or phrase to prioritize during Speechmatics transcription, with optional phonetic alternatives.
+ """
+
content: str = pydantic.Field()
"""
The word or phrase to add to the custom vocabulary.
diff --git a/src/vapi/types/speechmatics_transcriber.py b/src/vapi/types/speechmatics_transcriber.py
index 0d220c89..f8ead5c6 100644
--- a/src/vapi/types/speechmatics_transcriber.py
+++ b/src/vapi/types/speechmatics_transcriber.py
@@ -17,12 +17,20 @@
class SpeechmaticsTranscriber(UncheckedBaseModel):
+ """
+ Configuration for transcribing speech during assistant conversations with Speechmatics, including language, region, diarization, vocabulary, endpointing, formatting, and fallback settings.
+ """
+
model: typing.Optional[SpeechmaticsTranscriberModel] = pydantic.Field(default=None)
"""
This is the model that will be used for the transcription.
"""
- language: typing.Optional[SpeechmaticsTranscriberLanguage] = None
+ language: typing.Optional[SpeechmaticsTranscriberLanguage] = pydantic.Field(default=None)
+ """
+ Language used for transcription. Set to `auto` to detect the language automatically.
+ """
+
operating_point: typing_extensions.Annotated[
typing.Optional[SpeechmaticsTranscriberOperatingPoint],
FieldMetadata(alias="operatingPoint"),
@@ -57,7 +65,10 @@ class SpeechmaticsTranscriber(UncheckedBaseModel):
custom_vocabulary: typing_extensions.Annotated[
typing.List[SpeechmaticsCustomVocabularyItem],
FieldMetadata(alias="customVocabulary"),
- pydantic.Field(alias="customVocabulary"),
+ pydantic.Field(
+ alias="customVocabulary",
+ description="Words and phrases that Speechmatics should recognize more accurately, with optional phonetic alternatives.",
+ ),
]
numeral_style: typing_extensions.Annotated[
typing.Optional[SpeechmaticsTranscriberNumeralStyle],
diff --git a/src/vapi/types/spki_pem_public_key_config.py b/src/vapi/types/spki_pem_public_key_config.py
index fbf5f59a..2fb67995 100644
--- a/src/vapi/types/spki_pem_public_key_config.py
+++ b/src/vapi/types/spki_pem_public_key_config.py
@@ -8,6 +8,10 @@
class SpkiPemPublicKeyConfig(UncheckedBaseModel):
+ """
+ An SPKI public key in PEM format used to encrypt sensitive request data.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
Optional name of the key for identification purposes.
diff --git a/src/vapi/types/sql_injection_security_filter.py b/src/vapi/types/sql_injection_security_filter.py
index e4b31f43..046569a8 100644
--- a/src/vapi/types/sql_injection_security_filter.py
+++ b/src/vapi/types/sql_injection_security_filter.py
@@ -9,6 +9,10 @@
class SqlInjectionSecurityFilter(UncheckedBaseModel):
+ """
+ Filters potential SQL injection patterns from transcripts.
+ """
+
type: SqlInjectionSecurityFilterType = pydantic.Field()
"""
The type of security threat to filter.
diff --git a/src/vapi/types/squad.py b/src/vapi/types/squad.py
index d3d69bb2..ec4b10d8 100644
--- a/src/vapi/types/squad.py
+++ b/src/vapi/types/squad.py
@@ -13,6 +13,10 @@
class Squad(UncheckedBaseModel):
+ """
+ A saved squad configuration that coordinates a group of assistants during a conversation. The first member starts the call, and member destinations control transfers between assistants.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the squad.
diff --git a/src/vapi/types/squad_member_dto.py b/src/vapi/types/squad_member_dto.py
index 36dc4aac..d3ead046 100644
--- a/src/vapi/types/squad_member_dto.py
+++ b/src/vapi/types/squad_member_dto.py
@@ -12,10 +12,17 @@
class SquadMemberDto(UncheckedBaseModel):
+ """
+ An assistant member of a squad. Reference a saved assistant or provide a transient assistant, then configure member-specific overrides and destinations for transfers.
+ """
+
assistant_destinations: typing_extensions.Annotated[
typing.Optional[typing.List["SquadMemberDtoAssistantDestinationsItem"]],
FieldMetadata(alias="assistantDestinations"),
- pydantic.Field(alias="assistantDestinations"),
+ pydantic.Field(
+ alias="assistantDestinations",
+ description="Assistants this squad member can route the conversation to through a transfer or handoff.",
+ ),
] = None
assistant_id: typing_extensions.Annotated[
typing.Optional[str],
diff --git a/src/vapi/types/ssrf_security_filter.py b/src/vapi/types/ssrf_security_filter.py
index 586c3f06..65f6aef5 100644
--- a/src/vapi/types/ssrf_security_filter.py
+++ b/src/vapi/types/ssrf_security_filter.py
@@ -9,6 +9,10 @@
class SsrfSecurityFilter(UncheckedBaseModel):
+ """
+ Filters potential server-side request forgery (SSRF) patterns from transcripts.
+ """
+
type: SsrfSecurityFilterType = pydantic.Field()
"""
The type of security threat to filter.
diff --git a/src/vapi/types/start_speaking_plan.py b/src/vapi/types/start_speaking_plan.py
index 5c0c0d0c..98101629 100644
--- a/src/vapi/types/start_speaking_plan.py
+++ b/src/vapi/types/start_speaking_plan.py
@@ -14,6 +14,10 @@
class StartSpeakingPlan(UncheckedBaseModel):
+ """
+ Controls when the assistant begins speaking after customer speech, including the minimum wait, endpointing strategy, and custom endpointing rules.
+ """
+
wait_seconds: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="waitSeconds"),
diff --git a/src/vapi/types/stop_speaking_plan.py b/src/vapi/types/stop_speaking_plan.py
index ab1a6b9f..a712a2e6 100644
--- a/src/vapi/types/stop_speaking_plan.py
+++ b/src/vapi/types/stop_speaking_plan.py
@@ -10,6 +10,10 @@
class StopSpeakingPlan(UncheckedBaseModel):
+ """
+ Controls when the assistant stops speaking after a customer interruption, including word and voice thresholds, restart delay, and phrase exceptions.
+ """
+
num_words: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="numWords"),
diff --git a/src/vapi/types/structured_data_multi_plan.py b/src/vapi/types/structured_data_multi_plan.py
index 755c77e3..133d0b1a 100644
--- a/src/vapi/types/structured_data_multi_plan.py
+++ b/src/vapi/types/structured_data_multi_plan.py
@@ -11,6 +11,10 @@
class StructuredDataMultiPlan(UncheckedBaseModel):
+ """
+ Associates a catalog key with a structured data extraction plan.
+ """
+
key: str = pydantic.Field()
"""
This is the key of the structured data plan in the catalog.
diff --git a/src/vapi/types/structured_data_plan.py b/src/vapi/types/structured_data_plan.py
index 8108b4c4..1085089f 100644
--- a/src/vapi/types/structured_data_plan.py
+++ b/src/vapi/types/structured_data_plan.py
@@ -12,6 +12,10 @@
class StructuredDataPlan(UncheckedBaseModel):
+ """
+ Controls extraction of post-call structured data, including prompt messages, JSON schema, enablement, and request timeout.
+ """
+
messages: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = pydantic.Field(default=None)
"""
These are the messages used to generate the structured data.
diff --git a/src/vapi/types/structured_output.py b/src/vapi/types/structured_output.py
index 6af644e1..e42efa48 100644
--- a/src/vapi/types/structured_output.py
+++ b/src/vapi/types/structured_output.py
@@ -16,6 +16,10 @@
class StructuredOutput(UncheckedBaseModel):
+ """
+ A saved structured-output definition containing its extraction schema, execution method, model or regular expression, linked resources, and lifecycle metadata.
+ """
+
type: typing.Optional[StructuredOutputType] = pydantic.Field(default=None)
"""
This is the type of structured output.
diff --git a/src/vapi/types/structured_output_paginated_response.py b/src/vapi/types/structured_output_paginated_response.py
index c03572b4..f57189cb 100644
--- a/src/vapi/types/structured_output_paginated_response.py
+++ b/src/vapi/types/structured_output_paginated_response.py
@@ -12,8 +12,19 @@
class StructuredOutputPaginatedResponse(UncheckedBaseModel):
- results: typing.List[StructuredOutput]
- metadata: PaginationMeta
+ """
+ A paginated collection of structured-output definitions and metadata describing the result set.
+ """
+
+ results: typing.List[StructuredOutput] = pydantic.Field()
+ """
+ The structured-output definitions returned for the current page.
+ """
+
+ metadata: PaginationMeta = pydantic.Field()
+ """
+ Pagination metadata for the structured-output result set.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/subscription_limits.py b/src/vapi/types/subscription_limits.py
index bc48781b..c59f41b9 100644
--- a/src/vapi/types/subscription_limits.py
+++ b/src/vapi/types/subscription_limits.py
@@ -10,6 +10,10 @@
class SubscriptionLimits(UncheckedBaseModel):
+ """
+ Organization concurrency limits and remaining concurrent call capacity.
+ """
+
concurrency_blocked: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="concurrencyBlocked"),
diff --git a/src/vapi/types/success_evaluation_plan.py b/src/vapi/types/success_evaluation_plan.py
index 391d117d..4a15b6e4 100644
--- a/src/vapi/types/success_evaluation_plan.py
+++ b/src/vapi/types/success_evaluation_plan.py
@@ -11,6 +11,10 @@
class SuccessEvaluationPlan(UncheckedBaseModel):
+ """
+ Controls post-call success evaluation, including the rubric, prompt messages, enablement, and request timeout.
+ """
+
rubric: typing.Optional[SuccessEvaluationPlanRubric] = pydantic.Field(default=None)
"""
This enforces the rubric of the evaluation. The output is stored in `call.analysis.successEvaluation`.
diff --git a/src/vapi/types/summary_plan.py b/src/vapi/types/summary_plan.py
index 98818af8..4aac1996 100644
--- a/src/vapi/types/summary_plan.py
+++ b/src/vapi/types/summary_plan.py
@@ -10,6 +10,10 @@
class SummaryPlan(UncheckedBaseModel):
+ """
+ Controls generation of a post-call summary, including prompt messages, enablement, and request timeout.
+ """
+
messages: typing.Optional[typing.List[typing.Dict[str, typing.Any]]] = pydantic.Field(default=None)
"""
These are the messages used to generate the summary.
diff --git a/src/vapi/types/supabase_bucket_plan.py b/src/vapi/types/supabase_bucket_plan.py
index bb8327e5..a1272d8d 100644
--- a/src/vapi/types/supabase_bucket_plan.py
+++ b/src/vapi/types/supabase_bucket_plan.py
@@ -11,6 +11,10 @@
class SupabaseBucketPlan(UncheckedBaseModel):
+ """
+ Supabase S3-compatible bucket configuration for call artifacts, including region, endpoint, access keys, bucket name, and path.
+ """
+
region: SupabaseBucketPlanRegion = pydantic.Field()
"""
This is the S3 Region. It should look like us-east-1
diff --git a/src/vapi/types/system_message.py b/src/vapi/types/system_message.py
index e94cb04c..491b82db 100644
--- a/src/vapi/types/system_message.py
+++ b/src/vapi/types/system_message.py
@@ -10,6 +10,10 @@
class SystemMessage(UncheckedBaseModel):
+ """
+ A system-authored entry in the call message history, including its content and timing.
+ """
+
role: str = pydantic.Field()
"""
The role of the system in the conversation.
diff --git a/src/vapi/types/talkscriber_transcriber.py b/src/vapi/types/talkscriber_transcriber.py
index fd6115dc..c16cb8eb 100644
--- a/src/vapi/types/talkscriber_transcriber.py
+++ b/src/vapi/types/talkscriber_transcriber.py
@@ -13,6 +13,10 @@
class TalkscriberTranscriber(UncheckedBaseModel):
+ """
+ Configuration for transcribing speech during assistant conversations with Talkscriber, including model, language, and fallback settings.
+ """
+
model: typing.Optional[TalkscriberTranscriberModel] = pydantic.Field(default=None)
"""
This is the model that will be used for the transcription.
diff --git a/src/vapi/types/tavus_conversation_properties.py b/src/vapi/types/tavus_conversation_properties.py
index f1ea63e0..d9cc80d8 100644
--- a/src/vapi/types/tavus_conversation_properties.py
+++ b/src/vapi/types/tavus_conversation_properties.py
@@ -10,6 +10,10 @@
class TavusConversationProperties(UncheckedBaseModel):
+ """
+ Tavus conversation behavior and media settings, including duration, participant timeouts, recording, transcription, background, language, and recording storage.
+ """
+
max_call_duration: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="maxCallDuration"),
diff --git a/src/vapi/types/tavus_voice.py b/src/vapi/types/tavus_voice.py
index d416f5d6..ad984956 100644
--- a/src/vapi/types/tavus_voice.py
+++ b/src/vapi/types/tavus_voice.py
@@ -14,6 +14,10 @@
class TavusVoice(UncheckedBaseModel):
+ """
+ Configuration for using Tavus as the assistant's voice provider, including persona, callback, context, greeting, conversation properties, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/telnyx_phone_number.py b/src/vapi/types/telnyx_phone_number.py
index e707f316..0b1aecf0 100644
--- a/src/vapi/types/telnyx_phone_number.py
+++ b/src/vapi/types/telnyx_phone_number.py
@@ -15,6 +15,10 @@
class TelnyxPhoneNumber(UncheckedBaseModel):
+ """
+ A Telnyx phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[TelnyxPhoneNumberFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/text_content.py b/src/vapi/types/text_content.py
index eedfd886..1493c87f 100644
--- a/src/vapi/types/text_content.py
+++ b/src/vapi/types/text_content.py
@@ -10,9 +10,24 @@
class TextContent(UncheckedBaseModel):
- type: TextContentType
- text: str
- language: TextContentLanguage
+ """
+ Localized text content used as a language-specific message variant.
+ """
+
+ type: TextContentType = pydantic.Field()
+ """
+ Selects text as the content type.
+ """
+
+ text: str = pydantic.Field()
+ """
+ Text spoken or displayed for this content variant.
+ """
+
+ language: TextContentLanguage = pydantic.Field()
+ """
+ Language code associated with this text variant.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/text_editor_tool.py b/src/vapi/types/text_editor_tool.py
index bc7c61b5..c8ec8bcb 100644
--- a/src/vapi/types/text_editor_tool.py
+++ b/src/vapi/types/text_editor_tool.py
@@ -18,6 +18,10 @@
class TextEditorTool(UncheckedBaseModel):
+ """
+ A reusable tool that reads and edits text files in a configured environment.
+ """
+
messages: typing.Optional[typing.List[TextEditorToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/text_insight.py b/src/vapi/types/text_insight.py
index a0d7d7a7..39ded0a7 100644
--- a/src/vapi/types/text_insight.py
+++ b/src/vapi/types/text_insight.py
@@ -13,6 +13,10 @@
class TextInsight(UncheckedBaseModel):
+ """
+ A saved text-value insight containing its call-data queries, formula, time range, and lifecycle information.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -38,7 +42,9 @@ class TextInsight(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRange], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRange],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(alias="timeRange", description="The time range used to query the text-value data."),
] = None
queries: typing.List[TextInsightQueriesItem] = pydantic.Field()
"""
diff --git a/src/vapi/types/time_range.py b/src/vapi/types/time_range.py
index 9882ef50..0cab4f90 100644
--- a/src/vapi/types/time_range.py
+++ b/src/vapi/types/time_range.py
@@ -10,6 +10,10 @@
class TimeRange(UncheckedBaseModel):
+ """
+ Start, end, timezone, and time step used for analytics aggregation.
+ """
+
step: typing.Optional[TimeRangeStep] = pydantic.Field(default=None)
"""
This is the time step for aggregations.
diff --git a/src/vapi/types/together_ai_model.py b/src/vapi/types/together_ai_model.py
index b6a16bc2..1ebf221c 100644
--- a/src/vapi/types/together_ai_model.py
+++ b/src/vapi/types/together_ai_model.py
@@ -14,6 +14,10 @@
class TogetherAiModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with Together AI, including model, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/tool_call.py b/src/vapi/types/tool_call.py
index 20ba56c5..d1722cf0 100644
--- a/src/vapi/types/tool_call.py
+++ b/src/vapi/types/tool_call.py
@@ -9,6 +9,10 @@
class ToolCall(UncheckedBaseModel):
+ """
+ A tool invocation requested by the assistant, including its identifier, type, and function details.
+ """
+
id: str = pydantic.Field()
"""
This is the ID of the tool call
diff --git a/src/vapi/types/tool_call_function.py b/src/vapi/types/tool_call_function.py
index 6d61417a..71bffad6 100644
--- a/src/vapi/types/tool_call_function.py
+++ b/src/vapi/types/tool_call_function.py
@@ -8,6 +8,10 @@
class ToolCallFunction(UncheckedBaseModel):
+ """
+ The function name and serialized arguments associated with a tool call.
+ """
+
arguments: str = pydantic.Field()
"""
This is the arguments to call the function with
diff --git a/src/vapi/types/tool_call_hook_action.py b/src/vapi/types/tool_call_hook_action.py
index ea22f22f..5da89b9c 100644
--- a/src/vapi/types/tool_call_hook_action.py
+++ b/src/vapi/types/tool_call_hook_action.py
@@ -13,6 +13,10 @@
class ToolCallHookAction(UncheckedBaseModel):
+ """
+ A hook action that invokes an inline tool or an existing tool when the hook triggers.
+ """
+
type: ToolCallHookActionType = pydantic.Field()
"""
This is the type of action - must be "tool"
diff --git a/src/vapi/types/tool_call_message.py b/src/vapi/types/tool_call_message.py
index 0bd08e85..ad67d9eb 100644
--- a/src/vapi/types/tool_call_message.py
+++ b/src/vapi/types/tool_call_message.py
@@ -10,6 +10,10 @@
class ToolCallMessage(UncheckedBaseModel):
+ """
+ An entry in the call message history that records one or more tool calls requested during the conversation.
+ """
+
role: str = pydantic.Field()
"""
The role of the tool call in the conversation.
diff --git a/src/vapi/types/tool_call_result_message.py b/src/vapi/types/tool_call_result_message.py
index 9d7fcea0..6ba79edb 100644
--- a/src/vapi/types/tool_call_result_message.py
+++ b/src/vapi/types/tool_call_result_message.py
@@ -10,6 +10,10 @@
class ToolCallResultMessage(UncheckedBaseModel):
+ """
+ An entry in the call message history that records the result and metadata for a completed tool call.
+ """
+
role: str = pydantic.Field()
"""
The role of the tool call result in the conversation.
diff --git a/src/vapi/types/tool_message.py b/src/vapi/types/tool_message.py
index 918373d1..2c4eb9f0 100644
--- a/src/vapi/types/tool_message.py
+++ b/src/vapi/types/tool_message.py
@@ -9,6 +9,10 @@
class ToolMessage(UncheckedBaseModel):
+ """
+ A tool-result message associated with a specific tool call.
+ """
+
role: ToolMessageRole = pydantic.Field()
"""
This is the role of the message author
diff --git a/src/vapi/types/tool_message_complete.py b/src/vapi/types/tool_message_complete.py
index faefe736..14eaa55a 100644
--- a/src/vapi/types/tool_message_complete.py
+++ b/src/vapi/types/tool_message_complete.py
@@ -13,6 +13,10 @@
class ToolMessageComplete(UncheckedBaseModel):
+ """
+ Message spoken when a tool call completes, with optional language variants, argument conditions, role, and end-call behavior.
+ """
+
contents: typing.Optional[typing.List[TextContent]] = pydantic.Field(default=None)
"""
This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.
diff --git a/src/vapi/types/tool_message_delayed.py b/src/vapi/types/tool_message_delayed.py
index 1feca2f6..05cff805 100644
--- a/src/vapi/types/tool_message_delayed.py
+++ b/src/vapi/types/tool_message_delayed.py
@@ -12,6 +12,10 @@
class ToolMessageDelayed(UncheckedBaseModel):
+ """
+ Message spoken when a tool call exceeds a configured response delay, with optional language variants and argument conditions.
+ """
+
contents: typing.Optional[typing.List[TextContent]] = pydantic.Field(default=None)
"""
This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.
diff --git a/src/vapi/types/tool_message_failed.py b/src/vapi/types/tool_message_failed.py
index ca13db04..9e2948c5 100644
--- a/src/vapi/types/tool_message_failed.py
+++ b/src/vapi/types/tool_message_failed.py
@@ -12,6 +12,10 @@
class ToolMessageFailed(UncheckedBaseModel):
+ """
+ Message spoken when a tool call fails, with optional language variants, argument conditions, and end-call behavior.
+ """
+
contents: typing.Optional[typing.List[TextContent]] = pydantic.Field(default=None)
"""
This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.
diff --git a/src/vapi/types/tool_message_start.py b/src/vapi/types/tool_message_start.py
index fe94b908..89ced115 100644
--- a/src/vapi/types/tool_message_start.py
+++ b/src/vapi/types/tool_message_start.py
@@ -10,6 +10,10 @@
class ToolMessageStart(UncheckedBaseModel):
+ """
+ Message spoken when a tool call starts, with optional language variants, argument conditions, and blocking behavior.
+ """
+
contents: typing.Optional[typing.List[TextContent]] = pydantic.Field(default=None)
"""
This is an alternative to the `content` property. It allows to specify variants of the same content, one per language.
diff --git a/src/vapi/types/tool_node.py b/src/vapi/types/tool_node.py
index 8867f039..8a6af469 100644
--- a/src/vapi/types/tool_node.py
+++ b/src/vapi/types/tool_node.py
@@ -13,6 +13,10 @@
class ToolNode(UncheckedBaseModel):
+ """
+ A workflow node that invokes an inline tool or an existing saved tool.
+ """
+
tool: typing.Optional[ToolNodeTool] = pydantic.Field(default=None)
"""
This is the tool to call. To use an existing tool, send `toolId` instead.
@@ -25,7 +29,11 @@ class ToolNode(UncheckedBaseModel):
alias="toolId", description="This is the tool to call. To use a transient tool, send `tool` instead."
),
] = None
- name: str
+ name: str = pydantic.Field()
+ """
+ Unique name used to identify this workflow node.
+ """
+
is_start: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="isStart"),
diff --git a/src/vapi/types/tool_parameter.py b/src/vapi/types/tool_parameter.py
index cc93581c..c0827c23 100644
--- a/src/vapi/types/tool_parameter.py
+++ b/src/vapi/types/tool_parameter.py
@@ -9,6 +9,10 @@
class ToolParameter(UncheckedBaseModel):
+ """
+ Static key-value parameter added to a tool request, with Liquid template support for string values.
+ """
+
key: str = pydantic.Field()
"""
This is the key of the parameter.
diff --git a/src/vapi/types/tool_rejection_plan.py b/src/vapi/types/tool_rejection_plan.py
index 64877fc5..004ee0f7 100644
--- a/src/vapi/types/tool_rejection_plan.py
+++ b/src/vapi/types/tool_rejection_plan.py
@@ -11,6 +11,10 @@
class ToolRejectionPlan(UncheckedBaseModel):
+ """
+ Conditions evaluated to determine whether a requested tool call should be rejected.
+ """
+
conditions: typing.Optional[typing.List[ToolRejectionPlanConditionsItem]] = pydantic.Field(default=None)
"""
This is the list of conditions that must be evaluated.
diff --git a/src/vapi/types/transcriber_cost.py b/src/vapi/types/transcriber_cost.py
index cbd61e25..04f6591c 100644
--- a/src/vapi/types/transcriber_cost.py
+++ b/src/vapi/types/transcriber_cost.py
@@ -8,6 +8,10 @@
class TranscriberCost(UncheckedBaseModel):
+ """
+ Speech-to-text cost for a call, including transcriber, billable minutes, and amount.
+ """
+
transcriber: typing.Dict[str, typing.Any] = pydantic.Field()
"""
This is the transcriber that was used during the call.
diff --git a/src/vapi/types/transcript_plan.py b/src/vapi/types/transcript_plan.py
index 59ecd0da..397d535d 100644
--- a/src/vapi/types/transcript_plan.py
+++ b/src/vapi/types/transcript_plan.py
@@ -10,6 +10,10 @@
class TranscriptPlan(UncheckedBaseModel):
+ """
+ Controls whether the call transcript is stored and the speaker names used in the transcript.
+ """
+
enabled: typing.Optional[bool] = pydantic.Field(default=None)
"""
This determines whether the transcript is stored in `call.artifact.transcript`. Defaults to true.
diff --git a/src/vapi/types/transcription_endpointing_plan.py b/src/vapi/types/transcription_endpointing_plan.py
index ea2956b3..73f34200 100644
--- a/src/vapi/types/transcription_endpointing_plan.py
+++ b/src/vapi/types/transcription_endpointing_plan.py
@@ -10,6 +10,10 @@
class TranscriptionEndpointingPlan(UncheckedBaseModel):
+ """
+ Controls endpointing delays based on whether customer speech ends with punctuation, without punctuation, or with a number.
+ """
+
on_punctuation_seconds: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="onPunctuationSeconds"),
diff --git a/src/vapi/types/transfer_call_tool.py b/src/vapi/types/transfer_call_tool.py
index 81530bee..cd3ce970 100644
--- a/src/vapi/types/transfer_call_tool.py
+++ b/src/vapi/types/transfer_call_tool.py
@@ -16,6 +16,10 @@
class TransferCallTool(UncheckedBaseModel):
+ """
+ A reusable tool that transfers the active call to one of its configured destinations.
+ """
+
messages: typing.Optional[typing.List[TransferCallToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/transfer_destination_assistant.py b/src/vapi/types/transfer_destination_assistant.py
index 71d40eb1..34fc8f09 100644
--- a/src/vapi/types/transfer_destination_assistant.py
+++ b/src/vapi/types/transfer_destination_assistant.py
@@ -13,6 +13,10 @@
class TransferDestinationAssistant(UncheckedBaseModel):
+ """
+ Transfers a call to another assistant by name, with an optional message and assistant-transfer mode.
+ """
+
message: typing.Optional[TransferDestinationAssistantMessage] = pydantic.Field(default=None)
"""
This is spoken to the customer before connecting them to the destination.
@@ -24,7 +28,11 @@ class TransferDestinationAssistant(UncheckedBaseModel):
This accepts a string or a ToolMessageStart class. Latter is useful if you want to specify multiple messages for different languages through the `contents` field.
"""
- type: TransferDestinationAssistantType
+ type: TransferDestinationAssistantType = pydantic.Field()
+ """
+ Selects another assistant as the transfer destination.
+ """
+
transfer_mode: typing_extensions.Annotated[
typing.Optional[TransferMode],
FieldMetadata(alias="transferMode"),
diff --git a/src/vapi/types/transfer_destination_number.py b/src/vapi/types/transfer_destination_number.py
index a2eae071..f342d016 100644
--- a/src/vapi/types/transfer_destination_number.py
+++ b/src/vapi/types/transfer_destination_number.py
@@ -12,6 +12,10 @@
class TransferDestinationNumber(UncheckedBaseModel):
+ """
+ Transfers a call to a phone number, with optional extension, caller ID, message, transfer plan, and number validation.
+ """
+
message: typing.Optional[TransferDestinationNumberMessage] = pydantic.Field(default=None)
"""
This is spoken to the customer before connecting them to the destination.
diff --git a/src/vapi/types/transfer_destination_sip.py b/src/vapi/types/transfer_destination_sip.py
index 4f10e3e5..ce913178 100644
--- a/src/vapi/types/transfer_destination_sip.py
+++ b/src/vapi/types/transfer_destination_sip.py
@@ -12,6 +12,10 @@
class TransferDestinationSip(UncheckedBaseModel):
+ """
+ Transfers a call to a SIP URI, with optional caller ID, headers, message, and transfer plan.
+ """
+
message: typing.Optional[TransferDestinationSipMessage] = pydantic.Field(default=None)
"""
This is spoken to the customer before connecting them to the destination.
diff --git a/src/vapi/types/transfer_fallback_plan.py b/src/vapi/types/transfer_fallback_plan.py
index 6b14d6dd..8b93d5af 100644
--- a/src/vapi/types/transfer_fallback_plan.py
+++ b/src/vapi/types/transfer_fallback_plan.py
@@ -11,6 +11,10 @@
class TransferFallbackPlan(UncheckedBaseModel):
+ """
+ Controls the message and end-call behavior used when a call transfer fails.
+ """
+
message: TransferFallbackPlanMessage = pydantic.Field()
"""
This is the message the assistant will deliver to the customer if the transfer fails.
diff --git a/src/vapi/types/transfer_phone_number_hook_action.py b/src/vapi/types/transfer_phone_number_hook_action.py
index 0e56a13c..926d462d 100644
--- a/src/vapi/types/transfer_phone_number_hook_action.py
+++ b/src/vapi/types/transfer_phone_number_hook_action.py
@@ -9,6 +9,10 @@
class TransferPhoneNumberHookAction(UncheckedBaseModel):
+ """
+ A phone-number hook action that transfers the call to a phone number or SIP destination.
+ """
+
destination: typing.Optional[TransferPhoneNumberHookActionDestination] = pydantic.Field(default=None)
"""
This is the destination details for the transfer - can be a phone number or SIP URI
diff --git a/src/vapi/types/transfer_plan.py b/src/vapi/types/transfer_plan.py
index f9a02e49..a12ce0b1 100644
--- a/src/vapi/types/transfer_plan.py
+++ b/src/vapi/types/transfer_plan.py
@@ -15,6 +15,10 @@
class TransferPlan(UncheckedBaseModel):
+ """
+ Controls how a call transfer is executed, including blind and warm transfer modes, dialing and SIP behavior, hold audio, context, summary, and failure handling.
+ """
+
mode: TransferPlanMode = pydantic.Field()
"""
This configures how transfer is executed and the experience of the destination party receiving the call.
diff --git a/src/vapi/types/transport_configuration_twilio.py b/src/vapi/types/transport_configuration_twilio.py
index 06976f92..dff13837 100644
--- a/src/vapi/types/transport_configuration_twilio.py
+++ b/src/vapi/types/transport_configuration_twilio.py
@@ -12,7 +12,15 @@
class TransportConfigurationTwilio(UncheckedBaseModel):
- provider: TransportConfigurationTwilioProvider
+ """
+ Configuration passed to Twilio for assistant calls, including ring timeout and Twilio recording behavior.
+ """
+
+ provider: TransportConfigurationTwilioProvider = pydantic.Field()
+ """
+ Selects Twilio as the call transport provider.
+ """
+
timeout: typing.Optional[float] = pydantic.Field(default=None)
"""
The integer number of seconds that we should allow the phone to ring before assuming there is no answer.
diff --git a/src/vapi/types/transport_cost.py b/src/vapi/types/transport_cost.py
index a8dad049..0b63c080 100644
--- a/src/vapi/types/transport_cost.py
+++ b/src/vapi/types/transport_cost.py
@@ -9,7 +9,15 @@
class TransportCost(UncheckedBaseModel):
- provider: typing.Optional[TransportCostProvider] = None
+ """
+ Telephony transport cost for a call, including provider, billable minutes, and amount.
+ """
+
+ provider: typing.Optional[TransportCostProvider] = pydantic.Field(default=None)
+ """
+ Telephony or transport provider that generated the cost.
+ """
+
minutes: float = pydantic.Field()
"""
This is the minutes of `transport` usage. This should match `call.endedAt` - `call.startedAt`.
diff --git a/src/vapi/types/turn_latency.py b/src/vapi/types/turn_latency.py
index 9bfc02a2..e406b82a 100644
--- a/src/vapi/types/turn_latency.py
+++ b/src/vapi/types/turn_latency.py
@@ -10,6 +10,10 @@
class TurnLatency(UncheckedBaseModel):
+ """
+ Model, voice, transcription, endpointing, and total latency measurements for a conversation turn.
+ """
+
model_latency: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="modelLatency"),
diff --git a/src/vapi/types/twilio_phone_number.py b/src/vapi/types/twilio_phone_number.py
index da207c1f..8d36a1ce 100644
--- a/src/vapi/types/twilio_phone_number.py
+++ b/src/vapi/types/twilio_phone_number.py
@@ -15,6 +15,10 @@
class TwilioPhoneNumber(UncheckedBaseModel):
+ """
+ A Twilio phone number connected to Vapi, including its Twilio account details, SMS configuration, routing, hooks, server settings, and lifecycle metadata.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[TwilioPhoneNumberFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/twilio_voicemail_detection_plan.py b/src/vapi/types/twilio_voicemail_detection_plan.py
index 4b66a1d1..b4f1414d 100644
--- a/src/vapi/types/twilio_voicemail_detection_plan.py
+++ b/src/vapi/types/twilio_voicemail_detection_plan.py
@@ -14,6 +14,10 @@
class TwilioVoicemailDetectionPlan(UncheckedBaseModel):
+ """
+ Configuration for Twilio answering-machine detection, including recognized outcomes, enablement, timeout, speech thresholds, and silence timeout.
+ """
+
provider: TwilioVoicemailDetectionPlanProvider = pydantic.Field()
"""
This is the provider to use for voicemail detection.
diff --git a/src/vapi/types/update_api_request_tool_dto.py b/src/vapi/types/update_api_request_tool_dto.py
index 3fc43a8c..218e1cb4 100644
--- a/src/vapi/types/update_api_request_tool_dto.py
+++ b/src/vapi/types/update_api_request_tool_dto.py
@@ -18,6 +18,10 @@
class UpdateApiRequestToolDto(UncheckedBaseModel):
+ """
+ Fields used to update an API-request tool, including its URL, HTTP method, authentication, request data, retries, and response handling.
+ """
+
messages: typing.Optional[typing.List[UpdateApiRequestToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
@@ -25,7 +29,11 @@ class UpdateApiRequestToolDto(UncheckedBaseModel):
For some tools, this is auto-filled based on special fields like `tool.destinations`. For others like the function tool, these can be custom configured.
"""
- method: typing.Optional[UpdateApiRequestToolDtoMethod] = None
+ method: typing.Optional[UpdateApiRequestToolDtoMethod] = pydantic.Field(default=None)
+ """
+ The HTTP method used for the API request.
+ """
+
timeout_seconds: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="timeoutSeconds"),
diff --git a/src/vapi/types/update_bar_insight_from_call_table_dto.py b/src/vapi/types/update_bar_insight_from_call_table_dto.py
index e525a7f9..3f5507f4 100644
--- a/src/vapi/types/update_bar_insight_from_call_table_dto.py
+++ b/src/vapi/types/update_bar_insight_from_call_table_dto.py
@@ -15,6 +15,10 @@
class UpdateBarInsightFromCallTableDto(UncheckedBaseModel):
+ """
+ Fields used to update a bar-chart insight, including its queries, formulas, grouping, time range, metadata, and name.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -45,7 +49,11 @@ class UpdateBarInsightFromCallTableDto(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRangeWithStep], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRangeWithStep],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(
+ alias="timeRange", description="The time range and interval used to aggregate the bar-chart data."
+ ),
] = None
group_by: typing_extensions.Annotated[
typing.Optional[UpdateBarInsightFromCallTableDtoGroupBy],
diff --git a/src/vapi/types/update_bash_tool_dto.py b/src/vapi/types/update_bash_tool_dto.py
index 344544f6..4fa18df5 100644
--- a/src/vapi/types/update_bash_tool_dto.py
+++ b/src/vapi/types/update_bash_tool_dto.py
@@ -17,6 +17,10 @@
class UpdateBashToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a Bash tool, including its name, environment subtype, server, messages, and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateBashToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_byo_phone_number_dto.py b/src/vapi/types/update_byo_phone_number_dto.py
index 97261162..f58e1c69 100644
--- a/src/vapi/types/update_byo_phone_number_dto.py
+++ b/src/vapi/types/update_byo_phone_number_dto.py
@@ -13,6 +13,10 @@
class UpdateByoPhoneNumberDto(UncheckedBaseModel):
+ """
+ Fields used to update a bring-your-own phone number, including its credential, number, routing, hooks, and server settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[UpdateByoPhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/update_computer_tool_dto.py b/src/vapi/types/update_computer_tool_dto.py
index ff52740f..51562477 100644
--- a/src/vapi/types/update_computer_tool_dto.py
+++ b/src/vapi/types/update_computer_tool_dto.py
@@ -17,6 +17,10 @@
class UpdateComputerToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a computer tool, including its display settings, environment subtype, server, messages, and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateComputerToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_dtmf_tool_dto.py b/src/vapi/types/update_dtmf_tool_dto.py
index fb9931dd..f48321c0 100644
--- a/src/vapi/types/update_dtmf_tool_dto.py
+++ b/src/vapi/types/update_dtmf_tool_dto.py
@@ -14,6 +14,10 @@
class UpdateDtmfToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a DTMF tool, including its spoken messages, rejection plan, and SIP INFO behavior.
+ """
+
messages: typing.Optional[typing.List[UpdateDtmfToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_end_call_tool_dto.py b/src/vapi/types/update_end_call_tool_dto.py
index 725809b9..592d7907 100644
--- a/src/vapi/types/update_end_call_tool_dto.py
+++ b/src/vapi/types/update_end_call_tool_dto.py
@@ -14,6 +14,10 @@
class UpdateEndCallToolDto(UncheckedBaseModel):
+ """
+ Fields used to update an end-call tool, including its spoken messages and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateEndCallToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_function_tool_dto.py b/src/vapi/types/update_function_tool_dto.py
index af013a1e..58a5fb55 100644
--- a/src/vapi/types/update_function_tool_dto.py
+++ b/src/vapi/types/update_function_tool_dto.py
@@ -18,6 +18,10 @@
class UpdateFunctionToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a custom function tool, including its function definition, server, parameters, messages, and execution behavior.
+ """
+
messages: typing.Optional[typing.List[UpdateFunctionToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_go_high_level_calendar_availability_tool_dto.py b/src/vapi/types/update_go_high_level_calendar_availability_tool_dto.py
index b0e604a1..2f17532b 100644
--- a/src/vapi/types/update_go_high_level_calendar_availability_tool_dto.py
+++ b/src/vapi/types/update_go_high_level_calendar_availability_tool_dto.py
@@ -16,6 +16,10 @@
class UpdateGoHighLevelCalendarAvailabilityToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a GoHighLevel calendar-availability tool, including its spoken messages and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateGoHighLevelCalendarAvailabilityToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/update_go_high_level_calendar_event_create_tool_dto.py b/src/vapi/types/update_go_high_level_calendar_event_create_tool_dto.py
index 7e025efa..50d4fd4b 100644
--- a/src/vapi/types/update_go_high_level_calendar_event_create_tool_dto.py
+++ b/src/vapi/types/update_go_high_level_calendar_event_create_tool_dto.py
@@ -16,6 +16,10 @@
class UpdateGoHighLevelCalendarEventCreateToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a GoHighLevel calendar-event tool, including its spoken messages and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateGoHighLevelCalendarEventCreateToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/update_go_high_level_contact_create_tool_dto.py b/src/vapi/types/update_go_high_level_contact_create_tool_dto.py
index 7821eed3..0282af3d 100644
--- a/src/vapi/types/update_go_high_level_contact_create_tool_dto.py
+++ b/src/vapi/types/update_go_high_level_contact_create_tool_dto.py
@@ -16,6 +16,10 @@
class UpdateGoHighLevelContactCreateToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a GoHighLevel contact-creation tool, including its spoken messages and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateGoHighLevelContactCreateToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/update_go_high_level_contact_get_tool_dto.py b/src/vapi/types/update_go_high_level_contact_get_tool_dto.py
index fab72190..ed3eeff6 100644
--- a/src/vapi/types/update_go_high_level_contact_get_tool_dto.py
+++ b/src/vapi/types/update_go_high_level_contact_get_tool_dto.py
@@ -14,6 +14,10 @@
class UpdateGoHighLevelContactGetToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a GoHighLevel contact-retrieval tool, including its spoken messages and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateGoHighLevelContactGetToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/update_google_calendar_check_availability_tool_dto.py b/src/vapi/types/update_google_calendar_check_availability_tool_dto.py
index b06a4835..d63913e5 100644
--- a/src/vapi/types/update_google_calendar_check_availability_tool_dto.py
+++ b/src/vapi/types/update_google_calendar_check_availability_tool_dto.py
@@ -16,6 +16,10 @@
class UpdateGoogleCalendarCheckAvailabilityToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a Google Calendar availability tool, including its spoken messages and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateGoogleCalendarCheckAvailabilityToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/update_google_calendar_create_event_tool_dto.py b/src/vapi/types/update_google_calendar_create_event_tool_dto.py
index ece96fdf..9ae77290 100644
--- a/src/vapi/types/update_google_calendar_create_event_tool_dto.py
+++ b/src/vapi/types/update_google_calendar_create_event_tool_dto.py
@@ -16,6 +16,10 @@
class UpdateGoogleCalendarCreateEventToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a Google Calendar event-creation tool, including its spoken messages and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateGoogleCalendarCreateEventToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/update_google_sheets_row_append_tool_dto.py b/src/vapi/types/update_google_sheets_row_append_tool_dto.py
index f9eedf8a..6683fcd3 100644
--- a/src/vapi/types/update_google_sheets_row_append_tool_dto.py
+++ b/src/vapi/types/update_google_sheets_row_append_tool_dto.py
@@ -14,6 +14,10 @@
class UpdateGoogleSheetsRowAppendToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a Google Sheets row-append tool, including its spoken messages and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateGoogleSheetsRowAppendToolDtoMessagesItem]] = pydantic.Field(
default=None
)
diff --git a/src/vapi/types/update_handoff_tool_dto.py b/src/vapi/types/update_handoff_tool_dto.py
index f09193e1..c1915398 100644
--- a/src/vapi/types/update_handoff_tool_dto.py
+++ b/src/vapi/types/update_handoff_tool_dto.py
@@ -16,6 +16,10 @@
class UpdateHandoffToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a handoff tool, including its destinations, function definition, default result, messages, and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateHandoffToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_line_insight_from_call_table_dto.py b/src/vapi/types/update_line_insight_from_call_table_dto.py
index 6100fcbc..a6a8e767 100644
--- a/src/vapi/types/update_line_insight_from_call_table_dto.py
+++ b/src/vapi/types/update_line_insight_from_call_table_dto.py
@@ -15,6 +15,10 @@
class UpdateLineInsightFromCallTableDto(UncheckedBaseModel):
+ """
+ Fields used to update a line-chart insight, including its queries, formulas, grouping, time range, metadata, and name.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -45,7 +49,11 @@ class UpdateLineInsightFromCallTableDto(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRangeWithStep], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRangeWithStep],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(
+ alias="timeRange", description="The time range and interval used to aggregate the line-chart data."
+ ),
] = None
group_by: typing_extensions.Annotated[
typing.Optional[UpdateLineInsightFromCallTableDtoGroupBy],
diff --git a/src/vapi/types/update_mcp_tool_dto.py b/src/vapi/types/update_mcp_tool_dto.py
index 4daf5205..d3529487 100644
--- a/src/vapi/types/update_mcp_tool_dto.py
+++ b/src/vapi/types/update_mcp_tool_dto.py
@@ -17,6 +17,10 @@
class UpdateMcpToolDto(UncheckedBaseModel):
+ """
+ Fields used to update an MCP tool, including its server, connection metadata, exposed tool messages, and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateMcpToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
@@ -53,7 +57,10 @@ class UpdateMcpToolDto(UncheckedBaseModel):
description="This is the plan to reject a tool call based on the conversation state.\n\n// Example 1: Reject endCall if user didn't say goodbye\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '(?i)\\\\b(bye|goodbye|farewell|see you later|take care)\\\\b',\n target: { position: -1, role: 'user' },\n negate: true // Reject if pattern does NOT match\n }]\n}\n```\n\n// Example 2: Reject transfer if user is actually asking a question\n```json\n{\n conditions: [{\n type: 'regex',\n regex: '\\\\?',\n target: { position: -1, role: 'user' }\n }]\n}\n```\n\n// Example 3: Reject transfer if user didn't mention transfer recently\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 5 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' %}\n{% assign mentioned = false %}\n{% for msg in userMessages %}\n {% if msg.content contains 'transfer' or msg.content contains 'connect' or msg.content contains 'speak to' %}\n {% assign mentioned = true %}\n {% break %}\n {% endif %}\n{% endfor %}\n{% if mentioned %}\n false\n{% else %}\n true\n{% endif %}`\n }]\n}\n```\n\n// Example 4: Reject endCall if the bot is looping and trying to exit\n```json\n{\n conditions: [{\n type: 'liquid',\n liquid: `{% assign recentMessages = messages | last: 6 %}\n{% assign userMessages = recentMessages | where: 'role', 'user' | reverse %}\n{% if userMessages.size < 3 %}\n false\n{% else %}\n {% assign msg1 = userMessages[0].content | downcase %}\n {% assign msg2 = userMessages[1].content | downcase %}\n {% assign msg3 = userMessages[2].content | downcase %}\n {% comment %} Check for repetitive messages {% endcomment %}\n {% if msg1 == msg2 or msg1 == msg3 or msg2 == msg3 %}\n true\n {% comment %} Check for common loop phrases {% endcomment %}\n {% elsif msg1 contains 'cool thanks' or msg2 contains 'cool thanks' or msg3 contains 'cool thanks' %}\n true\n {% elsif msg1 contains 'okay thanks' or msg2 contains 'okay thanks' or msg3 contains 'okay thanks' %}\n true\n {% elsif msg1 contains 'got it' or msg2 contains 'got it' or msg3 contains 'got it' %}\n true\n {% else %}\n false\n {% endif %}\n{% endif %}`\n }]\n}\n```",
),
] = None
- metadata: typing.Optional[McpToolMetadata] = None
+ metadata: typing.Optional[McpToolMetadata] = pydantic.Field(default=None)
+ """
+ Connection metadata for the MCP server, including its communication protocol.
+ """
if IS_PYDANTIC_V2:
model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2
diff --git a/src/vapi/types/update_pie_insight_from_call_table_dto.py b/src/vapi/types/update_pie_insight_from_call_table_dto.py
index 8221e35d..a40b30b6 100644
--- a/src/vapi/types/update_pie_insight_from_call_table_dto.py
+++ b/src/vapi/types/update_pie_insight_from_call_table_dto.py
@@ -14,6 +14,10 @@
class UpdatePieInsightFromCallTableDto(UncheckedBaseModel):
+ """
+ Fields used to update a pie-chart insight, including its queries, formulas, grouping, time range, and name.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -39,7 +43,9 @@ class UpdatePieInsightFromCallTableDto(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRange], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRange],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(alias="timeRange", description="The time range used to query the pie-chart data."),
] = None
group_by: typing_extensions.Annotated[
typing.Optional[UpdatePieInsightFromCallTableDtoGroupBy],
diff --git a/src/vapi/types/update_query_tool_dto.py b/src/vapi/types/update_query_tool_dto.py
index 3c464c2b..2b257668 100644
--- a/src/vapi/types/update_query_tool_dto.py
+++ b/src/vapi/types/update_query_tool_dto.py
@@ -15,6 +15,10 @@
class UpdateQueryToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a query tool, including its knowledge bases, spoken messages, and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateQueryToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_sip_request_tool_dto.py b/src/vapi/types/update_sip_request_tool_dto.py
index 1b3ab8c0..8231d1cb 100644
--- a/src/vapi/types/update_sip_request_tool_dto.py
+++ b/src/vapi/types/update_sip_request_tool_dto.py
@@ -16,6 +16,10 @@
class UpdateSipRequestToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a SIP-request tool, including its method, headers, body, spoken messages, and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateSipRequestToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_slack_send_message_tool_dto.py b/src/vapi/types/update_slack_send_message_tool_dto.py
index b55e40f4..c4c5757f 100644
--- a/src/vapi/types/update_slack_send_message_tool_dto.py
+++ b/src/vapi/types/update_slack_send_message_tool_dto.py
@@ -14,6 +14,10 @@
class UpdateSlackSendMessageToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a Slack message tool, including its spoken messages and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateSlackSendMessageToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_sms_tool_dto.py b/src/vapi/types/update_sms_tool_dto.py
index d7a32a7e..0e67c6eb 100644
--- a/src/vapi/types/update_sms_tool_dto.py
+++ b/src/vapi/types/update_sms_tool_dto.py
@@ -14,6 +14,10 @@
class UpdateSmsToolDto(UncheckedBaseModel):
+ """
+ Fields used to update an SMS tool, including its spoken messages and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateSmsToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_telnyx_phone_number_dto.py b/src/vapi/types/update_telnyx_phone_number_dto.py
index ecba1493..32d100a1 100644
--- a/src/vapi/types/update_telnyx_phone_number_dto.py
+++ b/src/vapi/types/update_telnyx_phone_number_dto.py
@@ -13,6 +13,10 @@
class UpdateTelnyxPhoneNumberDto(UncheckedBaseModel):
+ """
+ Fields used to update a Telnyx phone number, including its credential, number, routing, hooks, and server settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[UpdateTelnyxPhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/update_text_editor_tool_dto.py b/src/vapi/types/update_text_editor_tool_dto.py
index 80ee713b..63488e3e 100644
--- a/src/vapi/types/update_text_editor_tool_dto.py
+++ b/src/vapi/types/update_text_editor_tool_dto.py
@@ -17,6 +17,10 @@
class UpdateTextEditorToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a text-editor tool, including its name, environment subtype, server, messages, and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateTextEditorToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_text_insight_from_call_table_dto.py b/src/vapi/types/update_text_insight_from_call_table_dto.py
index e2621fc4..bed32dcf 100644
--- a/src/vapi/types/update_text_insight_from_call_table_dto.py
+++ b/src/vapi/types/update_text_insight_from_call_table_dto.py
@@ -12,6 +12,10 @@
class UpdateTextInsightFromCallTableDto(UncheckedBaseModel):
+ """
+ Fields used to update a text-value insight, including its queries, formula, time range, and name.
+ """
+
name: typing.Optional[str] = pydantic.Field(default=None)
"""
This is the name of the Insight.
@@ -37,7 +41,9 @@ class UpdateTextInsightFromCallTableDto(UncheckedBaseModel):
"""
time_range: typing_extensions.Annotated[
- typing.Optional[InsightTimeRange], FieldMetadata(alias="timeRange"), pydantic.Field(alias="timeRange")
+ typing.Optional[InsightTimeRange],
+ FieldMetadata(alias="timeRange"),
+ pydantic.Field(alias="timeRange", description="The time range used to query the text-value data."),
] = None
queries: typing.Optional[typing.List[UpdateTextInsightFromCallTableDtoQueriesItem]] = pydantic.Field(default=None)
"""
diff --git a/src/vapi/types/update_transfer_call_tool_dto.py b/src/vapi/types/update_transfer_call_tool_dto.py
index 62fb42d8..e891a449 100644
--- a/src/vapi/types/update_transfer_call_tool_dto.py
+++ b/src/vapi/types/update_transfer_call_tool_dto.py
@@ -15,6 +15,10 @@
class UpdateTransferCallToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a call-transfer tool, including its destinations, spoken messages, and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateTransferCallToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_twilio_phone_number_dto.py b/src/vapi/types/update_twilio_phone_number_dto.py
index 6f83a9dd..1ceb6777 100644
--- a/src/vapi/types/update_twilio_phone_number_dto.py
+++ b/src/vapi/types/update_twilio_phone_number_dto.py
@@ -13,6 +13,10 @@
class UpdateTwilioPhoneNumberDto(UncheckedBaseModel):
+ """
+ Fields used to update a Twilio phone number, including its account credentials, SMS configuration, routing, hooks, and server settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[UpdateTwilioPhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/update_vapi_phone_number_dto.py b/src/vapi/types/update_vapi_phone_number_dto.py
index dc4fcf82..5d7f7bc4 100644
--- a/src/vapi/types/update_vapi_phone_number_dto.py
+++ b/src/vapi/types/update_vapi_phone_number_dto.py
@@ -14,6 +14,10 @@
class UpdateVapiPhoneNumberDto(UncheckedBaseModel):
+ """
+ Fields used to update a Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, and server settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[UpdateVapiPhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/update_voicemail_tool_dto.py b/src/vapi/types/update_voicemail_tool_dto.py
index 7f0e5709..d637fb44 100644
--- a/src/vapi/types/update_voicemail_tool_dto.py
+++ b/src/vapi/types/update_voicemail_tool_dto.py
@@ -14,6 +14,10 @@
class UpdateVoicemailToolDto(UncheckedBaseModel):
+ """
+ Fields used to update a voicemail-detection tool, including beep detection, spoken messages, and rejection plan.
+ """
+
messages: typing.Optional[typing.List[UpdateVoicemailToolDtoMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/update_vonage_phone_number_dto.py b/src/vapi/types/update_vonage_phone_number_dto.py
index 2d30691d..04875576 100644
--- a/src/vapi/types/update_vonage_phone_number_dto.py
+++ b/src/vapi/types/update_vonage_phone_number_dto.py
@@ -13,6 +13,10 @@
class UpdateVonagePhoneNumberDto(UncheckedBaseModel):
+ """
+ Fields used to update a Vonage phone number, including its credential, number, routing, hooks, and server settings.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[UpdateVonagePhoneNumberDtoFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/user_message.py b/src/vapi/types/user_message.py
index de99da4f..ee40b1ae 100644
--- a/src/vapi/types/user_message.py
+++ b/src/vapi/types/user_message.py
@@ -10,6 +10,10 @@
class UserMessage(UncheckedBaseModel):
+ """
+ A user-authored entry in the call message history, including content, timing, security-filter results, and optional speaker metadata.
+ """
+
role: str = pydantic.Field()
"""
The role of the user in the conversation.
diff --git a/src/vapi/types/vapi_cost.py b/src/vapi/types/vapi_cost.py
index 78bc57aa..6a8445e9 100644
--- a/src/vapi/types/vapi_cost.py
+++ b/src/vapi/types/vapi_cost.py
@@ -11,6 +11,10 @@
class VapiCost(UncheckedBaseModel):
+ """
+ Vapi platform cost for a call, including cost subtype, billable minutes, and amount.
+ """
+
sub_type: typing_extensions.Annotated[
VapiCostSubType,
FieldMetadata(alias="subType"),
diff --git a/src/vapi/types/vapi_phone_number.py b/src/vapi/types/vapi_phone_number.py
index 5b2c2ce5..73ab948a 100644
--- a/src/vapi/types/vapi_phone_number.py
+++ b/src/vapi/types/vapi_phone_number.py
@@ -16,6 +16,10 @@
class VapiPhoneNumber(UncheckedBaseModel):
+ """
+ A Vapi-managed phone number or SIP URI, including its authentication, routing, hooks, server settings, and lifecycle metadata.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[VapiPhoneNumberFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/vapi_pronunciation_dictionary_locator.py b/src/vapi/types/vapi_pronunciation_dictionary_locator.py
index f9a2506e..0f453ca2 100644
--- a/src/vapi/types/vapi_pronunciation_dictionary_locator.py
+++ b/src/vapi/types/vapi_pronunciation_dictionary_locator.py
@@ -10,6 +10,10 @@
class VapiPronunciationDictionaryLocator(UncheckedBaseModel):
+ """
+ Identifies a pronunciation dictionary and optional version used for voice synthesis.
+ """
+
pronunciation_dict_id: typing_extensions.Annotated[
str,
FieldMetadata(alias="pronunciationDictId"),
diff --git a/src/vapi/types/vapi_smart_endpointing_plan.py b/src/vapi/types/vapi_smart_endpointing_plan.py
index 305ba154..d08b9503 100644
--- a/src/vapi/types/vapi_smart_endpointing_plan.py
+++ b/src/vapi/types/vapi_smart_endpointing_plan.py
@@ -9,6 +9,10 @@
class VapiSmartEndpointingPlan(UncheckedBaseModel):
+ """
+ Selects Vapi smart endpointing to determine when customer speech is complete.
+ """
+
provider: VapiSmartEndpointingPlanProvider = pydantic.Field()
"""
This is the provider for the smart endpointing plan.
diff --git a/src/vapi/types/vapi_voice.py b/src/vapi/types/vapi_voice.py
index b41584f5..da86ee78 100644
--- a/src/vapi/types/vapi_voice.py
+++ b/src/vapi/types/vapi_voice.py
@@ -14,6 +14,10 @@
class VapiVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with Vapi, including voice selection, speed, pronunciation dictionary, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/vapi_voicemail_detection_plan.py b/src/vapi/types/vapi_voicemail_detection_plan.py
index 56dbe8fb..21de204f 100644
--- a/src/vapi/types/vapi_voicemail_detection_plan.py
+++ b/src/vapi/types/vapi_voicemail_detection_plan.py
@@ -13,6 +13,10 @@
class VapiVoicemailDetectionPlan(UncheckedBaseModel):
+ """
+ Configuration for detecting voicemail with Vapi, including detection type, maximum beep wait, and retry backoff.
+ """
+
beep_max_await_seconds: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="beepMaxAwaitSeconds"),
diff --git a/src/vapi/types/variable_extraction_alias.py b/src/vapi/types/variable_extraction_alias.py
index 1faa57f3..bb298ef5 100644
--- a/src/vapi/types/variable_extraction_alias.py
+++ b/src/vapi/types/variable_extraction_alias.py
@@ -8,6 +8,10 @@
class VariableExtractionAlias(UncheckedBaseModel):
+ """
+ Defines an additional Liquid-based variable from values extracted during a call.
+ """
+
key: str = pydantic.Field()
"""
This is the key of the variable.
diff --git a/src/vapi/types/variable_extraction_plan.py b/src/vapi/types/variable_extraction_plan.py
index 7c4e75f5..5511c2bb 100644
--- a/src/vapi/types/variable_extraction_plan.py
+++ b/src/vapi/types/variable_extraction_plan.py
@@ -13,6 +13,10 @@
class VariableExtractionPlan(UncheckedBaseModel):
+ """
+ Defines structured variables to extract and optional aliases made available during and after a call.
+ """
+
schema_: typing_extensions.Annotated[
typing.Optional["JsonSchema"],
FieldMetadata(alias="schema"),
diff --git a/src/vapi/types/variable_value_group_by.py b/src/vapi/types/variable_value_group_by.py
index b85502ef..422c578b 100644
--- a/src/vapi/types/variable_value_group_by.py
+++ b/src/vapi/types/variable_value_group_by.py
@@ -8,6 +8,10 @@
class VariableValueGroupBy(UncheckedBaseModel):
+ """
+ Groups analytics results by a selected assistant variable-value key.
+ """
+
key: str = pydantic.Field()
"""
This is the key of the variable value to group by.
diff --git a/src/vapi/types/voice_cost.py b/src/vapi/types/voice_cost.py
index 30d3ef54..c3aa5070 100644
--- a/src/vapi/types/voice_cost.py
+++ b/src/vapi/types/voice_cost.py
@@ -8,6 +8,10 @@
class VoiceCost(UncheckedBaseModel):
+ """
+ Voice-synthesis cost for a call, including voice, character usage, and amount.
+ """
+
voice: typing.Dict[str, typing.Any] = pydantic.Field()
"""
This is the voice that was used during the call.
diff --git a/src/vapi/types/voicemail_detection_backoff_plan.py b/src/vapi/types/voicemail_detection_backoff_plan.py
index 54e70dd0..3bbbb2c8 100644
--- a/src/vapi/types/voicemail_detection_backoff_plan.py
+++ b/src/vapi/types/voicemail_detection_backoff_plan.py
@@ -10,6 +10,10 @@
class VoicemailDetectionBackoffPlan(UncheckedBaseModel):
+ """
+ Controls voicemail-detection retry timing, including when retries start, retry frequency, and maximum attempts.
+ """
+
start_at_seconds: typing_extensions.Annotated[
typing.Optional[float],
FieldMetadata(alias="startAtSeconds"),
diff --git a/src/vapi/types/voicemail_detection_cost.py b/src/vapi/types/voicemail_detection_cost.py
index 926ee994..2b7154ed 100644
--- a/src/vapi/types/voicemail_detection_cost.py
+++ b/src/vapi/types/voicemail_detection_cost.py
@@ -11,6 +11,10 @@
class VoicemailDetectionCost(UncheckedBaseModel):
+ """
+ Voicemail-detection model cost, including provider, model, multimodal token usage, and amount.
+ """
+
model: typing.Dict[str, typing.Any] = pydantic.Field()
"""
This is the model that was used to perform the analysis.
diff --git a/src/vapi/types/voicemail_tool.py b/src/vapi/types/voicemail_tool.py
index 8788d2fd..c41f5d4c 100644
--- a/src/vapi/types/voicemail_tool.py
+++ b/src/vapi/types/voicemail_tool.py
@@ -15,6 +15,10 @@
class VoicemailTool(UncheckedBaseModel):
+ """
+ A reusable voicemail-detection tool with optional beep detection for supported calls.
+ """
+
messages: typing.Optional[typing.List[VoicemailToolMessagesItem]] = pydantic.Field(default=None)
"""
These are the messages that will be spoken to the user as the tool is running.
diff --git a/src/vapi/types/vonage_phone_number.py b/src/vapi/types/vonage_phone_number.py
index 940e8d6e..f9115043 100644
--- a/src/vapi/types/vonage_phone_number.py
+++ b/src/vapi/types/vonage_phone_number.py
@@ -15,6 +15,10 @@
class VonagePhoneNumber(UncheckedBaseModel):
+ """
+ A Vonage phone number connected to Vapi, including its credential, routing, hooks, server settings, and lifecycle metadata.
+ """
+
fallback_destination: typing_extensions.Annotated[
typing.Optional[VonagePhoneNumberFallbackDestination],
FieldMetadata(alias="fallbackDestination"),
diff --git a/src/vapi/types/well_said_voice.py b/src/vapi/types/well_said_voice.py
index d9dacf36..acc63328 100644
--- a/src/vapi/types/well_said_voice.py
+++ b/src/vapi/types/well_said_voice.py
@@ -13,6 +13,10 @@
class WellSaidVoice(UncheckedBaseModel):
+ """
+ Configuration for synthesizing assistant speech with WellSaid, including voice and model selection, Speech Synthesis Markup Language support, voice libraries, chunking, caching, and fallback settings.
+ """
+
caching_enabled: typing_extensions.Annotated[
typing.Optional[bool],
FieldMetadata(alias="cachingEnabled"),
diff --git a/src/vapi/types/workflow_anthropic_bedrock_model.py b/src/vapi/types/workflow_anthropic_bedrock_model.py
index 00245be6..1898e5d9 100644
--- a/src/vapi/types/workflow_anthropic_bedrock_model.py
+++ b/src/vapi/types/workflow_anthropic_bedrock_model.py
@@ -12,6 +12,10 @@
class WorkflowAnthropicBedrockModel(UncheckedBaseModel):
+ """
+ Workflow model configuration for Anthropic through Amazon Bedrock, including model selection, thinking, temperature, and maximum output tokens.
+ """
+
model: WorkflowAnthropicBedrockModelModel = pydantic.Field()
"""
This is the specific model that will be used.
diff --git a/src/vapi/types/workflow_anthropic_model.py b/src/vapi/types/workflow_anthropic_model.py
index d69497e2..da9fe15a 100644
--- a/src/vapi/types/workflow_anthropic_model.py
+++ b/src/vapi/types/workflow_anthropic_model.py
@@ -12,6 +12,10 @@
class WorkflowAnthropicModel(UncheckedBaseModel):
+ """
+ Workflow model configuration for Anthropic, including model selection, thinking, temperature, and maximum output tokens.
+ """
+
model: WorkflowAnthropicModelModel = pydantic.Field()
"""
This is the specific model that will be used.
diff --git a/src/vapi/types/workflow_custom_model.py b/src/vapi/types/workflow_custom_model.py
index 19d8f975..d2dfa1a1 100644
--- a/src/vapi/types/workflow_custom_model.py
+++ b/src/vapi/types/workflow_custom_model.py
@@ -11,6 +11,10 @@
class WorkflowCustomModel(UncheckedBaseModel):
+ """
+ Workflow model configuration for a custom language model endpoint, including URL, headers, metadata delivery, timeout, model, temperature, and maximum output tokens.
+ """
+
metadata_send_mode: typing_extensions.Annotated[
typing.Optional[WorkflowCustomModelMetadataSendMode],
FieldMetadata(alias="metadataSendMode"),
diff --git a/src/vapi/types/workflow_google_model.py b/src/vapi/types/workflow_google_model.py
index 3d3f8bd1..b98a0c40 100644
--- a/src/vapi/types/workflow_google_model.py
+++ b/src/vapi/types/workflow_google_model.py
@@ -11,6 +11,10 @@
class WorkflowGoogleModel(UncheckedBaseModel):
+ """
+ Workflow model configuration for Google, including model selection, temperature, and maximum output tokens.
+ """
+
model: WorkflowGoogleModelModel = pydantic.Field()
"""
This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b
diff --git a/src/vapi/types/workflow_open_ai_model.py b/src/vapi/types/workflow_open_ai_model.py
index 0493901a..acf621ba 100644
--- a/src/vapi/types/workflow_open_ai_model.py
+++ b/src/vapi/types/workflow_open_ai_model.py
@@ -11,6 +11,10 @@
class WorkflowOpenAiModel(UncheckedBaseModel):
+ """
+ Workflow model configuration for OpenAI, including model selection, temperature, and maximum output tokens.
+ """
+
model: WorkflowOpenAiModelModel = pydantic.Field()
"""
This is the OpenAI model that will be used.
diff --git a/src/vapi/types/workflow_overrides.py b/src/vapi/types/workflow_overrides.py
index e73980f2..42b32cc4 100644
--- a/src/vapi/types/workflow_overrides.py
+++ b/src/vapi/types/workflow_overrides.py
@@ -10,6 +10,10 @@
class WorkflowOverrides(UncheckedBaseModel):
+ """
+ Per-call overrides for values used in workflow template variables.
+ """
+
variable_values: typing_extensions.Annotated[
typing.Optional[typing.Dict[str, typing.Any]],
FieldMetadata(alias="variableValues"),
diff --git a/src/vapi/types/xai_model.py b/src/vapi/types/xai_model.py
index ce4cfeee..87e24e26 100644
--- a/src/vapi/types/xai_model.py
+++ b/src/vapi/types/xai_model.py
@@ -15,6 +15,10 @@
class XaiModel(UncheckedBaseModel):
+ """
+ Configuration for generating assistant responses with xAI, including model, prompts, tools, knowledge-base access, and generation settings.
+ """
+
messages: typing.Optional[typing.List[OpenAiMessage]] = pydantic.Field(default=None)
"""
This is the starting state for the conversation.
diff --git a/src/vapi/types/xss_security_filter.py b/src/vapi/types/xss_security_filter.py
index 82644a94..b19766a1 100644
--- a/src/vapi/types/xss_security_filter.py
+++ b/src/vapi/types/xss_security_filter.py
@@ -9,6 +9,10 @@
class XssSecurityFilter(UncheckedBaseModel):
+ """
+ Filters potential cross-site scripting (XSS) patterns from transcripts.
+ """
+
type: XssSecurityFilterType = pydantic.Field()
"""
The type of security threat to filter.