@chatbotkit/sdk 1.28.0 → 1.29.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 (68) hide show
  1. package/README.md +14 -0
  2. package/dist/cjs/client.cjs +5 -3
  3. package/dist/cjs/client.d.ts +7 -2
  4. package/dist/cjs/index.cjs +18 -21
  5. package/dist/cjs/index.d.ts +1 -3
  6. package/dist/cjs/integration/googlechat/index.cjs +30 -0
  7. package/dist/cjs/integration/googlechat/index.d.ts +11 -0
  8. package/dist/cjs/integration/googlechat/v1.cjs +50 -0
  9. package/dist/cjs/integration/googlechat/v1.d.ts +33 -0
  10. package/dist/cjs/integration/index.cjs +28 -24
  11. package/dist/cjs/integration/index.d.ts +4 -0
  12. package/dist/cjs/integration/teams/index.cjs +30 -0
  13. package/dist/cjs/integration/teams/index.d.ts +11 -0
  14. package/dist/cjs/integration/teams/v1.cjs +50 -0
  15. package/dist/cjs/integration/teams/v1.d.ts +33 -0
  16. package/dist/cjs/platform/ability/index.cjs +3 -0
  17. package/dist/cjs/platform/ability/index.d.ts +1 -0
  18. package/dist/cjs/platform/ability/v1.cjs +10 -0
  19. package/dist/cjs/platform/ability/v1.d.ts +8 -0
  20. package/dist/cjs/platform/report/index.cjs +9 -0
  21. package/dist/cjs/platform/report/index.d.ts +3 -0
  22. package/dist/cjs/platform/report/v1.cjs +30 -0
  23. package/dist/cjs/platform/report/v1.d.ts +12 -0
  24. package/dist/cjs/platform/secret/index.cjs +3 -0
  25. package/dist/cjs/platform/secret/index.d.ts +1 -0
  26. package/dist/cjs/platform/secret/v1.cjs +10 -0
  27. package/dist/cjs/platform/secret/v1.d.ts +5 -0
  28. package/dist/cjs/types/ability.d.ts +2302 -0
  29. package/dist/cjs/types/api/v1.d.ts +2391 -699
  30. package/dist/cjs/types/report.d.ts +139 -1
  31. package/dist/esm/client.d.ts +7 -2
  32. package/dist/esm/client.js +5 -3
  33. package/dist/esm/index.d.ts +1 -3
  34. package/dist/esm/index.js +0 -3
  35. package/dist/esm/integration/googlechat/index.d.ts +11 -0
  36. package/dist/esm/integration/googlechat/index.js +26 -0
  37. package/dist/esm/integration/googlechat/v1.d.ts +33 -0
  38. package/dist/esm/integration/googlechat/v1.js +42 -0
  39. package/dist/esm/integration/index.d.ts +4 -0
  40. package/dist/esm/integration/index.js +4 -0
  41. package/dist/esm/integration/teams/index.d.ts +11 -0
  42. package/dist/esm/integration/teams/index.js +26 -0
  43. package/dist/esm/integration/teams/v1.d.ts +33 -0
  44. package/dist/esm/integration/teams/v1.js +42 -0
  45. package/dist/esm/platform/ability/index.d.ts +1 -0
  46. package/dist/esm/platform/ability/index.js +4 -1
  47. package/dist/esm/platform/ability/v1.d.ts +8 -0
  48. package/dist/esm/platform/ability/v1.js +9 -0
  49. package/dist/esm/platform/report/index.d.ts +3 -0
  50. package/dist/esm/platform/report/index.js +10 -1
  51. package/dist/esm/platform/report/v1.d.ts +12 -0
  52. package/dist/esm/platform/report/v1.js +27 -0
  53. package/dist/esm/platform/secret/index.d.ts +1 -0
  54. package/dist/esm/platform/secret/index.js +4 -1
  55. package/dist/esm/platform/secret/v1.d.ts +5 -0
  56. package/dist/esm/platform/secret/v1.js +9 -0
  57. package/dist/esm/types/ability.d.ts +2302 -0
  58. package/dist/esm/types/api/v1.d.ts +2391 -699
  59. package/dist/esm/types/report.d.ts +139 -1
  60. package/package.json +122 -52
  61. package/dist/cjs/report/index.cjs +0 -18
  62. package/dist/cjs/report/index.d.ts +0 -6
  63. package/dist/cjs/report/v1.cjs +0 -22
  64. package/dist/cjs/report/v1.d.ts +0 -9
  65. package/dist/esm/report/index.d.ts +0 -6
  66. package/dist/esm/report/index.js +0 -14
  67. package/dist/esm/report/v1.d.ts +0 -9
  68. package/dist/esm/report/v1.js +0 -18
@@ -0,0 +1,2302 @@
1
+ /**
2
+ * This file is auto-generated. Do not edit manually.
3
+ * Generated from the CBK ability catalogue.
4
+ */
5
+
6
+ // --- Ability Names ---
7
+
8
+ export type CbkAbilityName = 'abort'
9
+ | 'abort[failure]'
10
+ | 'abort[success]'
11
+ | 'agent/execute'
12
+ | 'agent/task/evaluate'
13
+ | 'agent/task/plan'
14
+ | 'attachment/read'
15
+ | 'blueprint/note/list'
16
+ | 'blueprint/resource/list'
17
+ | 'bot/ask'
18
+ | 'bot/ask[by-id]'
19
+ | 'bot/ask[multi]'
20
+ | 'bot/backstory/read'
21
+ | 'bot/backstory/read[by-id]'
22
+ | 'bot/backstory/write'
23
+ | 'bot/backstory/write[by-id]'
24
+ | 'bot/call'
25
+ | 'bot/call[by-id]'
26
+ | 'bot/call[multi]'
27
+ | 'bot/list'
28
+ | 'browser/dispatch'
29
+ | 'conversation/fetch[bot][by-id]'
30
+ | 'conversation/fetch[by-id]'
31
+ | 'conversation/fetch[contact][by-id]'
32
+ | 'conversation/list'
33
+ | 'conversation/list[bot]'
34
+ | 'conversation/list[contact]'
35
+ | 'conversation/mcp/install[url]'
36
+ | 'conversation/search'
37
+ | 'conversation/search[bot]'
38
+ | 'conversation/search[contact]'
39
+ | 'conversation/skillset/install[by-id]'
40
+ | 'dataset/create'
41
+ | 'dataset/file/create[url]'
42
+ | 'dataset/list'
43
+ | 'dataset/record/create'
44
+ | 'dataset/search'
45
+ | 'discord/conversation/start[by-id]'
46
+ | 'email/conversation/start[by-id]'
47
+ | 'email/send'
48
+ | 'example/fetch/api/get'
49
+ | 'example/fetch/api/post'
50
+ | 'example/fetch/api/post[params]'
51
+ | 'fetch/metadata'
52
+ | 'fetch/request'
53
+ | 'fetch/request[with-auth]'
54
+ | 'fetch/text/get'
55
+ | 'file/append'
56
+ | 'file/append[by-id]'
57
+ | 'file/prepend'
58
+ | 'file/prepend[by-id]'
59
+ | 'file/read'
60
+ | 'file/read[by-id]'
61
+ | 'file/replace'
62
+ | 'file/replace[by-id]'
63
+ | 'file/rw'
64
+ | 'file/rw[by-id]'
65
+ | 'file/sql'
66
+ | 'file/sql[by-id]'
67
+ | 'file/write'
68
+ | 'file/write[by-id]'
69
+ | 'git/file/fetch'
70
+ | 'git/tree/fetch'
71
+ | 'graphql[cbk]'
72
+ | 'image/generate'
73
+ | 'image/generate[gemini-2.5-flash-image]'
74
+ | 'image/generate[gemini-3.1-flash-image]'
75
+ | 'image/generate[gpt-image-1.5]'
76
+ | 'image/generate[gpt-image-1]'
77
+ | 'image/modify'
78
+ | 'image/modify[gemini-2.5-flash-image]'
79
+ | 'image/modify[gemini-3.1-flash-image]'
80
+ | 'image/modify[gpt-image-1.5]'
81
+ | 'image/modify[gpt-image-1]'
82
+ | 'listen/transcribe'
83
+ | 'math/evaluate'
84
+ | 'memory/create'
85
+ | 'memory/create[bot]'
86
+ | 'memory/create[contact]'
87
+ | 'memory/delete[bot][by-id]'
88
+ | 'memory/delete[by-id]'
89
+ | 'memory/delete[contact][by-id]'
90
+ | 'memory/list'
91
+ | 'memory/list[bot]'
92
+ | 'memory/list[contact]'
93
+ | 'memory/search'
94
+ | 'memory/search[bot]'
95
+ | 'memory/search[contact]'
96
+ | 'memory/update[bot][by-id]'
97
+ | 'memory/update[by-id]'
98
+ | 'memory/update[contact][by-id]'
99
+ | 'mock/api[create]'
100
+ | 'mock/api[delete]'
101
+ | 'mock/api[list]'
102
+ | 'mock/api[update]'
103
+ | 'mock/api/[search]'
104
+ | 'mock/dataset'
105
+ | 'mock/sql'
106
+ | 'pack/bot/reprogramming'
107
+ | 'pack/cbk/space/skills'
108
+ | 'pack/cbk/space/storage'
109
+ | 'pack/cbk/space/storage[read-only]'
110
+ | 'pack/file'
111
+ | 'pack/file[by-id]'
112
+ | 'pack/shell'
113
+ | 'search/images'
114
+ | 'search/news'
115
+ | 'search/videos'
116
+ | 'search/web'
117
+ | 'shell/eval/node'
118
+ | 'shell/eval/python'
119
+ | 'shell/exec'
120
+ | 'shell/exec/node'
121
+ | 'shell/exec/python'
122
+ | 'shell/import'
123
+ | 'shell/read'
124
+ | 'shell/rw'
125
+ | 'shell/skillset/install[by-id]'
126
+ | 'shell/write'
127
+ | 'slack/conversation/start[by-id]'
128
+ | 'space/create'
129
+ | 'space/create[contact]'
130
+ | 'space/delete[by-id]'
131
+ | 'space/delete[contact][by-id]'
132
+ | 'space/fetch[by-id]'
133
+ | 'space/fetch[contact][by-id]'
134
+ | 'space/list'
135
+ | 'space/list[contact]'
136
+ | 'space/skill/create'
137
+ | 'space/skill/create[by-id]'
138
+ | 'space/skill/list'
139
+ | 'space/skill/list[by-id]'
140
+ | 'space/skill/read'
141
+ | 'space/skill/read[by-id]'
142
+ | 'space/storage/copy'
143
+ | 'space/storage/copy[by-id]'
144
+ | 'space/storage/delete'
145
+ | 'space/storage/delete[by-id]'
146
+ | 'space/storage/import'
147
+ | 'space/storage/import[by-id]'
148
+ | 'space/storage/link'
149
+ | 'space/storage/link[by-id]'
150
+ | 'space/storage/list'
151
+ | 'space/storage/list[by-id]'
152
+ | 'space/storage/move'
153
+ | 'space/storage/move[by-id]'
154
+ | 'space/storage/read'
155
+ | 'space/storage/read[by-id]'
156
+ | 'space/storage/rw'
157
+ | 'space/storage/rw[by-id]'
158
+ | 'space/storage/search'
159
+ | 'space/storage/search[by-id]'
160
+ | 'space/storage/write'
161
+ | 'space/storage/write[by-id]'
162
+ | 'space/update[by-id]'
163
+ | 'space/update[contact][by-id]'
164
+ | 'task/create'
165
+ | 'task/create[contact]'
166
+ | 'task/delete[by-id]'
167
+ | 'task/delete[contact][by-id]'
168
+ | 'task/fetch[by-id]'
169
+ | 'task/fetch[contact][by-id]'
170
+ | 'task/list'
171
+ | 'task/list[contact]'
172
+ | 'task/run[by-id]'
173
+ | 'task/run[contact][by-id]'
174
+ | 'task/update[by-id]'
175
+ | 'task/update[contact][by-id]'
176
+ | 'telegram/conversation/start[by-id]'
177
+ | 'text/article/generate'
178
+ | 'text/email/generate'
179
+ | 'text/generate'
180
+ | 'text/summarize'
181
+ | 'text/translate'
182
+ | 'todo/manage'
183
+ | 'todo/read'
184
+ | 'todo/write'
185
+ | 'url/graphql'
186
+ | 'url/sql'
187
+ | 'view/describe'
188
+ | 'whatsapp/conversation/start[by-id]'
189
+
190
+ // --- Ability Metadata ---
191
+
192
+ export interface CbkAbilityMetadata {
193
+ name: string
194
+ description: string
195
+ tags: string[]
196
+ }
197
+
198
+ // --- Ability Parameters ---
199
+
200
+ export type AbortParameters = {
201
+ /** a very short reason for the abort, e.g. "task succeeded", "task failed", etc */
202
+ reason: string
203
+ }
204
+
205
+ export type AbortFailureParameters = {
206
+ /** a very short reason for the abort, e.g. "task failed", "task aborted", etc */
207
+ reason: string
208
+ }
209
+
210
+ export type AbortSuccessParameters = {
211
+ /** a very short reason for the abort, e.g. "task succeeded", "task completed", etc */
212
+ reason: string
213
+ }
214
+
215
+ export type AgentExecuteParameters = {
216
+ /** the role and personality of the executor */
217
+ backstory: string
218
+ /** the model to use */
219
+ '@model'?: string
220
+ /** instructions for the task execution */
221
+ '@instructions'?: string
222
+ }
223
+
224
+ export type AgentTaskEvaluateParameters = {
225
+ /** the role and personality of the evaluator */
226
+ '@backstory': string
227
+ /** the model to use */
228
+ '@model'?: string
229
+ /** instructions for the evaluation */
230
+ '@instructions'?: string
231
+ }
232
+
233
+ export type AgentTaskPlanParameters = {
234
+ /** the role and personality of the planner */
235
+ '@backstory': string
236
+ /** the model to use */
237
+ '@model'?: string
238
+ /** instructions for the task plan */
239
+ '@instructions'?: string
240
+ }
241
+
242
+ export type AttachmentReadParameters = {
243
+ /** the attachment name to read */
244
+ name: string
245
+ }
246
+
247
+ export type BlueprintNoteListParameters = Record<string, never>
248
+
249
+ export type BlueprintResourceListParameters = {
250
+ /** optional resource type to filter by */
251
+ type?: string
252
+ }
253
+
254
+ export type BotAskParameters = {
255
+ /** the question to ask the bot */
256
+ question: string
257
+ }
258
+
259
+ export type BotAskByIdParameters = {
260
+ /** the bot ID */
261
+ botId: string
262
+ /** the question to ask the bot */
263
+ question: string
264
+ }
265
+
266
+ export type BotAskMultiParameters = {
267
+ /** comma-separated list of bot IDs to ask */
268
+ ids: string
269
+ /** the question to ask the bots */
270
+ question: string
271
+ }
272
+
273
+ export type BotBackstoryReadParameters = Record<string, never>
274
+
275
+ export type BotBackstoryReadByIdParameters = {
276
+ /** the bot ID */
277
+ botId: string
278
+ }
279
+
280
+ export type BotBackstoryWriteParameters = {
281
+ /** the new backstory content for the bot */
282
+ content: string
283
+ }
284
+
285
+ export type BotBackstoryWriteByIdParameters = {
286
+ /** the bot ID */
287
+ botId: string
288
+ /** the new backstory content for the bot */
289
+ content: string
290
+ }
291
+
292
+ export type BotCallParameters = {
293
+ /** detailed description of the action to be performed */
294
+ action: string
295
+ }
296
+
297
+ export type BotCallByIdParameters = {
298
+ /** the bot ID */
299
+ botId: string
300
+ /** detailed description of the action to be performed */
301
+ action: string
302
+ }
303
+
304
+ export type BotCallMultiParameters = {
305
+ /** comma-separated list of bot IDs to call */
306
+ ids: string
307
+ /** detailed description of the action to be performed */
308
+ action: string
309
+ }
310
+
311
+ export type BotListParameters = {
312
+ /** optional limit on the number of bots to return */
313
+ take?: number
314
+ }
315
+
316
+ export type BrowserDispatchParameters = {
317
+ /** the task to perform in the browser */
318
+ task: string
319
+ /** optional URL of the page to dispatch the action */
320
+ url?: string
321
+ /** timeout in milliseconds */
322
+ timeout?: number
323
+ }
324
+
325
+ export type ConversationFetchBotByIdParameters = {
326
+ /** the ID of the conversation to fetch */
327
+ conversationId: string
328
+ }
329
+
330
+ export type ConversationFetchByIdParameters = {
331
+ /** the ID of the conversation to fetch */
332
+ conversationId: string
333
+ }
334
+
335
+ export type ConversationFetchContactByIdParameters = {
336
+ /** the ID of the conversation to fetch */
337
+ conversationId: string
338
+ }
339
+
340
+ export type ConversationListParameters = Record<string, never>
341
+
342
+ export type ConversationListBotParameters = Record<string, never>
343
+
344
+ export type ConversationListContactParameters = Record<string, never>
345
+
346
+ export type ConversationMcpInstallUrlParameters = {
347
+ /** the remote MCP URL */
348
+ url: string
349
+ }
350
+
351
+ export type ConversationSearchParameters = {
352
+ /** the search query to find conversations */
353
+ query: string
354
+ }
355
+
356
+ export type ConversationSearchBotParameters = {
357
+ /** the search query to find conversations */
358
+ query: string
359
+ }
360
+
361
+ export type ConversationSearchContactParameters = {
362
+ /** the search query to find conversations */
363
+ query: string
364
+ }
365
+
366
+ export type ConversationSkillsetInstallByIdParameters = {
367
+ /** the skillset ID to install */
368
+ skillsetId: string
369
+ }
370
+
371
+ export type DatasetCreateParameters = {
372
+ /** the name of the dataset */
373
+ name: string
374
+ }
375
+
376
+ export type DatasetFileCreateUrlParameters = {
377
+ /** the dataset Id that you want to add the file to */
378
+ datasetId: string
379
+ /** the URL of the file to add */
380
+ url: string
381
+ }
382
+
383
+ export type DatasetListParameters = Record<string, never>
384
+
385
+ export type DatasetRecordCreateParameters = {
386
+ /** the dataset Id that you want to create a record in */
387
+ datasetId: string
388
+ /** the record to create */
389
+ record: string
390
+ }
391
+
392
+ export type DatasetSearchParameters = {
393
+ /** the dataset Id that you want to search */
394
+ datasetId: string
395
+ /** search query */
396
+ query: string
397
+ }
398
+
399
+ export type DiscordConversationStartByIdParameters = {
400
+ /** The ID of the Discord integration to use */
401
+ discordIntegrationId: string
402
+ /** The Discord channel ID to send the message to */
403
+ channelId: string
404
+ /** The initial message text to send to start the conversation */
405
+ text: string
406
+ /** Optional context about the recipient or conversation, typically generated by the agent */
407
+ context?: string
408
+ }
409
+
410
+ export type EmailConversationStartByIdParameters = {
411
+ /** The ID of the email integration to use */
412
+ emailIntegrationId: string
413
+ /** The recipient email address to send to */
414
+ email: string
415
+ /** The subject line of the email */
416
+ subject: string
417
+ /** The initial message text to send to start the conversation */
418
+ text: string
419
+ /** Optional context about the recipient or conversation, which will be used to inform how to proceed with the conversation */
420
+ context?: string
421
+ }
422
+
423
+ export type EmailSendParameters = {
424
+ /** recipient's email address */
425
+ to: string
426
+ /** the email subject */
427
+ subject?: string
428
+ /** the content of the email in markdown format */
429
+ content: string
430
+ }
431
+
432
+ export type ExampleFetchApiGetParameters = Record<string, never>
433
+
434
+ export type ExampleFetchApiPostParameters = Record<string, never>
435
+
436
+ export type ExampleFetchApiPostParamsParameters = {
437
+ /** The description of param1 */
438
+ param1: string
439
+ /** The description of param2 */
440
+ param2: string
441
+ }
442
+
443
+ export type FetchMetadataParameters = {
444
+ /** the url of the page to fetch, including https:// prefix */
445
+ url: string
446
+ }
447
+
448
+ export type FetchRequestParameters = {
449
+ /** the HTTP method to use (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS) */
450
+ method: string
451
+ /** the full URL to make the request to */
452
+ url: string
453
+ /** the content type header (e.g., application/json, text/plain) */
454
+ contentType?: string
455
+ /** the request body as text - for POST, PUT, PATCH requests */
456
+ body?: string
457
+ }
458
+
459
+ export type FetchRequestWithAuthParameters = {
460
+ /** the HTTP method to use (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS) */
461
+ method: string
462
+ /** the full URL to make the request to */
463
+ url: string
464
+ /** the content type header (e.g., application/json, text/plain) */
465
+ contentType?: string
466
+ /** the request body as text - for POST, PUT, PATCH requests */
467
+ body?: string
468
+ }
469
+
470
+ export type FetchTextGetParameters = {
471
+ /** the url of the page to fetch, including https:// prefix */
472
+ url: string
473
+ }
474
+
475
+ export type FileAppendParameters = {
476
+ /** content to append to the file */
477
+ content: string
478
+ }
479
+
480
+ export type FileAppendByIdParameters = {
481
+ /** the file Id that you want to append to */
482
+ fileId: string
483
+ /** content to append to the file */
484
+ content: string
485
+ }
486
+
487
+ export type FilePrependParameters = {
488
+ /** content to prepend to the file */
489
+ content: string
490
+ }
491
+
492
+ export type FilePrependByIdParameters = {
493
+ /** the file Id that you want to prepend to */
494
+ fileId: string
495
+ /** content to prepend to the file */
496
+ content: string
497
+ }
498
+
499
+ export type FileReadParameters = {
500
+ /** the line number to start reading from (1-indexed, line 1 is the first line) */
501
+ startLine: number
502
+ /** the line number to end reading at, inclusive (1-indexed). Prefer reading at least 100 lines or more per request to minimize round trips */
503
+ endLine: number
504
+ }
505
+
506
+ export type FileReadByIdParameters = {
507
+ /** the file Id that you want to read */
508
+ fileId: string
509
+ /** the line number to start reading from (1-indexed, line 1 is the first line) */
510
+ startLine?: number
511
+ /** the line number to end reading at, inclusive (1-indexed). Prefer reading at least 100 lines or more per request to minimize round trips */
512
+ endLine?: number
513
+ }
514
+
515
+ export type FileReplaceParameters = {
516
+ /** text to search for */
517
+ search: string
518
+ /** text to replace with */
519
+ replace: string
520
+ /** number of occurrences to replace (optional, replaces all if not specified) */
521
+ count: number
522
+ }
523
+
524
+ export type FileReplaceByIdParameters = {
525
+ /** the file Id that you want to replace in */
526
+ fileId: string
527
+ /** text to search for */
528
+ search: string
529
+ /** text to replace with */
530
+ replace: string
531
+ /** number of occurrences to replace (optional, replaces all if not specified) */
532
+ count: number
533
+ }
534
+
535
+ export type FileRwParameters = {
536
+ /** 'operation mode: "read" to read content, "write" to write content' */
537
+ mode: string
538
+ /** content to write (required for write mode) */
539
+ content?: string
540
+ /** 'the line number to start from (1-indexed). For read: where to start reading. For write: where to start writing.' */
541
+ startLine?: number
542
+ /** 'the line number to end at, inclusive (1-indexed). For read: where to stop reading. For write: range to replace.' */
543
+ endLine?: number
544
+ }
545
+
546
+ export type FileRwByIdParameters = {
547
+ /** the file Id that you want to read from or write to */
548
+ fileId: string
549
+ /** 'operation mode: "read" to read content, "write" to write content' */
550
+ mode: string
551
+ /** content to write (required for write mode) */
552
+ content?: string
553
+ /** 'the line number to start from (1-indexed). For read: where to start reading. For write: where to start writing.' */
554
+ startLine?: number
555
+ /** 'the line number to end at, inclusive (1-indexed). For read: where to stop reading. For write: range to replace.' */
556
+ endLine?: number
557
+ }
558
+
559
+ export type FileSqlParameters = {
560
+ /** the SQL query to execute for table "table1" */
561
+ sql: string
562
+ }
563
+
564
+ export type FileSqlByIdParameters = {
565
+ /** the SQL query to execute */
566
+ sql: string
567
+ /** the file ID for the "table1" table where to load the data from */
568
+ table1_fileId: string
569
+ }
570
+
571
+ export type FileWriteParameters = {
572
+ /** content to write to the file */
573
+ content: string
574
+ /** the line number to start writing at (1-indexed). If only startLine is provided, content is inserted before this line. If both startLine and endLine are provided, lines in that range are replaced. */
575
+ startLine?: number
576
+ /** the line number to end writing at, inclusive (1-indexed). Used with startLine to replace a range of lines. */
577
+ endLine?: number
578
+ }
579
+
580
+ export type FileWriteByIdParameters = {
581
+ /** the file Id that you want to write to */
582
+ fileId: string
583
+ /** content to write to the file */
584
+ content: string
585
+ /** the line number to start writing at (1-indexed). If only startLine is provided, content is inserted before this line. If both startLine and endLine are provided, lines in that range are replaced. */
586
+ startLine?: number
587
+ /** the line number to end writing at, inclusive (1-indexed). Used with startLine to replace a range of lines. */
588
+ endLine?: number
589
+ }
590
+
591
+ export type GitFileFetchParameters = {
592
+ /** Git repository URL */
593
+ url: string
594
+ /** Git reference (branch, tag, or commit SHA) */
595
+ ref: string
596
+ /** Path to the file within the repository */
597
+ filePath: string
598
+ }
599
+
600
+ export type GitTreeFetchParameters = {
601
+ /** Git repository URL */
602
+ url: string
603
+ /** Git reference (branch, tag, or commit SHA) */
604
+ ref: string
605
+ /** Path to the subtree within the repository */
606
+ path: string
607
+ /** Pattern to exclude from the subtree */
608
+ pattern: string
609
+ }
610
+
611
+ export type GraphqlCbkParameters = {
612
+ /** the GraphQL query to execute */
613
+ query: string
614
+ /** optional GraphQL query variables in JSON format */
615
+ variables?: string
616
+ }
617
+
618
+ export type ImageGenerateParameters = {
619
+ /** the prompt to use for image generation */
620
+ prompt: string
621
+ /** the image model to use */
622
+ model: string
623
+ }
624
+
625
+ export type ImageGenerateGemini25FlashImageParameters = {
626
+ /** the prompt to use for image generation */
627
+ prompt: string
628
+ /** detailed directions how to generate the image */
629
+ directions?: string
630
+ }
631
+
632
+ export type ImageGenerateGemini31FlashImageParameters = {
633
+ /** the prompt to use for image generation */
634
+ prompt: string
635
+ /** detailed directions how to generate the image */
636
+ directions?: string
637
+ }
638
+
639
+ export type ImageGenerateGptImage15Parameters = {
640
+ /** the prompt to use for image generation */
641
+ prompt: string
642
+ /** detailed directions how to generate the image */
643
+ directions?: string
644
+ }
645
+
646
+ export type ImageGenerateGptImage1Parameters = {
647
+ /** the prompt to use for image generation */
648
+ prompt: string
649
+ /** detailed directions how to generate the image */
650
+ directions?: string
651
+ }
652
+
653
+ export type ImageModifyParameters = {
654
+ /** the prompt to use for image generation */
655
+ prompt: string
656
+ /** the URL of the image to edit */
657
+ image_url: string
658
+ /** the image model to use */
659
+ model: string
660
+ }
661
+
662
+ export type ImageModifyGemini25FlashImageParameters = {
663
+ /** the prompt to use for image generation */
664
+ prompt: string
665
+ /** detailed directions how to modify the image */
666
+ directions?: string
667
+ /** the URL of the image to edit */
668
+ image_url: string
669
+ }
670
+
671
+ export type ImageModifyGemini31FlashImageParameters = {
672
+ /** the prompt to use for image generation */
673
+ prompt: string
674
+ /** detailed directions how to modify the image */
675
+ directions?: string
676
+ /** the URL of the image to edit */
677
+ image_url: string
678
+ }
679
+
680
+ export type ImageModifyGptImage15Parameters = {
681
+ /** the prompt to use for image generation */
682
+ prompt: string
683
+ /** detailed directions how to modify the image */
684
+ directions?: string
685
+ /** the URL of the image to edit */
686
+ image_url: string
687
+ }
688
+
689
+ export type ImageModifyGptImage1Parameters = {
690
+ /** the prompt to use for image generation */
691
+ prompt: string
692
+ /** detailed directions how to modify the image */
693
+ directions?: string
694
+ /** the URL of the image to edit */
695
+ image_url: string
696
+ }
697
+
698
+ export type ListenTranscribeParameters = {
699
+ /** directions how to describe an image */
700
+ directions?: string
701
+ /** the URL of the audio file to transcribe */
702
+ audio_url: string
703
+ }
704
+
705
+ export type MathEvaluateParameters = {
706
+ /** the math expression to evaluate */
707
+ expression: string
708
+ }
709
+
710
+ export type MemoryCreateParameters = {
711
+ /** the content of the memory to create */
712
+ content: string
713
+ }
714
+
715
+ export type MemoryCreateBotParameters = {
716
+ /** the content of the memory to create */
717
+ content: string
718
+ }
719
+
720
+ export type MemoryCreateContactParameters = {
721
+ /** the content of the memory to create */
722
+ content: string
723
+ }
724
+
725
+ export type MemoryDeleteBotByIdParameters = {
726
+ /** the ID of the memory to delete */
727
+ memoryId: string
728
+ }
729
+
730
+ export type MemoryDeleteByIdParameters = {
731
+ /** the ID of the memory to delete */
732
+ memoryId: string
733
+ }
734
+
735
+ export type MemoryDeleteContactByIdParameters = {
736
+ /** the ID of the memory to delete */
737
+ memoryId: string
738
+ }
739
+
740
+ export type MemoryListParameters = Record<string, never>
741
+
742
+ export type MemoryListBotParameters = Record<string, never>
743
+
744
+ export type MemoryListContactParameters = Record<string, never>
745
+
746
+ export type MemorySearchParameters = {
747
+ /** the search query */
748
+ query: string
749
+ }
750
+
751
+ export type MemorySearchBotParameters = {
752
+ /** the search query */
753
+ query: string
754
+ }
755
+
756
+ export type MemorySearchContactParameters = {
757
+ /** the search query */
758
+ query: string
759
+ }
760
+
761
+ export type MemoryUpdateBotByIdParameters = {
762
+ /** the ID of the memory to update */
763
+ memoryId: string
764
+ /** the updated content of the memory */
765
+ content: string
766
+ }
767
+
768
+ export type MemoryUpdateByIdParameters = {
769
+ /** the ID of the memory to update */
770
+ memoryId: string
771
+ /** the updated content of the memory */
772
+ content: string
773
+ }
774
+
775
+ export type MemoryUpdateContactByIdParameters = {
776
+ /** the ID of the memory to update */
777
+ memoryId: string
778
+ /** the updated content of the memory */
779
+ content: string
780
+ }
781
+
782
+ export type MockApiCreateParameters = {
783
+ /** a made up request body in json format that matches the method name and description */
784
+ body?: string
785
+ }
786
+
787
+ export type MockApiDeleteParameters = {
788
+ /** the ID of the resource to delete */
789
+ id?: string
790
+ }
791
+
792
+ export type MockApiListParameters = Record<string, never>
793
+
794
+ export type MockApiUpdateParameters = {
795
+ /** the ID of the resource to update */
796
+ id?: string
797
+ /** a made up request body in json format that matches the method name and description */
798
+ body?: string
799
+ }
800
+
801
+ export type MockApiSearchParameters = {
802
+ /** a made up search query that matches the method name and description */
803
+ query: string
804
+ }
805
+
806
+ export type MockDatasetParameters = {
807
+ /** a made up search query that matches the method name and description */
808
+ query: string
809
+ }
810
+
811
+ export type MockSqlParameters = {
812
+ /** a made up sql query to execute that matches the method name and description */
813
+ query: string
814
+ }
815
+
816
+ export type PackBotReprogrammingParameters = Record<string, never>
817
+
818
+ export type PackCbkSpaceSkillsParameters = Record<string, never>
819
+
820
+ export type PackCbkSpaceStorageParameters = Record<string, never>
821
+
822
+ export type PackCbkSpaceStorageReadOnlyParameters = Record<string, never>
823
+
824
+ export type PackFileParameters = Record<string, never>
825
+
826
+ export type PackFileByIdParameters = Record<string, never>
827
+
828
+ export type PackShellParameters = Record<string, never>
829
+
830
+ export type SearchImagesParameters = {
831
+ /** search query */
832
+ query: string
833
+ }
834
+
835
+ export type SearchNewsParameters = {
836
+ /** search query */
837
+ query: string
838
+ }
839
+
840
+ export type SearchVideosParameters = {
841
+ /** search query */
842
+ query: string
843
+ }
844
+
845
+ export type SearchWebParameters = {
846
+ /** search query */
847
+ query: string
848
+ }
849
+
850
+ export type ShellEvalNodeParameters = {
851
+ /** the JavaScript code to evaluate */
852
+ code: string
853
+ /** timeout in milliseconds (max 300000ms/5min) */
854
+ timeout?: number
855
+ }
856
+
857
+ export type ShellEvalPythonParameters = {
858
+ /** the Python code to evaluate */
859
+ code: string
860
+ /** timeout in milliseconds (max 300000ms/5min) */
861
+ timeout?: number
862
+ }
863
+
864
+ export type ShellExecParameters = {
865
+ /** the bash shell command or script */
866
+ command: string
867
+ /** timeout in milliseconds (max 300000ms/5min) */
868
+ timeout?: number
869
+ }
870
+
871
+ export type ShellExecNodeParameters = {
872
+ /** the Node.js script content */
873
+ script: string
874
+ /** timeout in milliseconds (max 300000ms/5min) */
875
+ timeout?: number
876
+ }
877
+
878
+ export type ShellExecPythonParameters = {
879
+ /** the Python script content */
880
+ script: string
881
+ /** timeout in milliseconds (max 300000ms/5min) */
882
+ timeout?: number
883
+ }
884
+
885
+ export type ShellImportParameters = {
886
+ /** the URL to import data from (must be http or https) */
887
+ url: string
888
+ /** the destination path in the shell sandbox */
889
+ path: string
890
+ }
891
+
892
+ export type ShellReadParameters = {
893
+ /** absolute path to the file to read */
894
+ path: string
895
+ /** the line number to start reading from (1-indexed, line 1 is the first line) */
896
+ startLine: number
897
+ /** the line number to end reading at, inclusive (1-indexed). Prefer reading at least 100 lines or more per request to minimize round trips */
898
+ endLine: number
899
+ }
900
+
901
+ export type ShellRwParameters = {
902
+ /** absolute path to the file to read from or write to */
903
+ path: string
904
+ /** 'operation mode: "read" to read content, "write" to write content' */
905
+ mode: string
906
+ /** content to write (required for write mode) */
907
+ content?: string
908
+ /** 'the line number to start from (1-indexed). For read: where to start reading. For write: where to start writing.' */
909
+ startLine?: number
910
+ /** 'the line number to end at, inclusive (1-indexed). For read: where to stop reading. For write: range to replace.' */
911
+ endLine?: number
912
+ }
913
+
914
+ export type ShellSkillsetInstallByIdParameters = {
915
+ /** the ID of the skillset to install */
916
+ skillsetId: string
917
+ }
918
+
919
+ export type ShellWriteParameters = {
920
+ /** absolute path to the file to write to */
921
+ path: string
922
+ /** the content to write to the file */
923
+ content: string
924
+ /** the line number to start writing at (1-indexed). If only startLine is provided, content is inserted before this line. If both startLine and endLine are provided, lines in that range are replaced. */
925
+ startLine?: number
926
+ /** the line number to end writing at, inclusive (1-indexed). Used with startLine to replace a range of lines. */
927
+ endLine?: number
928
+ }
929
+
930
+ export type SlackConversationStartByIdParameters = {
931
+ /** The ID of the Slack integration to use */
932
+ slackIntegrationId: string
933
+ /** 'The Slack channel or user to send to. Supports: channel IDs (C01234567), DM IDs (D01234567), #channel-name, or @username' */
934
+ channel: string
935
+ /** The initial message text to send to start the conversation */
936
+ text: string
937
+ /** Optional context about the recipient or conversation, typically generated by the agent */
938
+ context?: string
939
+ }
940
+
941
+ export type SpaceCreateParameters = {
942
+ /** the name of the space */
943
+ name: string
944
+ /** an optional description of the space */
945
+ description?: string
946
+ }
947
+
948
+ export type SpaceCreateContactParameters = {
949
+ /** the name of the space */
950
+ name: string
951
+ /** an optional description of the space */
952
+ description?: string
953
+ }
954
+
955
+ export type SpaceDeleteByIdParameters = {
956
+ /** the ID of the space to delete */
957
+ spaceId: string
958
+ }
959
+
960
+ export type SpaceDeleteContactByIdParameters = {
961
+ /** the ID of the space to delete */
962
+ spaceId: string
963
+ }
964
+
965
+ export type SpaceFetchByIdParameters = {
966
+ /** the ID of the space to fetch */
967
+ spaceId: string
968
+ }
969
+
970
+ export type SpaceFetchContactByIdParameters = {
971
+ /** the ID of the space to fetch */
972
+ spaceId: string
973
+ }
974
+
975
+ export type SpaceListParameters = Record<string, never>
976
+
977
+ export type SpaceListContactParameters = Record<string, never>
978
+
979
+ export type SpaceSkillCreateParameters = {
980
+ /** Lowercase kebab-case slug for the skill, used as the directory name under .skills/ */
981
+ slug: string
982
+ /** The display name of the skill */
983
+ name: string
984
+ /** A short description of what the skill does */
985
+ description: string
986
+ /** The main body content of the skill */
987
+ content: string
988
+ }
989
+
990
+ export type SpaceSkillCreateByIdParameters = {
991
+ /** The ID of the space to create the skill(s) in */
992
+ spaceId: string
993
+ /** Lowercase kebab-case slug for the skill, used as the directory name under .skills/ */
994
+ slug: string
995
+ /** The display name of the skill */
996
+ name: string
997
+ /** A short description of what the skill does */
998
+ description: string
999
+ /** The main body content of the skill */
1000
+ content: string
1001
+ }
1002
+
1003
+ export type SpaceSkillListParameters = Record<string, never>
1004
+
1005
+ export type SpaceSkillListByIdParameters = {
1006
+ /** The ID of the space to list skills from */
1007
+ spaceId: string
1008
+ }
1009
+
1010
+ export type SpaceSkillReadParameters = {
1011
+ /** Path to a SKILL.md file, as returned by the list ability */
1012
+ path: string
1013
+ }
1014
+
1015
+ export type SpaceSkillReadByIdParameters = {
1016
+ /** The ID of the space to read skills from */
1017
+ spaceId: string
1018
+ /** Path to a SKILL.md file, as returned by the list ability */
1019
+ path: string
1020
+ }
1021
+
1022
+ export type SpaceStorageCopyParameters = {
1023
+ /** the path to the file to copy */
1024
+ path: string
1025
+ /** the destination path for the copied file */
1026
+ destinationPath: string
1027
+ }
1028
+
1029
+ export type SpaceStorageCopyByIdParameters = {
1030
+ /** the ID of the space to copy files in */
1031
+ spaceId: string
1032
+ /** the path to the file to copy */
1033
+ path: string
1034
+ /** the destination path for the copied file */
1035
+ destinationPath: string
1036
+ }
1037
+
1038
+ export type SpaceStorageDeleteParameters = {
1039
+ /** the path to the file to delete */
1040
+ path: string
1041
+ }
1042
+
1043
+ export type SpaceStorageDeleteByIdParameters = {
1044
+ /** the ID of the space to delete files from */
1045
+ spaceId: string
1046
+ /** the path to the file to delete */
1047
+ path: string
1048
+ }
1049
+
1050
+ export type SpaceStorageImportParameters = {
1051
+ /** the URL to import from */
1052
+ url: string
1053
+ /** the destination path in the space storage */
1054
+ path: string
1055
+ }
1056
+
1057
+ export type SpaceStorageImportByIdParameters = {
1058
+ /** the ID of the space to import into */
1059
+ spaceId: string
1060
+ /** the URL to import from */
1061
+ url: string
1062
+ /** the destination path in the space storage */
1063
+ path: string
1064
+ }
1065
+
1066
+ export type SpaceStorageLinkParameters = {
1067
+ /** the path to the file to get a link for */
1068
+ path: string
1069
+ }
1070
+
1071
+ export type SpaceStorageLinkByIdParameters = {
1072
+ /** the ID of the space */
1073
+ spaceId: string
1074
+ /** the path to the file to get a link for */
1075
+ path: string
1076
+ }
1077
+
1078
+ export type SpaceStorageListParameters = {
1079
+ /** optional directory path to list files from */
1080
+ path?: string
1081
+ /** whether to list files recursively */
1082
+ recursive?: boolean
1083
+ }
1084
+
1085
+ export type SpaceStorageListByIdParameters = {
1086
+ /** the ID of the space to list files from */
1087
+ spaceId: string
1088
+ /** optional directory path to list files from */
1089
+ path?: string
1090
+ /** whether to list files recursively */
1091
+ recursive?: boolean
1092
+ }
1093
+
1094
+ export type SpaceStorageMoveParameters = {
1095
+ /** the path to the file to move */
1096
+ path: string
1097
+ /** the destination path for the file */
1098
+ destinationPath: string
1099
+ }
1100
+
1101
+ export type SpaceStorageMoveByIdParameters = {
1102
+ /** the ID of the space to move files in */
1103
+ spaceId: string
1104
+ /** the path to the file to move */
1105
+ path: string
1106
+ /** the destination path for the file */
1107
+ destinationPath: string
1108
+ }
1109
+
1110
+ export type SpaceStorageReadParameters = {
1111
+ /** absolute path to the file to read */
1112
+ path: string
1113
+ /** the line number to start reading from (1-indexed, line 1 is the first line) */
1114
+ startLine?: number
1115
+ /** the line number to end reading at, inclusive (1-indexed). Prefer reading at least 100 lines or more per request to minimize round trips */
1116
+ endLine?: number
1117
+ }
1118
+
1119
+ export type SpaceStorageReadByIdParameters = {
1120
+ /** the ID of the space to read files from */
1121
+ spaceId: string
1122
+ /** the path to the file to read */
1123
+ path: string
1124
+ /** the line number to start reading from (1-indexed, line 1 is the first line) */
1125
+ startLine?: number
1126
+ /** the line number to end reading at, inclusive (1-indexed). Prefer reading at least 100 lines or more per request to minimize round trips */
1127
+ endLine?: number
1128
+ }
1129
+
1130
+ export type SpaceStorageRwParameters = {
1131
+ /** the path to the file to read or write */
1132
+ path: string
1133
+ /** 'the mode: "read" to read file contents, "write" to write content' */
1134
+ mode: string
1135
+ /** the content to write to the file (required for write mode) */
1136
+ content?: string
1137
+ /** the line number to start at (1-indexed). For read mode, limits the output. For write mode with only startLine, content is inserted before this line. For write mode with both startLine and endLine, lines in that range are replaced. */
1138
+ startLine?: number
1139
+ /** the line number to end at, inclusive (1-indexed). For read mode, limits the output. For write mode, used with startLine to replace a range of lines. */
1140
+ endLine?: number
1141
+ }
1142
+
1143
+ export type SpaceStorageRwByIdParameters = {
1144
+ /** the ID of the space to read or write files in */
1145
+ spaceId: string
1146
+ /** the path to the file to read or write */
1147
+ path: string
1148
+ /** 'the mode: "read" to read file contents, "write" to write content' */
1149
+ mode: string
1150
+ /** the content to write to the file (required for write mode) */
1151
+ content?: string
1152
+ /** the line number to start at (1-indexed). For read mode, limits the output. For write mode with only startLine, content is inserted before this line. For write mode with both startLine and endLine, lines in that range are replaced. */
1153
+ startLine?: number
1154
+ /** the line number to end at, inclusive (1-indexed). For read mode, limits the output. For write mode, used with startLine to replace a range of lines. */
1155
+ endLine?: number
1156
+ }
1157
+
1158
+ export type SpaceStorageSearchParameters = {
1159
+ /** the search query */
1160
+ query: string
1161
+ }
1162
+
1163
+ export type SpaceStorageSearchByIdParameters = {
1164
+ /** the ID of the space to search files in */
1165
+ spaceId: string
1166
+ /** the search query */
1167
+ query: string
1168
+ }
1169
+
1170
+ export type SpaceStorageWriteParameters = {
1171
+ /** absolute path to the file to write */
1172
+ path: string
1173
+ /** the content to write to the file */
1174
+ content: string
1175
+ /** the line number to start writing at (1-indexed). If only startLine is provided, content is inserted before this line. If both startLine and endLine are provided, lines in that range are replaced. */
1176
+ startLine?: number
1177
+ /** the line number to end writing at, inclusive (1-indexed). Used with startLine to replace a range of lines. */
1178
+ endLine?: number
1179
+ }
1180
+
1181
+ export type SpaceStorageWriteByIdParameters = {
1182
+ /** the ID of the space to write files to */
1183
+ spaceId: string
1184
+ /** the path to the file to write */
1185
+ path: string
1186
+ /** the content to write to the file */
1187
+ content: string
1188
+ /** the line number to start writing at (1-indexed). If only startLine is provided, content is inserted before this line. If both startLine and endLine are provided, lines in that range are replaced. */
1189
+ startLine?: number
1190
+ /** the line number to end writing at, inclusive (1-indexed). Used with startLine to replace a range of lines. */
1191
+ endLine?: number
1192
+ }
1193
+
1194
+ export type SpaceUpdateByIdParameters = {
1195
+ /** the ID of the space to update */
1196
+ spaceId: string
1197
+ /** the updated name of the space */
1198
+ name?: string
1199
+ /** the updated description of the space */
1200
+ description?: string
1201
+ }
1202
+
1203
+ export type SpaceUpdateContactByIdParameters = {
1204
+ /** the ID of the space to update */
1205
+ spaceId: string
1206
+ /** the updated name of the space */
1207
+ name?: string
1208
+ /** the updated description of the space */
1209
+ description?: string
1210
+ }
1211
+
1212
+ export type TaskCreateParameters = {
1213
+ /** the name of the task */
1214
+ name: string
1215
+ /** a detailed description that captures all the necessary information to complete the task */
1216
+ description: string
1217
+ /** optional schedule - e.g. 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
1218
+ schedule?: string
1219
+ }
1220
+
1221
+ export type TaskCreateContactParameters = {
1222
+ /** the name of the task */
1223
+ name: string
1224
+ /** a detailed description that captures all the necessary information to complete the task */
1225
+ description: string
1226
+ /** optional schedule - e.g. 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
1227
+ schedule?: string
1228
+ }
1229
+
1230
+ export type TaskDeleteByIdParameters = {
1231
+ /** the ID of the task to delete */
1232
+ taskId: string
1233
+ }
1234
+
1235
+ export type TaskDeleteContactByIdParameters = {
1236
+ /** the ID of the task to delete */
1237
+ taskId: string
1238
+ }
1239
+
1240
+ export type TaskFetchByIdParameters = {
1241
+ /** the ID of the task to fetch */
1242
+ taskId: string
1243
+ }
1244
+
1245
+ export type TaskFetchContactByIdParameters = {
1246
+ /** the ID of the task to fetch */
1247
+ taskId: string
1248
+ }
1249
+
1250
+ export type TaskListParameters = Record<string, never>
1251
+
1252
+ export type TaskListContactParameters = Record<string, never>
1253
+
1254
+ export type TaskRunByIdParameters = {
1255
+ /** the ID of the task to run */
1256
+ taskId: string
1257
+ }
1258
+
1259
+ export type TaskRunContactByIdParameters = {
1260
+ /** the ID of the task to run */
1261
+ taskId: string
1262
+ }
1263
+
1264
+ export type TaskUpdateByIdParameters = {
1265
+ /** the ID of the task to update */
1266
+ taskId: string
1267
+ /** the updated name of the task */
1268
+ name: string
1269
+ /** an updated detailed description that captures all the necessary information to complete the task */
1270
+ description: string
1271
+ /** optional schedule - e.g. 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
1272
+ schedule?: string
1273
+ }
1274
+
1275
+ export type TaskUpdateContactByIdParameters = {
1276
+ /** the ID of the task to update */
1277
+ taskId: string
1278
+ /** the updated name of the task */
1279
+ name: string
1280
+ /** an updated detailed description that captures all the necessary information to complete the task */
1281
+ description: string
1282
+ /** optional schedule - e.g. 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
1283
+ schedule?: string
1284
+ }
1285
+
1286
+ export type TelegramConversationStartByIdParameters = {
1287
+ /** The ID of the Telegram integration to use */
1288
+ telegramIntegrationId: string
1289
+ /** The Telegram chat ID to send the message to. This can be a user ID, group chat ID, or channel ID */
1290
+ chatId: string
1291
+ /** The initial message text to send to start the conversation */
1292
+ text: string
1293
+ /** Optional context about the recipient or conversation, typically generated by the agent */
1294
+ context?: string
1295
+ }
1296
+
1297
+ export type TextArticleGenerateParameters = {
1298
+ /** additional directions how to generate the article */
1299
+ directions?: string
1300
+ /** the topic of the article */
1301
+ topic: string
1302
+ /** the source to use for the article generation */
1303
+ source: string
1304
+ }
1305
+
1306
+ export type TextEmailGenerateParameters = {
1307
+ /** optional directions how to generate the email */
1308
+ directions?: string
1309
+ /** the source to use for email generation */
1310
+ source: string
1311
+ }
1312
+
1313
+ export type TextGenerateParameters = {
1314
+ /** optional directions how to generate the text */
1315
+ directions?: string
1316
+ /** the source to use for text generation */
1317
+ source: string
1318
+ }
1319
+
1320
+ export type TextSummarizeParameters = {
1321
+ /** optional directions how to summarize the text */
1322
+ directions?: string
1323
+ /** the source text to summarize */
1324
+ source: string
1325
+ }
1326
+
1327
+ export type TextTranslateParameters = {
1328
+ /** optional directions how to translate the text */
1329
+ directions?: string
1330
+ /** the source text to translate */
1331
+ source: string
1332
+ }
1333
+
1334
+ export type TodoManageParameters = {
1335
+ /** 'the operation to perform: read to retrieve todos, write to replace the entire list' */
1336
+ operation: string
1337
+ /** unique identifier for the todo */
1338
+ id: number
1339
+ /** concise action-oriented todo label (3-7 words) */
1340
+ title: string
1341
+ /** 'not-started: not begun | in-progress: currently working | completed: finished' */
1342
+ status: string
1343
+ }
1344
+
1345
+ export type TodoReadParameters = Record<string, never>
1346
+
1347
+ export type TodoWriteParameters = {
1348
+ /** unique identifier for the todo (sequential numbers) */
1349
+ id: number
1350
+ /** concise action-oriented todo label (3-7 words) */
1351
+ title: string
1352
+ /** the current status of the todo */
1353
+ status: string
1354
+ }
1355
+
1356
+ export type UrlGraphqlParameters = {
1357
+ /** the GraphQL endpoint URL */
1358
+ endpoint: string
1359
+ /** the GraphQL query to execute */
1360
+ query: string
1361
+ /** optional GraphQL query variables in JSON format */
1362
+ variables?: string
1363
+ }
1364
+
1365
+ export type UrlSqlParameters = {
1366
+ /** the SQL query to execute for table "table1" */
1367
+ sql: string
1368
+ /** the url for the "table1" table where to load the data from */
1369
+ table1_url: string
1370
+ }
1371
+
1372
+ export type ViewDescribeParameters = {
1373
+ /** directions how to describe an image */
1374
+ directions?: string
1375
+ /** The URL of the image */
1376
+ image_url?: string
1377
+ }
1378
+
1379
+ export type WhatsappConversationStartByIdParameters = {
1380
+ /** The ID of the WhatsApp integration to use */
1381
+ whatsappIntegrationId: string
1382
+ /** The recipient phone number in international format (e.g. 14155238886) */
1383
+ to: string
1384
+ /** The initial message text to send to start the conversation */
1385
+ text: string
1386
+ /** Optional context about the recipient or conversation, typically generated by the agent */
1387
+ context?: string
1388
+ }
1389
+
1390
+ // --- Ability Registry ---
1391
+
1392
+ export interface CbkAbilityRegistry {
1393
+ 'abort': {
1394
+ name: 'Abort Operation'
1395
+ description: 'Abort the current operation'
1396
+ parameters: AbortParameters
1397
+ }
1398
+ 'abort[failure]': {
1399
+ name: 'Failure'
1400
+ description: 'Exit the current operation by marking the current operation as failure - must be called as the last operation if an unrecoverable error is encountered'
1401
+ parameters: AbortFailureParameters
1402
+ }
1403
+ 'abort[success]': {
1404
+ name: 'Success'
1405
+ description: 'Exit the current operation by marking the current operation as successful - must be called as the last operation once all tasks are completed'
1406
+ parameters: AbortSuccessParameters
1407
+ }
1408
+ 'agent/execute': {
1409
+ name: 'Execute Task'
1410
+ description: 'Execute a task using an agent'
1411
+ parameters: AgentExecuteParameters
1412
+ }
1413
+ 'agent/task/evaluate': {
1414
+ name: 'Evaluate Task Execution'
1415
+ description: 'Evaluate how well a task was executed by an agent'
1416
+ parameters: AgentTaskEvaluateParameters
1417
+ }
1418
+ 'agent/task/plan': {
1419
+ name: 'Plan Task Execution'
1420
+ description: 'Plan how a task should be executed by an agent'
1421
+ parameters: AgentTaskPlanParameters
1422
+ }
1423
+ 'attachment/read': {
1424
+ name: 'Read Attachment'
1425
+ description: 'Read and extract content from uploaded file attachments. For text-based files, extracts and returns the text content. For image files (png, jpg, jpeg, gif, webp, bmp, tiff, svg), analyzes the image using vision capabilities. Locate the corresponding tool call for the attachment information. Does not support audio or video files.'
1426
+ parameters: AttachmentReadParameters
1427
+ }
1428
+ 'blueprint/note/list': {
1429
+ name: 'List Current Blueprint Notes'
1430
+ description: 'List the notes stored in the current blueprint'
1431
+ parameters: BlueprintNoteListParameters
1432
+ }
1433
+ 'blueprint/resource/list': {
1434
+ name: 'List Current Blueprint Resources'
1435
+ description: 'List the resources available in the current blueprint'
1436
+ parameters: BlueprintResourceListParameters
1437
+ }
1438
+ 'bot/ask': {
1439
+ name: 'Ask Bot'
1440
+ description: 'Ask another bot a question'
1441
+ parameters: BotAskParameters
1442
+ }
1443
+ 'bot/ask[by-id]': {
1444
+ name: 'Ask Bot'
1445
+ description: 'Ask another bot a question'
1446
+ parameters: BotAskByIdParameters
1447
+ }
1448
+ 'bot/ask[multi]': {
1449
+ name: 'Ask Multiple Bots'
1450
+ description: 'Ask multiple bots a question'
1451
+ parameters: BotAskMultiParameters
1452
+ }
1453
+ 'bot/backstory/read': {
1454
+ name: 'Read Bot Backstory'
1455
+ description: 'Read the backstory of a connected bot'
1456
+ parameters: BotBackstoryReadParameters
1457
+ }
1458
+ 'bot/backstory/read[by-id]': {
1459
+ name: 'Read Bot Backstory'
1460
+ description: 'Read the backstory of a bot by ID'
1461
+ parameters: BotBackstoryReadByIdParameters
1462
+ }
1463
+ 'bot/backstory/write': {
1464
+ name: 'Write Bot Backstory'
1465
+ description: 'Write the backstory of a connected bot'
1466
+ parameters: BotBackstoryWriteParameters
1467
+ }
1468
+ 'bot/backstory/write[by-id]': {
1469
+ name: 'Write Bot Backstory'
1470
+ description: 'Write the backstory of a bot by ID'
1471
+ parameters: BotBackstoryWriteByIdParameters
1472
+ }
1473
+ 'bot/call': {
1474
+ name: 'Call Bot'
1475
+ description: 'Call another bot to perform an action'
1476
+ parameters: BotCallParameters
1477
+ }
1478
+ 'bot/call[by-id]': {
1479
+ name: 'Call Bot'
1480
+ description: 'Call another bot to perform an action'
1481
+ parameters: BotCallByIdParameters
1482
+ }
1483
+ 'bot/call[multi]': {
1484
+ name: 'Call Multiple Bots'
1485
+ description: 'Call multiple bots to perform an action'
1486
+ parameters: BotCallMultiParameters
1487
+ }
1488
+ 'bot/list': {
1489
+ name: 'List Bots'
1490
+ description: 'List all available bots for the current user account'
1491
+ parameters: BotListParameters
1492
+ }
1493
+ 'browser/dispatch': {
1494
+ name: 'Dispatch Browser Task'
1495
+ description: 'Dispatch a specific task within a live web browser.'
1496
+ parameters: BrowserDispatchParameters
1497
+ }
1498
+ 'conversation/fetch[bot][by-id]': {
1499
+ name: 'Fetch Conversation'
1500
+ description: 'Fetch details of a specific conversation'
1501
+ parameters: ConversationFetchBotByIdParameters
1502
+ }
1503
+ 'conversation/fetch[by-id]': {
1504
+ name: 'Fetch Conversation'
1505
+ description: 'Fetch details of a specific conversation'
1506
+ parameters: ConversationFetchByIdParameters
1507
+ }
1508
+ 'conversation/fetch[contact][by-id]': {
1509
+ name: 'Fetch Conversation'
1510
+ description: 'Fetch details of a specific conversation'
1511
+ parameters: ConversationFetchContactByIdParameters
1512
+ }
1513
+ 'conversation/list': {
1514
+ name: 'List Conversations'
1515
+ description: 'List all conversations'
1516
+ parameters: ConversationListParameters
1517
+ }
1518
+ 'conversation/list[bot]': {
1519
+ name: 'List Conversations'
1520
+ description: 'List all conversations'
1521
+ parameters: ConversationListBotParameters
1522
+ }
1523
+ 'conversation/list[contact]': {
1524
+ name: 'List Conversations'
1525
+ description: 'List all conversations'
1526
+ parameters: ConversationListContactParameters
1527
+ }
1528
+ 'conversation/mcp/install[url]': {
1529
+ name: 'Install MCP'
1530
+ description: 'Bring MCP (model context protocol) functions into context'
1531
+ parameters: ConversationMcpInstallUrlParameters
1532
+ }
1533
+ 'conversation/search': {
1534
+ name: 'Search Conversations'
1535
+ description: 'Search conversations by query'
1536
+ parameters: ConversationSearchParameters
1537
+ }
1538
+ 'conversation/search[bot]': {
1539
+ name: 'Search Conversations'
1540
+ description: 'Search conversations by query'
1541
+ parameters: ConversationSearchBotParameters
1542
+ }
1543
+ 'conversation/search[contact]': {
1544
+ name: 'Search Conversations'
1545
+ description: 'Search conversations by query'
1546
+ parameters: ConversationSearchContactParameters
1547
+ }
1548
+ 'conversation/skillset/install[by-id]': {
1549
+ name: 'Install Skillset'
1550
+ description: 'Bring a skillset into context by its ID'
1551
+ parameters: ConversationSkillsetInstallByIdParameters
1552
+ }
1553
+ 'dataset/create': {
1554
+ name: 'Create Dataset'
1555
+ description: 'Create a new dataset'
1556
+ parameters: DatasetCreateParameters
1557
+ }
1558
+ 'dataset/file/create[url]': {
1559
+ name: 'Add File to Dataset'
1560
+ description: 'Creates and synchronizes a file in a dataset from a URL source.'
1561
+ parameters: DatasetFileCreateUrlParameters
1562
+ }
1563
+ 'dataset/list': {
1564
+ name: 'List Datasets'
1565
+ description: 'Retrieve a list of datasets associated with the user'
1566
+ parameters: DatasetListParameters
1567
+ }
1568
+ 'dataset/record/create': {
1569
+ name: 'Create Dataset Record'
1570
+ description: 'Create a new record in a dataset'
1571
+ parameters: DatasetRecordCreateParameters
1572
+ }
1573
+ 'dataset/search': {
1574
+ name: 'Search Dataset'
1575
+ description: 'Search a dataset for specific keywords or filters'
1576
+ parameters: DatasetSearchParameters
1577
+ }
1578
+ 'discord/conversation/start[by-id]': {
1579
+ name: 'Start Discord Conversation'
1580
+ description: 'Initiates a new conversation by sending a message to a Discord channel.'
1581
+ parameters: DiscordConversationStartByIdParameters
1582
+ }
1583
+ 'email/conversation/start[by-id]': {
1584
+ name: 'Start Email Conversation'
1585
+ description: 'Initiates a new conversation by sending an email to a recipient.'
1586
+ parameters: EmailConversationStartByIdParameters
1587
+ }
1588
+ 'email/send': {
1589
+ name: 'Send Email'
1590
+ description: 'Compose and send an email using the provided content in markdown format'
1591
+ parameters: EmailSendParameters
1592
+ }
1593
+ 'example/fetch/api/get': {
1594
+ name: 'Fetch Web API'
1595
+ description: 'Fetch data from a web API using a URL and optional parameters'
1596
+ parameters: ExampleFetchApiGetParameters
1597
+ }
1598
+ 'example/fetch/api/post': {
1599
+ name: 'Post Data to Web API'
1600
+ description: 'Post data to a web API using a URL and JSON payload'
1601
+ parameters: ExampleFetchApiPostParameters
1602
+ }
1603
+ 'example/fetch/api/post[params]': {
1604
+ name: 'Post Data to Web API with Parameters'
1605
+ description: 'Post data to a web API using a URL and form parameters'
1606
+ parameters: ExampleFetchApiPostParamsParameters
1607
+ }
1608
+ 'fetch/metadata': {
1609
+ name: 'Fetch Metadata'
1610
+ description: 'Fetch the title, description, keywords, icon and other metadata of a web page'
1611
+ parameters: FetchMetadataParameters
1612
+ }
1613
+ 'fetch/request': {
1614
+ name: 'Custom HTTP Request (Public)'
1615
+ description: 'Make a custom HTTP request to a public API without authentication. Full control over method, URL, headers, and body.'
1616
+ parameters: FetchRequestParameters
1617
+ }
1618
+ 'fetch/request[with-auth]': {
1619
+ name: 'Custom HTTP Request'
1620
+ description: 'Make a custom HTTP request with full control over method, URL, headers, and body. Use this for any API that requires specific HTTP configurations.'
1621
+ parameters: FetchRequestWithAuthParameters
1622
+ }
1623
+ 'fetch/text/get': {
1624
+ name: 'Fetch Web Page'
1625
+ description: 'Fetch the content of a web page using a URL and convert it to text'
1626
+ parameters: FetchTextGetParameters
1627
+ }
1628
+ 'file/append': {
1629
+ name: 'Append to File'
1630
+ description: 'Append content to a file'
1631
+ parameters: FileAppendParameters
1632
+ }
1633
+ 'file/append[by-id]': {
1634
+ name: 'Append to File'
1635
+ description: 'Append content to a file'
1636
+ parameters: FileAppendByIdParameters
1637
+ }
1638
+ 'file/prepend': {
1639
+ name: 'Prepend to File'
1640
+ description: 'Prepend content to a file'
1641
+ parameters: FilePrependParameters
1642
+ }
1643
+ 'file/prepend[by-id]': {
1644
+ name: 'Prepend to File'
1645
+ description: 'Prepend content to a file'
1646
+ parameters: FilePrependByIdParameters
1647
+ }
1648
+ 'file/read': {
1649
+ name: 'Read File'
1650
+ description: 'Read the content of a file. Supports optional line range to read specific sections. For efficiency, prefer reading larger chunks rather than many small sequential reads.'
1651
+ parameters: FileReadParameters
1652
+ }
1653
+ 'file/read[by-id]': {
1654
+ name: 'Read File'
1655
+ description: 'Read the content of a file. Supports optional line range to read specific sections. For efficiency, prefer reading larger chunks rather than many small sequential reads.'
1656
+ parameters: FileReadByIdParameters
1657
+ }
1658
+ 'file/replace': {
1659
+ name: 'Replace in File'
1660
+ description: 'Replace text in a file'
1661
+ parameters: FileReplaceParameters
1662
+ }
1663
+ 'file/replace[by-id]': {
1664
+ name: 'Replace in File'
1665
+ description: 'Replace text in a file'
1666
+ parameters: FileReplaceByIdParameters
1667
+ }
1668
+ 'file/rw': {
1669
+ name: 'Read/Write File'
1670
+ description: 'Read or write file content with a single combined operation. Use mode "read" to read content, or mode "write" to write content. Supports optional line ranges for both modes.'
1671
+ parameters: FileRwParameters
1672
+ }
1673
+ 'file/rw[by-id]': {
1674
+ name: 'Read/Write File'
1675
+ description: 'Read or write file content with a single combined operation. Use mode "read" to read content, or mode "write" to write content. Supports optional line ranges for both modes.'
1676
+ parameters: FileRwByIdParameters
1677
+ }
1678
+ 'file/sql': {
1679
+ name: 'Query File with SQL'
1680
+ description: 'Execute SQL queries on structured data files (CSV, Excel, JSON) to filter, aggregate, and analyze data.'
1681
+ parameters: FileSqlParameters
1682
+ }
1683
+ 'file/sql[by-id]': {
1684
+ name: 'Query File with SQL'
1685
+ description: 'Execute SQL queries on structured data files (CSV, Excel, JSON) to filter, aggregate, and analyze data.'
1686
+ parameters: FileSqlByIdParameters
1687
+ }
1688
+ 'file/write': {
1689
+ name: 'Write File'
1690
+ description: 'Write content to a file. Without line parameters, overwrites the entire file. With startLine only, inserts before that line. With startLine and endLine, replaces that range.'
1691
+ parameters: FileWriteParameters
1692
+ }
1693
+ 'file/write[by-id]': {
1694
+ name: 'Write File'
1695
+ description: 'Write content to a file. Without line parameters, overwrites the entire file. With startLine only, inserts before that line. With startLine and endLine, replaces that range.'
1696
+ parameters: FileWriteByIdParameters
1697
+ }
1698
+ 'git/file/fetch': {
1699
+ name: 'Fetch Git File'
1700
+ description: 'Fetches a file from a Git repository at a specific reference.'
1701
+ parameters: GitFileFetchParameters
1702
+ }
1703
+ 'git/tree/fetch': {
1704
+ name: 'Fetch Git Tree'
1705
+ description: 'Fetches all files from a directory in a Git repository at a specific reference.'
1706
+ parameters: GitTreeFetchParameters
1707
+ }
1708
+ 'graphql[cbk]': {
1709
+ name: 'Execute GraphQL Query'
1710
+ description: 'Execute a graphql query against ChatBotKit platform services'
1711
+ parameters: GraphqlCbkParameters
1712
+ }
1713
+ 'image/generate': {
1714
+ name: 'Generate Image'
1715
+ description: 'Generate an image from the provided input prompt.'
1716
+ parameters: ImageGenerateParameters
1717
+ }
1718
+ 'image/generate[gemini-2.5-flash-image]': {
1719
+ name: 'Generate Image'
1720
+ description: 'Generate an image using the Gemini 2.5 Flash Image model (also known as "Nano Banana") with state-of-the-art contextual understanding.'
1721
+ parameters: ImageGenerateGemini25FlashImageParameters
1722
+ }
1723
+ 'image/generate[gemini-3.1-flash-image]': {
1724
+ name: 'Generate Image'
1725
+ description: 'Generate an image using the Gemini 3.1 Flash Image model with Pro-level visual quality at Flash speed.'
1726
+ parameters: ImageGenerateGemini31FlashImageParameters
1727
+ }
1728
+ 'image/generate[gpt-image-1.5]': {
1729
+ name: 'Generate Image'
1730
+ description: 'Generate an image using the GPT Image 1.5 model with enhanced quality and fidelity.'
1731
+ parameters: ImageGenerateGptImage15Parameters
1732
+ }
1733
+ 'image/generate[gpt-image-1]': {
1734
+ name: 'Generate Image'
1735
+ description: 'Generate an image from the provided input prompt.'
1736
+ parameters: ImageGenerateGptImage1Parameters
1737
+ }
1738
+ 'image/modify': {
1739
+ name: 'Modify Image'
1740
+ description: 'Create a new image from previous input images and a provided input prompt.'
1741
+ parameters: ImageModifyParameters
1742
+ }
1743
+ 'image/modify[gemini-2.5-flash-image]': {
1744
+ name: 'Modify Image'
1745
+ description: 'Create a new image from previous input images using the Gemini 2.5 Flash Image model (also known as "Nano Banana").'
1746
+ parameters: ImageModifyGemini25FlashImageParameters
1747
+ }
1748
+ 'image/modify[gemini-3.1-flash-image]': {
1749
+ name: 'Modify Image'
1750
+ description: 'Create a new image from previous input images using the Gemini 3.1 Flash Image model.'
1751
+ parameters: ImageModifyGemini31FlashImageParameters
1752
+ }
1753
+ 'image/modify[gpt-image-1.5]': {
1754
+ name: 'Modify Image'
1755
+ description: 'Create a new image from previous input images using the GPT Image 1.5 model.'
1756
+ parameters: ImageModifyGptImage15Parameters
1757
+ }
1758
+ 'image/modify[gpt-image-1]': {
1759
+ name: 'Modify Image'
1760
+ description: 'Create a new image from previous input images and a provided input prompt.'
1761
+ parameters: ImageModifyGptImage1Parameters
1762
+ }
1763
+ 'listen/transcribe': {
1764
+ name: 'Transcribe Audio'
1765
+ description: 'Transcribe the content of an audio URL'
1766
+ parameters: ListenTranscribeParameters
1767
+ }
1768
+ 'math/evaluate': {
1769
+ name: 'Evaluate Math Expression'
1770
+ description: 'Evaluate a math expression'
1771
+ parameters: MathEvaluateParameters
1772
+ }
1773
+ 'memory/create': {
1774
+ name: 'Create Memory'
1775
+ description: 'Create a new memory using the provided content'
1776
+ parameters: MemoryCreateParameters
1777
+ }
1778
+ 'memory/create[bot]': {
1779
+ name: 'Create Memory'
1780
+ description: 'Create a new memory using the provided content'
1781
+ parameters: MemoryCreateBotParameters
1782
+ }
1783
+ 'memory/create[contact]': {
1784
+ name: 'Create Memory'
1785
+ description: 'Create a new memory using the provided content'
1786
+ parameters: MemoryCreateContactParameters
1787
+ }
1788
+ 'memory/delete[bot][by-id]': {
1789
+ name: 'Delete Memory'
1790
+ description: 'Delete an existing memory'
1791
+ parameters: MemoryDeleteBotByIdParameters
1792
+ }
1793
+ 'memory/delete[by-id]': {
1794
+ name: 'Delete Memory'
1795
+ description: 'Delete an existing memory'
1796
+ parameters: MemoryDeleteByIdParameters
1797
+ }
1798
+ 'memory/delete[contact][by-id]': {
1799
+ name: 'Delete Memory'
1800
+ description: 'Delete an existing memory'
1801
+ parameters: MemoryDeleteContactByIdParameters
1802
+ }
1803
+ 'memory/list': {
1804
+ name: 'List Memories'
1805
+ description: 'List the most recent memories'
1806
+ parameters: MemoryListParameters
1807
+ }
1808
+ 'memory/list[bot]': {
1809
+ name: 'List Memories'
1810
+ description: 'List the most recent memories'
1811
+ parameters: MemoryListBotParameters
1812
+ }
1813
+ 'memory/list[contact]': {
1814
+ name: 'List Memories'
1815
+ description: 'List the most recent memories'
1816
+ parameters: MemoryListContactParameters
1817
+ }
1818
+ 'memory/search': {
1819
+ name: 'Search Memories'
1820
+ description: 'Search memories using specific search terms'
1821
+ parameters: MemorySearchParameters
1822
+ }
1823
+ 'memory/search[bot]': {
1824
+ name: 'Search Memories'
1825
+ description: 'Search memories using specific search terms'
1826
+ parameters: MemorySearchBotParameters
1827
+ }
1828
+ 'memory/search[contact]': {
1829
+ name: 'Search Memories'
1830
+ description: 'Search memories using specific search terms'
1831
+ parameters: MemorySearchContactParameters
1832
+ }
1833
+ 'memory/update[bot][by-id]': {
1834
+ name: 'Update Memory'
1835
+ description: 'Update an existing memory using the provided content'
1836
+ parameters: MemoryUpdateBotByIdParameters
1837
+ }
1838
+ 'memory/update[by-id]': {
1839
+ name: 'Update Memory'
1840
+ description: 'Update an existing memory using the provided content'
1841
+ parameters: MemoryUpdateByIdParameters
1842
+ }
1843
+ 'memory/update[contact][by-id]': {
1844
+ name: 'Update Memory'
1845
+ description: 'Update an existing memory using the provided content'
1846
+ parameters: MemoryUpdateContactByIdParameters
1847
+ }
1848
+ 'mock/api[create]': {
1849
+ name: 'API Create'
1850
+ description: 'Create a new resource'
1851
+ parameters: MockApiCreateParameters
1852
+ }
1853
+ 'mock/api[delete]': {
1854
+ name: 'API Delete'
1855
+ description: 'Delete an existing resource'
1856
+ parameters: MockApiDeleteParameters
1857
+ }
1858
+ 'mock/api[list]': {
1859
+ name: 'API List'
1860
+ description: 'List resources from an API endpoint'
1861
+ parameters: MockApiListParameters
1862
+ }
1863
+ 'mock/api[update]': {
1864
+ name: 'API Update'
1865
+ description: 'Update an existing resource'
1866
+ parameters: MockApiUpdateParameters
1867
+ }
1868
+ 'mock/api/[search]': {
1869
+ name: 'API Search'
1870
+ description: 'Search resources from an API endpoint'
1871
+ parameters: MockApiSearchParameters
1872
+ }
1873
+ 'mock/dataset': {
1874
+ name: 'Query Dataset'
1875
+ description: 'Query a dataset using specific terms'
1876
+ parameters: MockDatasetParameters
1877
+ }
1878
+ 'mock/sql': {
1879
+ name: 'Query Database'
1880
+ description: 'Query a database using SQL'
1881
+ parameters: MockSqlParameters
1882
+ }
1883
+ 'pack/bot/reprogramming': {
1884
+ name: 'Install Bot Reprogramming Tools'
1885
+ description: 'Installs bot backstory read and write tools into the conversation. You can read the current backstory of the connected bot and overwrite it with new content.'
1886
+ parameters: PackBotReprogrammingParameters
1887
+ }
1888
+ 'pack/cbk/space/skills': {
1889
+ name: 'Install Space Skills Tools'
1890
+ description: 'Installs space skills tools into the conversation. You can list available skills and read their full content from the linked space.'
1891
+ parameters: PackCbkSpaceSkillsParameters
1892
+ }
1893
+ 'pack/cbk/space/storage': {
1894
+ name: 'Install Space Storage Tools'
1895
+ description: 'Installs space storage tools into the conversation. You can list, read, write, delete, move, copy, search, import, and link files in the linked space.'
1896
+ parameters: PackCbkSpaceStorageParameters
1897
+ }
1898
+ 'pack/cbk/space/storage[read-only]': {
1899
+ name: 'Install Space Storage Read-Only Tools'
1900
+ description: 'Installs read-only space storage tools into the conversation. You can list, read, search, and link files in the linked space without modification.'
1901
+ parameters: PackCbkSpaceStorageReadOnlyParameters
1902
+ }
1903
+ 'pack/file': {
1904
+ name: 'Install File Tools'
1905
+ description: 'Installs tools to read, write, prepend, append, and replace content in the specified file.'
1906
+ parameters: PackFileParameters
1907
+ }
1908
+ 'pack/file[by-id]': {
1909
+ name: 'Install File Tools'
1910
+ description: 'Installs file tools into the conversation to read, write, prepend, append, and replace content in files by specifying the file ID.'
1911
+ parameters: PackFileByIdParameters
1912
+ }
1913
+ 'pack/shell': {
1914
+ name: 'Install Shell Tools'
1915
+ description: 'Installs shell tools into the conversation to execute commands and scripts.'
1916
+ parameters: PackShellParameters
1917
+ }
1918
+ 'search/images': {
1919
+ name: 'Search Images'
1920
+ description: 'Search the web for images based on specific keywords'
1921
+ parameters: SearchImagesParameters
1922
+ }
1923
+ 'search/news': {
1924
+ name: 'Search News'
1925
+ description: 'Search the web for news articles based on specific keywords'
1926
+ parameters: SearchNewsParameters
1927
+ }
1928
+ 'search/videos': {
1929
+ name: 'Search Videos'
1930
+ description: 'Search the web for videos based on specific keywords'
1931
+ parameters: SearchVideosParameters
1932
+ }
1933
+ 'search/web': {
1934
+ name: 'Search Web'
1935
+ description: 'Search the web for specific keywords'
1936
+ parameters: SearchWebParameters
1937
+ }
1938
+ 'shell/eval/node': {
1939
+ name: 'Evaluate Node.js Code'
1940
+ description: 'Evaluate JavaScript code using a code interpreter (node.js)'
1941
+ parameters: ShellEvalNodeParameters
1942
+ }
1943
+ 'shell/eval/python': {
1944
+ name: 'Evaluate Python Code'
1945
+ description: 'Evaluate Python code using a code interpreter (python3)'
1946
+ parameters: ShellEvalPythonParameters
1947
+ }
1948
+ 'shell/exec': {
1949
+ name: 'Execute Shell Command'
1950
+ description: 'Execute a shell command or script'
1951
+ parameters: ShellExecParameters
1952
+ }
1953
+ 'shell/exec/node': {
1954
+ name: 'Execute Node.js Script'
1955
+ description: 'Execute a Node.js script'
1956
+ parameters: ShellExecNodeParameters
1957
+ }
1958
+ 'shell/exec/python': {
1959
+ name: 'Execute Python Script'
1960
+ description: 'Execute a Python script'
1961
+ parameters: ShellExecPythonParameters
1962
+ }
1963
+ 'shell/import': {
1964
+ name: 'Import URL to Shell Environment'
1965
+ description: 'Import data from a URL and save it to a file in the shell environment. Supports HTTP/HTTPS URLs and can handle both text and binary content.'
1966
+ parameters: ShellImportParameters
1967
+ }
1968
+ 'shell/read': {
1969
+ name: 'Read File from Shell Environment'
1970
+ description: 'Read the content of a file in a shell environment. Supports optional line range to read specific sections. For efficiency, prefer reading larger chunks rather than many small sequential reads. Supports parallel reads of different sections when needed upfront.'
1971
+ parameters: ShellReadParameters
1972
+ }
1973
+ 'shell/rw': {
1974
+ name: 'Read/Write File in Shell Environment'
1975
+ description: 'Read or write file content in a shell environment with a single combined operation. Use mode "read" to read content, or mode "write" to write content. Supports optional line ranges for both modes.'
1976
+ parameters: ShellRwParameters
1977
+ }
1978
+ 'shell/skillset/install[by-id]': {
1979
+ name: 'Install Skillset as Shell Command'
1980
+ description: 'Install a skillset as an executable shell command in the sandbox environment. The skillset abilities become available as subcommands.'
1981
+ parameters: ShellSkillsetInstallByIdParameters
1982
+ }
1983
+ 'shell/write': {
1984
+ name: 'Write File in Shell Environment'
1985
+ description: 'Write content to a file in a shell environment. Without line parameters, overwrites the entire file. With startLine only, inserts before that line. With startLine and endLine, replaces that range.'
1986
+ parameters: ShellWriteParameters
1987
+ }
1988
+ 'slack/conversation/start[by-id]': {
1989
+ name: 'Start Slack Conversation'
1990
+ description: 'Initiates a new conversation by sending a message to a Slack channel or direct message.'
1991
+ parameters: SlackConversationStartByIdParameters
1992
+ }
1993
+ 'space/create': {
1994
+ name: 'Create Space'
1995
+ description: 'Create a new space'
1996
+ parameters: SpaceCreateParameters
1997
+ }
1998
+ 'space/create[contact]': {
1999
+ name: 'Create Space'
2000
+ description: 'Create a new space'
2001
+ parameters: SpaceCreateContactParameters
2002
+ }
2003
+ 'space/delete[by-id]': {
2004
+ name: 'Delete Space'
2005
+ description: 'Delete an existing space'
2006
+ parameters: SpaceDeleteByIdParameters
2007
+ }
2008
+ 'space/delete[contact][by-id]': {
2009
+ name: 'Delete Space'
2010
+ description: 'Delete an existing space'
2011
+ parameters: SpaceDeleteContactByIdParameters
2012
+ }
2013
+ 'space/fetch[by-id]': {
2014
+ name: 'Fetch Space'
2015
+ description: 'Fetch details of a specific space'
2016
+ parameters: SpaceFetchByIdParameters
2017
+ }
2018
+ 'space/fetch[contact][by-id]': {
2019
+ name: 'Fetch Space'
2020
+ description: 'Fetch details of a specific space'
2021
+ parameters: SpaceFetchContactByIdParameters
2022
+ }
2023
+ 'space/list': {
2024
+ name: 'List Spaces'
2025
+ description: 'List all spaces'
2026
+ parameters: SpaceListParameters
2027
+ }
2028
+ 'space/list[contact]': {
2029
+ name: 'List Spaces'
2030
+ description: 'List all spaces'
2031
+ parameters: SpaceListContactParameters
2032
+ }
2033
+ 'space/skill/create': {
2034
+ name: 'Create Space Skills'
2035
+ description: 'Creates one or more skills in the linked space under the .skills directory. Each skill is stored as a SKILL.md file with frontmatter containing the name and description.'
2036
+ parameters: SpaceSkillCreateParameters
2037
+ }
2038
+ 'space/skill/create[by-id]': {
2039
+ name: 'Create Space Skills'
2040
+ description: 'Creates one or more skills in the specified space under the .skills directory. Each skill is stored as a SKILL.md file with frontmatter containing the name and description.'
2041
+ parameters: SpaceSkillCreateByIdParameters
2042
+ }
2043
+ 'space/skill/list': {
2044
+ name: 'List Space Skills'
2045
+ description: 'Lists all available skills in the linked space by scanning .skills, .github/skills, and .claude/skills directories. Returns the name, description, and path for each skill found.'
2046
+ parameters: SpaceSkillListParameters
2047
+ }
2048
+ 'space/skill/list[by-id]': {
2049
+ name: 'List Space Skills'
2050
+ description: 'Lists all available skills in the space by scanning .skills, .github/skills, and .claude/skills directories. Returns the name, description, and path for each skill found.'
2051
+ parameters: SpaceSkillListByIdParameters
2052
+ }
2053
+ 'space/skill/read': {
2054
+ name: 'Read Space Skills'
2055
+ description: 'Reads the full content of one or more skill files from the linked space by their paths. Use the list ability first to discover available skill paths.'
2056
+ parameters: SpaceSkillReadParameters
2057
+ }
2058
+ 'space/skill/read[by-id]': {
2059
+ name: 'Read Space Skills'
2060
+ description: 'Reads the full content of one or more skill files from the space by their paths. Use the list ability first to discover available skill paths.'
2061
+ parameters: SpaceSkillReadByIdParameters
2062
+ }
2063
+ 'space/storage/copy': {
2064
+ name: 'Copy Space Storage File'
2065
+ description: 'Copy a file to another location in a specific space directory'
2066
+ parameters: SpaceStorageCopyParameters
2067
+ }
2068
+ 'space/storage/copy[by-id]': {
2069
+ name: 'Copy Space Storage File'
2070
+ description: 'Copy a file to another location in a specific space directory'
2071
+ parameters: SpaceStorageCopyByIdParameters
2072
+ }
2073
+ 'space/storage/delete': {
2074
+ name: 'Delete Space Storage File'
2075
+ description: 'Delete a file in a specific space directory'
2076
+ parameters: SpaceStorageDeleteParameters
2077
+ }
2078
+ 'space/storage/delete[by-id]': {
2079
+ name: 'Delete Space Storage File'
2080
+ description: 'Delete a file in a specific space directory'
2081
+ parameters: SpaceStorageDeleteByIdParameters
2082
+ }
2083
+ 'space/storage/import': {
2084
+ name: 'Import URL to Space Storage'
2085
+ description: 'Import a file from a URL into space storage'
2086
+ parameters: SpaceStorageImportParameters
2087
+ }
2088
+ 'space/storage/import[by-id]': {
2089
+ name: 'Import URL to Space Storage'
2090
+ description: 'Import a file from a URL into space storage'
2091
+ parameters: SpaceStorageImportByIdParameters
2092
+ }
2093
+ 'space/storage/link': {
2094
+ name: 'Get Space Storage File Link'
2095
+ description: 'Get a public link (presigned URL) to access a file in space storage'
2096
+ parameters: SpaceStorageLinkParameters
2097
+ }
2098
+ 'space/storage/link[by-id]': {
2099
+ name: 'Get Space Storage File Link'
2100
+ description: 'Get a public link (presigned URL) to access a file in space storage'
2101
+ parameters: SpaceStorageLinkByIdParameters
2102
+ }
2103
+ 'space/storage/list': {
2104
+ name: 'List Space Storage Files'
2105
+ description: 'List all files in a specific space directory'
2106
+ parameters: SpaceStorageListParameters
2107
+ }
2108
+ 'space/storage/list[by-id]': {
2109
+ name: 'List Space Storage Files'
2110
+ description: 'List all files in a specific space directory'
2111
+ parameters: SpaceStorageListByIdParameters
2112
+ }
2113
+ 'space/storage/move': {
2114
+ name: 'Move Space Storage File'
2115
+ description: 'Move or rename a file in a specific space directory'
2116
+ parameters: SpaceStorageMoveParameters
2117
+ }
2118
+ 'space/storage/move[by-id]': {
2119
+ name: 'Move Space Storage File'
2120
+ description: 'Move or rename a file in a specific space directory'
2121
+ parameters: SpaceStorageMoveByIdParameters
2122
+ }
2123
+ 'space/storage/read': {
2124
+ name: 'Read Space Storage File'
2125
+ description: 'Read the content of a file in a specific space directory. Supports optional line range to read specific sections. For efficiency, prefer reading larger chunks rather than many small sequential reads.'
2126
+ parameters: SpaceStorageReadParameters
2127
+ }
2128
+ 'space/storage/read[by-id]': {
2129
+ name: 'Read Space Storage File'
2130
+ description: 'Read the content of a file in a specific space directory. Supports optional line range to read specific sections. For efficiency, prefer reading larger chunks rather than many small sequential reads.'
2131
+ parameters: SpaceStorageReadByIdParameters
2132
+ }
2133
+ 'space/storage/rw': {
2134
+ name: 'Read/Write Space Storage File'
2135
+ description: 'Read or write content to a file in the space storage. Use mode "read" to read file contents, or mode "write" to write content. For write mode, without line parameters overwrites the entire file, with startLine only inserts before that line, with startLine and endLine replaces that range.'
2136
+ parameters: SpaceStorageRwParameters
2137
+ }
2138
+ 'space/storage/rw[by-id]': {
2139
+ name: 'Read/Write Space Storage File'
2140
+ description: 'Read or write content to a file in a specific space. Use mode "read" to read file contents, or mode "write" to write content. For write mode, without line parameters overwrites the entire file, with startLine only inserts before that line, with startLine and endLine replaces that range.'
2141
+ parameters: SpaceStorageRwByIdParameters
2142
+ }
2143
+ 'space/storage/search': {
2144
+ name: 'Search Space Storage Files'
2145
+ description: 'Search files in a specific space directory using specific terms'
2146
+ parameters: SpaceStorageSearchParameters
2147
+ }
2148
+ 'space/storage/search[by-id]': {
2149
+ name: 'Search Space Storage Files'
2150
+ description: 'Search files in a specific space directory using specific terms'
2151
+ parameters: SpaceStorageSearchByIdParameters
2152
+ }
2153
+ 'space/storage/write': {
2154
+ name: 'Write Space Storage File'
2155
+ description: 'Write content to a file in a specific space directory. Without line parameters, overwrites the entire file. With startLine only, inserts before that line. With startLine and endLine, replaces that range.'
2156
+ parameters: SpaceStorageWriteParameters
2157
+ }
2158
+ 'space/storage/write[by-id]': {
2159
+ name: 'Write Space Storage File'
2160
+ description: 'Write content to a file in a specific space directory. Without line parameters, overwrites the entire file. With startLine only, inserts before that line. With startLine and endLine, replaces that range.'
2161
+ parameters: SpaceStorageWriteByIdParameters
2162
+ }
2163
+ 'space/update[by-id]': {
2164
+ name: 'Update Space'
2165
+ description: 'Update an existing space'
2166
+ parameters: SpaceUpdateByIdParameters
2167
+ }
2168
+ 'space/update[contact][by-id]': {
2169
+ name: 'Update Space'
2170
+ description: 'Update an existing space'
2171
+ parameters: SpaceUpdateContactByIdParameters
2172
+ }
2173
+ 'task/create': {
2174
+ name: 'Create Task'
2175
+ description: 'Create a task using details provided'
2176
+ parameters: TaskCreateParameters
2177
+ }
2178
+ 'task/create[contact]': {
2179
+ name: 'Create Task'
2180
+ description: 'Create a task using details provided'
2181
+ parameters: TaskCreateContactParameters
2182
+ }
2183
+ 'task/delete[by-id]': {
2184
+ name: 'Delete Task'
2185
+ description: 'Delete an existing task'
2186
+ parameters: TaskDeleteByIdParameters
2187
+ }
2188
+ 'task/delete[contact][by-id]': {
2189
+ name: 'Delete Task'
2190
+ description: 'Delete an existing task'
2191
+ parameters: TaskDeleteContactByIdParameters
2192
+ }
2193
+ 'task/fetch[by-id]': {
2194
+ name: 'Fetch Task'
2195
+ description: 'Fetch details of a specific task'
2196
+ parameters: TaskFetchByIdParameters
2197
+ }
2198
+ 'task/fetch[contact][by-id]': {
2199
+ name: 'Fetch Task'
2200
+ description: 'Fetch details of a specific task'
2201
+ parameters: TaskFetchContactByIdParameters
2202
+ }
2203
+ 'task/list': {
2204
+ name: 'List Tasks'
2205
+ description: 'List scheduled and one-time tasks'
2206
+ parameters: TaskListParameters
2207
+ }
2208
+ 'task/list[contact]': {
2209
+ name: 'List Tasks'
2210
+ description: 'List scheduled and one-time tasks'
2211
+ parameters: TaskListContactParameters
2212
+ }
2213
+ 'task/run[by-id]': {
2214
+ name: 'Run Task'
2215
+ description: 'Perform a single run of a task using the provided task ID'
2216
+ parameters: TaskRunByIdParameters
2217
+ }
2218
+ 'task/run[contact][by-id]': {
2219
+ name: 'Run Task'
2220
+ description: 'Perform a single run of a task using the provided task ID'
2221
+ parameters: TaskRunContactByIdParameters
2222
+ }
2223
+ 'task/update[by-id]': {
2224
+ name: 'Update Task'
2225
+ description: 'Update an existing task or to-do item'
2226
+ parameters: TaskUpdateByIdParameters
2227
+ }
2228
+ 'task/update[contact][by-id]': {
2229
+ name: 'Update Task'
2230
+ description: 'Update an existing task or to-do item'
2231
+ parameters: TaskUpdateContactByIdParameters
2232
+ }
2233
+ 'telegram/conversation/start[by-id]': {
2234
+ name: 'Start Telegram Conversation'
2235
+ description: 'Initiates a new conversation by sending a message to a Telegram chat.'
2236
+ parameters: TelegramConversationStartByIdParameters
2237
+ }
2238
+ 'text/article/generate': {
2239
+ name: 'Generate Article'
2240
+ description: 'Generate an article on the provided topic and source text'
2241
+ parameters: TextArticleGenerateParameters
2242
+ }
2243
+ 'text/email/generate': {
2244
+ name: 'Generate Email'
2245
+ description: 'Generate an email based on the provided source text'
2246
+ parameters: TextEmailGenerateParameters
2247
+ }
2248
+ 'text/generate': {
2249
+ name: 'Generate Text'
2250
+ description: 'Generate text based on the provided source text'
2251
+ parameters: TextGenerateParameters
2252
+ }
2253
+ 'text/summarize': {
2254
+ name: 'Summarize Text'
2255
+ description: 'Summarize the content of a text'
2256
+ parameters: TextSummarizeParameters
2257
+ }
2258
+ 'text/translate': {
2259
+ name: 'Translate Text'
2260
+ description: 'Translate text from one language to another'
2261
+ parameters: TextTranslateParameters
2262
+ }
2263
+ 'todo/manage': {
2264
+ name: 'Manage Todo List'
2265
+ description: 'Manage a structured todo list to track progress and plan tasks. Use read to retrieve the current list, write to replace it entirely.'
2266
+ parameters: TodoManageParameters
2267
+ }
2268
+ 'todo/read': {
2269
+ name: 'Read Todo List'
2270
+ description: 'Retrieve the current todo list'
2271
+ parameters: TodoReadParameters
2272
+ }
2273
+ 'todo/write': {
2274
+ name: 'Write Todo List'
2275
+ description: 'Replace the entire todo list with a new set of items. Always provide the complete list.'
2276
+ parameters: TodoWriteParameters
2277
+ }
2278
+ 'url/graphql': {
2279
+ name: 'Execute GraphQL Query'
2280
+ description: 'Execute a graphql query on a remote GraphQL endpoint'
2281
+ parameters: UrlGraphqlParameters
2282
+ }
2283
+ 'url/sql': {
2284
+ name: 'Execute File SQL Query'
2285
+ description: 'Execute SQL queries on structured data files (CSV, Excel, JSON) to filter, aggregate, and analyze data.'
2286
+ parameters: UrlSqlParameters
2287
+ }
2288
+ 'view/describe': {
2289
+ name: 'Describe Image'
2290
+ description: 'Describe the content of an image URL'
2291
+ parameters: ViewDescribeParameters
2292
+ }
2293
+ 'whatsapp/conversation/start[by-id]': {
2294
+ name: 'Start WhatsApp Conversation'
2295
+ description: 'Initiates a new conversation by sending a message to a WhatsApp user.'
2296
+ parameters: WhatsappConversationStartByIdParameters
2297
+ }
2298
+ }
2299
+
2300
+ // --- Helper Types ---
2301
+
2302
+ export type CbkAbilityParameters<T extends CbkAbilityName> = CbkAbilityRegistry[T]['parameters']