@realtimex/sdk 2.0.18 → 2.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts ADDED
@@ -0,0 +1,1448 @@
1
+ export type InvalidAPIKey = {
2
+ message?: string;
3
+ };
4
+
5
+ export type ChatRequest = {
6
+ messages?: Array<{
7
+ role?: string;
8
+ content?: string;
9
+ }>;
10
+ model?: string;
11
+ temperature?: number;
12
+ max_tokens?: number;
13
+ };
14
+
15
+ export type ApproveChannelPairingCodeParams = {
16
+ code: string;
17
+ };
18
+ export type ApproveChannelPairingCodeQuery = Record<string, never>;
19
+ export type ApproveChannelPairingCodeHeaders = {
20
+ "x-app-id"?: string;
21
+ };
22
+ export type ApproveChannelPairingCodeBody = unknown;
23
+ export type ApproveChannelPairingCodeResponse = Record<string, unknown>;
24
+ export interface ApproveChannelPairingCodeOptions extends RealtimeXRequestOptions {
25
+ params?: ApproveChannelPairingCodeParams;
26
+ query?: ApproveChannelPairingCodeQuery;
27
+ headers?: ApproveChannelPairingCodeHeaders & Record<string, string>;
28
+ body?: ApproveChannelPairingCodeBody;
29
+ }
30
+
31
+ export type ChatWithTerminalAgentParams = Record<string, never>;
32
+ export type ChatWithTerminalAgentQuery = Record<string, never>;
33
+ export type ChatWithTerminalAgentHeaders = Record<string, never>;
34
+ export type ChatWithTerminalAgentBody = {
35
+ workspaceName?: string;
36
+ threadName?: string;
37
+ agentName?: string;
38
+ agentSearch?: string;
39
+ modelName?: string;
40
+ skipModelSelection?: boolean;
41
+ messageText?: string;
42
+ messageConfirmation?: string;
43
+ workspaceTimeoutMs?: number;
44
+ threadTimeoutMs?: number;
45
+ actionTimeoutMs?: number;
46
+ actionDelayMs?: number;
47
+ recordVideo?: boolean;
48
+ videoPath?: string;
49
+ logProgress?: boolean;
50
+ tour?: boolean;
51
+ tourId?: string;
52
+ tourTts?: string;
53
+ tourLang?: string;
54
+ tourTtsVoice?: string;
55
+ tourSurface?: string;
56
+ tourTtsMaxWaitMs?: number;
57
+ timeoutMs?: number;
58
+ confirmDestructive?: boolean;
59
+ };
60
+ export type ChatWithTerminalAgentResponse = Record<string, unknown>;
61
+ export interface ChatWithTerminalAgentOptions extends RealtimeXRequestOptions {
62
+ params?: ChatWithTerminalAgentParams;
63
+ query?: ChatWithTerminalAgentQuery;
64
+ headers?: ChatWithTerminalAgentHeaders & Record<string, string>;
65
+ body?: ChatWithTerminalAgentBody;
66
+ }
67
+
68
+ export type ClearWorkspaceDefaultAgentParams = {
69
+ workspaceSlug: string;
70
+ };
71
+ export type ClearWorkspaceDefaultAgentQuery = Record<string, never>;
72
+ export type ClearWorkspaceDefaultAgentHeaders = {
73
+ authorization?: string;
74
+ "x-app-id"?: string;
75
+ };
76
+ export type ClearWorkspaceDefaultAgentBody = unknown;
77
+ export type ClearWorkspaceDefaultAgentResponse = Record<string, unknown>;
78
+ export interface ClearWorkspaceDefaultAgentOptions extends RealtimeXRequestOptions {
79
+ params?: ClearWorkspaceDefaultAgentParams;
80
+ query?: ClearWorkspaceDefaultAgentQuery;
81
+ headers?: ClearWorkspaceDefaultAgentHeaders & Record<string, string>;
82
+ body?: ClearWorkspaceDefaultAgentBody;
83
+ }
84
+
85
+ export type CreateChannelParams = {
86
+ workspaceSlug: string;
87
+ };
88
+ export type CreateChannelQuery = Record<string, never>;
89
+ export type CreateChannelHeaders = {
90
+ "x-app-id"?: string;
91
+ };
92
+ export type CreateChannelBody = {
93
+ name?: string;
94
+ plugin_type?: "telegram" | "discord" | "zalo";
95
+ channelType?: "telegram" | "discord" | "zalo";
96
+ type?: "telegram" | "discord" | "zalo";
97
+ botToken?: string;
98
+ thread_id?: number;
99
+ threadId?: number;
100
+ autoStart?: boolean;
101
+ autostart?: boolean;
102
+ start?: boolean;
103
+ enabled?: boolean;
104
+ config?: Record<string, unknown>;
105
+ settings?: Record<string, unknown>;
106
+ };
107
+ export type CreateChannelResponse = Record<string, unknown>;
108
+ export interface CreateChannelOptions extends RealtimeXRequestOptions {
109
+ params?: CreateChannelParams;
110
+ query?: CreateChannelQuery;
111
+ headers?: CreateChannelHeaders & Record<string, string>;
112
+ body?: CreateChannelBody;
113
+ }
114
+
115
+ export type CreateThreadParams = {
116
+ workspaceSlug: string;
117
+ };
118
+ export type CreateThreadQuery = Record<string, never>;
119
+ export type CreateThreadHeaders = {
120
+ "x-app-id"?: string;
121
+ };
122
+ export type CreateThreadBody = {
123
+ name?: string;
124
+ };
125
+ export type CreateThreadResponse = Record<string, unknown>;
126
+ export interface CreateThreadOptions extends RealtimeXRequestOptions {
127
+ params?: CreateThreadParams;
128
+ query?: CreateThreadQuery;
129
+ headers?: CreateThreadHeaders & Record<string, string>;
130
+ body?: CreateThreadBody;
131
+ }
132
+
133
+ export type CreateWorkspaceParams = Record<string, never>;
134
+ export type CreateWorkspaceQuery = Record<string, never>;
135
+ export type CreateWorkspaceHeaders = {
136
+ authorization?: string;
137
+ "x-app-id"?: string;
138
+ };
139
+ export type CreateWorkspaceBody = {
140
+ name: string;
141
+ };
142
+ export type CreateWorkspaceResponse = Record<string, unknown>;
143
+ export interface CreateWorkspaceOptions extends RealtimeXRequestOptions {
144
+ params?: CreateWorkspaceParams;
145
+ query?: CreateWorkspaceQuery;
146
+ headers?: CreateWorkspaceHeaders & Record<string, string>;
147
+ body?: CreateWorkspaceBody;
148
+ }
149
+
150
+ export type CreateWorkspaceAgentSkillParams = {
151
+ workspaceSlug: string;
152
+ };
153
+ export type CreateWorkspaceAgentSkillQuery = Record<string, never>;
154
+ export type CreateWorkspaceAgentSkillHeaders = {
155
+ "x-app-id"?: string;
156
+ };
157
+ export type CreateWorkspaceAgentSkillBody = {
158
+ displayName: string;
159
+ name?: string;
160
+ description?: string;
161
+ };
162
+ export type CreateWorkspaceAgentSkillResponse = Record<string, unknown>;
163
+ export interface CreateWorkspaceAgentSkillOptions extends RealtimeXRequestOptions {
164
+ params?: CreateWorkspaceAgentSkillParams;
165
+ query?: CreateWorkspaceAgentSkillQuery;
166
+ headers?: CreateWorkspaceAgentSkillHeaders & Record<string, string>;
167
+ body?: CreateWorkspaceAgentSkillBody;
168
+ }
169
+
170
+ export type DeleteChannelParams = {
171
+ channelId: string;
172
+ };
173
+ export type DeleteChannelQuery = Record<string, never>;
174
+ export type DeleteChannelHeaders = {
175
+ "x-app-id"?: string;
176
+ };
177
+ export type DeleteChannelBody = unknown;
178
+ export type DeleteChannelResponse = Record<string, unknown>;
179
+ export interface DeleteChannelOptions extends RealtimeXRequestOptions {
180
+ params?: DeleteChannelParams;
181
+ query?: DeleteChannelQuery;
182
+ headers?: DeleteChannelHeaders & Record<string, string>;
183
+ body?: DeleteChannelBody;
184
+ }
185
+
186
+ export type DeleteThreadParams = {
187
+ workspaceSlug: string;
188
+ threadSlug: string;
189
+ };
190
+ export type DeleteThreadQuery = Record<string, never>;
191
+ export type DeleteThreadHeaders = {
192
+ "x-app-id"?: string;
193
+ };
194
+ export type DeleteThreadBody = unknown;
195
+ export type DeleteThreadResponse = Record<string, unknown>;
196
+ export interface DeleteThreadOptions extends RealtimeXRequestOptions {
197
+ params?: DeleteThreadParams;
198
+ query?: DeleteThreadQuery;
199
+ headers?: DeleteThreadHeaders & Record<string, string>;
200
+ body?: DeleteThreadBody;
201
+ }
202
+
203
+ export type DeleteWorkspaceParams = {
204
+ workspaceSlug: string;
205
+ };
206
+ export type DeleteWorkspaceQuery = Record<string, never>;
207
+ export type DeleteWorkspaceHeaders = {
208
+ "x-app-id"?: string;
209
+ };
210
+ export type DeleteWorkspaceBody = unknown;
211
+ export type DeleteWorkspaceResponse = Record<string, unknown>;
212
+ export interface DeleteWorkspaceOptions extends RealtimeXRequestOptions {
213
+ params?: DeleteWorkspaceParams;
214
+ query?: DeleteWorkspaceQuery;
215
+ headers?: DeleteWorkspaceHeaders & Record<string, string>;
216
+ body?: DeleteWorkspaceBody;
217
+ }
218
+
219
+ export type DisablePluginParams = {
220
+ pluginId: string;
221
+ };
222
+ export type DisablePluginQuery = Record<string, never>;
223
+ export type DisablePluginHeaders = {
224
+ "x-app-id"?: string;
225
+ };
226
+ export type DisablePluginBody = unknown;
227
+ export type DisablePluginResponse = Record<string, unknown>;
228
+ export interface DisablePluginOptions extends RealtimeXRequestOptions {
229
+ params?: DisablePluginParams;
230
+ query?: DisablePluginQuery;
231
+ headers?: DisablePluginHeaders & Record<string, string>;
232
+ body?: DisablePluginBody;
233
+ }
234
+
235
+ export type DisableWorkspaceAgentSkillParams = {
236
+ workspaceSlug: string;
237
+ skillId: string;
238
+ };
239
+ export type DisableWorkspaceAgentSkillQuery = Record<string, never>;
240
+ export type DisableWorkspaceAgentSkillHeaders = {
241
+ authorization?: string;
242
+ "x-app-id"?: string;
243
+ };
244
+ export type DisableWorkspaceAgentSkillBody = unknown;
245
+ export type DisableWorkspaceAgentSkillResponse = Record<string, unknown>;
246
+ export interface DisableWorkspaceAgentSkillOptions extends RealtimeXRequestOptions {
247
+ params?: DisableWorkspaceAgentSkillParams;
248
+ query?: DisableWorkspaceAgentSkillQuery;
249
+ headers?: DisableWorkspaceAgentSkillHeaders & Record<string, string>;
250
+ body?: DisableWorkspaceAgentSkillBody;
251
+ }
252
+
253
+ export type EnablePluginParams = {
254
+ pluginId: string;
255
+ };
256
+ export type EnablePluginQuery = Record<string, never>;
257
+ export type EnablePluginHeaders = {
258
+ "x-app-id"?: string;
259
+ };
260
+ export type EnablePluginBody = unknown;
261
+ export type EnablePluginResponse = Record<string, unknown>;
262
+ export interface EnablePluginOptions extends RealtimeXRequestOptions {
263
+ params?: EnablePluginParams;
264
+ query?: EnablePluginQuery;
265
+ headers?: EnablePluginHeaders & Record<string, string>;
266
+ body?: EnablePluginBody;
267
+ }
268
+
269
+ export type EnableWorkspaceAgentSkillParams = {
270
+ workspaceSlug: string;
271
+ skillId: string;
272
+ };
273
+ export type EnableWorkspaceAgentSkillQuery = Record<string, never>;
274
+ export type EnableWorkspaceAgentSkillHeaders = {
275
+ authorization?: string;
276
+ "x-app-id"?: string;
277
+ };
278
+ export type EnableWorkspaceAgentSkillBody = unknown;
279
+ export type EnableWorkspaceAgentSkillResponse = Record<string, unknown>;
280
+ export interface EnableWorkspaceAgentSkillOptions extends RealtimeXRequestOptions {
281
+ params?: EnableWorkspaceAgentSkillParams;
282
+ query?: EnableWorkspaceAgentSkillQuery;
283
+ headers?: EnableWorkspaceAgentSkillHeaders & Record<string, string>;
284
+ body?: EnableWorkspaceAgentSkillBody;
285
+ }
286
+
287
+ export type GetArtifactParams = {
288
+ artifactId: string;
289
+ };
290
+ export type GetArtifactQuery = Record<string, never>;
291
+ export type GetArtifactHeaders = {
292
+ "x-app-id"?: string;
293
+ };
294
+ export type GetArtifactBody = unknown;
295
+ export type GetArtifactResponse = unknown;
296
+ export interface GetArtifactOptions extends RealtimeXRequestOptions {
297
+ params?: GetArtifactParams;
298
+ query?: GetArtifactQuery;
299
+ headers?: GetArtifactHeaders & Record<string, string>;
300
+ body?: GetArtifactBody;
301
+ }
302
+
303
+ export type GetThreadParams = {
304
+ workspaceSlug: string;
305
+ threadSlug: string;
306
+ };
307
+ export type GetThreadQuery = Record<string, never>;
308
+ export type GetThreadHeaders = {
309
+ "x-app-id"?: string;
310
+ };
311
+ export type GetThreadBody = unknown;
312
+ export type GetThreadResponse = Record<string, unknown>;
313
+ export interface GetThreadOptions extends RealtimeXRequestOptions {
314
+ params?: GetThreadParams;
315
+ query?: GetThreadQuery;
316
+ headers?: GetThreadHeaders & Record<string, string>;
317
+ body?: GetThreadBody;
318
+ }
319
+
320
+ export type GetWorkspaceParams = {
321
+ workspaceSlug: string;
322
+ };
323
+ export type GetWorkspaceQuery = Record<string, never>;
324
+ export type GetWorkspaceHeaders = {
325
+ "x-app-id"?: string;
326
+ };
327
+ export type GetWorkspaceBody = unknown;
328
+ export type GetWorkspaceResponse = Record<string, unknown>;
329
+ export interface GetWorkspaceOptions extends RealtimeXRequestOptions {
330
+ params?: GetWorkspaceParams;
331
+ query?: GetWorkspaceQuery;
332
+ headers?: GetWorkspaceHeaders & Record<string, string>;
333
+ body?: GetWorkspaceBody;
334
+ }
335
+
336
+ export type ListAgentSkillsParams = Record<string, never>;
337
+ export type ListAgentSkillsQuery = Record<string, never>;
338
+ export type ListAgentSkillsHeaders = {
339
+ "x-app-id"?: string;
340
+ };
341
+ export type ListAgentSkillsBody = unknown;
342
+ export type ListAgentSkillsResponse = Record<string, unknown>;
343
+ export interface ListAgentSkillsOptions extends RealtimeXRequestOptions {
344
+ params?: ListAgentSkillsParams;
345
+ query?: ListAgentSkillsQuery;
346
+ headers?: ListAgentSkillsHeaders & Record<string, string>;
347
+ body?: ListAgentSkillsBody;
348
+ }
349
+
350
+ export type ListArtifactsParams = {
351
+ workspaceSlug: string;
352
+ };
353
+ export type ListArtifactsQuery = Record<string, never>;
354
+ export type ListArtifactsHeaders = {
355
+ "x-app-id"?: string;
356
+ };
357
+ export type ListArtifactsBody = unknown;
358
+ export type ListArtifactsResponse = unknown;
359
+ export interface ListArtifactsOptions extends RealtimeXRequestOptions {
360
+ params?: ListArtifactsParams;
361
+ query?: ListArtifactsQuery;
362
+ headers?: ListArtifactsHeaders & Record<string, string>;
363
+ body?: ListArtifactsBody;
364
+ }
365
+
366
+ export type ListChannelsParams = Record<string, never>;
367
+ export type ListChannelsQuery = Record<string, never>;
368
+ export type ListChannelsHeaders = {
369
+ "x-app-id"?: string;
370
+ };
371
+ export type ListChannelsBody = unknown;
372
+ export type ListChannelsResponse = Record<string, unknown>;
373
+ export interface ListChannelsOptions extends RealtimeXRequestOptions {
374
+ params?: ListChannelsParams;
375
+ query?: ListChannelsQuery;
376
+ headers?: ListChannelsHeaders & Record<string, string>;
377
+ body?: ListChannelsBody;
378
+ }
379
+
380
+ export type ListLlmModelsParams = {
381
+ provider: string;
382
+ };
383
+ export type ListLlmModelsQuery = Record<string, never>;
384
+ export type ListLlmModelsHeaders = {
385
+ "x-app-id"?: string;
386
+ };
387
+ export type ListLlmModelsBody = unknown;
388
+ export type ListLlmModelsResponse = Record<string, unknown>;
389
+ export interface ListLlmModelsOptions extends RealtimeXRequestOptions {
390
+ params?: ListLlmModelsParams;
391
+ query?: ListLlmModelsQuery;
392
+ headers?: ListLlmModelsHeaders & Record<string, string>;
393
+ body?: ListLlmModelsBody;
394
+ }
395
+
396
+ export type ListLlmProvidersParams = Record<string, never>;
397
+ export type ListLlmProvidersQuery = Record<string, never>;
398
+ export type ListLlmProvidersHeaders = {
399
+ "x-app-id"?: string;
400
+ };
401
+ export type ListLlmProvidersBody = unknown;
402
+ export type ListLlmProvidersResponse = Record<string, unknown>;
403
+ export interface ListLlmProvidersOptions extends RealtimeXRequestOptions {
404
+ params?: ListLlmProvidersParams;
405
+ query?: ListLlmProvidersQuery;
406
+ headers?: ListLlmProvidersHeaders & Record<string, string>;
407
+ body?: ListLlmProvidersBody;
408
+ }
409
+
410
+ export type ListPluginsParams = Record<string, never>;
411
+ export type ListPluginsQuery = Record<string, never>;
412
+ export type ListPluginsHeaders = {
413
+ "x-app-id"?: string;
414
+ };
415
+ export type ListPluginsBody = unknown;
416
+ export type ListPluginsResponse = Record<string, unknown>;
417
+ export interface ListPluginsOptions extends RealtimeXRequestOptions {
418
+ params?: ListPluginsParams;
419
+ query?: ListPluginsQuery;
420
+ headers?: ListPluginsHeaders & Record<string, string>;
421
+ body?: ListPluginsBody;
422
+ }
423
+
424
+ export type ListTerminalAgentsParams = Record<string, never>;
425
+ export type ListTerminalAgentsQuery = Record<string, never>;
426
+ export type ListTerminalAgentsHeaders = {
427
+ "x-app-id"?: string;
428
+ };
429
+ export type ListTerminalAgentsBody = unknown;
430
+ export type ListTerminalAgentsResponse = unknown;
431
+ export interface ListTerminalAgentsOptions extends RealtimeXRequestOptions {
432
+ params?: ListTerminalAgentsParams;
433
+ query?: ListTerminalAgentsQuery;
434
+ headers?: ListTerminalAgentsHeaders & Record<string, string>;
435
+ body?: ListTerminalAgentsBody;
436
+ }
437
+
438
+ export type ListTerminalSessionsParams = Record<string, never>;
439
+ export type ListTerminalSessionsQuery = {
440
+ workspaceSlug?: string;
441
+ threadSlug?: string;
442
+ includeClosed?: boolean;
443
+ limit?: number;
444
+ };
445
+ export type ListTerminalSessionsHeaders = {
446
+ "x-app-id"?: string;
447
+ };
448
+ export type ListTerminalSessionsBody = unknown;
449
+ export type ListTerminalSessionsResponse = unknown;
450
+ export interface ListTerminalSessionsOptions extends RealtimeXRequestOptions {
451
+ params?: ListTerminalSessionsParams;
452
+ query?: ListTerminalSessionsQuery;
453
+ headers?: ListTerminalSessionsHeaders & Record<string, string>;
454
+ body?: ListTerminalSessionsBody;
455
+ }
456
+
457
+ export type ListThreadsParams = {
458
+ workspaceSlug: string;
459
+ };
460
+ export type ListThreadsQuery = Record<string, never>;
461
+ export type ListThreadsHeaders = {
462
+ "x-app-id"?: string;
463
+ };
464
+ export type ListThreadsBody = unknown;
465
+ export type ListThreadsResponse = unknown;
466
+ export interface ListThreadsOptions extends RealtimeXRequestOptions {
467
+ params?: ListThreadsParams;
468
+ query?: ListThreadsQuery;
469
+ headers?: ListThreadsHeaders & Record<string, string>;
470
+ body?: ListThreadsBody;
471
+ }
472
+
473
+ export type ListWorkspaceAgentSkillsParams = {
474
+ workspaceSlug: string;
475
+ };
476
+ export type ListWorkspaceAgentSkillsQuery = Record<string, never>;
477
+ export type ListWorkspaceAgentSkillsHeaders = {
478
+ authorization?: string;
479
+ "x-app-id"?: string;
480
+ };
481
+ export type ListWorkspaceAgentSkillsBody = unknown;
482
+ export type ListWorkspaceAgentSkillsResponse = Record<string, unknown>;
483
+ export interface ListWorkspaceAgentSkillsOptions extends RealtimeXRequestOptions {
484
+ params?: ListWorkspaceAgentSkillsParams;
485
+ query?: ListWorkspaceAgentSkillsQuery;
486
+ headers?: ListWorkspaceAgentSkillsHeaders & Record<string, string>;
487
+ body?: ListWorkspaceAgentSkillsBody;
488
+ }
489
+
490
+ export type ListWorkspacesParams = Record<string, never>;
491
+ export type ListWorkspacesQuery = Record<string, never>;
492
+ export type ListWorkspacesHeaders = {
493
+ "x-app-id"?: string;
494
+ };
495
+ export type ListWorkspacesBody = unknown;
496
+ export type ListWorkspacesResponse = unknown;
497
+ export interface ListWorkspacesOptions extends RealtimeXRequestOptions {
498
+ params?: ListWorkspacesParams;
499
+ query?: ListWorkspacesQuery;
500
+ headers?: ListWorkspacesHeaders & Record<string, string>;
501
+ body?: ListWorkspacesBody;
502
+ }
503
+
504
+ export type OpenTerminalSessionParams = Record<string, never>;
505
+ export type OpenTerminalSessionQuery = Record<string, never>;
506
+ export type OpenTerminalSessionHeaders = {
507
+ "x-app-id"?: string;
508
+ };
509
+ export type OpenTerminalSessionBody = {
510
+ agentName: string;
511
+ workspaceSlug?: string;
512
+ threadSlug?: string;
513
+ providerId?: string;
514
+ modelId?: string;
515
+ message?: string;
516
+ firstTurnDelivery?: "queued" | "launch-args";
517
+ requestedBy?: string;
518
+ };
519
+ export type OpenTerminalSessionResponse = Record<string, unknown>;
520
+ export interface OpenTerminalSessionOptions extends RealtimeXRequestOptions {
521
+ params?: OpenTerminalSessionParams;
522
+ query?: OpenTerminalSessionQuery;
523
+ headers?: OpenTerminalSessionHeaders & Record<string, string>;
524
+ body?: OpenTerminalSessionBody;
525
+ }
526
+
527
+ export type PauseArtifactParams = {
528
+ artifactId: string;
529
+ };
530
+ export type PauseArtifactQuery = Record<string, never>;
531
+ export type PauseArtifactHeaders = {
532
+ "x-app-id"?: string;
533
+ };
534
+ export type PauseArtifactBody = unknown;
535
+ export type PauseArtifactResponse = unknown;
536
+ export interface PauseArtifactOptions extends RealtimeXRequestOptions {
537
+ params?: PauseArtifactParams;
538
+ query?: PauseArtifactQuery;
539
+ headers?: PauseArtifactHeaders & Record<string, string>;
540
+ body?: PauseArtifactBody;
541
+ }
542
+
543
+ export type PrepareParams = Record<string, never>;
544
+ export type PrepareQuery = {
545
+ workspaceSlug?: string;
546
+ threadSlug?: string;
547
+ };
548
+ export type PrepareHeaders = {
549
+ "x-app-id"?: string;
550
+ };
551
+ export type PrepareBody = unknown;
552
+ export type PrepareResponse = {
553
+ currentWorkspace?: {
554
+ id?: number;
555
+ slug?: string;
556
+ name?: string;
557
+ missing?: boolean;
558
+ };
559
+ currentThread?: {
560
+ id?: number;
561
+ slug?: string;
562
+ name?: string;
563
+ workspaceId?: number;
564
+ workspaceSlug?: string;
565
+ missing?: boolean;
566
+ };
567
+ workspaces?: Array<{
568
+ id?: number;
569
+ slug?: string;
570
+ name?: string;
571
+ }>;
572
+ threads?: Array<{
573
+ id?: number;
574
+ slug?: string;
575
+ name?: string;
576
+ workspaceId?: number;
577
+ workspaceSlug?: string;
578
+ }>;
579
+ providers?: Array<unknown>;
580
+ models?: Array<unknown>;
581
+ agents?: Array<unknown>;
582
+ };
583
+ export interface PrepareOptions extends RealtimeXRequestOptions {
584
+ params?: PrepareParams;
585
+ query?: PrepareQuery;
586
+ headers?: PrepareHeaders & Record<string, string>;
587
+ body?: PrepareBody;
588
+ }
589
+
590
+ export type PromoteWorkspaceAgentSkillParams = {
591
+ workspaceSlug: string;
592
+ skillId: string;
593
+ };
594
+ export type PromoteWorkspaceAgentSkillQuery = Record<string, never>;
595
+ export type PromoteWorkspaceAgentSkillHeaders = {
596
+ "x-app-id"?: string;
597
+ };
598
+ export type PromoteWorkspaceAgentSkillBody = {
599
+ displayName?: string;
600
+ name?: string;
601
+ description?: string;
602
+ };
603
+ export type PromoteWorkspaceAgentSkillResponse = Record<string, unknown>;
604
+ export interface PromoteWorkspaceAgentSkillOptions extends RealtimeXRequestOptions {
605
+ params?: PromoteWorkspaceAgentSkillParams;
606
+ query?: PromoteWorkspaceAgentSkillQuery;
607
+ headers?: PromoteWorkspaceAgentSkillHeaders & Record<string, string>;
608
+ body?: PromoteWorkspaceAgentSkillBody;
609
+ }
610
+
611
+ export type PublishArtifactParams = {
612
+ workspaceSlug: string;
613
+ };
614
+ export type PublishArtifactQuery = Record<string, never>;
615
+ export type PublishArtifactHeaders = {
616
+ "x-app-id"?: string;
617
+ };
618
+ export type PublishArtifactBody = {
619
+ artifactPath: string;
620
+ entryFile?: string;
621
+ expiresAt?: string;
622
+ };
623
+ export type PublishArtifactResponse = unknown;
624
+ export interface PublishArtifactOptions extends RealtimeXRequestOptions {
625
+ params?: PublishArtifactParams;
626
+ query?: PublishArtifactQuery;
627
+ headers?: PublishArtifactHeaders & Record<string, string>;
628
+ body?: PublishArtifactBody;
629
+ }
630
+
631
+ export type ReloadAgentSkillsParams = Record<string, never>;
632
+ export type ReloadAgentSkillsQuery = Record<string, never>;
633
+ export type ReloadAgentSkillsHeaders = {
634
+ "x-app-id"?: string;
635
+ };
636
+ export type ReloadAgentSkillsBody = {
637
+ workspaceSlug?: string;
638
+ };
639
+ export type ReloadAgentSkillsResponse = Record<string, unknown>;
640
+ export interface ReloadAgentSkillsOptions extends RealtimeXRequestOptions {
641
+ params?: ReloadAgentSkillsParams;
642
+ query?: ReloadAgentSkillsQuery;
643
+ headers?: ReloadAgentSkillsHeaders & Record<string, string>;
644
+ body?: ReloadAgentSkillsBody;
645
+ }
646
+
647
+ export type ReloadPluginParams = {
648
+ pluginId: string;
649
+ };
650
+ export type ReloadPluginQuery = Record<string, never>;
651
+ export type ReloadPluginHeaders = {
652
+ "x-app-id"?: string;
653
+ };
654
+ export type ReloadPluginBody = unknown;
655
+ export type ReloadPluginResponse = Record<string, unknown>;
656
+ export interface ReloadPluginOptions extends RealtimeXRequestOptions {
657
+ params?: ReloadPluginParams;
658
+ query?: ReloadPluginQuery;
659
+ headers?: ReloadPluginHeaders & Record<string, string>;
660
+ body?: ReloadPluginBody;
661
+ }
662
+
663
+ export type RenameThreadParams = {
664
+ workspaceSlug: string;
665
+ threadSlug: string;
666
+ };
667
+ export type RenameThreadQuery = Record<string, never>;
668
+ export type RenameThreadHeaders = {
669
+ "x-app-id"?: string;
670
+ };
671
+ export type RenameThreadBody = {
672
+ name: string;
673
+ };
674
+ export type RenameThreadResponse = Record<string, unknown>;
675
+ export interface RenameThreadOptions extends RealtimeXRequestOptions {
676
+ params?: RenameThreadParams;
677
+ query?: RenameThreadQuery;
678
+ headers?: RenameThreadHeaders & Record<string, string>;
679
+ body?: RenameThreadBody;
680
+ }
681
+
682
+ export type RenameWorkspaceParams = {
683
+ workspaceSlug: string;
684
+ };
685
+ export type RenameWorkspaceQuery = Record<string, never>;
686
+ export type RenameWorkspaceHeaders = {
687
+ "x-app-id"?: string;
688
+ };
689
+ export type RenameWorkspaceBody = {
690
+ name: string;
691
+ };
692
+ export type RenameWorkspaceResponse = Record<string, unknown>;
693
+ export interface RenameWorkspaceOptions extends RealtimeXRequestOptions {
694
+ params?: RenameWorkspaceParams;
695
+ query?: RenameWorkspaceQuery;
696
+ headers?: RenameWorkspaceHeaders & Record<string, string>;
697
+ body?: RenameWorkspaceBody;
698
+ }
699
+
700
+ export type ResumeArtifactParams = {
701
+ artifactId: string;
702
+ };
703
+ export type ResumeArtifactQuery = Record<string, never>;
704
+ export type ResumeArtifactHeaders = {
705
+ "x-app-id"?: string;
706
+ };
707
+ export type ResumeArtifactBody = unknown;
708
+ export type ResumeArtifactResponse = unknown;
709
+ export interface ResumeArtifactOptions extends RealtimeXRequestOptions {
710
+ params?: ResumeArtifactParams;
711
+ query?: ResumeArtifactQuery;
712
+ headers?: ResumeArtifactHeaders & Record<string, string>;
713
+ body?: ResumeArtifactBody;
714
+ }
715
+
716
+ export type ResumeLatestTerminalSessionParams = Record<string, never>;
717
+ export type ResumeLatestTerminalSessionQuery = Record<string, never>;
718
+ export type ResumeLatestTerminalSessionHeaders = {
719
+ "x-app-id"?: string;
720
+ };
721
+ export type ResumeLatestTerminalSessionBody = {
722
+ workspaceSlug: string;
723
+ threadSlug: string;
724
+ requestedBy?: string;
725
+ };
726
+ export type ResumeLatestTerminalSessionResponse = Record<string, unknown>;
727
+ export interface ResumeLatestTerminalSessionOptions extends RealtimeXRequestOptions {
728
+ params?: ResumeLatestTerminalSessionParams;
729
+ query?: ResumeLatestTerminalSessionQuery;
730
+ headers?: ResumeLatestTerminalSessionHeaders & Record<string, string>;
731
+ body?: ResumeLatestTerminalSessionBody;
732
+ }
733
+
734
+ export type ResumeTerminalSessionParams = {
735
+ sessionId: string;
736
+ };
737
+ export type ResumeTerminalSessionQuery = Record<string, never>;
738
+ export type ResumeTerminalSessionHeaders = {
739
+ "x-app-id"?: string;
740
+ };
741
+ export type ResumeTerminalSessionBody = {
742
+ workspaceSlug?: string;
743
+ threadSlug?: string;
744
+ requestedBy?: string;
745
+ };
746
+ export type ResumeTerminalSessionResponse = Record<string, unknown>;
747
+ export interface ResumeTerminalSessionOptions extends RealtimeXRequestOptions {
748
+ params?: ResumeTerminalSessionParams;
749
+ query?: ResumeTerminalSessionQuery;
750
+ headers?: ResumeTerminalSessionHeaders & Record<string, string>;
751
+ body?: ResumeTerminalSessionBody;
752
+ }
753
+
754
+ export type RevokeArtifactParams = {
755
+ artifactId: string;
756
+ };
757
+ export type RevokeArtifactQuery = Record<string, never>;
758
+ export type RevokeArtifactHeaders = {
759
+ "x-app-id"?: string;
760
+ };
761
+ export type RevokeArtifactBody = unknown;
762
+ export type RevokeArtifactResponse = unknown;
763
+ export interface RevokeArtifactOptions extends RealtimeXRequestOptions {
764
+ params?: RevokeArtifactParams;
765
+ query?: RevokeArtifactQuery;
766
+ headers?: RevokeArtifactHeaders & Record<string, string>;
767
+ body?: RevokeArtifactBody;
768
+ }
769
+
770
+ export type RunAutomationFlowParams = {
771
+ command: string;
772
+ };
773
+ export type RunAutomationFlowQuery = Record<string, never>;
774
+ export type RunAutomationFlowHeaders = {
775
+ "x-app-id"?: string;
776
+ };
777
+ export type RunAutomationFlowBody = {
778
+ options?: Record<string, unknown>;
779
+ timeoutMs?: number;
780
+ confirmDestructive?: boolean;
781
+ };
782
+ export type RunAutomationFlowResponse = Record<string, unknown>;
783
+ export interface RunAutomationFlowOptions extends RealtimeXRequestOptions {
784
+ params?: RunAutomationFlowParams;
785
+ query?: RunAutomationFlowQuery;
786
+ headers?: RunAutomationFlowHeaders & Record<string, string>;
787
+ body?: RunAutomationFlowBody;
788
+ }
789
+
790
+ export type RunAutomationWorkflowParams = Record<string, never>;
791
+ export type RunAutomationWorkflowQuery = Record<string, never>;
792
+ export type RunAutomationWorkflowHeaders = {
793
+ "x-app-id"?: string;
794
+ };
795
+ export type RunAutomationWorkflowBody = {
796
+ workflowName: string;
797
+ optionsJson?: string;
798
+ timeoutMs?: number;
799
+ confirmDestructive?: boolean;
800
+ };
801
+ export type RunAutomationWorkflowResponse = Record<string, unknown>;
802
+ export interface RunAutomationWorkflowOptions extends RealtimeXRequestOptions {
803
+ params?: RunAutomationWorkflowParams;
804
+ query?: RunAutomationWorkflowQuery;
805
+ headers?: RunAutomationWorkflowHeaders & Record<string, string>;
806
+ body?: RunAutomationWorkflowBody;
807
+ }
808
+
809
+ export type SendChannelFileParams = Record<string, never>;
810
+ export type SendChannelFileQuery = Record<string, never>;
811
+ export type SendChannelFileHeaders = {
812
+ "x-app-id"?: string;
813
+ };
814
+ export type SendChannelFileBody = {
815
+ context: string;
816
+ filePath?: string;
817
+ fileName?: string;
818
+ runtimeSessionId?: string;
819
+ mime?: string;
820
+ contentBase64?: string;
821
+ caption?: string;
822
+ };
823
+ export type SendChannelFileResponse = Record<string, unknown>;
824
+ export interface SendChannelFileOptions extends RealtimeXRequestOptions {
825
+ params?: SendChannelFileParams;
826
+ query?: SendChannelFileQuery;
827
+ headers?: SendChannelFileHeaders & Record<string, string>;
828
+ body?: SendChannelFileBody;
829
+ }
830
+
831
+ export type SendMessageParams = {
832
+ workspaceSlug: string;
833
+ threadSlug: string;
834
+ };
835
+ export type SendMessageQuery = Record<string, never>;
836
+ export type SendMessageHeaders = {
837
+ "x-app-id"?: string;
838
+ };
839
+ export type SendMessageBody = {
840
+ message: string;
841
+ attachments?: Array<Record<string, unknown>>;
842
+ webSearchEnabled?: boolean;
843
+ broadcastThreadEvents?: boolean;
844
+ stripAgentPrefixForDelivery?: boolean;
845
+ channelTurnId?: string;
846
+ };
847
+ export type SendMessageResponse = Record<string, unknown>;
848
+ export interface SendMessageOptions extends RealtimeXRequestOptions {
849
+ params?: SendMessageParams;
850
+ query?: SendMessageQuery;
851
+ headers?: SendMessageHeaders & Record<string, string>;
852
+ body?: SendMessageBody;
853
+ }
854
+
855
+ export type SetDefaultWorkspaceAgentParams = Record<string, never>;
856
+ export type SetDefaultWorkspaceAgentQuery = Record<string, never>;
857
+ export type SetDefaultWorkspaceAgentHeaders = Record<string, never>;
858
+ export type SetDefaultWorkspaceAgentBody = {
859
+ workspaceName?: string;
860
+ agentName?: string;
861
+ modelName?: string;
862
+ skipModelSelection?: boolean;
863
+ actionTimeoutMs?: number;
864
+ actionDelayMs?: number;
865
+ tour?: boolean;
866
+ tourId?: string;
867
+ tourTts?: string;
868
+ tourLang?: string;
869
+ tourTtsVoice?: string;
870
+ tourSurface?: string;
871
+ tourTtsMaxWaitMs?: number;
872
+ logProgress?: boolean;
873
+ timeoutMs?: number;
874
+ confirmDestructive?: boolean;
875
+ };
876
+ export type SetDefaultWorkspaceAgentResponse = Record<string, unknown>;
877
+ export interface SetDefaultWorkspaceAgentOptions extends RealtimeXRequestOptions {
878
+ params?: SetDefaultWorkspaceAgentParams;
879
+ query?: SetDefaultWorkspaceAgentQuery;
880
+ headers?: SetDefaultWorkspaceAgentHeaders & Record<string, string>;
881
+ body?: SetDefaultWorkspaceAgentBody;
882
+ }
883
+
884
+ export type SetHeartbeatActiveHoursParams = Record<string, never>;
885
+ export type SetHeartbeatActiveHoursQuery = Record<string, never>;
886
+ export type SetHeartbeatActiveHoursHeaders = {
887
+ "x-app-id"?: string;
888
+ };
889
+ export type SetHeartbeatActiveHoursBody = {
890
+ scope: "workspace" | "global" | "ambient";
891
+ workspaceSlug?: string;
892
+ start: string;
893
+ end: string;
894
+ };
895
+ export type SetHeartbeatActiveHoursResponse = Record<string, unknown>;
896
+ export interface SetHeartbeatActiveHoursOptions extends RealtimeXRequestOptions {
897
+ params?: SetHeartbeatActiveHoursParams;
898
+ query?: SetHeartbeatActiveHoursQuery;
899
+ headers?: SetHeartbeatActiveHoursHeaders & Record<string, string>;
900
+ body?: SetHeartbeatActiveHoursBody;
901
+ }
902
+
903
+ export type SetHeartbeatAutoPilotParams = Record<string, never>;
904
+ export type SetHeartbeatAutoPilotQuery = Record<string, never>;
905
+ export type SetHeartbeatAutoPilotHeaders = {
906
+ "x-app-id"?: string;
907
+ };
908
+ export type SetHeartbeatAutoPilotBody = {
909
+ scope: "workspace" | "global" | "ambient";
910
+ workspaceSlug?: string;
911
+ enabled: boolean;
912
+ };
913
+ export type SetHeartbeatAutoPilotResponse = Record<string, unknown>;
914
+ export interface SetHeartbeatAutoPilotOptions extends RealtimeXRequestOptions {
915
+ params?: SetHeartbeatAutoPilotParams;
916
+ query?: SetHeartbeatAutoPilotQuery;
917
+ headers?: SetHeartbeatAutoPilotHeaders & Record<string, string>;
918
+ body?: SetHeartbeatAutoPilotBody;
919
+ }
920
+
921
+ export type SetHeartbeatDefaultAgentParams = Record<string, never>;
922
+ export type SetHeartbeatDefaultAgentQuery = Record<string, never>;
923
+ export type SetHeartbeatDefaultAgentHeaders = {
924
+ "x-app-id"?: string;
925
+ };
926
+ export type SetHeartbeatDefaultAgentBody = {
927
+ scope: "workspace" | "global" | "ambient";
928
+ workspaceSlug?: string;
929
+ canonical: string;
930
+ providerId?: string;
931
+ modelId?: string;
932
+ reasoning_effort?: string;
933
+ };
934
+ export type SetHeartbeatDefaultAgentResponse = Record<string, unknown>;
935
+ export interface SetHeartbeatDefaultAgentOptions extends RealtimeXRequestOptions {
936
+ params?: SetHeartbeatDefaultAgentParams;
937
+ query?: SetHeartbeatDefaultAgentQuery;
938
+ headers?: SetHeartbeatDefaultAgentHeaders & Record<string, string>;
939
+ body?: SetHeartbeatDefaultAgentBody;
940
+ }
941
+
942
+ export type SetHeartbeatEnabledParams = Record<string, never>;
943
+ export type SetHeartbeatEnabledQuery = Record<string, never>;
944
+ export type SetHeartbeatEnabledHeaders = {
945
+ "x-app-id"?: string;
946
+ };
947
+ export type SetHeartbeatEnabledBody = {
948
+ scope: "workspace" | "global" | "ambient";
949
+ workspaceSlug?: string;
950
+ enabled: boolean;
951
+ };
952
+ export type SetHeartbeatEnabledResponse = Record<string, unknown>;
953
+ export interface SetHeartbeatEnabledOptions extends RealtimeXRequestOptions {
954
+ params?: SetHeartbeatEnabledParams;
955
+ query?: SetHeartbeatEnabledQuery;
956
+ headers?: SetHeartbeatEnabledHeaders & Record<string, string>;
957
+ body?: SetHeartbeatEnabledBody;
958
+ }
959
+
960
+ export type SetHeartbeatIntervalParams = Record<string, never>;
961
+ export type SetHeartbeatIntervalQuery = Record<string, never>;
962
+ export type SetHeartbeatIntervalHeaders = {
963
+ "x-app-id"?: string;
964
+ };
965
+ export type SetHeartbeatIntervalBody = {
966
+ scope: "workspace" | "global" | "ambient";
967
+ workspaceSlug?: string;
968
+ interval: string;
969
+ };
970
+ export type SetHeartbeatIntervalResponse = Record<string, unknown>;
971
+ export interface SetHeartbeatIntervalOptions extends RealtimeXRequestOptions {
972
+ params?: SetHeartbeatIntervalParams;
973
+ query?: SetHeartbeatIntervalQuery;
974
+ headers?: SetHeartbeatIntervalHeaders & Record<string, string>;
975
+ body?: SetHeartbeatIntervalBody;
976
+ }
977
+
978
+ export type SetHeartbeatTimezoneParams = Record<string, never>;
979
+ export type SetHeartbeatTimezoneQuery = Record<string, never>;
980
+ export type SetHeartbeatTimezoneHeaders = {
981
+ "x-app-id"?: string;
982
+ };
983
+ export type SetHeartbeatTimezoneBody = {
984
+ scope: "workspace" | "global" | "ambient";
985
+ workspaceSlug?: string;
986
+ timezone: string;
987
+ };
988
+ export type SetHeartbeatTimezoneResponse = Record<string, unknown>;
989
+ export interface SetHeartbeatTimezoneOptions extends RealtimeXRequestOptions {
990
+ params?: SetHeartbeatTimezoneParams;
991
+ query?: SetHeartbeatTimezoneQuery;
992
+ headers?: SetHeartbeatTimezoneHeaders & Record<string, string>;
993
+ body?: SetHeartbeatTimezoneBody;
994
+ }
995
+
996
+ export type SetupHeartbeatTasksParams = Record<string, never>;
997
+ export type SetupHeartbeatTasksQuery = {
998
+ workspaceSlug?: string;
999
+ scope: string;
1000
+ };
1001
+ export type SetupHeartbeatTasksHeaders = {
1002
+ "x-app-id"?: string;
1003
+ };
1004
+ export type SetupHeartbeatTasksBody = unknown;
1005
+ export type SetupHeartbeatTasksResponse = {
1006
+ path?: string;
1007
+ template?: string;
1008
+ files?: {
1009
+ heartbeat?: string;
1010
+ };
1011
+ instructions?: Array<string>;
1012
+ };
1013
+ export interface SetupHeartbeatTasksOptions extends RealtimeXRequestOptions {
1014
+ params?: SetupHeartbeatTasksParams;
1015
+ query?: SetupHeartbeatTasksQuery;
1016
+ headers?: SetupHeartbeatTasksHeaders & Record<string, string>;
1017
+ body?: SetupHeartbeatTasksBody;
1018
+ }
1019
+
1020
+ export type SetupPersonalityParams = Record<string, never>;
1021
+ export type SetupPersonalityQuery = {
1022
+ workspaceSlug?: string;
1023
+ scope: string;
1024
+ };
1025
+ export type SetupPersonalityHeaders = {
1026
+ "x-app-id"?: string;
1027
+ };
1028
+ export type SetupPersonalityBody = unknown;
1029
+ export type SetupPersonalityResponse = {
1030
+ path?: string;
1031
+ template?: string;
1032
+ files?: {
1033
+ agents?: string;
1034
+ claude?: string;
1035
+ suggestedChildren?: Array<string>;
1036
+ };
1037
+ instructions?: Array<string>;
1038
+ };
1039
+ export interface SetupPersonalityOptions extends RealtimeXRequestOptions {
1040
+ params?: SetupPersonalityParams;
1041
+ query?: SetupPersonalityQuery;
1042
+ headers?: SetupPersonalityHeaders & Record<string, string>;
1043
+ body?: SetupPersonalityBody;
1044
+ }
1045
+
1046
+ export type SetupWorkingDirParams = Record<string, never>;
1047
+ export type SetupWorkingDirQuery = Record<string, never>;
1048
+ export type SetupWorkingDirHeaders = Record<string, never>;
1049
+ export type SetupWorkingDirBody = {
1050
+ path?: string;
1051
+ description?: string;
1052
+ workspaces?: string;
1053
+ agents?: string;
1054
+ mode?: string;
1055
+ resetScopesToAll?: boolean;
1056
+ actionTimeoutMs?: number;
1057
+ actionDelayMs?: number;
1058
+ tour?: boolean;
1059
+ tourId?: string;
1060
+ tourTts?: string;
1061
+ tourLang?: string;
1062
+ tourTtsVoice?: string;
1063
+ tourSurface?: string;
1064
+ tourTtsMaxWaitMs?: number;
1065
+ logProgress?: boolean;
1066
+ timeoutMs?: number;
1067
+ confirmDestructive?: boolean;
1068
+ };
1069
+ export type SetupWorkingDirResponse = Record<string, unknown>;
1070
+ export interface SetupWorkingDirOptions extends RealtimeXRequestOptions {
1071
+ params?: SetupWorkingDirParams;
1072
+ query?: SetupWorkingDirQuery;
1073
+ headers?: SetupWorkingDirHeaders & Record<string, string>;
1074
+ body?: SetupWorkingDirBody;
1075
+ }
1076
+
1077
+ export type SetWorkspaceDefaultAgentParams = {
1078
+ workspaceSlug: string;
1079
+ };
1080
+ export type SetWorkspaceDefaultAgentQuery = Record<string, never>;
1081
+ export type SetWorkspaceDefaultAgentHeaders = {
1082
+ authorization?: string;
1083
+ "x-app-id"?: string;
1084
+ };
1085
+ export type SetWorkspaceDefaultAgentBody = {
1086
+ canonical: string;
1087
+ providerId?: string;
1088
+ modelId?: string;
1089
+ reasoning_effort?: string;
1090
+ };
1091
+ export type SetWorkspaceDefaultAgentResponse = Record<string, unknown>;
1092
+ export interface SetWorkspaceDefaultAgentOptions extends RealtimeXRequestOptions {
1093
+ params?: SetWorkspaceDefaultAgentParams;
1094
+ query?: SetWorkspaceDefaultAgentQuery;
1095
+ headers?: SetWorkspaceDefaultAgentHeaders & Record<string, string>;
1096
+ body?: SetWorkspaceDefaultAgentBody;
1097
+ }
1098
+
1099
+ export type StartChannelParams = {
1100
+ channelId: string;
1101
+ };
1102
+ export type StartChannelQuery = Record<string, never>;
1103
+ export type StartChannelHeaders = {
1104
+ "x-app-id"?: string;
1105
+ };
1106
+ export type StartChannelBody = unknown;
1107
+ export type StartChannelResponse = Record<string, unknown>;
1108
+ export interface StartChannelOptions extends RealtimeXRequestOptions {
1109
+ params?: StartChannelParams;
1110
+ query?: StartChannelQuery;
1111
+ headers?: StartChannelHeaders & Record<string, string>;
1112
+ body?: StartChannelBody;
1113
+ }
1114
+
1115
+ export type StopChannelParams = {
1116
+ channelId: string;
1117
+ };
1118
+ export type StopChannelQuery = Record<string, never>;
1119
+ export type StopChannelHeaders = {
1120
+ "x-app-id"?: string;
1121
+ };
1122
+ export type StopChannelBody = unknown;
1123
+ export type StopChannelResponse = Record<string, unknown>;
1124
+ export interface StopChannelOptions extends RealtimeXRequestOptions {
1125
+ params?: StopChannelParams;
1126
+ query?: StopChannelQuery;
1127
+ headers?: StopChannelHeaders & Record<string, string>;
1128
+ body?: StopChannelBody;
1129
+ }
1130
+
1131
+ export type StopThreadTerminalSessionParams = Record<string, never>;
1132
+ export type StopThreadTerminalSessionQuery = Record<string, never>;
1133
+ export type StopThreadTerminalSessionHeaders = {
1134
+ "x-app-id"?: string;
1135
+ };
1136
+ export type StopThreadTerminalSessionBody = unknown;
1137
+ export type StopThreadTerminalSessionResponse = Record<string, unknown>;
1138
+ export interface StopThreadTerminalSessionOptions extends RealtimeXRequestOptions {
1139
+ params?: StopThreadTerminalSessionParams;
1140
+ query?: StopThreadTerminalSessionQuery;
1141
+ headers?: StopThreadTerminalSessionHeaders & Record<string, string>;
1142
+ body?: StopThreadTerminalSessionBody;
1143
+ }
1144
+
1145
+ export type TerminateTerminalSessionParams = {
1146
+ sessionId: string;
1147
+ };
1148
+ export type TerminateTerminalSessionQuery = Record<string, never>;
1149
+ export type TerminateTerminalSessionHeaders = {
1150
+ "x-app-id"?: string;
1151
+ };
1152
+ export type TerminateTerminalSessionBody = unknown;
1153
+ export type TerminateTerminalSessionResponse = unknown;
1154
+ export interface TerminateTerminalSessionOptions extends RealtimeXRequestOptions {
1155
+ params?: TerminateTerminalSessionParams;
1156
+ query?: TerminateTerminalSessionQuery;
1157
+ headers?: TerminateTerminalSessionHeaders & Record<string, string>;
1158
+ body?: TerminateTerminalSessionBody;
1159
+ }
1160
+
1161
+ export type TriggerWorkspaceHeartbeatParams = {
1162
+ workspaceSlug: string;
1163
+ };
1164
+ export type TriggerWorkspaceHeartbeatQuery = Record<string, never>;
1165
+ export type TriggerWorkspaceHeartbeatHeaders = {
1166
+ "x-app-id"?: string;
1167
+ };
1168
+ export type TriggerWorkspaceHeartbeatBody = unknown;
1169
+ export type TriggerWorkspaceHeartbeatResponse = Record<string, unknown>;
1170
+ export interface TriggerWorkspaceHeartbeatOptions extends RealtimeXRequestOptions {
1171
+ params?: TriggerWorkspaceHeartbeatParams;
1172
+ query?: TriggerWorkspaceHeartbeatQuery;
1173
+ headers?: TriggerWorkspaceHeartbeatHeaders & Record<string, string>;
1174
+ body?: TriggerWorkspaceHeartbeatBody;
1175
+ }
1176
+
1177
+ export type TriggerWorkspaceHeartbeatTasksParams = {
1178
+ workspaceSlug: string;
1179
+ };
1180
+ export type TriggerWorkspaceHeartbeatTasksQuery = Record<string, never>;
1181
+ export type TriggerWorkspaceHeartbeatTasksHeaders = {
1182
+ "x-app-id"?: string;
1183
+ };
1184
+ export type TriggerWorkspaceHeartbeatTasksBody = {
1185
+ tasks: Array<string>;
1186
+ };
1187
+ export type TriggerWorkspaceHeartbeatTasksResponse = Record<string, unknown>;
1188
+ export interface TriggerWorkspaceHeartbeatTasksOptions extends RealtimeXRequestOptions {
1189
+ params?: TriggerWorkspaceHeartbeatTasksParams;
1190
+ query?: TriggerWorkspaceHeartbeatTasksQuery;
1191
+ headers?: TriggerWorkspaceHeartbeatTasksHeaders & Record<string, string>;
1192
+ body?: TriggerWorkspaceHeartbeatTasksBody;
1193
+ }
1194
+
1195
+ export type UpdateChannelParams = {
1196
+ channelId: string;
1197
+ };
1198
+ export type UpdateChannelQuery = Record<string, never>;
1199
+ export type UpdateChannelHeaders = {
1200
+ "x-app-id"?: string;
1201
+ };
1202
+ export type UpdateChannelBody = {
1203
+ name?: string;
1204
+ thread_id?: number;
1205
+ threadId?: number;
1206
+ terminalProgressRelay?: boolean;
1207
+ terminalProgressThrottleSeconds?: number;
1208
+ terminalExternalUserContext?: boolean;
1209
+ maxFileUploadMb?: number;
1210
+ ttsEnabled?: boolean;
1211
+ tts_enabled?: boolean;
1212
+ };
1213
+ export type UpdateChannelResponse = Record<string, unknown>;
1214
+ export interface UpdateChannelOptions extends RealtimeXRequestOptions {
1215
+ params?: UpdateChannelParams;
1216
+ query?: UpdateChannelQuery;
1217
+ headers?: UpdateChannelHeaders & Record<string, string>;
1218
+ body?: UpdateChannelBody;
1219
+ }
1220
+
1221
+ export interface RealtimeXClientOptions {
1222
+ baseUrl?: string;
1223
+ appId?: string;
1224
+ appIdAuth?: string;
1225
+ apiKey?: string;
1226
+ token?: string;
1227
+ headers?: Record<string, string>;
1228
+ fetch?: typeof fetch;
1229
+ }
1230
+
1231
+ export interface RealtimeXRequestOptions {
1232
+ params?: Record<string, unknown>;
1233
+ query?: Record<string, unknown>;
1234
+ headers?: Record<string, string>;
1235
+ body?: unknown;
1236
+ signal?: AbortSignal;
1237
+ }
1238
+
1239
+ export declare class RealtimeXApiError extends Error {
1240
+ status?: number;
1241
+ statusText?: string;
1242
+ body: unknown;
1243
+ response: Response;
1244
+ }
1245
+
1246
+ export declare class RealtimeXClient {
1247
+ constructor(options?: RealtimeXClientOptions);
1248
+ request(operationName: string, options?: RealtimeXRequestOptions): Promise<unknown>;
1249
+ /** Approve one pending channel pairing code by visible 6-digit code or database id. Works for telegram, discord, and zalo channel pairing requests. */
1250
+ approveChannelPairingCode(options?: ApproveChannelPairingCodeOptions): Promise<ApproveChannelPairingCodeResponse>;
1251
+ approveChannelPairingCode(code: string, options?: Omit<ApproveChannelPairingCodeOptions, 'params'>): Promise<ApproveChannelPairingCodeResponse>;
1252
+ /** Guide a user through sending a chat message to the terminal agent. */
1253
+ chatWithTerminalAgent(options?: ChatWithTerminalAgentOptions): Promise<ChatWithTerminalAgentResponse>;
1254
+ chatWithTerminalAgent(body: ChatWithTerminalAgentBody, options?: Omit<ChatWithTerminalAgentOptions, 'body'>): Promise<ChatWithTerminalAgentResponse>;
1255
+ /** Clear the default CLI agent from a workspace. */
1256
+ clearWorkspaceDefaultAgent(options?: ClearWorkspaceDefaultAgentOptions): Promise<ClearWorkspaceDefaultAgentResponse>;
1257
+ clearWorkspaceDefaultAgent(workspaceSlug: string, options?: Omit<ClearWorkspaceDefaultAgentOptions, 'params'>): Promise<ClearWorkspaceDefaultAgentResponse>;
1258
+ /** Create a chat channel in one exact workspace. Defaults to Telegram when plugin_type, channelType, and type are omitted. Use flat botToken and thread_id fields instead of nested config/settings. */
1259
+ createChannel(options?: CreateChannelOptions): Promise<CreateChannelResponse>;
1260
+ createChannel(workspaceSlug: string, body: CreateChannelBody, options?: Omit<CreateChannelOptions, 'params' | 'body'>): Promise<CreateChannelResponse>;
1261
+ /** Create a thread in one workspace. The name is optional but recommended. */
1262
+ createThread(options?: CreateThreadOptions): Promise<CreateThreadResponse>;
1263
+ createThread(workspaceSlug: string, body: CreateThreadBody, options?: Omit<CreateThreadOptions, 'params' | 'body'>): Promise<CreateThreadResponse>;
1264
+ /** Create a workspace. Requires a human-readable workspace name. */
1265
+ createWorkspace(options?: CreateWorkspaceOptions): Promise<CreateWorkspaceResponse>;
1266
+ createWorkspace(body: CreateWorkspaceBody, options?: Omit<CreateWorkspaceOptions, 'body'>): Promise<CreateWorkspaceResponse>;
1267
+ /** Create a managed agent skill owned by one workspace. Terminal agents should use this instead of writing final skill content into runtime skill directories. */
1268
+ createWorkspaceAgentSkill(options?: CreateWorkspaceAgentSkillOptions): Promise<CreateWorkspaceAgentSkillResponse>;
1269
+ createWorkspaceAgentSkill(workspaceSlug: string, body: CreateWorkspaceAgentSkillBody, options?: Omit<CreateWorkspaceAgentSkillOptions, 'params' | 'body'>): Promise<CreateWorkspaceAgentSkillResponse>;
1270
+ /** Delete one chat channel by exact channel id. */
1271
+ deleteChannel(options?: DeleteChannelOptions): Promise<DeleteChannelResponse>;
1272
+ deleteChannel(channelId: string, options?: Omit<DeleteChannelOptions, 'params'>): Promise<DeleteChannelResponse>;
1273
+ /** Delete one thread by exact workspace slug and exact thread slug. */
1274
+ deleteThread(options?: DeleteThreadOptions): Promise<DeleteThreadResponse>;
1275
+ deleteThread(params: DeleteThreadParams, options?: Omit<DeleteThreadOptions, 'params'>): Promise<DeleteThreadResponse>;
1276
+ /** Delete one workspace by exact workspace slug. */
1277
+ deleteWorkspace(options?: DeleteWorkspaceOptions): Promise<DeleteWorkspaceResponse>;
1278
+ deleteWorkspace(workspaceSlug: string, options?: Omit<DeleteWorkspaceOptions, 'params'>): Promise<DeleteWorkspaceResponse>;
1279
+ /** Disable one installed plugin globally and unload it from runtime. Use a plugin id, name, or displayName from list-plugins. */
1280
+ disablePlugin(options?: DisablePluginOptions): Promise<DisablePluginResponse>;
1281
+ disablePlugin(pluginId: string, options?: Omit<DisablePluginOptions, 'params'>): Promise<DisablePluginResponse>;
1282
+ /** Disable one agent skill in a workspace. Use a skill id, name, or displayName from list-workspace-agent-skills. */
1283
+ disableWorkspaceAgentSkill(options?: DisableWorkspaceAgentSkillOptions): Promise<DisableWorkspaceAgentSkillResponse>;
1284
+ disableWorkspaceAgentSkill(params: DisableWorkspaceAgentSkillParams, options?: Omit<DisableWorkspaceAgentSkillOptions, 'params'>): Promise<DisableWorkspaceAgentSkillResponse>;
1285
+ /** Enable one installed plugin globally and load it into runtime. Use a plugin id, name, or displayName from list-plugins. */
1286
+ enablePlugin(options?: EnablePluginOptions): Promise<EnablePluginResponse>;
1287
+ enablePlugin(pluginId: string, options?: Omit<EnablePluginOptions, 'params'>): Promise<EnablePluginResponse>;
1288
+ /** Enable one agent skill in a workspace. Use a skill id, name, or displayName from list-workspace-agent-skills. */
1289
+ enableWorkspaceAgentSkill(options?: EnableWorkspaceAgentSkillOptions): Promise<EnableWorkspaceAgentSkillResponse>;
1290
+ enableWorkspaceAgentSkill(params: EnableWorkspaceAgentSkillParams, options?: Omit<EnableWorkspaceAgentSkillOptions, 'params'>): Promise<EnableWorkspaceAgentSkillResponse>;
1291
+ /** Get one public artifact by artifact id. */
1292
+ getArtifact(options?: GetArtifactOptions): Promise<GetArtifactResponse>;
1293
+ getArtifact(artifactId: string, options?: Omit<GetArtifactOptions, 'params'>): Promise<GetArtifactResponse>;
1294
+ /** Get one thread by exact workspace slug and exact thread slug. */
1295
+ getThread(options?: GetThreadOptions): Promise<GetThreadResponse>;
1296
+ getThread(params: GetThreadParams, options?: Omit<GetThreadOptions, 'params'>): Promise<GetThreadResponse>;
1297
+ /** Get one workspace by exact workspace slug. */
1298
+ getWorkspace(options?: GetWorkspaceOptions): Promise<GetWorkspaceResponse>;
1299
+ getWorkspace(workspaceSlug: string, options?: Omit<GetWorkspaceOptions, 'params'>): Promise<GetWorkspaceResponse>;
1300
+ /** List published agent skills. Use list-workspace-agent-skills to see enabled/disabled state for one workspace. */
1301
+ listAgentSkills(options?: ListAgentSkillsOptions): Promise<ListAgentSkillsResponse>;
1302
+ /** List public artifacts for one exact workspace slug. Revoked artifacts are hidden unless includeRevoked=true is passed. */
1303
+ listArtifacts(options?: ListArtifactsOptions): Promise<ListArtifactsResponse>;
1304
+ listArtifacts(workspaceSlug: string, options?: Omit<ListArtifactsOptions, 'params'>): Promise<ListArtifactsResponse>;
1305
+ /** List configured chat channels. Use returned channel ids with update-channel. */
1306
+ listChannels(options?: ListChannelsOptions): Promise<ListChannelsResponse>;
1307
+ /** List models for one provider id. Use an exact model id from this response when configuring workspace or thread LLM settings. */
1308
+ listLlmModels(options?: ListLlmModelsOptions): Promise<ListLlmModelsResponse>;
1309
+ listLlmModels(provider: string, options?: Omit<ListLlmModelsOptions, 'params'>): Promise<ListLlmModelsResponse>;
1310
+ /** List supported LLM providers. Use provider ids from this response when configuring workspace or thread LLM settings. */
1311
+ listLlmProviders(options?: ListLlmProvidersOptions): Promise<ListLlmProvidersResponse>;
1312
+ /** List installed plugins with enabled state and runtime load status. Use returned ids with enable-plugin, disable-plugin, and reload-plugin. */
1313
+ listPlugins(options?: ListPluginsOptions): Promise<ListPluginsResponse>;
1314
+ /** List terminal CLI agents that can be used with open-terminal-session. This is the same compact agent catalog returned by prepare.agents. */
1315
+ listTerminalAgents(options?: ListTerminalAgentsOptions): Promise<ListTerminalAgentsResponse>;
1316
+ /** List terminal runtime sessions known to the desktop app. Optionally filter by workspaceSlug and threadSlug. workspaceSlug is required when threadSlug is provided. */
1317
+ listTerminalSessions(options?: ListTerminalSessionsOptions): Promise<ListTerminalSessionsResponse>;
1318
+ listTerminalSessions(query?: ListTerminalSessionsQuery, options?: Omit<ListTerminalSessionsOptions, 'query'>): Promise<ListTerminalSessionsResponse>;
1319
+ /** List threads for one exact workspace slug. */
1320
+ listThreads(options?: ListThreadsOptions): Promise<ListThreadsResponse>;
1321
+ listThreads(workspaceSlug: string, options?: Omit<ListThreadsOptions, 'params'>): Promise<ListThreadsResponse>;
1322
+ /** List published agent skills with enabled/disabled state for one exact workspace slug. */
1323
+ listWorkspaceAgentSkills(options?: ListWorkspaceAgentSkillsOptions): Promise<ListWorkspaceAgentSkillsResponse>;
1324
+ listWorkspaceAgentSkills(workspaceSlug: string, options?: Omit<ListWorkspaceAgentSkillsOptions, 'params'>): Promise<ListWorkspaceAgentSkillsResponse>;
1325
+ /** List all workspaces visible to the current API caller. Use this before choosing a workspace slug. */
1326
+ listWorkspaces(options?: ListWorkspacesOptions): Promise<ListWorkspacesResponse>;
1327
+ /** Open a new desktop terminal session for one terminal CLI agent. Use list-terminal-agents or prepare.agents to choose agentName/providerId/modelId. workspaceSlug is required when threadSlug is provided. */
1328
+ openTerminalSession(options?: OpenTerminalSessionOptions): Promise<OpenTerminalSessionResponse>;
1329
+ openTerminalSession(body: OpenTerminalSessionBody, options?: Omit<OpenTerminalSessionOptions, 'body'>): Promise<OpenTerminalSessionResponse>;
1330
+ /** Pause one published artifact by artifact id. Paused artifacts remain listed but stop serving publicly. */
1331
+ pauseArtifact(options?: PauseArtifactOptions): Promise<PauseArtifactResponse>;
1332
+ pauseArtifact(artifactId: string, options?: Omit<PauseArtifactOptions, 'params'>): Promise<PauseArtifactResponse>;
1333
+ /** Return compact workspace, thread, current workspace/thread from explicit workspaceSlug and threadSlug query parameters, LLM provider, model, and CLI agent context for agents before choosing arguments. Agents should pass --workspace-slug "$RTX_WORKSPACE_SLUG" and --thread-slug "$RTX_THREAD_SLUG" when those environment variables exist. */
1334
+ prepare(options?: PrepareOptions): Promise<PrepareResponse>;
1335
+ prepare(query?: PrepareQuery, options?: Omit<PrepareOptions, 'query'>): Promise<PrepareResponse>;
1336
+ /** Promote one workspace-owned agent skill to a global managed skill by copying its files into a new global skill row. */
1337
+ promoteWorkspaceAgentSkill(options?: PromoteWorkspaceAgentSkillOptions): Promise<PromoteWorkspaceAgentSkillResponse>;
1338
+ promoteWorkspaceAgentSkill(params: PromoteWorkspaceAgentSkillParams, body: PromoteWorkspaceAgentSkillBody, options?: Omit<PromoteWorkspaceAgentSkillOptions, 'params' | 'body'>): Promise<PromoteWorkspaceAgentSkillResponse>;
1339
+ /** Publish a browser-viewable file or folder under a workspace artifacts directory. artifactPath is relative to that workspace artifacts directory. */
1340
+ publishArtifact(options?: PublishArtifactOptions): Promise<PublishArtifactResponse>;
1341
+ publishArtifact(workspaceSlug: string, body: PublishArtifactBody, options?: Omit<PublishArtifactOptions, 'params' | 'body'>): Promise<PublishArtifactResponse>;
1342
+ /** Force reload all enabled agent skills into one workspace working directory. Pass workspaceSlug; agents should pass the current RTX_WORKSPACE_SLUG when reloading the current workspace. After files are reloaded, the running agent must reload its own skill context before relying on updated skill instructions. */
1343
+ reloadAgentSkills(options?: ReloadAgentSkillsOptions): Promise<ReloadAgentSkillsResponse>;
1344
+ reloadAgentSkills(body: ReloadAgentSkillsBody, options?: Omit<ReloadAgentSkillsOptions, 'body'>): Promise<ReloadAgentSkillsResponse>;
1345
+ /** Reload one enabled plugin in runtime. Disabled plugins must be enabled before reload. */
1346
+ reloadPlugin(options?: ReloadPluginOptions): Promise<ReloadPluginResponse>;
1347
+ reloadPlugin(pluginId: string, options?: Omit<ReloadPluginOptions, 'params'>): Promise<ReloadPluginResponse>;
1348
+ /** Rename one thread by exact workspace slug and exact thread slug. Only the name is changed. */
1349
+ renameThread(options?: RenameThreadOptions): Promise<RenameThreadResponse>;
1350
+ renameThread(params: RenameThreadParams, body: RenameThreadBody, options?: Omit<RenameThreadOptions, 'params' | 'body'>): Promise<RenameThreadResponse>;
1351
+ /** Rename one workspace by exact workspace slug. Only the name is changed. */
1352
+ renameWorkspace(options?: RenameWorkspaceOptions): Promise<RenameWorkspaceResponse>;
1353
+ renameWorkspace(workspaceSlug: string, body: RenameWorkspaceBody, options?: Omit<RenameWorkspaceOptions, 'params' | 'body'>): Promise<RenameWorkspaceResponse>;
1354
+ /** Resume one paused artifact by artifact id. */
1355
+ resumeArtifact(options?: ResumeArtifactOptions): Promise<ResumeArtifactResponse>;
1356
+ resumeArtifact(artifactId: string, options?: Omit<ResumeArtifactOptions, 'params'>): Promise<ResumeArtifactResponse>;
1357
+ /** Resume the latest terminal runtime session for one exact thread. workspaceSlug and threadSlug are required in the body or query string. */
1358
+ resumeLatestTerminalSession(options?: ResumeLatestTerminalSessionOptions): Promise<ResumeLatestTerminalSessionResponse>;
1359
+ resumeLatestTerminalSession(body: ResumeLatestTerminalSessionBody, options?: Omit<ResumeLatestTerminalSessionOptions, 'body'>): Promise<ResumeLatestTerminalSessionResponse>;
1360
+ /** Resume a terminal runtime session by attaching a CLI controller. If the live session is closed or missing, historical resume metadata is used when available. */
1361
+ resumeTerminalSession(options?: ResumeTerminalSessionOptions): Promise<ResumeTerminalSessionResponse>;
1362
+ resumeTerminalSession(sessionId: string, body: ResumeTerminalSessionBody, options?: Omit<ResumeTerminalSessionOptions, 'params' | 'body'>): Promise<ResumeTerminalSessionResponse>;
1363
+ /** Revoke one artifact by artifact id. Revoked artifacts stop serving publicly and are hidden from list-artifacts by default. */
1364
+ revokeArtifact(options?: RevokeArtifactOptions): Promise<RevokeArtifactResponse>;
1365
+ revokeArtifact(artifactId: string, options?: Omit<RevokeArtifactOptions, 'params'>): Promise<RevokeArtifactResponse>;
1366
+ /** Run one app automation flow or scenario exposed via flowMetadata.cli.enabled=true. The command is the flowMetadata.cli.command value. */
1367
+ runAutomationFlow(options?: RunAutomationFlowOptions): Promise<RunAutomationFlowResponse>;
1368
+ runAutomationFlow(command: string, body: RunAutomationFlowBody, options?: Omit<RunAutomationFlowOptions, 'params' | 'body'>): Promise<RunAutomationFlowResponse>;
1369
+ /** Run any app automation flow or scenario exposed via flowMetadata.cli.enabled=true by passing workflowName. */
1370
+ runAutomationWorkflow(options?: RunAutomationWorkflowOptions): Promise<RunAutomationWorkflowResponse>;
1371
+ runAutomationWorkflow(body: RunAutomationWorkflowBody, options?: Omit<RunAutomationWorkflowOptions, 'body'>): Promise<RunAutomationWorkflowResponse>;
1372
+ /** Send one local CLI file back to an external channel using an explicit channel delivery context id. Channel-linked terminal agents should pass --context "$REALTIMEX_CHANNEL_DELIVERY_CONTEXT_ID". In desktop/local runtime the CLI should send an absolute filePath; contentBase64 remains available as fallback transport. */
1373
+ sendChannelFile(options?: SendChannelFileOptions): Promise<SendChannelFileResponse>;
1374
+ sendChannelFile(body: SendChannelFileBody, options?: Omit<SendChannelFileOptions, 'body'>): Promise<SendChannelFileResponse>;
1375
+ /** Send one message to an exact thread using the same routing as channel replies. Terminal-agent threads are dispatched to the terminal runtime; other threads use the configured LLM chat path. */
1376
+ sendMessage(options?: SendMessageOptions): Promise<SendMessageResponse>;
1377
+ sendMessage(params: SendMessageParams, body: SendMessageBody, options?: Omit<SendMessageOptions, 'params' | 'body'>): Promise<SendMessageResponse>;
1378
+ /** Set a workspace default agent from the desktop workspace chat settings UI. */
1379
+ setDefaultWorkspaceAgent(options?: SetDefaultWorkspaceAgentOptions): Promise<SetDefaultWorkspaceAgentResponse>;
1380
+ setDefaultWorkspaceAgent(body: SetDefaultWorkspaceAgentBody, options?: Omit<SetDefaultWorkspaceAgentOptions, 'body'>): Promise<SetDefaultWorkspaceAgentResponse>;
1381
+ /** Set workspace or global ambient-agent active hours using HH:mm start and end values. */
1382
+ setHeartbeatActiveHours(options?: SetHeartbeatActiveHoursOptions): Promise<SetHeartbeatActiveHoursResponse>;
1383
+ setHeartbeatActiveHours(body: SetHeartbeatActiveHoursBody, options?: Omit<SetHeartbeatActiveHoursOptions, 'body'>): Promise<SetHeartbeatActiveHoursResponse>;
1384
+ /** Turn workspace or global ambient-agent heartbeat auto pilot on or off. */
1385
+ setHeartbeatAutoPilot(options?: SetHeartbeatAutoPilotOptions): Promise<SetHeartbeatAutoPilotResponse>;
1386
+ setHeartbeatAutoPilot(body: SetHeartbeatAutoPilotBody, options?: Omit<SetHeartbeatAutoPilotOptions, 'body'>): Promise<SetHeartbeatAutoPilotResponse>;
1387
+ /** Set workspace or global ambient-agent default terminal agent and optional model for heartbeat defaults and legacy fallback. */
1388
+ setHeartbeatDefaultAgent(options?: SetHeartbeatDefaultAgentOptions): Promise<SetHeartbeatDefaultAgentResponse>;
1389
+ setHeartbeatDefaultAgent(body: SetHeartbeatDefaultAgentBody, options?: Omit<SetHeartbeatDefaultAgentOptions, 'body'>): Promise<SetHeartbeatDefaultAgentResponse>;
1390
+ /** Turn workspace or global ambient-agent heartbeat on or off. */
1391
+ setHeartbeatEnabled(options?: SetHeartbeatEnabledOptions): Promise<SetHeartbeatEnabledResponse>;
1392
+ setHeartbeatEnabled(body: SetHeartbeatEnabledBody, options?: Omit<SetHeartbeatEnabledOptions, 'body'>): Promise<SetHeartbeatEnabledResponse>;
1393
+ /** Set workspace or global ambient-agent scheduler check interval. Supports simple intervals only: m, h, or d, for example 3m, 1h, or 1d. */
1394
+ setHeartbeatInterval(options?: SetHeartbeatIntervalOptions): Promise<SetHeartbeatIntervalResponse>;
1395
+ setHeartbeatInterval(body: SetHeartbeatIntervalBody, options?: Omit<SetHeartbeatIntervalOptions, 'body'>): Promise<SetHeartbeatIntervalResponse>;
1396
+ /** Set workspace or global ambient-agent heartbeat timezone, for example Asia/Saigon or UTC. */
1397
+ setHeartbeatTimezone(options?: SetHeartbeatTimezoneOptions): Promise<SetHeartbeatTimezoneResponse>;
1398
+ setHeartbeatTimezone(body: SetHeartbeatTimezoneBody, options?: Omit<SetHeartbeatTimezoneOptions, 'body'>): Promise<SetHeartbeatTimezoneResponse>;
1399
+ /** Set up HEARTBEAT.md task instructions for a workspace or global ambient agent. Returns the target path, template, file path, and concise editing instructions. */
1400
+ setupHeartbeatTasks(options?: SetupHeartbeatTasksOptions): Promise<SetupHeartbeatTasksResponse>;
1401
+ setupHeartbeatTasks(query?: SetupHeartbeatTasksQuery, options?: Omit<SetupHeartbeatTasksOptions, 'query'>): Promise<SetupHeartbeatTasksResponse>;
1402
+ /** Set up AGENTS.md and CLAUDE.md personality files for a workspace or global ambient agent. Returns the target path, template, file paths, and concise editing instructions. */
1403
+ setupPersonality(options?: SetupPersonalityOptions): Promise<SetupPersonalityResponse>;
1404
+ setupPersonality(query?: SetupPersonalityQuery, options?: Omit<SetupPersonalityOptions, 'query'>): Promise<SetupPersonalityResponse>;
1405
+ /** Add or edit an agent working directory from the desktop settings UI. */
1406
+ setupWorkingDir(options?: SetupWorkingDirOptions): Promise<SetupWorkingDirResponse>;
1407
+ setupWorkingDir(body: SetupWorkingDirBody, options?: Omit<SetupWorkingDirOptions, 'body'>): Promise<SetupWorkingDirResponse>;
1408
+ /** Set the default CLI agent for a workspace. Use prepare first to find a valid agent canonical/providerId and optional modelId. */
1409
+ setWorkspaceDefaultAgent(options?: SetWorkspaceDefaultAgentOptions): Promise<SetWorkspaceDefaultAgentResponse>;
1410
+ setWorkspaceDefaultAgent(workspaceSlug: string, body: SetWorkspaceDefaultAgentBody, options?: Omit<SetWorkspaceDefaultAgentOptions, 'params' | 'body'>): Promise<SetWorkspaceDefaultAgentResponse>;
1411
+ /** Start one chat channel by exact channel id. */
1412
+ startChannel(options?: StartChannelOptions): Promise<StartChannelResponse>;
1413
+ startChannel(channelId: string, options?: Omit<StartChannelOptions, 'params'>): Promise<StartChannelResponse>;
1414
+ /** Stop one chat channel by exact channel id. */
1415
+ stopChannel(options?: StopChannelOptions): Promise<StopChannelResponse>;
1416
+ stopChannel(channelId: string, options?: Omit<StopChannelOptions, 'params'>): Promise<StopChannelResponse>;
1417
+ /** Interrupt the selected or current chat-linked terminal session for one exact thread without closing the underlying terminal session. This uses the same stop dispatcher as channel /stop commands. */
1418
+ stopThreadTerminalSession(options?: StopThreadTerminalSessionOptions): Promise<StopThreadTerminalSessionResponse>;
1419
+ /** Terminate a terminal runtime session by detaching any controller and closing the underlying PTY session. */
1420
+ terminateTerminalSession(options?: TerminateTerminalSessionOptions): Promise<TerminateTerminalSessionResponse>;
1421
+ terminateTerminalSession(sessionId: string, options?: Omit<TerminateTerminalSessionOptions, 'params'>): Promise<TerminateTerminalSessionResponse>;
1422
+ /** Trigger the default HEARTBEAT.md task for a workspace immediately. Falls back to the legacy heartbeat executor when no tasks are defined. */
1423
+ triggerWorkspaceHeartbeat(options?: TriggerWorkspaceHeartbeatOptions): Promise<TriggerWorkspaceHeartbeatResponse>;
1424
+ triggerWorkspaceHeartbeat(workspaceSlug: string, body: TriggerWorkspaceHeartbeatBody, options?: Omit<TriggerWorkspaceHeartbeatOptions, 'params' | 'body'>): Promise<TriggerWorkspaceHeartbeatResponse>;
1425
+ /** Trigger specified HEARTBEAT.md task names for a workspace immediately. */
1426
+ triggerWorkspaceHeartbeatTasks(options?: TriggerWorkspaceHeartbeatTasksOptions): Promise<TriggerWorkspaceHeartbeatTasksResponse>;
1427
+ triggerWorkspaceHeartbeatTasks(workspaceSlug: string, body: TriggerWorkspaceHeartbeatTasksBody, options?: Omit<TriggerWorkspaceHeartbeatTasksOptions, 'params' | 'body'>): Promise<TriggerWorkspaceHeartbeatTasksResponse>;
1428
+ /** Update one chat channel by exact channel id. Only channel writable fields are changed. */
1429
+ updateChannel(options?: UpdateChannelOptions): Promise<UpdateChannelResponse>;
1430
+ updateChannel(channelId: string, body: UpdateChannelBody, options?: Omit<UpdateChannelOptions, 'params' | 'body'>): Promise<UpdateChannelResponse>;
1431
+ }
1432
+
1433
+ export declare function createRealtimeXClient(
1434
+ options?: RealtimeXClientOptions
1435
+ ): RealtimeXClient;
1436
+ export declare const createClient: typeof createRealtimeXClient;
1437
+ export declare const operations: Record<
1438
+ string,
1439
+ {
1440
+ method: string;
1441
+ path: string;
1442
+ pathParams: string[];
1443
+ queryParams: string[];
1444
+ headerParams: string[];
1445
+ hasBody: boolean;
1446
+ }
1447
+ >;
1448
+ export declare const version: string;