retell-sdk 4.65.0 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -1326
- package/LICENSE +1 -1
- package/README.md +120 -44
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +217 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +217 -0
- package/client.d.ts.map +1 -0
- package/client.js +513 -0
- package/client.js.map +1 -0
- package/client.mjs +509 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +1 -46
- package/error.d.ts.map +1 -1
- package/error.js +3 -110
- package/error.js.map +1 -1
- package/error.mjs +1 -96
- package/error.mjs.map +1 -1
- package/index.d.mts +6 -151
- package/index.d.mts.map +1 -0
- package/index.d.ts +5 -150
- package/index.d.ts.map +1 -1
- package/index.js +12 -150
- package/index.js.map +1 -1
- package/index.mjs +5 -123
- package/index.mjs.map +1 -1
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +40 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +37 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +85 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +79 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +101 -65
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +1 -5
- package/resource.d.ts.map +1 -1
- package/resource.js +3 -8
- package/resource.js.map +1 -1
- package/resource.mjs +1 -6
- package/resource.mjs.map +1 -1
- package/resources/agent.d.mts +1803 -0
- package/resources/agent.d.mts.map +1 -0
- package/resources/agent.d.ts +377 -81
- package/resources/agent.d.ts.map +1 -1
- package/resources/agent.js +33 -20
- package/resources/agent.js.map +1 -1
- package/resources/agent.mjs +33 -20
- package/resources/agent.mjs.map +1 -1
- package/resources/batch-call.d.mts +926 -0
- package/resources/batch-call.d.mts.map +1 -0
- package/resources/batch-call.d.ts +220 -28
- package/resources/batch-call.d.ts.map +1 -1
- package/resources/batch-call.js +6 -2
- package/resources/batch-call.js.map +1 -1
- package/resources/batch-call.mjs +6 -2
- package/resources/batch-call.mjs.map +1 -1
- package/resources/call.d.mts +4280 -0
- package/resources/call.d.mts.map +1 -0
- package/resources/call.d.ts +556 -110
- package/resources/call.d.ts.map +1 -1
- package/resources/call.js +20 -10
- package/resources/call.js.map +1 -1
- package/resources/call.mjs +20 -10
- package/resources/call.mjs.map +1 -1
- package/resources/chat-agent.d.mts +836 -0
- package/resources/chat-agent.d.mts.map +1 -0
- package/resources/chat-agent.d.ts +118 -23
- package/resources/chat-agent.d.ts.map +1 -1
- package/resources/chat-agent.js +33 -20
- package/resources/chat-agent.js.map +1 -1
- package/resources/chat-agent.mjs +33 -20
- package/resources/chat-agent.mjs.map +1 -1
- package/resources/chat.d.mts +607 -0
- package/resources/chat.d.mts.map +1 -0
- package/resources/chat.d.ts +82 -30
- package/resources/chat.d.ts.map +1 -1
- package/resources/chat.js +21 -11
- package/resources/chat.js.map +1 -1
- package/resources/chat.mjs +21 -11
- package/resources/chat.mjs.map +1 -1
- package/resources/concurrency.d.mts +51 -0
- package/resources/concurrency.d.mts.map +1 -0
- package/resources/concurrency.d.ts +14 -3
- package/resources/concurrency.d.ts.map +1 -1
- package/resources/concurrency.js +1 -1
- package/resources/concurrency.js.map +1 -1
- package/resources/concurrency.mjs +1 -1
- package/resources/concurrency.mjs.map +1 -1
- package/resources/conversation-flow-component.d.mts +11838 -0
- package/resources/conversation-flow-component.d.mts.map +1 -0
- package/resources/conversation-flow-component.d.ts +6600 -2597
- package/resources/conversation-flow-component.d.ts.map +1 -1
- package/resources/conversation-flow-component.js +10 -8
- package/resources/conversation-flow-component.js.map +1 -1
- package/resources/conversation-flow-component.mjs +10 -8
- package/resources/conversation-flow-component.mjs.map +1 -1
- package/resources/conversation-flow.d.mts +23851 -0
- package/resources/conversation-flow.d.mts.map +1 -0
- package/resources/conversation-flow.d.ts +15877 -7958
- package/resources/conversation-flow.d.ts.map +1 -1
- package/resources/conversation-flow.js +30 -15
- package/resources/conversation-flow.js.map +1 -1
- package/resources/conversation-flow.mjs +30 -15
- package/resources/conversation-flow.mjs.map +1 -1
- package/resources/index.d.mts +15 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +4 -4
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -2
- package/resources/index.mjs.map +1 -1
- package/resources/knowledge-base.d.mts +228 -0
- package/resources/knowledge-base.d.mts.map +1 -0
- package/resources/knowledge-base.d.ts +23 -14
- package/resources/knowledge-base.d.ts.map +1 -1
- package/resources/knowledge-base.js +16 -36
- package/resources/knowledge-base.js.map +1 -1
- package/resources/knowledge-base.mjs +16 -13
- package/resources/knowledge-base.mjs.map +1 -1
- package/resources/llm.d.mts +5306 -0
- package/resources/llm.d.mts.map +1 -0
- package/resources/llm.d.ts +1189 -477
- package/resources/llm.d.ts.map +1 -1
- package/resources/llm.js +28 -15
- package/resources/llm.js.map +1 -1
- package/resources/llm.mjs +28 -15
- package/resources/llm.mjs.map +1 -1
- package/resources/mcp-tool.d.mts +45 -0
- package/resources/mcp-tool.d.mts.map +1 -0
- package/resources/mcp-tool.d.ts +8 -3
- package/resources/mcp-tool.d.ts.map +1 -1
- package/resources/mcp-tool.js +4 -3
- package/resources/mcp-tool.js.map +1 -1
- package/resources/mcp-tool.mjs +4 -3
- package/resources/mcp-tool.mjs.map +1 -1
- package/resources/phone-number.d.mts +595 -0
- package/resources/phone-number.d.mts.map +1 -0
- package/resources/phone-number.d.ts +332 -13
- package/resources/phone-number.d.ts.map +1 -1
- package/resources/phone-number.js +7 -5
- package/resources/phone-number.js.map +1 -1
- package/resources/phone-number.mjs +7 -5
- package/resources/phone-number.mjs.map +1 -1
- package/resources/tests.d.mts +561 -0
- package/resources/tests.d.mts.map +1 -0
- package/resources/tests.d.ts +437 -7
- package/resources/tests.d.ts.map +1 -1
- package/resources/tests.js +60 -1
- package/resources/tests.js.map +1 -1
- package/resources/tests.mjs +60 -1
- package/resources/tests.mjs.map +1 -1
- package/resources/voice.d.mts +130 -0
- package/resources/voice.d.mts.map +1 -0
- package/resources/voice.d.ts +89 -6
- package/resources/voice.d.ts.map +1 -1
- package/resources/voice.js +23 -3
- package/resources/voice.js.map +1 -1
- package/resources/voice.mjs +23 -3
- package/resources/voice.mjs.map +1 -1
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts.map +1 -1
- package/resources.js +2 -15
- package/resources.js.map +1 -1
- package/src/api-promise.ts +2 -0
- package/src/client.ts +1005 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -130
- package/src/index.ts +5 -405
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +56 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +126 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/resource.ts +2 -11
- package/src/resources/agent.ts +610 -101
- package/src/resources/batch-call.ts +318 -26
- package/src/resources/call.ts +835 -111
- package/src/resources/chat-agent.ts +191 -41
- package/src/resources/chat.ts +108 -40
- package/src/resources/concurrency.ts +16 -3
- package/src/resources/conversation-flow-component.ts +9469 -4285
- package/src/resources/conversation-flow.ts +21572 -11318
- package/src/resources/index.ts +25 -2
- package/src/resources/knowledge-base.ts +40 -28
- package/src/resources/llm.ts +1422 -599
- package/src/resources/mcp-tool.ts +13 -6
- package/src/resources/phone-number.ts +410 -18
- package/src/resources/tests.ts +608 -9
- package/src/resources/voice.ts +122 -7
- package/src/tsconfig.json +2 -2
- package/src/uploads.ts +2 -259
- package/src/version.ts +1 -1
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +1 -74
- package/uploads.d.ts.map +1 -1
- package/uploads.js +3 -175
- package/uploads.js.map +1 -1
- package/uploads.mjs +1 -164
- package/uploads.mjs.map +1 -1
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
- package/_shims/MultipartBody.d.ts +0 -9
- package/_shims/MultipartBody.d.ts.map +0 -1
- package/_shims/MultipartBody.js +0 -16
- package/_shims/MultipartBody.js.map +0 -1
- package/_shims/MultipartBody.mjs +0 -12
- package/_shims/MultipartBody.mjs.map +0 -1
- package/_shims/README.md +0 -46
- package/_shims/auto/runtime-bun.d.ts +0 -5
- package/_shims/auto/runtime-bun.d.ts.map +0 -1
- package/_shims/auto/runtime-bun.js +0 -21
- package/_shims/auto/runtime-bun.js.map +0 -1
- package/_shims/auto/runtime-bun.mjs +0 -2
- package/_shims/auto/runtime-bun.mjs.map +0 -1
- package/_shims/auto/runtime-node.d.ts +0 -5
- package/_shims/auto/runtime-node.d.ts.map +0 -1
- package/_shims/auto/runtime-node.js +0 -21
- package/_shims/auto/runtime-node.js.map +0 -1
- package/_shims/auto/runtime-node.mjs +0 -2
- package/_shims/auto/runtime-node.mjs.map +0 -1
- package/_shims/auto/runtime.d.ts +0 -5
- package/_shims/auto/runtime.d.ts.map +0 -1
- package/_shims/auto/runtime.js +0 -21
- package/_shims/auto/runtime.js.map +0 -1
- package/_shims/auto/runtime.mjs +0 -2
- package/_shims/auto/runtime.mjs.map +0 -1
- package/_shims/auto/types-node.d.ts +0 -5
- package/_shims/auto/types-node.d.ts.map +0 -1
- package/_shims/auto/types-node.js +0 -21
- package/_shims/auto/types-node.js.map +0 -1
- package/_shims/auto/types-node.mjs +0 -2
- package/_shims/auto/types-node.mjs.map +0 -1
- package/_shims/auto/types.d.ts +0 -101
- package/_shims/auto/types.js +0 -3
- package/_shims/auto/types.mjs +0 -3
- package/_shims/bun-runtime.d.ts +0 -6
- package/_shims/bun-runtime.d.ts.map +0 -1
- package/_shims/bun-runtime.js +0 -14
- package/_shims/bun-runtime.js.map +0 -1
- package/_shims/bun-runtime.mjs +0 -10
- package/_shims/bun-runtime.mjs.map +0 -1
- package/_shims/index.d.ts +0 -83
- package/_shims/index.js +0 -17
- package/_shims/index.mjs +0 -11
- package/_shims/manual-types.d.ts +0 -12
- package/_shims/manual-types.js +0 -3
- package/_shims/manual-types.mjs +0 -3
- package/_shims/node-runtime.d.ts +0 -3
- package/_shims/node-runtime.d.ts.map +0 -1
- package/_shims/node-runtime.js +0 -89
- package/_shims/node-runtime.js.map +0 -1
- package/_shims/node-runtime.mjs +0 -56
- package/_shims/node-runtime.mjs.map +0 -1
- package/_shims/node-types.d.ts +0 -42
- package/_shims/node-types.js +0 -3
- package/_shims/node-types.mjs +0 -3
- package/_shims/registry.d.ts +0 -37
- package/_shims/registry.d.ts.map +0 -1
- package/_shims/registry.js +0 -41
- package/_shims/registry.js.map +0 -1
- package/_shims/registry.mjs +0 -37
- package/_shims/registry.mjs.map +0 -1
- package/_shims/web-runtime.d.ts +0 -5
- package/_shims/web-runtime.d.ts.map +0 -1
- package/_shims/web-runtime.js +0 -78
- package/_shims/web-runtime.js.map +0 -1
- package/_shims/web-runtime.mjs +0 -71
- package/_shims/web-runtime.mjs.map +0 -1
- package/_shims/web-types.d.ts +0 -83
- package/_shims/web-types.js +0 -3
- package/_shims/web-types.mjs +0 -3
- package/core.d.ts +0 -255
- package/core.d.ts.map +0 -1
- package/core.js +0 -924
- package/core.js.map +0 -1
- package/core.mjs +0 -892
- package/core.mjs.map +0 -1
- package/lib/webhook_auth.d.ts +0 -27
- package/lib/webhook_auth.d.ts.map +0 -1
- package/lib/webhook_auth.js +0 -50
- package/lib/webhook_auth.js.map +0 -1
- package/lib/webhook_auth.mjs +0 -45
- package/lib/webhook_auth.mjs.map +0 -1
- package/shims/node.d.ts +0 -30
- package/shims/node.d.ts.map +0 -1
- package/shims/node.js +0 -31
- package/shims/node.js.map +0 -1
- package/shims/node.mjs +0 -5
- package/shims/node.mjs.map +0 -1
- package/shims/web.d.ts +0 -26
- package/shims/web.d.ts.map +0 -1
- package/shims/web.js +0 -31
- package/shims/web.js.map +0 -1
- package/shims/web.mjs +0 -5
- package/shims/web.mjs.map +0 -1
- package/src/_shims/MultipartBody.ts +0 -9
- package/src/_shims/README.md +0 -46
- package/src/_shims/auto/runtime-bun.ts +0 -4
- package/src/_shims/auto/runtime-node.ts +0 -4
- package/src/_shims/auto/runtime.ts +0 -4
- package/src/_shims/auto/types-node.ts +0 -4
- package/src/_shims/auto/types.d.ts +0 -101
- package/src/_shims/auto/types.js +0 -3
- package/src/_shims/auto/types.mjs +0 -3
- package/src/_shims/bun-runtime.ts +0 -14
- package/src/_shims/index.d.ts +0 -83
- package/src/_shims/index.js +0 -17
- package/src/_shims/index.mjs +0 -11
- package/src/_shims/manual-types.d.ts +0 -12
- package/src/_shims/manual-types.js +0 -3
- package/src/_shims/manual-types.mjs +0 -3
- package/src/_shims/node-runtime.ts +0 -81
- package/src/_shims/node-types.d.ts +0 -42
- package/src/_shims/node-types.js +0 -3
- package/src/_shims/node-types.mjs +0 -3
- package/src/_shims/registry.ts +0 -67
- package/src/_shims/web-runtime.ts +0 -103
- package/src/_shims/web-types.d.ts +0 -83
- package/src/_shims/web-types.js +0 -3
- package/src/_shims/web-types.mjs +0 -3
- package/src/core.ts +0 -1236
- package/src/lib/webhook_auth.ts +0 -69
- package/src/shims/node.ts +0 -50
- package/src/shims/web.ts +0 -50
package/resources/agent.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { APIResource } from "../resource.js";
|
|
2
|
-
import
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
3
4
|
export declare class Agent extends APIResource {
|
|
4
5
|
/**
|
|
5
6
|
* Create a new agent
|
|
@@ -15,7 +16,7 @@ export declare class Agent extends APIResource {
|
|
|
15
16
|
* });
|
|
16
17
|
* ```
|
|
17
18
|
*/
|
|
18
|
-
create(body: AgentCreateParams, options?:
|
|
19
|
+
create(body: AgentCreateParams, options?: RequestOptions): APIPromise<AgentResponse>;
|
|
19
20
|
/**
|
|
20
21
|
* Retrieve details of a specific agent
|
|
21
22
|
*
|
|
@@ -26,8 +27,7 @@ export declare class Agent extends APIResource {
|
|
|
26
27
|
* );
|
|
27
28
|
* ```
|
|
28
29
|
*/
|
|
29
|
-
retrieve(
|
|
30
|
-
retrieve(agentId: string, options?: Core.RequestOptions): Core.APIPromise<AgentResponse>;
|
|
30
|
+
retrieve(agentID: string, query?: AgentRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<AgentResponse>;
|
|
31
31
|
/**
|
|
32
32
|
* Update an existing agent's latest draft version
|
|
33
33
|
*
|
|
@@ -39,7 +39,7 @@ export declare class Agent extends APIResource {
|
|
|
39
39
|
* );
|
|
40
40
|
* ```
|
|
41
41
|
*/
|
|
42
|
-
update(
|
|
42
|
+
update(agentID: string, params: AgentUpdateParams, options?: RequestOptions): APIPromise<AgentResponse>;
|
|
43
43
|
/**
|
|
44
44
|
* List all agents
|
|
45
45
|
*
|
|
@@ -48,8 +48,7 @@ export declare class Agent extends APIResource {
|
|
|
48
48
|
* const agentResponses = await client.agent.list();
|
|
49
49
|
* ```
|
|
50
50
|
*/
|
|
51
|
-
list(query?: AgentListParams, options?:
|
|
52
|
-
list(options?: Core.RequestOptions): Core.APIPromise<AgentListResponse>;
|
|
51
|
+
list(query?: AgentListParams | null | undefined, options?: RequestOptions): APIPromise<AgentListResponse>;
|
|
53
52
|
/**
|
|
54
53
|
* Delete an existing agent
|
|
55
54
|
*
|
|
@@ -60,7 +59,7 @@ export declare class Agent extends APIResource {
|
|
|
60
59
|
* );
|
|
61
60
|
* ```
|
|
62
61
|
*/
|
|
63
|
-
delete(
|
|
62
|
+
delete(agentID: string, options?: RequestOptions): APIPromise<void>;
|
|
64
63
|
/**
|
|
65
64
|
* Get all versions of an agent
|
|
66
65
|
*
|
|
@@ -71,7 +70,7 @@ export declare class Agent extends APIResource {
|
|
|
71
70
|
* );
|
|
72
71
|
* ```
|
|
73
72
|
*/
|
|
74
|
-
getVersions(
|
|
73
|
+
getVersions(agentID: string, options?: RequestOptions): APIPromise<AgentGetVersionsResponse>;
|
|
75
74
|
/**
|
|
76
75
|
* Publish the latest version of the agent and create a new draft agent with newer
|
|
77
76
|
* version.
|
|
@@ -83,7 +82,7 @@ export declare class Agent extends APIResource {
|
|
|
83
82
|
* );
|
|
84
83
|
* ```
|
|
85
84
|
*/
|
|
86
|
-
publish(
|
|
85
|
+
publish(agentID: string, options?: RequestOptions): APIPromise<void>;
|
|
87
86
|
}
|
|
88
87
|
export interface AgentResponse {
|
|
89
88
|
/**
|
|
@@ -101,6 +100,10 @@ export interface AgentResponse {
|
|
|
101
100
|
* agent.
|
|
102
101
|
*/
|
|
103
102
|
response_engine: AgentResponse.ResponseEngineRetellLm | AgentResponse.ResponseEngineCustomLm | AgentResponse.ResponseEngineConversationFlow;
|
|
103
|
+
/**
|
|
104
|
+
* Version of the agent.
|
|
105
|
+
*/
|
|
106
|
+
version: number;
|
|
104
107
|
/**
|
|
105
108
|
* Unique voice id used for the agent. Find list of available voices and their
|
|
106
109
|
* preview in Dashboard.
|
|
@@ -121,24 +124,18 @@ export interface AgentResponse {
|
|
|
121
124
|
*
|
|
122
125
|
* - `coffee-shop`: Coffee shop ambience with people chatting in background.
|
|
123
126
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
|
|
124
|
-
*
|
|
125
127
|
* - `convention-hall`: Convention hall ambience, with some echo and people
|
|
126
128
|
* chatting in background.
|
|
127
129
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
|
|
128
|
-
*
|
|
129
130
|
* - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
|
|
130
131
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
|
|
131
|
-
*
|
|
132
132
|
* - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
|
|
133
133
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
|
|
134
|
-
*
|
|
135
134
|
* - `static-noise`: Constant static noise.
|
|
136
135
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/static-noise.wav)
|
|
137
|
-
*
|
|
138
136
|
* - `call-center`: Call center work noise.
|
|
139
137
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/call-center.wav)
|
|
140
|
-
*
|
|
141
|
-
* Set to `null` to remove ambient sound from this agent.
|
|
138
|
+
* Set to `null` to remove ambient sound from this agent.
|
|
142
139
|
*/
|
|
143
140
|
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
|
|
144
141
|
/**
|
|
@@ -187,6 +184,10 @@ export interface AgentResponse {
|
|
|
187
184
|
* street, etc.
|
|
188
185
|
*/
|
|
189
186
|
boosted_keywords?: Array<string> | null;
|
|
187
|
+
/**
|
|
188
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
189
|
+
*/
|
|
190
|
+
custom_stt_config?: AgentResponse.CustomSttConfig;
|
|
190
191
|
/**
|
|
191
192
|
* Granular setting to manage how Retell stores sensitive data (transcripts,
|
|
192
193
|
* recordings, logs, etc.). This replaces the deprecated
|
|
@@ -200,9 +201,10 @@ export interface AgentResponse {
|
|
|
200
201
|
*/
|
|
201
202
|
data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
|
|
202
203
|
/**
|
|
203
|
-
* If set, determines what denoising mode to use.
|
|
204
|
+
* If set, determines what denoising mode to use. Use "no-denoise" to bypass all
|
|
205
|
+
* audio denoising. Default to noise-cancellation.
|
|
204
206
|
*/
|
|
205
|
-
denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
207
|
+
denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
206
208
|
/**
|
|
207
209
|
* Controls whether the agent would backchannel (agent interjects the speaker with
|
|
208
210
|
* phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
|
|
@@ -210,6 +212,16 @@ export interface AgentResponse {
|
|
|
210
212
|
* will not backchannel.
|
|
211
213
|
*/
|
|
212
214
|
enable_backchannel?: boolean;
|
|
215
|
+
/**
|
|
216
|
+
* If set to true, will enable dynamic voice speed adjustment based on the user's
|
|
217
|
+
* speech rate and conversation context. If unset, default value false will apply.
|
|
218
|
+
*/
|
|
219
|
+
enable_dynamic_voice_speed?: boolean;
|
|
220
|
+
/**
|
|
221
|
+
* If set to true, will detect whether the call enters a voicemail. Note that this
|
|
222
|
+
* feature is only available for phone calls.
|
|
223
|
+
*/
|
|
224
|
+
enable_voicemail_detection?: boolean;
|
|
213
225
|
/**
|
|
214
226
|
* If users stay silent for a period after agent speech, end the call. The minimum
|
|
215
227
|
* value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
|
|
@@ -223,6 +235,11 @@ export interface AgentResponse {
|
|
|
223
235
|
* one. Set to null to remove voice fallback for the agent.
|
|
224
236
|
*/
|
|
225
237
|
fallback_voice_ids?: Array<string> | null;
|
|
238
|
+
/**
|
|
239
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
240
|
+
* agent output and user input.
|
|
241
|
+
*/
|
|
242
|
+
guardrail_config?: AgentResponse.GuardrailConfig;
|
|
226
243
|
/**
|
|
227
244
|
* Controls how sensitive the agent is to user interruptions. Value ranging from
|
|
228
245
|
* [0,1]. Lower value means it will take longer / more words for user to interrupt
|
|
@@ -231,17 +248,28 @@ export interface AgentResponse {
|
|
|
231
248
|
* interrupted.
|
|
232
249
|
*/
|
|
233
250
|
interruption_sensitivity?: number;
|
|
251
|
+
/**
|
|
252
|
+
* Whether the agent is public. When set to true, the agent is available for public
|
|
253
|
+
* agent preview link.
|
|
254
|
+
*/
|
|
255
|
+
is_public?: boolean | null;
|
|
234
256
|
/**
|
|
235
257
|
* Whether the agent is published.
|
|
236
258
|
*/
|
|
237
259
|
is_published?: boolean;
|
|
260
|
+
/**
|
|
261
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
262
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
263
|
+
* null to disable IVR detection.
|
|
264
|
+
*/
|
|
265
|
+
ivr_option?: AgentResponse.IvrOption | null;
|
|
238
266
|
/**
|
|
239
267
|
* Specifies what language (and dialect) the speech recognition will operate in.
|
|
240
268
|
* For instance, selecting `en-GB` optimizes speech recognition for British
|
|
241
269
|
* English. If unset, will use default value `en-US`. Select `multi` for
|
|
242
|
-
* multilingual support
|
|
270
|
+
* multilingual support.
|
|
243
271
|
*/
|
|
244
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | '
|
|
272
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | 'multi';
|
|
245
273
|
/**
|
|
246
274
|
* Maximum allowed length for the call, will force end the call if reached. The
|
|
247
275
|
* minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
|
|
@@ -277,7 +305,7 @@ export interface AgentResponse {
|
|
|
277
305
|
/**
|
|
278
306
|
* The model to use for post call analysis. Default to gpt-4.1-mini.
|
|
279
307
|
*/
|
|
280
|
-
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | null;
|
|
308
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
|
|
281
309
|
/**
|
|
282
310
|
* A list of words / phrases and their pronunciation to be used to guide the audio
|
|
283
311
|
* synthesize for consistent pronunciation. Currently only supported for English &
|
|
@@ -317,14 +345,15 @@ export interface AgentResponse {
|
|
|
317
345
|
signed_url_expiration_ms?: number | null;
|
|
318
346
|
/**
|
|
319
347
|
* If set, determines whether speech to text should focus on latency or accuracy.
|
|
320
|
-
* Default to fast mode.
|
|
348
|
+
* Default to fast mode. When set to custom, custom_stt_config must be provided.
|
|
321
349
|
*/
|
|
322
|
-
stt_mode?: 'fast' | 'accurate';
|
|
350
|
+
stt_mode?: 'fast' | 'accurate' | 'custom';
|
|
323
351
|
user_dtmf_options?: AgentResponse.UserDtmfOptions | null;
|
|
324
352
|
/**
|
|
325
|
-
*
|
|
353
|
+
* Optional description of the agent version. Used for your own reference and
|
|
354
|
+
* documentation.
|
|
326
355
|
*/
|
|
327
|
-
|
|
356
|
+
version_description?: string | null;
|
|
328
357
|
/**
|
|
329
358
|
* If set, determines the vocabulary set to use for transcription. This setting
|
|
330
359
|
* only applies for English agents, for non English agent, this setting is a no-op.
|
|
@@ -332,12 +361,16 @@ export interface AgentResponse {
|
|
|
332
361
|
*/
|
|
333
362
|
vocab_specialization?: 'general' | 'medical';
|
|
334
363
|
/**
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
|
|
338
|
-
|
|
364
|
+
* Controls the emotional tone of the agent's voice. Currently supported for
|
|
365
|
+
* Cartesia and Minimax TTS providers. If unset, no emotion will be used.
|
|
366
|
+
*/
|
|
367
|
+
voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
|
|
368
|
+
/**
|
|
369
|
+
* Select the voice model used for the selected voice. Each provider has a set of
|
|
370
|
+
* available voice models. Set to null to remove voice model selection, and default
|
|
371
|
+
* ones will apply. Check out dashboard for more details of each voice model.
|
|
339
372
|
*/
|
|
340
|
-
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'tts-1' | 'gpt-4o-mini-tts' | null;
|
|
373
|
+
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'sonic-2' | 'sonic-3' | 'sonic-3-latest' | 'sonic-turbo' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | null;
|
|
341
374
|
/**
|
|
342
375
|
* Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
|
|
343
376
|
* speech, while higher value means faster speech rate. If unset, default value 1
|
|
@@ -351,6 +384,19 @@ export interface AgentResponse {
|
|
|
351
384
|
* apply.
|
|
352
385
|
*/
|
|
353
386
|
voice_temperature?: number;
|
|
387
|
+
/**
|
|
388
|
+
* Configures when to stop running voicemail detection, as it becomes unlikely to
|
|
389
|
+
* hit voicemail after a couple minutes, and keep running it will only have
|
|
390
|
+
* negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
|
|
391
|
+
* allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
|
|
392
|
+
*/
|
|
393
|
+
voicemail_detection_timeout_ms?: number;
|
|
394
|
+
/**
|
|
395
|
+
* The message to be played when the call enters a voicemail. Note that this
|
|
396
|
+
* feature is only available for phone calls. If you want to hangup after hitting
|
|
397
|
+
* voicemail, set this to empty string.
|
|
398
|
+
*/
|
|
399
|
+
voicemail_message?: string;
|
|
354
400
|
/**
|
|
355
401
|
* If this option is set, the call will try to detect voicemail in the first 3
|
|
356
402
|
* minutes of the call. Actions defined (hangup, or leave a message) will be
|
|
@@ -364,6 +410,11 @@ export interface AgentResponse {
|
|
|
364
410
|
* If unset, default value 1 will apply.
|
|
365
411
|
*/
|
|
366
412
|
volume?: number;
|
|
413
|
+
/**
|
|
414
|
+
* Which webhook events this agent should receive. If not set, defaults to
|
|
415
|
+
* call_started, call_ended, call_analyzed.
|
|
416
|
+
*/
|
|
417
|
+
webhook_events?: Array<'call_started' | 'call_ended' | 'call_analyzed' | 'transcript_updated' | 'transfer_started' | 'transfer_bridged' | 'transfer_cancelled' | 'transfer_ended'> | null;
|
|
367
418
|
/**
|
|
368
419
|
* The timeout for the webhook in milliseconds. If not set, default value of 10000
|
|
369
420
|
* will apply.
|
|
@@ -416,6 +467,49 @@ export declare namespace AgentResponse {
|
|
|
416
467
|
*/
|
|
417
468
|
version?: number | null;
|
|
418
469
|
}
|
|
470
|
+
/**
|
|
471
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
472
|
+
*/
|
|
473
|
+
interface CustomSttConfig {
|
|
474
|
+
/**
|
|
475
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for azure, 10 for deepgram.
|
|
476
|
+
*/
|
|
477
|
+
endpointing_ms: number;
|
|
478
|
+
/**
|
|
479
|
+
* The STT provider to use.
|
|
480
|
+
*/
|
|
481
|
+
provider: 'azure' | 'deepgram';
|
|
482
|
+
}
|
|
483
|
+
/**
|
|
484
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
485
|
+
* agent output and user input.
|
|
486
|
+
*/
|
|
487
|
+
interface GuardrailConfig {
|
|
488
|
+
/**
|
|
489
|
+
* Selected prohibited user topic categories to check. When user messages contain
|
|
490
|
+
* these topics, the agent will respond with a placeholder message instead of
|
|
491
|
+
* processing the request.
|
|
492
|
+
*/
|
|
493
|
+
input_topics?: Array<'platform_integrity_jailbreaking'> | null;
|
|
494
|
+
/**
|
|
495
|
+
* Selected prohibited agent topic categories to check. When agent messages contain
|
|
496
|
+
* these topics, they will be replaced with a placeholder message.
|
|
497
|
+
*/
|
|
498
|
+
output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
|
|
499
|
+
}
|
|
500
|
+
/**
|
|
501
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
502
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
503
|
+
* null to disable IVR detection.
|
|
504
|
+
*/
|
|
505
|
+
interface IvrOption {
|
|
506
|
+
action: IvrOption.Action;
|
|
507
|
+
}
|
|
508
|
+
namespace IvrOption {
|
|
509
|
+
interface Action {
|
|
510
|
+
type: 'hangup';
|
|
511
|
+
}
|
|
512
|
+
}
|
|
419
513
|
/**
|
|
420
514
|
* Configuration for PII scrubbing from transcripts and recordings.
|
|
421
515
|
*/
|
|
@@ -423,7 +517,7 @@ export declare namespace AgentResponse {
|
|
|
423
517
|
/**
|
|
424
518
|
* List of PII categories to scrub from transcripts and recordings.
|
|
425
519
|
*/
|
|
426
|
-
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth'>;
|
|
520
|
+
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
|
|
427
521
|
/**
|
|
428
522
|
* The processing mode for PII scrubbing. Currently only post-call is supported.
|
|
429
523
|
*/
|
|
@@ -516,7 +610,7 @@ export declare namespace AgentResponse {
|
|
|
516
610
|
digit_limit?: number | null;
|
|
517
611
|
/**
|
|
518
612
|
* A single key that signals the end of DTMF input. Acceptable values include any
|
|
519
|
-
* digit (0
|
|
613
|
+
* digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
|
|
520
614
|
*/
|
|
521
615
|
termination_key?: string | null;
|
|
522
616
|
/**
|
|
@@ -532,7 +626,7 @@ export declare namespace AgentResponse {
|
|
|
532
626
|
* detection.
|
|
533
627
|
*/
|
|
534
628
|
interface VoicemailOption {
|
|
535
|
-
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup;
|
|
629
|
+
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup | VoicemailOption.VoicemailActionBridgeTransfer;
|
|
536
630
|
}
|
|
537
631
|
namespace VoicemailOption {
|
|
538
632
|
interface VoicemailActionPrompt {
|
|
@@ -553,6 +647,9 @@ export declare namespace AgentResponse {
|
|
|
553
647
|
interface VoicemailActionHangup {
|
|
554
648
|
type: 'hangup';
|
|
555
649
|
}
|
|
650
|
+
interface VoicemailActionBridgeTransfer {
|
|
651
|
+
type: 'bridge_transfer';
|
|
652
|
+
}
|
|
556
653
|
}
|
|
557
654
|
}
|
|
558
655
|
export type AgentListResponse = Array<AgentResponse>;
|
|
@@ -584,24 +681,18 @@ export interface AgentCreateParams {
|
|
|
584
681
|
*
|
|
585
682
|
* - `coffee-shop`: Coffee shop ambience with people chatting in background.
|
|
586
683
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
|
|
587
|
-
*
|
|
588
684
|
* - `convention-hall`: Convention hall ambience, with some echo and people
|
|
589
685
|
* chatting in background.
|
|
590
686
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
|
|
591
|
-
*
|
|
592
687
|
* - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
|
|
593
688
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
|
|
594
|
-
*
|
|
595
689
|
* - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
|
|
596
690
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
|
|
597
|
-
*
|
|
598
691
|
* - `static-noise`: Constant static noise.
|
|
599
692
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/static-noise.wav)
|
|
600
|
-
*
|
|
601
693
|
* - `call-center`: Call center work noise.
|
|
602
694
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/call-center.wav)
|
|
603
|
-
*
|
|
604
|
-
* Set to `null` to remove ambient sound from this agent.
|
|
695
|
+
* Set to `null` to remove ambient sound from this agent.
|
|
605
696
|
*/
|
|
606
697
|
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
|
|
607
698
|
/**
|
|
@@ -650,6 +741,10 @@ export interface AgentCreateParams {
|
|
|
650
741
|
* street, etc.
|
|
651
742
|
*/
|
|
652
743
|
boosted_keywords?: Array<string> | null;
|
|
744
|
+
/**
|
|
745
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
746
|
+
*/
|
|
747
|
+
custom_stt_config?: AgentCreateParams.CustomSttConfig;
|
|
653
748
|
/**
|
|
654
749
|
* Granular setting to manage how Retell stores sensitive data (transcripts,
|
|
655
750
|
* recordings, logs, etc.). This replaces the deprecated
|
|
@@ -663,9 +758,10 @@ export interface AgentCreateParams {
|
|
|
663
758
|
*/
|
|
664
759
|
data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
|
|
665
760
|
/**
|
|
666
|
-
* If set, determines what denoising mode to use.
|
|
761
|
+
* If set, determines what denoising mode to use. Use "no-denoise" to bypass all
|
|
762
|
+
* audio denoising. Default to noise-cancellation.
|
|
667
763
|
*/
|
|
668
|
-
denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
764
|
+
denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
669
765
|
/**
|
|
670
766
|
* Controls whether the agent would backchannel (agent interjects the speaker with
|
|
671
767
|
* phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
|
|
@@ -673,6 +769,16 @@ export interface AgentCreateParams {
|
|
|
673
769
|
* will not backchannel.
|
|
674
770
|
*/
|
|
675
771
|
enable_backchannel?: boolean;
|
|
772
|
+
/**
|
|
773
|
+
* If set to true, will enable dynamic voice speed adjustment based on the user's
|
|
774
|
+
* speech rate and conversation context. If unset, default value false will apply.
|
|
775
|
+
*/
|
|
776
|
+
enable_dynamic_voice_speed?: boolean;
|
|
777
|
+
/**
|
|
778
|
+
* If set to true, will detect whether the call enters a voicemail. Note that this
|
|
779
|
+
* feature is only available for phone calls.
|
|
780
|
+
*/
|
|
781
|
+
enable_voicemail_detection?: boolean;
|
|
676
782
|
/**
|
|
677
783
|
* If users stay silent for a period after agent speech, end the call. The minimum
|
|
678
784
|
* value allowed is 10,000 ms (10 s). By default, this is set to 600000 (10 min).
|
|
@@ -686,6 +792,11 @@ export interface AgentCreateParams {
|
|
|
686
792
|
* one. Set to null to remove voice fallback for the agent.
|
|
687
793
|
*/
|
|
688
794
|
fallback_voice_ids?: Array<string> | null;
|
|
795
|
+
/**
|
|
796
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
797
|
+
* agent output and user input.
|
|
798
|
+
*/
|
|
799
|
+
guardrail_config?: AgentCreateParams.GuardrailConfig;
|
|
689
800
|
/**
|
|
690
801
|
* Controls how sensitive the agent is to user interruptions. Value ranging from
|
|
691
802
|
* [0,1]. Lower value means it will take longer / more words for user to interrupt
|
|
@@ -694,13 +805,24 @@ export interface AgentCreateParams {
|
|
|
694
805
|
* interrupted.
|
|
695
806
|
*/
|
|
696
807
|
interruption_sensitivity?: number;
|
|
808
|
+
/**
|
|
809
|
+
* Whether the agent is public. When set to true, the agent is available for public
|
|
810
|
+
* agent preview link.
|
|
811
|
+
*/
|
|
812
|
+
is_public?: boolean | null;
|
|
813
|
+
/**
|
|
814
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
815
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
816
|
+
* null to disable IVR detection.
|
|
817
|
+
*/
|
|
818
|
+
ivr_option?: AgentCreateParams.IvrOption | null;
|
|
697
819
|
/**
|
|
698
820
|
* Specifies what language (and dialect) the speech recognition will operate in.
|
|
699
821
|
* For instance, selecting `en-GB` optimizes speech recognition for British
|
|
700
822
|
* English. If unset, will use default value `en-US`. Select `multi` for
|
|
701
|
-
* multilingual support
|
|
823
|
+
* multilingual support.
|
|
702
824
|
*/
|
|
703
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | '
|
|
825
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | 'multi';
|
|
704
826
|
/**
|
|
705
827
|
* Maximum allowed length for the call, will force end the call if reached. The
|
|
706
828
|
* minimum value allowed is 60,000 ms (1 min), and maximum value allowed is
|
|
@@ -736,7 +858,7 @@ export interface AgentCreateParams {
|
|
|
736
858
|
/**
|
|
737
859
|
* The model to use for post call analysis. Default to gpt-4.1-mini.
|
|
738
860
|
*/
|
|
739
|
-
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | null;
|
|
861
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
|
|
740
862
|
/**
|
|
741
863
|
* A list of words / phrases and their pronunciation to be used to guide the audio
|
|
742
864
|
* synthesize for consistent pronunciation. Currently only supported for English &
|
|
@@ -776,10 +898,15 @@ export interface AgentCreateParams {
|
|
|
776
898
|
signed_url_expiration_ms?: number | null;
|
|
777
899
|
/**
|
|
778
900
|
* If set, determines whether speech to text should focus on latency or accuracy.
|
|
779
|
-
* Default to fast mode.
|
|
901
|
+
* Default to fast mode. When set to custom, custom_stt_config must be provided.
|
|
780
902
|
*/
|
|
781
|
-
stt_mode?: 'fast' | 'accurate';
|
|
903
|
+
stt_mode?: 'fast' | 'accurate' | 'custom';
|
|
782
904
|
user_dtmf_options?: AgentCreateParams.UserDtmfOptions | null;
|
|
905
|
+
/**
|
|
906
|
+
* Optional description of the agent version. Used for your own reference and
|
|
907
|
+
* documentation.
|
|
908
|
+
*/
|
|
909
|
+
version_description?: string | null;
|
|
783
910
|
/**
|
|
784
911
|
* If set, determines the vocabulary set to use for transcription. This setting
|
|
785
912
|
* only applies for English agents, for non English agent, this setting is a no-op.
|
|
@@ -787,12 +914,16 @@ export interface AgentCreateParams {
|
|
|
787
914
|
*/
|
|
788
915
|
vocab_specialization?: 'general' | 'medical';
|
|
789
916
|
/**
|
|
790
|
-
*
|
|
791
|
-
*
|
|
792
|
-
|
|
793
|
-
|
|
917
|
+
* Controls the emotional tone of the agent's voice. Currently supported for
|
|
918
|
+
* Cartesia and Minimax TTS providers. If unset, no emotion will be used.
|
|
919
|
+
*/
|
|
920
|
+
voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
|
|
921
|
+
/**
|
|
922
|
+
* Select the voice model used for the selected voice. Each provider has a set of
|
|
923
|
+
* available voice models. Set to null to remove voice model selection, and default
|
|
924
|
+
* ones will apply. Check out dashboard for more details of each voice model.
|
|
794
925
|
*/
|
|
795
|
-
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'tts-1' | 'gpt-4o-mini-tts' | null;
|
|
926
|
+
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'sonic-2' | 'sonic-3' | 'sonic-3-latest' | 'sonic-turbo' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | null;
|
|
796
927
|
/**
|
|
797
928
|
* Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
|
|
798
929
|
* speech, while higher value means faster speech rate. If unset, default value 1
|
|
@@ -806,6 +937,19 @@ export interface AgentCreateParams {
|
|
|
806
937
|
* apply.
|
|
807
938
|
*/
|
|
808
939
|
voice_temperature?: number;
|
|
940
|
+
/**
|
|
941
|
+
* Configures when to stop running voicemail detection, as it becomes unlikely to
|
|
942
|
+
* hit voicemail after a couple minutes, and keep running it will only have
|
|
943
|
+
* negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum value
|
|
944
|
+
* allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
|
|
945
|
+
*/
|
|
946
|
+
voicemail_detection_timeout_ms?: number;
|
|
947
|
+
/**
|
|
948
|
+
* The message to be played when the call enters a voicemail. Note that this
|
|
949
|
+
* feature is only available for phone calls. If you want to hangup after hitting
|
|
950
|
+
* voicemail, set this to empty string.
|
|
951
|
+
*/
|
|
952
|
+
voicemail_message?: string;
|
|
809
953
|
/**
|
|
810
954
|
* If this option is set, the call will try to detect voicemail in the first 3
|
|
811
955
|
* minutes of the call. Actions defined (hangup, or leave a message) will be
|
|
@@ -819,6 +963,11 @@ export interface AgentCreateParams {
|
|
|
819
963
|
* If unset, default value 1 will apply.
|
|
820
964
|
*/
|
|
821
965
|
volume?: number;
|
|
966
|
+
/**
|
|
967
|
+
* Which webhook events this agent should receive. If not set, defaults to
|
|
968
|
+
* call_started, call_ended, call_analyzed.
|
|
969
|
+
*/
|
|
970
|
+
webhook_events?: Array<'call_started' | 'call_ended' | 'call_analyzed' | 'transcript_updated' | 'transfer_started' | 'transfer_bridged' | 'transfer_cancelled' | 'transfer_ended'> | null;
|
|
822
971
|
/**
|
|
823
972
|
* The timeout for the webhook in milliseconds. If not set, default value of 10000
|
|
824
973
|
* will apply.
|
|
@@ -871,6 +1020,49 @@ export declare namespace AgentCreateParams {
|
|
|
871
1020
|
*/
|
|
872
1021
|
version?: number | null;
|
|
873
1022
|
}
|
|
1023
|
+
/**
|
|
1024
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
1025
|
+
*/
|
|
1026
|
+
interface CustomSttConfig {
|
|
1027
|
+
/**
|
|
1028
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for azure, 10 for deepgram.
|
|
1029
|
+
*/
|
|
1030
|
+
endpointing_ms: number;
|
|
1031
|
+
/**
|
|
1032
|
+
* The STT provider to use.
|
|
1033
|
+
*/
|
|
1034
|
+
provider: 'azure' | 'deepgram';
|
|
1035
|
+
}
|
|
1036
|
+
/**
|
|
1037
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
1038
|
+
* agent output and user input.
|
|
1039
|
+
*/
|
|
1040
|
+
interface GuardrailConfig {
|
|
1041
|
+
/**
|
|
1042
|
+
* Selected prohibited user topic categories to check. When user messages contain
|
|
1043
|
+
* these topics, the agent will respond with a placeholder message instead of
|
|
1044
|
+
* processing the request.
|
|
1045
|
+
*/
|
|
1046
|
+
input_topics?: Array<'platform_integrity_jailbreaking'> | null;
|
|
1047
|
+
/**
|
|
1048
|
+
* Selected prohibited agent topic categories to check. When agent messages contain
|
|
1049
|
+
* these topics, they will be replaced with a placeholder message.
|
|
1050
|
+
*/
|
|
1051
|
+
output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
|
|
1052
|
+
}
|
|
1053
|
+
/**
|
|
1054
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
1055
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
1056
|
+
* null to disable IVR detection.
|
|
1057
|
+
*/
|
|
1058
|
+
interface IvrOption {
|
|
1059
|
+
action: IvrOption.Action;
|
|
1060
|
+
}
|
|
1061
|
+
namespace IvrOption {
|
|
1062
|
+
interface Action {
|
|
1063
|
+
type: 'hangup';
|
|
1064
|
+
}
|
|
1065
|
+
}
|
|
874
1066
|
/**
|
|
875
1067
|
* Configuration for PII scrubbing from transcripts and recordings.
|
|
876
1068
|
*/
|
|
@@ -878,7 +1070,7 @@ export declare namespace AgentCreateParams {
|
|
|
878
1070
|
/**
|
|
879
1071
|
* List of PII categories to scrub from transcripts and recordings.
|
|
880
1072
|
*/
|
|
881
|
-
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth'>;
|
|
1073
|
+
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
|
|
882
1074
|
/**
|
|
883
1075
|
* The processing mode for PII scrubbing. Currently only post-call is supported.
|
|
884
1076
|
*/
|
|
@@ -971,7 +1163,7 @@ export declare namespace AgentCreateParams {
|
|
|
971
1163
|
digit_limit?: number | null;
|
|
972
1164
|
/**
|
|
973
1165
|
* A single key that signals the end of DTMF input. Acceptable values include any
|
|
974
|
-
* digit (0
|
|
1166
|
+
* digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
|
|
975
1167
|
*/
|
|
976
1168
|
termination_key?: string | null;
|
|
977
1169
|
/**
|
|
@@ -987,7 +1179,7 @@ export declare namespace AgentCreateParams {
|
|
|
987
1179
|
* detection.
|
|
988
1180
|
*/
|
|
989
1181
|
interface VoicemailOption {
|
|
990
|
-
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup;
|
|
1182
|
+
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup | VoicemailOption.VoicemailActionBridgeTransfer;
|
|
991
1183
|
}
|
|
992
1184
|
namespace VoicemailOption {
|
|
993
1185
|
interface VoicemailActionPrompt {
|
|
@@ -1008,6 +1200,9 @@ export declare namespace AgentCreateParams {
|
|
|
1008
1200
|
interface VoicemailActionHangup {
|
|
1009
1201
|
type: 'hangup';
|
|
1010
1202
|
}
|
|
1203
|
+
interface VoicemailActionBridgeTransfer {
|
|
1204
|
+
type: 'bridge_transfer';
|
|
1205
|
+
}
|
|
1011
1206
|
}
|
|
1012
1207
|
}
|
|
1013
1208
|
export interface AgentRetrieveParams {
|
|
@@ -1038,24 +1233,18 @@ export interface AgentUpdateParams {
|
|
|
1038
1233
|
*
|
|
1039
1234
|
* - `coffee-shop`: Coffee shop ambience with people chatting in background.
|
|
1040
1235
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
|
|
1041
|
-
*
|
|
1042
1236
|
* - `convention-hall`: Convention hall ambience, with some echo and people
|
|
1043
1237
|
* chatting in background.
|
|
1044
1238
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
|
|
1045
|
-
*
|
|
1046
1239
|
* - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
|
|
1047
1240
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
|
|
1048
|
-
*
|
|
1049
1241
|
* - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
|
|
1050
1242
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
|
|
1051
|
-
*
|
|
1052
1243
|
* - `static-noise`: Constant static noise.
|
|
1053
1244
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/static-noise.wav)
|
|
1054
|
-
*
|
|
1055
1245
|
* - `call-center`: Call center work noise.
|
|
1056
1246
|
* [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/call-center.wav)
|
|
1057
|
-
*
|
|
1058
|
-
* Set to `null` to remove ambient sound from this agent.
|
|
1247
|
+
* Set to `null` to remove ambient sound from this agent.
|
|
1059
1248
|
*/
|
|
1060
1249
|
ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'static-noise' | 'call-center' | null;
|
|
1061
1250
|
/**
|
|
@@ -1104,6 +1293,10 @@ export interface AgentUpdateParams {
|
|
|
1104
1293
|
* brands, street, etc.
|
|
1105
1294
|
*/
|
|
1106
1295
|
boosted_keywords?: Array<string> | null;
|
|
1296
|
+
/**
|
|
1297
|
+
* Body param: Custom STT configuration. Only used when stt_mode is set to custom.
|
|
1298
|
+
*/
|
|
1299
|
+
custom_stt_config?: AgentUpdateParams.CustomSttConfig;
|
|
1107
1300
|
/**
|
|
1108
1301
|
* Body param: Granular setting to manage how Retell stores sensitive data
|
|
1109
1302
|
* (transcripts, recordings, logs, etc.). This replaces the deprecated
|
|
@@ -1117,10 +1310,10 @@ export interface AgentUpdateParams {
|
|
|
1117
1310
|
*/
|
|
1118
1311
|
data_storage_setting?: 'everything' | 'everything_except_pii' | 'basic_attributes_only';
|
|
1119
1312
|
/**
|
|
1120
|
-
* Body param: If set, determines what denoising mode to use.
|
|
1121
|
-
* noise-cancellation.
|
|
1313
|
+
* Body param: If set, determines what denoising mode to use. Use "no-denoise" to
|
|
1314
|
+
* bypass all audio denoising. Default to noise-cancellation.
|
|
1122
1315
|
*/
|
|
1123
|
-
denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
1316
|
+
denoising_mode?: 'no-denoise' | 'noise-cancellation' | 'noise-and-background-speech-cancellation';
|
|
1124
1317
|
/**
|
|
1125
1318
|
* Body param: Controls whether the agent would backchannel (agent interjects the
|
|
1126
1319
|
* speaker with phrases like "yeah", "uh-huh" to signify interest and engagement).
|
|
@@ -1128,6 +1321,17 @@ export interface AgentUpdateParams {
|
|
|
1128
1321
|
* set, agent will not backchannel.
|
|
1129
1322
|
*/
|
|
1130
1323
|
enable_backchannel?: boolean;
|
|
1324
|
+
/**
|
|
1325
|
+
* Body param: If set to true, will enable dynamic voice speed adjustment based on
|
|
1326
|
+
* the user's speech rate and conversation context. If unset, default value false
|
|
1327
|
+
* will apply.
|
|
1328
|
+
*/
|
|
1329
|
+
enable_dynamic_voice_speed?: boolean;
|
|
1330
|
+
/**
|
|
1331
|
+
* Body param: If set to true, will detect whether the call enters a voicemail.
|
|
1332
|
+
* Note that this feature is only available for phone calls.
|
|
1333
|
+
*/
|
|
1334
|
+
enable_voicemail_detection?: boolean;
|
|
1131
1335
|
/**
|
|
1132
1336
|
* Body param: If users stay silent for a period after agent speech, end the call.
|
|
1133
1337
|
* The minimum value allowed is 10,000 ms (10 s). By default, this is set to 600000
|
|
@@ -1142,6 +1346,11 @@ export interface AgentUpdateParams {
|
|
|
1142
1346
|
* the next one. Set to null to remove voice fallback for the agent.
|
|
1143
1347
|
*/
|
|
1144
1348
|
fallback_voice_ids?: Array<string> | null;
|
|
1349
|
+
/**
|
|
1350
|
+
* Body param: Configuration for guardrail checks to detect and prevent prohibited
|
|
1351
|
+
* topics in agent output and user input.
|
|
1352
|
+
*/
|
|
1353
|
+
guardrail_config?: AgentUpdateParams.GuardrailConfig;
|
|
1145
1354
|
/**
|
|
1146
1355
|
* Body param: Controls how sensitive the agent is to user interruptions. Value
|
|
1147
1356
|
* ranging from [0,1]. Lower value means it will take longer / more words for user
|
|
@@ -1150,13 +1359,24 @@ export interface AgentUpdateParams {
|
|
|
1150
1359
|
* never be interrupted.
|
|
1151
1360
|
*/
|
|
1152
1361
|
interruption_sensitivity?: number;
|
|
1362
|
+
/**
|
|
1363
|
+
* Body param: Whether the agent is public. When set to true, the agent is
|
|
1364
|
+
* available for public agent preview link.
|
|
1365
|
+
*/
|
|
1366
|
+
is_public?: boolean | null;
|
|
1367
|
+
/**
|
|
1368
|
+
* Body param: If this option is set, the call will try to detect IVR in the first
|
|
1369
|
+
* 3 minutes of the call. Actions defined will be applied when the IVR is detected.
|
|
1370
|
+
* Set this to null to disable IVR detection.
|
|
1371
|
+
*/
|
|
1372
|
+
ivr_option?: AgentUpdateParams.IvrOption | null;
|
|
1153
1373
|
/**
|
|
1154
1374
|
* Body param: Specifies what language (and dialect) the speech recognition will
|
|
1155
1375
|
* operate in. For instance, selecting `en-GB` optimizes speech recognition for
|
|
1156
1376
|
* British English. If unset, will use default value `en-US`. Select `multi` for
|
|
1157
|
-
* multilingual support
|
|
1377
|
+
* multilingual support.
|
|
1158
1378
|
*/
|
|
1159
|
-
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | '
|
|
1379
|
+
language?: 'en-US' | 'en-IN' | 'en-GB' | 'en-AU' | 'en-NZ' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'fr-FR' | 'fr-CA' | 'ja-JP' | 'pt-PT' | 'pt-BR' | 'zh-CN' | 'ru-RU' | 'it-IT' | 'ko-KR' | 'nl-NL' | 'nl-BE' | 'pl-PL' | 'tr-TR' | 'vi-VN' | 'ro-RO' | 'bg-BG' | 'ca-ES' | 'th-TH' | 'da-DK' | 'fi-FI' | 'el-GR' | 'hu-HU' | 'id-ID' | 'no-NO' | 'sk-SK' | 'sv-SE' | 'lt-LT' | 'lv-LV' | 'cs-CZ' | 'ms-MY' | 'af-ZA' | 'ar-SA' | 'az-AZ' | 'bs-BA' | 'cy-GB' | 'fa-IR' | 'fil-PH' | 'gl-ES' | 'he-IL' | 'hr-HR' | 'hy-AM' | 'is-IS' | 'kk-KZ' | 'kn-IN' | 'mk-MK' | 'mr-IN' | 'ne-NP' | 'sl-SI' | 'sr-RS' | 'sw-KE' | 'ta-IN' | 'ur-IN' | 'yue-CN' | 'uk-UA' | 'multi';
|
|
1160
1380
|
/**
|
|
1161
1381
|
* Body param: Maximum allowed length for the call, will force end the call if
|
|
1162
1382
|
* reached. The minimum value allowed is 60,000 ms (1 min), and maximum value
|
|
@@ -1192,7 +1412,7 @@ export interface AgentUpdateParams {
|
|
|
1192
1412
|
/**
|
|
1193
1413
|
* Body param: The model to use for post call analysis. Default to gpt-4.1-mini.
|
|
1194
1414
|
*/
|
|
1195
|
-
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | null;
|
|
1415
|
+
post_call_analysis_model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
|
|
1196
1416
|
/**
|
|
1197
1417
|
* Body param: A list of words / phrases and their pronunciation to be used to
|
|
1198
1418
|
* guide the audio synthesize for consistent pronunciation. Currently only
|
|
@@ -1240,31 +1460,43 @@ export interface AgentUpdateParams {
|
|
|
1240
1460
|
signed_url_expiration_ms?: number | null;
|
|
1241
1461
|
/**
|
|
1242
1462
|
* Body param: If set, determines whether speech to text should focus on latency or
|
|
1243
|
-
* accuracy. Default to fast mode.
|
|
1463
|
+
* accuracy. Default to fast mode. When set to custom, custom_stt_config must be
|
|
1464
|
+
* provided.
|
|
1244
1465
|
*/
|
|
1245
|
-
stt_mode?: 'fast' | 'accurate';
|
|
1466
|
+
stt_mode?: 'fast' | 'accurate' | 'custom';
|
|
1246
1467
|
/**
|
|
1247
|
-
* Body param
|
|
1468
|
+
* Body param
|
|
1248
1469
|
*/
|
|
1249
1470
|
user_dtmf_options?: AgentUpdateParams.UserDtmfOptions | null;
|
|
1471
|
+
/**
|
|
1472
|
+
* Body param: Optional description of the agent version. Used for your own
|
|
1473
|
+
* reference and documentation.
|
|
1474
|
+
*/
|
|
1475
|
+
version_description?: string | null;
|
|
1250
1476
|
/**
|
|
1251
1477
|
* Body param: If set, determines the vocabulary set to use for transcription. This
|
|
1252
1478
|
* setting only applies for English agents, for non English agent, this setting is
|
|
1253
1479
|
* a no-op. Default to general.
|
|
1254
1480
|
*/
|
|
1255
1481
|
vocab_specialization?: 'general' | 'medical';
|
|
1482
|
+
/**
|
|
1483
|
+
* Body param: Controls the emotional tone of the agent's voice. Currently
|
|
1484
|
+
* supported for Cartesia and Minimax TTS providers. If unset, no emotion will be
|
|
1485
|
+
* used.
|
|
1486
|
+
*/
|
|
1487
|
+
voice_emotion?: 'calm' | 'sympathetic' | 'happy' | 'sad' | 'angry' | 'fearful' | 'surprised' | null;
|
|
1256
1488
|
/**
|
|
1257
1489
|
* Body param: Unique voice id used for the agent. Find list of available voices
|
|
1258
1490
|
* and their preview in Dashboard.
|
|
1259
1491
|
*/
|
|
1260
1492
|
voice_id?: string;
|
|
1261
1493
|
/**
|
|
1262
|
-
* Body param:
|
|
1263
|
-
*
|
|
1264
|
-
*
|
|
1265
|
-
*
|
|
1494
|
+
* Body param: Select the voice model used for the selected voice. Each provider
|
|
1495
|
+
* has a set of available voice models. Set to null to remove voice model
|
|
1496
|
+
* selection, and default ones will apply. Check out dashboard for more details of
|
|
1497
|
+
* each voice model.
|
|
1266
1498
|
*/
|
|
1267
|
-
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'tts-1' | 'gpt-4o-mini-tts' | null;
|
|
1499
|
+
voice_model?: 'eleven_turbo_v2' | 'eleven_flash_v2' | 'eleven_turbo_v2_5' | 'eleven_flash_v2_5' | 'eleven_multilingual_v2' | 'sonic-2' | 'sonic-3' | 'sonic-3-latest' | 'sonic-turbo' | 'tts-1' | 'gpt-4o-mini-tts' | 'speech-02-turbo' | 'speech-2.8-turbo' | null;
|
|
1268
1500
|
/**
|
|
1269
1501
|
* Body param: Controls speed of voice. Value ranging from [0.5,2]. Lower value
|
|
1270
1502
|
* means slower speech, while higher value means faster speech rate. If unset,
|
|
@@ -1278,6 +1510,19 @@ export interface AgentUpdateParams {
|
|
|
1278
1510
|
* 1 will apply.
|
|
1279
1511
|
*/
|
|
1280
1512
|
voice_temperature?: number;
|
|
1513
|
+
/**
|
|
1514
|
+
* Body param: Configures when to stop running voicemail detection, as it becomes
|
|
1515
|
+
* unlikely to hit voicemail after a couple minutes, and keep running it will only
|
|
1516
|
+
* have negative impact. The minimum value allowed is 5,000 ms (5 s), and maximum
|
|
1517
|
+
* value allowed is 180,000 (3 minutes). By default, this is set to 30,000 (30 s).
|
|
1518
|
+
*/
|
|
1519
|
+
voicemail_detection_timeout_ms?: number;
|
|
1520
|
+
/**
|
|
1521
|
+
* Body param: The message to be played when the call enters a voicemail. Note that
|
|
1522
|
+
* this feature is only available for phone calls. If you want to hangup after
|
|
1523
|
+
* hitting voicemail, set this to empty string.
|
|
1524
|
+
*/
|
|
1525
|
+
voicemail_message?: string;
|
|
1281
1526
|
/**
|
|
1282
1527
|
* Body param: If this option is set, the call will try to detect voicemail in the
|
|
1283
1528
|
* first 3 minutes of the call. Actions defined (hangup, or leave a message) will
|
|
@@ -1291,6 +1536,11 @@ export interface AgentUpdateParams {
|
|
|
1291
1536
|
* agent speech. If unset, default value 1 will apply.
|
|
1292
1537
|
*/
|
|
1293
1538
|
volume?: number;
|
|
1539
|
+
/**
|
|
1540
|
+
* Body param: Which webhook events this agent should receive. If not set, defaults
|
|
1541
|
+
* to call_started, call_ended, call_analyzed.
|
|
1542
|
+
*/
|
|
1543
|
+
webhook_events?: Array<'call_started' | 'call_ended' | 'call_analyzed' | 'transcript_updated' | 'transfer_started' | 'transfer_bridged' | 'transfer_cancelled' | 'transfer_ended'> | null;
|
|
1294
1544
|
/**
|
|
1295
1545
|
* Body param: The timeout for the webhook in milliseconds. If not set, default
|
|
1296
1546
|
* value of 10000 will apply.
|
|
@@ -1305,6 +1555,49 @@ export interface AgentUpdateParams {
|
|
|
1305
1555
|
webhook_url?: string | null;
|
|
1306
1556
|
}
|
|
1307
1557
|
export declare namespace AgentUpdateParams {
|
|
1558
|
+
/**
|
|
1559
|
+
* Custom STT configuration. Only used when stt_mode is set to custom.
|
|
1560
|
+
*/
|
|
1561
|
+
interface CustomSttConfig {
|
|
1562
|
+
/**
|
|
1563
|
+
* Endpointing timeout in milliseconds. Minimum is 100 for azure, 10 for deepgram.
|
|
1564
|
+
*/
|
|
1565
|
+
endpointing_ms: number;
|
|
1566
|
+
/**
|
|
1567
|
+
* The STT provider to use.
|
|
1568
|
+
*/
|
|
1569
|
+
provider: 'azure' | 'deepgram';
|
|
1570
|
+
}
|
|
1571
|
+
/**
|
|
1572
|
+
* Configuration for guardrail checks to detect and prevent prohibited topics in
|
|
1573
|
+
* agent output and user input.
|
|
1574
|
+
*/
|
|
1575
|
+
interface GuardrailConfig {
|
|
1576
|
+
/**
|
|
1577
|
+
* Selected prohibited user topic categories to check. When user messages contain
|
|
1578
|
+
* these topics, the agent will respond with a placeholder message instead of
|
|
1579
|
+
* processing the request.
|
|
1580
|
+
*/
|
|
1581
|
+
input_topics?: Array<'platform_integrity_jailbreaking'> | null;
|
|
1582
|
+
/**
|
|
1583
|
+
* Selected prohibited agent topic categories to check. When agent messages contain
|
|
1584
|
+
* these topics, they will be replaced with a placeholder message.
|
|
1585
|
+
*/
|
|
1586
|
+
output_topics?: Array<'harassment' | 'self_harm' | 'sexual_exploitation' | 'violence' | 'defense_and_national_security' | 'illicit_and_harmful_activity' | 'gambling' | 'regulated_professional_advice' | 'child_safety_and_exploitation'> | null;
|
|
1587
|
+
}
|
|
1588
|
+
/**
|
|
1589
|
+
* If this option is set, the call will try to detect IVR in the first 3 minutes of
|
|
1590
|
+
* the call. Actions defined will be applied when the IVR is detected. Set this to
|
|
1591
|
+
* null to disable IVR detection.
|
|
1592
|
+
*/
|
|
1593
|
+
interface IvrOption {
|
|
1594
|
+
action: IvrOption.Action;
|
|
1595
|
+
}
|
|
1596
|
+
namespace IvrOption {
|
|
1597
|
+
interface Action {
|
|
1598
|
+
type: 'hangup';
|
|
1599
|
+
}
|
|
1600
|
+
}
|
|
1308
1601
|
/**
|
|
1309
1602
|
* Configuration for PII scrubbing from transcripts and recordings.
|
|
1310
1603
|
*/
|
|
@@ -1312,7 +1605,7 @@ export declare namespace AgentUpdateParams {
|
|
|
1312
1605
|
/**
|
|
1313
1606
|
* List of PII categories to scrub from transcripts and recordings.
|
|
1314
1607
|
*/
|
|
1315
|
-
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth'>;
|
|
1608
|
+
categories: Array<'person_name' | 'address' | 'email' | 'phone_number' | 'ssn' | 'passport' | 'driver_license' | 'credit_card' | 'bank_account' | 'password' | 'pin' | 'medical_id' | 'date_of_birth' | 'customer_account_number'>;
|
|
1316
1609
|
/**
|
|
1317
1610
|
* The processing mode for PII scrubbing. Currently only post-call is supported.
|
|
1318
1611
|
*/
|
|
@@ -1443,7 +1736,7 @@ export declare namespace AgentUpdateParams {
|
|
|
1443
1736
|
digit_limit?: number | null;
|
|
1444
1737
|
/**
|
|
1445
1738
|
* A single key that signals the end of DTMF input. Acceptable values include any
|
|
1446
|
-
* digit (0
|
|
1739
|
+
* digit (0-9), the pound/hash symbol (#), or the asterisk (\*).
|
|
1447
1740
|
*/
|
|
1448
1741
|
termination_key?: string | null;
|
|
1449
1742
|
/**
|
|
@@ -1459,7 +1752,7 @@ export declare namespace AgentUpdateParams {
|
|
|
1459
1752
|
* detection.
|
|
1460
1753
|
*/
|
|
1461
1754
|
interface VoicemailOption {
|
|
1462
|
-
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup;
|
|
1755
|
+
action: VoicemailOption.VoicemailActionPrompt | VoicemailOption.VoicemailActionStaticText | VoicemailOption.VoicemailActionHangup | VoicemailOption.VoicemailActionBridgeTransfer;
|
|
1463
1756
|
}
|
|
1464
1757
|
namespace VoicemailOption {
|
|
1465
1758
|
interface VoicemailActionPrompt {
|
|
@@ -1480,6 +1773,9 @@ export declare namespace AgentUpdateParams {
|
|
|
1480
1773
|
interface VoicemailActionHangup {
|
|
1481
1774
|
type: 'hangup';
|
|
1482
1775
|
}
|
|
1776
|
+
interface VoicemailActionBridgeTransfer {
|
|
1777
|
+
type: 'bridge_transfer';
|
|
1778
|
+
}
|
|
1483
1779
|
}
|
|
1484
1780
|
}
|
|
1485
1781
|
export interface AgentListParams {
|