retell-sdk 0.1.0-alpha.1

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.
Files changed (193) hide show
  1. package/CHANGELOG.md +59 -0
  2. package/LICENSE +201 -0
  3. package/README.md +304 -0
  4. package/_shims/MultipartBody.d.ts +9 -0
  5. package/_shims/MultipartBody.d.ts.map +1 -0
  6. package/_shims/MultipartBody.js +16 -0
  7. package/_shims/MultipartBody.js.map +1 -0
  8. package/_shims/MultipartBody.mjs +12 -0
  9. package/_shims/MultipartBody.mjs.map +1 -0
  10. package/_shims/README.md +46 -0
  11. package/_shims/auto/runtime-bun.d.ts +5 -0
  12. package/_shims/auto/runtime-bun.d.ts.map +1 -0
  13. package/_shims/auto/runtime-bun.js +21 -0
  14. package/_shims/auto/runtime-bun.js.map +1 -0
  15. package/_shims/auto/runtime-bun.mjs +2 -0
  16. package/_shims/auto/runtime-bun.mjs.map +1 -0
  17. package/_shims/auto/runtime-node.d.ts +5 -0
  18. package/_shims/auto/runtime-node.d.ts.map +1 -0
  19. package/_shims/auto/runtime-node.js +21 -0
  20. package/_shims/auto/runtime-node.js.map +1 -0
  21. package/_shims/auto/runtime-node.mjs +2 -0
  22. package/_shims/auto/runtime-node.mjs.map +1 -0
  23. package/_shims/auto/runtime.d.ts +5 -0
  24. package/_shims/auto/runtime.d.ts.map +1 -0
  25. package/_shims/auto/runtime.js +21 -0
  26. package/_shims/auto/runtime.js.map +1 -0
  27. package/_shims/auto/runtime.mjs +2 -0
  28. package/_shims/auto/runtime.mjs.map +1 -0
  29. package/_shims/auto/types-node.d.ts +5 -0
  30. package/_shims/auto/types-node.d.ts.map +1 -0
  31. package/_shims/auto/types-node.js +21 -0
  32. package/_shims/auto/types-node.js.map +1 -0
  33. package/_shims/auto/types-node.mjs +2 -0
  34. package/_shims/auto/types-node.mjs.map +1 -0
  35. package/_shims/auto/types.d.ts +101 -0
  36. package/_shims/auto/types.js +3 -0
  37. package/_shims/auto/types.mjs +3 -0
  38. package/_shims/bun-runtime.d.ts +6 -0
  39. package/_shims/bun-runtime.d.ts.map +1 -0
  40. package/_shims/bun-runtime.js +14 -0
  41. package/_shims/bun-runtime.js.map +1 -0
  42. package/_shims/bun-runtime.mjs +10 -0
  43. package/_shims/bun-runtime.mjs.map +1 -0
  44. package/_shims/index.d.ts +81 -0
  45. package/_shims/index.js +13 -0
  46. package/_shims/index.mjs +7 -0
  47. package/_shims/manual-types.d.ts +12 -0
  48. package/_shims/manual-types.js +3 -0
  49. package/_shims/manual-types.mjs +3 -0
  50. package/_shims/node-runtime.d.ts +3 -0
  51. package/_shims/node-runtime.d.ts.map +1 -0
  52. package/_shims/node-runtime.js +90 -0
  53. package/_shims/node-runtime.js.map +1 -0
  54. package/_shims/node-runtime.mjs +56 -0
  55. package/_shims/node-runtime.mjs.map +1 -0
  56. package/_shims/node-types.d.ts +42 -0
  57. package/_shims/node-types.js +3 -0
  58. package/_shims/node-types.mjs +3 -0
  59. package/_shims/registry.d.ts +37 -0
  60. package/_shims/registry.d.ts.map +1 -0
  61. package/_shims/registry.js +41 -0
  62. package/_shims/registry.js.map +1 -0
  63. package/_shims/registry.mjs +37 -0
  64. package/_shims/registry.mjs.map +1 -0
  65. package/_shims/web-runtime.d.ts +5 -0
  66. package/_shims/web-runtime.d.ts.map +1 -0
  67. package/_shims/web-runtime.js +78 -0
  68. package/_shims/web-runtime.js.map +1 -0
  69. package/_shims/web-runtime.mjs +71 -0
  70. package/_shims/web-runtime.mjs.map +1 -0
  71. package/_shims/web-types.d.ts +83 -0
  72. package/_shims/web-types.js +3 -0
  73. package/_shims/web-types.mjs +3 -0
  74. package/core.d.ts +237 -0
  75. package/core.d.ts.map +1 -0
  76. package/core.js +868 -0
  77. package/core.js.map +1 -0
  78. package/core.mjs +837 -0
  79. package/core.mjs.map +1 -0
  80. package/error.d.ts +53 -0
  81. package/error.d.ts.map +1 -0
  82. package/error.js +143 -0
  83. package/error.js.map +1 -0
  84. package/error.mjs +127 -0
  85. package/error.mjs.map +1 -0
  86. package/index.d.mts +133 -0
  87. package/index.d.ts +133 -0
  88. package/index.d.ts.map +1 -0
  89. package/index.js +117 -0
  90. package/index.js.map +1 -0
  91. package/index.mjs +89 -0
  92. package/index.mjs.map +1 -0
  93. package/package.json +107 -0
  94. package/resource.d.ts +6 -0
  95. package/resource.d.ts.map +1 -0
  96. package/resource.js +11 -0
  97. package/resource.js.map +1 -0
  98. package/resource.mjs +7 -0
  99. package/resource.mjs.map +1 -0
  100. package/resources/agent.d.ts +372 -0
  101. package/resources/agent.d.ts.map +1 -0
  102. package/resources/agent.js +44 -0
  103. package/resources/agent.js.map +1 -0
  104. package/resources/agent.mjs +40 -0
  105. package/resources/agent.mjs.map +1 -0
  106. package/resources/call.d.ts +461 -0
  107. package/resources/call.d.ts.map +1 -0
  108. package/resources/call.js +36 -0
  109. package/resources/call.js.map +1 -0
  110. package/resources/call.mjs +32 -0
  111. package/resources/call.mjs.map +1 -0
  112. package/resources/index.d.ts +5 -0
  113. package/resources/index.d.ts.map +1 -0
  114. package/resources/index.js +13 -0
  115. package/resources/index.js.map +1 -0
  116. package/resources/index.mjs +6 -0
  117. package/resources/index.mjs.map +1 -0
  118. package/resources/llm.d.ts +1355 -0
  119. package/resources/llm.d.ts.map +1 -0
  120. package/resources/llm.js +44 -0
  121. package/resources/llm.js.map +1 -0
  122. package/resources/llm.mjs +40 -0
  123. package/resources/llm.mjs.map +1 -0
  124. package/resources/phone-number.d.ts +78 -0
  125. package/resources/phone-number.d.ts.map +1 -0
  126. package/resources/phone-number.js +44 -0
  127. package/resources/phone-number.js.map +1 -0
  128. package/resources/phone-number.mjs +40 -0
  129. package/resources/phone-number.mjs.map +1 -0
  130. package/shims/node.d.ts +29 -0
  131. package/shims/node.d.ts.map +1 -0
  132. package/shims/node.js +31 -0
  133. package/shims/node.js.map +1 -0
  134. package/shims/node.mjs +5 -0
  135. package/shims/node.mjs.map +1 -0
  136. package/shims/web.d.ts +26 -0
  137. package/shims/web.d.ts.map +1 -0
  138. package/shims/web.js +31 -0
  139. package/shims/web.js.map +1 -0
  140. package/shims/web.mjs +5 -0
  141. package/shims/web.mjs.map +1 -0
  142. package/src/_shims/MultipartBody.ts +9 -0
  143. package/src/_shims/README.md +46 -0
  144. package/src/_shims/auto/runtime-bun.ts +4 -0
  145. package/src/_shims/auto/runtime-node.ts +4 -0
  146. package/src/_shims/auto/runtime.ts +4 -0
  147. package/src/_shims/auto/types-node.ts +4 -0
  148. package/src/_shims/auto/types.d.ts +101 -0
  149. package/src/_shims/auto/types.js +3 -0
  150. package/src/_shims/auto/types.mjs +3 -0
  151. package/src/_shims/bun-runtime.ts +14 -0
  152. package/src/_shims/index.d.ts +81 -0
  153. package/src/_shims/index.js +13 -0
  154. package/src/_shims/index.mjs +7 -0
  155. package/src/_shims/manual-types.d.ts +12 -0
  156. package/src/_shims/manual-types.js +3 -0
  157. package/src/_shims/manual-types.mjs +3 -0
  158. package/src/_shims/node-runtime.ts +83 -0
  159. package/src/_shims/node-types.d.ts +42 -0
  160. package/src/_shims/node-types.js +3 -0
  161. package/src/_shims/node-types.mjs +3 -0
  162. package/src/_shims/registry.ts +67 -0
  163. package/src/_shims/web-runtime.ts +103 -0
  164. package/src/_shims/web-types.d.ts +83 -0
  165. package/src/_shims/web-types.js +3 -0
  166. package/src/_shims/web-types.mjs +3 -0
  167. package/src/core.ts +1146 -0
  168. package/src/error.ts +146 -0
  169. package/src/index.ts +215 -0
  170. package/src/lib/.keep +4 -0
  171. package/src/resource.ts +11 -0
  172. package/src/resources/agent.ts +468 -0
  173. package/src/resources/call.ts +542 -0
  174. package/src/resources/index.ts +21 -0
  175. package/src/resources/llm.ts +1643 -0
  176. package/src/resources/phone-number.ts +111 -0
  177. package/src/shims/node.ts +50 -0
  178. package/src/shims/web.ts +50 -0
  179. package/src/tsconfig.json +11 -0
  180. package/src/uploads.ts +248 -0
  181. package/src/version.ts +1 -0
  182. package/uploads.d.ts +75 -0
  183. package/uploads.d.ts.map +1 -0
  184. package/uploads.js +165 -0
  185. package/uploads.js.map +1 -0
  186. package/uploads.mjs +152 -0
  187. package/uploads.mjs.map +1 -0
  188. package/version.d.ts +2 -0
  189. package/version.d.ts.map +1 -0
  190. package/version.js +5 -0
  191. package/version.js.map +1 -0
  192. package/version.mjs +2 -0
  193. package/version.mjs.map +1 -0
@@ -0,0 +1,372 @@
1
+ import * as Core from 'retell-sdk/core';
2
+ import { APIResource } from 'retell-sdk/resource';
3
+ import * as AgentAPI from 'retell-sdk/resources/agent';
4
+ export declare class Agent extends APIResource {
5
+ /**
6
+ * Create a new agent
7
+ */
8
+ create(body: AgentCreateParams, options?: Core.RequestOptions): Core.APIPromise<AgentResponse>;
9
+ /**
10
+ * Retrieve details of a specific agent
11
+ */
12
+ retrieve(agentId: string, options?: Core.RequestOptions): Core.APIPromise<AgentResponse>;
13
+ /**
14
+ * Update an existing agent
15
+ */
16
+ update(agentId: string, body: AgentUpdateParams, options?: Core.RequestOptions): Core.APIPromise<AgentResponse>;
17
+ /**
18
+ * List all agents
19
+ */
20
+ list(options?: Core.RequestOptions): Core.APIPromise<AgentListResponse>;
21
+ /**
22
+ * Delete an existing agent
23
+ */
24
+ delete(agentId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
25
+ }
26
+ export interface AgentResponse {
27
+ /**
28
+ * Unique id of agent.
29
+ */
30
+ agent_id: string;
31
+ /**
32
+ * Last modification timestamp (milliseconds since epoch). Either the time of last
33
+ * update or creation if no updates available.
34
+ */
35
+ last_modification_timestamp: number;
36
+ /**
37
+ * The URL we will establish LLM websocket for getting response, usually your
38
+ * server. Check out [LLM WebSocket](/api-references/llm-websocket) for more about
39
+ * request format (sent from us) and response format (send to us).
40
+ */
41
+ llm_websocket_url: string;
42
+ /**
43
+ * Unique voice id used for the agent. Find list of available voices and their
44
+ * preview in Dashboard.
45
+ */
46
+ voice_id: string;
47
+ /**
48
+ * The name of the agent. Only used for your own reference.
49
+ */
50
+ agent_name?: string;
51
+ /**
52
+ * If set, will add ambient environment sound to the call to make experience more
53
+ * realistic. Currently supports the following options:
54
+ *
55
+ * - `coffee-shop`: Coffee shop ambience with people chatting in background.
56
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
57
+ *
58
+ * - `convention-hall`: Convention hall ambience, with some echo and people
59
+ * chatting in background.
60
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
61
+ *
62
+ * - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
63
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
64
+ *
65
+ * - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
66
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
67
+ *
68
+ * Set to string `null` to remove ambient sound from this agent.
69
+ */
70
+ ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'null';
71
+ /**
72
+ * Provide a customized list of keywords to bias the transcriber model, so that
73
+ * these words are more likely to get transcribed. Commonly used for names, brands,
74
+ * street, etc.
75
+ */
76
+ boosted_keywords?: Array<string>;
77
+ /**
78
+ * Controls whether the agent would backchannel (agent interjects the speaker with
79
+ * phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
80
+ * when enabled tends to show up more in longer user utterances. If not set, agent
81
+ * will not backchannel.
82
+ */
83
+ enable_backchannel?: boolean;
84
+ /**
85
+ * Whether to format the transcribed text with inverse text normalization. It
86
+ * transforms the spoken form of text into written form for entities like phone
87
+ * number, email address, street address, etc. For example, "february fourth twenty
88
+ * twenty two" can be converted into "february 4th 2022". If not set, the default
89
+ * is true.
90
+ */
91
+ format_text?: boolean;
92
+ /**
93
+ * `Beta feature, use with caution.`
94
+ *
95
+ * This setting specifies the agent's operational language, including base language
96
+ * and dialect. Speech recognition considers both elements, but text-to-speech
97
+ * currently only recognizes the base language.
98
+ *
99
+ * For instance, selecting `en-GB` optimizes speech recognition for British
100
+ * English, yet text-to-speech output will be in standard English. If
101
+ * dialect-specific text-to-speech is required, please contact us for support.
102
+ *
103
+ * - `11lab voices`: supports English(en), German(de), Spanish(es), Hindi(hi),
104
+ * Portuguese(pt)
105
+ *
106
+ * - `openAI voices`: supports English(en), German(de), Spanish(es), Hindi(hi),
107
+ * Portuguese(pt), Japanese(ja)
108
+ *
109
+ * - `deepgram voices`: supports English(en)
110
+ */
111
+ language?: 'en-US' | 'en-IN' | 'en-GB' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'ja-JP' | 'pt-PT' | 'pt-BR';
112
+ /**
113
+ * Disable transcripts and recordings storage for enhanced privacy. Access
114
+ * transcripts securely via webhooks.
115
+ */
116
+ optOutSensitiveDataStorage?: boolean;
117
+ /**
118
+ * Controls how responsive is the agent. Value ranging from [0,1]. Lower value
119
+ * means less responsive agent (wait more, respond slower), while higher value
120
+ * means faster exchanges (respond when it can). If unset, default value 1 will
121
+ * apply.
122
+ */
123
+ responsiveness?: number;
124
+ /**
125
+ * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
126
+ * speech, while higher value means faster speech rate. If unset, default value 1
127
+ * will apply.
128
+ */
129
+ voice_speed?: number;
130
+ /**
131
+ * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
132
+ * more stable, and higher value means more variant speech generation. Currently
133
+ * this setting only applies to `11labs` voices. If unset, default value 1 will
134
+ * apply.
135
+ */
136
+ voice_temperature?: number;
137
+ /**
138
+ * The webhook for agent to listen to call events. See what events it would get at
139
+ * [webhook doc](/features/webhook). If set, will binds webhook events for this
140
+ * agent to the specified url, and will ignore the account level webhook for this
141
+ * agent. Set to string `null` to remove webhook url from this agent.
142
+ */
143
+ webhook_url?: string;
144
+ }
145
+ export type AgentListResponse = Array<AgentResponse>;
146
+ export interface AgentCreateParams {
147
+ /**
148
+ * The URL we will establish LLM websocket for getting response, usually your
149
+ * server. Check out [LLM WebSocket](/api-references/llm-websocket) for more about
150
+ * request format (sent from us) and response format (send to us).
151
+ */
152
+ llm_websocket_url: string;
153
+ /**
154
+ * Unique voice id used for the agent. Find list of available voices and their
155
+ * preview in Dashboard.
156
+ */
157
+ voice_id: string;
158
+ /**
159
+ * The name of the agent. Only used for your own reference.
160
+ */
161
+ agent_name?: string;
162
+ /**
163
+ * If set, will add ambient environment sound to the call to make experience more
164
+ * realistic. Currently supports the following options:
165
+ *
166
+ * - `coffee-shop`: Coffee shop ambience with people chatting in background.
167
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
168
+ *
169
+ * - `convention-hall`: Convention hall ambience, with some echo and people
170
+ * chatting in background.
171
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
172
+ *
173
+ * - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
174
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
175
+ *
176
+ * - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
177
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
178
+ *
179
+ * Set to string `null` to remove ambient sound from this agent.
180
+ */
181
+ ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'null';
182
+ /**
183
+ * Provide a customized list of keywords to bias the transcriber model, so that
184
+ * these words are more likely to get transcribed. Commonly used for names, brands,
185
+ * street, etc.
186
+ */
187
+ boosted_keywords?: Array<string>;
188
+ /**
189
+ * Controls whether the agent would backchannel (agent interjects the speaker with
190
+ * phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
191
+ * when enabled tends to show up more in longer user utterances. If not set, agent
192
+ * will not backchannel.
193
+ */
194
+ enable_backchannel?: boolean;
195
+ /**
196
+ * Whether to format the transcribed text with inverse text normalization. It
197
+ * transforms the spoken form of text into written form for entities like phone
198
+ * number, email address, street address, etc. For example, "february fourth twenty
199
+ * twenty two" can be converted into "february 4th 2022". If not set, the default
200
+ * is true.
201
+ */
202
+ format_text?: boolean;
203
+ /**
204
+ * `Beta feature, use with caution.`
205
+ *
206
+ * This setting specifies the agent's operational language, including base language
207
+ * and dialect. Speech recognition considers both elements, but text-to-speech
208
+ * currently only recognizes the base language.
209
+ *
210
+ * For instance, selecting `en-GB` optimizes speech recognition for British
211
+ * English, yet text-to-speech output will be in standard English. If
212
+ * dialect-specific text-to-speech is required, please contact us for support.
213
+ *
214
+ * - `11lab voices`: supports English(en), German(de), Spanish(es), Hindi(hi),
215
+ * Portuguese(pt)
216
+ *
217
+ * - `openAI voices`: supports English(en), German(de), Spanish(es), Hindi(hi),
218
+ * Portuguese(pt), Japanese(ja)
219
+ *
220
+ * - `deepgram voices`: supports English(en)
221
+ */
222
+ language?: 'en-US' | 'en-IN' | 'en-GB' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'ja-JP' | 'pt-PT' | 'pt-BR';
223
+ /**
224
+ * Disable transcripts and recordings storage for enhanced privacy. Access
225
+ * transcripts securely via webhooks.
226
+ */
227
+ optOutSensitiveDataStorage?: boolean;
228
+ /**
229
+ * Controls how responsive is the agent. Value ranging from [0,1]. Lower value
230
+ * means less responsive agent (wait more, respond slower), while higher value
231
+ * means faster exchanges (respond when it can). If unset, default value 1 will
232
+ * apply.
233
+ */
234
+ responsiveness?: number;
235
+ /**
236
+ * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
237
+ * speech, while higher value means faster speech rate. If unset, default value 1
238
+ * will apply.
239
+ */
240
+ voice_speed?: number;
241
+ /**
242
+ * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
243
+ * more stable, and higher value means more variant speech generation. Currently
244
+ * this setting only applies to `11labs` voices. If unset, default value 1 will
245
+ * apply.
246
+ */
247
+ voice_temperature?: number;
248
+ /**
249
+ * The webhook for agent to listen to call events. See what events it would get at
250
+ * [webhook doc](/features/webhook). If set, will binds webhook events for this
251
+ * agent to the specified url, and will ignore the account level webhook for this
252
+ * agent. Set to string `null` to remove webhook url from this agent.
253
+ */
254
+ webhook_url?: string;
255
+ }
256
+ export interface AgentUpdateParams {
257
+ /**
258
+ * The name of the agent. Only used for your own reference.
259
+ */
260
+ agent_name?: string;
261
+ /**
262
+ * If set, will add ambient environment sound to the call to make experience more
263
+ * realistic. Currently supports the following options:
264
+ *
265
+ * - `coffee-shop`: Coffee shop ambience with people chatting in background.
266
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/coffee-shop.wav)
267
+ *
268
+ * - `convention-hall`: Convention hall ambience, with some echo and people
269
+ * chatting in background.
270
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/convention-hall.wav)
271
+ *
272
+ * - `summer-outdoor`: Summer outdoor ambience with cicada chirping.
273
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/summer-outdoor.wav)
274
+ *
275
+ * - `mountain-outdoor`: Mountain outdoor ambience with birds singing.
276
+ * [Listen to Ambience](https://retell-utils-public.s3.us-west-2.amazonaws.com/mountain-outdoor.wav)
277
+ *
278
+ * Set to string `null` to remove ambient sound from this agent.
279
+ */
280
+ ambient_sound?: 'coffee-shop' | 'convention-hall' | 'summer-outdoor' | 'mountain-outdoor' | 'null';
281
+ /**
282
+ * Provide a customized list of keywords to bias the transcriber model, so that
283
+ * these words are more likely to get transcribed. Commonly used for names, brands,
284
+ * street, etc.
285
+ */
286
+ boosted_keywords?: Array<string>;
287
+ /**
288
+ * Controls whether the agent would backchannel (agent interjects the speaker with
289
+ * phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
290
+ * when enabled tends to show up more in longer user utterances. If not set, agent
291
+ * will not backchannel.
292
+ */
293
+ enable_backchannel?: boolean;
294
+ /**
295
+ * Whether to format the transcribed text with inverse text normalization. It
296
+ * transforms the spoken form of text into written form for entities like phone
297
+ * number, email address, street address, etc. For example, "february fourth twenty
298
+ * twenty two" can be converted into "february 4th 2022". If not set, the default
299
+ * is true.
300
+ */
301
+ format_text?: boolean;
302
+ /**
303
+ * `Beta feature, use with caution.`
304
+ *
305
+ * This setting specifies the agent's operational language, including base language
306
+ * and dialect. Speech recognition considers both elements, but text-to-speech
307
+ * currently only recognizes the base language.
308
+ *
309
+ * For instance, selecting `en-GB` optimizes speech recognition for British
310
+ * English, yet text-to-speech output will be in standard English. If
311
+ * dialect-specific text-to-speech is required, please contact us for support.
312
+ *
313
+ * - `11lab voices`: supports English(en), German(de), Spanish(es), Hindi(hi),
314
+ * Portuguese(pt)
315
+ *
316
+ * - `openAI voices`: supports English(en), German(de), Spanish(es), Hindi(hi),
317
+ * Portuguese(pt), Japanese(ja)
318
+ *
319
+ * - `deepgram voices`: supports English(en)
320
+ */
321
+ language?: 'en-US' | 'en-IN' | 'en-GB' | 'de-DE' | 'es-ES' | 'es-419' | 'hi-IN' | 'ja-JP' | 'pt-PT' | 'pt-BR';
322
+ /**
323
+ * The URL we will establish LLM websocket for getting response, usually your
324
+ * server. Check out [LLM WebSocket](/api-references/llm-websocket) for more about
325
+ * request format (sent from us) and response format (send to us).
326
+ */
327
+ llm_websocket_url?: string;
328
+ /**
329
+ * Disable transcripts and recordings storage for enhanced privacy. Access
330
+ * transcripts securely via webhooks.
331
+ */
332
+ optOutSensitiveDataStorage?: boolean;
333
+ /**
334
+ * Controls how responsive is the agent. Value ranging from [0,1]. Lower value
335
+ * means less responsive agent (wait more, respond slower), while higher value
336
+ * means faster exchanges (respond when it can). If unset, default value 1 will
337
+ * apply.
338
+ */
339
+ responsiveness?: number;
340
+ /**
341
+ * Unique voice id used for the agent. Find list of available voices and their
342
+ * preview in Dashboard.
343
+ */
344
+ voice_id?: string;
345
+ /**
346
+ * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
347
+ * speech, while higher value means faster speech rate. If unset, default value 1
348
+ * will apply.
349
+ */
350
+ voice_speed?: number;
351
+ /**
352
+ * Controls how stable the voice is. Value ranging from [0,2]. Lower value means
353
+ * more stable, and higher value means more variant speech generation. Currently
354
+ * this setting only applies to `11labs` voices. If unset, default value 1 will
355
+ * apply.
356
+ */
357
+ voice_temperature?: number;
358
+ /**
359
+ * The webhook for agent to listen to call events. See what events it would get at
360
+ * [webhook doc](/features/webhook). If set, will binds webhook events for this
361
+ * agent to the specified url, and will ignore the account level webhook for this
362
+ * agent. Set to string `null` to remove webhook url from this agent.
363
+ */
364
+ webhook_url?: string;
365
+ }
366
+ export declare namespace Agent {
367
+ export import AgentResponse = AgentAPI.AgentResponse;
368
+ export import AgentListResponse = AgentAPI.AgentListResponse;
369
+ export import AgentCreateParams = AgentAPI.AgentCreateParams;
370
+ export import AgentUpdateParams = AgentAPI.AgentUpdateParams;
371
+ }
372
+ //# sourceMappingURL=agent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/resources/agent.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,QAAQ,MAAM,4BAA4B,CAAC;AAEvD,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;IAI9F;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;IAIxF;;OAEG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;IAIjC;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAIvE;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAM9E;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,2BAA2B,EAAE,MAAM,CAAC;IAEpC;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,aAAa,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,MAAM,CAAC;IAEnG;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,EACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,CAAC;IAEZ;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;AAErD,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,aAAa,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,MAAM,CAAC;IAEnG;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,EACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,CAAC;IAEZ;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,aAAa,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,MAAM,CAAC;IAEnG;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,EACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,CAAC;IAEZ;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,yBAAiB,KAAK,CAAC;IACrB,MAAM,QAAQ,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC;IACrD,MAAM,QAAQ,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IAC7D,MAAM,QAAQ,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC;IAC7D,MAAM,QAAQ,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC;CAC9D"}
@@ -0,0 +1,44 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.Agent = void 0;
5
+ const resource_1 = require("retell-sdk/resource");
6
+ class Agent extends resource_1.APIResource {
7
+ /**
8
+ * Create a new agent
9
+ */
10
+ create(body, options) {
11
+ return this._client.post('/create-agent', { body, ...options });
12
+ }
13
+ /**
14
+ * Retrieve details of a specific agent
15
+ */
16
+ retrieve(agentId, options) {
17
+ return this._client.get(`/get-agent/${agentId}`, options);
18
+ }
19
+ /**
20
+ * Update an existing agent
21
+ */
22
+ update(agentId, body, options) {
23
+ return this._client.patch(`/update-agent/${agentId}`, { body, ...options });
24
+ }
25
+ /**
26
+ * List all agents
27
+ */
28
+ list(options) {
29
+ return this._client.get('/list-agents', options);
30
+ }
31
+ /**
32
+ * Delete an existing agent
33
+ */
34
+ delete(agentId, options) {
35
+ return this._client.delete(`/delete-agent/${agentId}`, {
36
+ ...options,
37
+ headers: { Accept: '*/*', ...options?.headers },
38
+ });
39
+ }
40
+ }
41
+ exports.Agent = Agent;
42
+ (function (Agent) {
43
+ })(Agent = exports.Agent || (exports.Agent = {}));
44
+ //# sourceMappingURL=agent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"agent.js","sourceRoot":"","sources":["../src/resources/agent.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAGtF,kDAAkD;AAGlD,MAAa,KAAM,SAAQ,sBAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,OAAe,EACf,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAe,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,OAAO,EAAE,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AA1CD,sBA0CC;AA8ZD,WAAiB,KAAK;AAKtB,CAAC,EALgB,KAAK,GAAL,aAAK,KAAL,aAAK,QAKrB"}
@@ -0,0 +1,40 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from 'retell-sdk/resource';
3
+ export class Agent extends APIResource {
4
+ /**
5
+ * Create a new agent
6
+ */
7
+ create(body, options) {
8
+ return this._client.post('/create-agent', { body, ...options });
9
+ }
10
+ /**
11
+ * Retrieve details of a specific agent
12
+ */
13
+ retrieve(agentId, options) {
14
+ return this._client.get(`/get-agent/${agentId}`, options);
15
+ }
16
+ /**
17
+ * Update an existing agent
18
+ */
19
+ update(agentId, body, options) {
20
+ return this._client.patch(`/update-agent/${agentId}`, { body, ...options });
21
+ }
22
+ /**
23
+ * List all agents
24
+ */
25
+ list(options) {
26
+ return this._client.get('/list-agents', options);
27
+ }
28
+ /**
29
+ * Delete an existing agent
30
+ */
31
+ delete(agentId, options) {
32
+ return this._client.delete(`/delete-agent/${agentId}`, {
33
+ ...options,
34
+ headers: { Accept: '*/*', ...options?.headers },
35
+ });
36
+ }
37
+ }
38
+ (function (Agent) {
39
+ })(Agent || (Agent = {}));
40
+ //# sourceMappingURL=agent.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"agent.mjs","sourceRoot":"","sources":["../src/resources/agent.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAG/E,EAAE,WAAW,EAAE,MAAM,qBAAqB;AAGjD,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,OAAe,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,OAAe,EACf,IAAuB,EACvB,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAe,EAAE,OAA6B;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,iBAAiB,OAAO,EAAE,EAAE;YACrD,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AA8ZD,WAAiB,KAAK;AAKtB,CAAC,EALgB,KAAK,KAAL,KAAK,QAKrB"}