@composio/client 0.1.0-alpha.68 → 0.1.0-alpha.69
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/package.json +1 -1
- package/resources/auth-configs.js +6 -6
- package/resources/auth-configs.js.map +1 -1
- package/resources/auth-configs.mjs +6 -6
- package/resources/auth-configs.mjs.map +1 -1
- package/resources/cli/cli.js +2 -2
- package/resources/cli/cli.js.map +1 -1
- package/resources/cli/cli.mjs +2 -2
- package/resources/cli/cli.mjs.map +1 -1
- package/resources/cli/realtime.js +2 -2
- package/resources/cli/realtime.js.map +1 -1
- package/resources/cli/realtime.mjs +2 -2
- package/resources/cli/realtime.mjs.map +1 -1
- package/resources/connected-accounts.d.mts +164 -11
- package/resources/connected-accounts.d.mts.map +1 -1
- package/resources/connected-accounts.d.ts +164 -11
- package/resources/connected-accounts.d.ts.map +1 -1
- package/resources/connected-accounts.js +16 -7
- package/resources/connected-accounts.js.map +1 -1
- package/resources/connected-accounts.mjs +16 -7
- package/resources/connected-accounts.mjs.map +1 -1
- package/resources/files.js +2 -2
- package/resources/files.js.map +1 -1
- package/resources/files.mjs +2 -2
- package/resources/files.mjs.map +1 -1
- package/resources/link.d.mts +78 -44
- package/resources/link.d.mts.map +1 -1
- package/resources/link.d.ts +78 -44
- package/resources/link.d.ts.map +1 -1
- package/resources/link.js +1 -1
- package/resources/link.js.map +1 -1
- package/resources/link.mjs +1 -1
- package/resources/link.mjs.map +1 -1
- package/resources/logs/tools.js +2 -2
- package/resources/logs/tools.js.map +1 -1
- package/resources/logs/tools.mjs +2 -2
- package/resources/logs/tools.mjs.map +1 -1
- package/resources/logs/triggers.js +2 -2
- package/resources/logs/triggers.js.map +1 -1
- package/resources/logs/triggers.mjs +2 -2
- package/resources/logs/triggers.mjs.map +1 -1
- package/resources/mcp/custom.js +1 -1
- package/resources/mcp/custom.js.map +1 -1
- package/resources/mcp/custom.mjs +1 -1
- package/resources/mcp/custom.mjs.map +1 -1
- package/resources/mcp/generate.js +1 -1
- package/resources/mcp/generate.js.map +1 -1
- package/resources/mcp/generate.mjs +1 -1
- package/resources/mcp/generate.mjs.map +1 -1
- package/resources/mcp/mcp.js +6 -6
- package/resources/mcp/mcp.js.map +1 -1
- package/resources/mcp/mcp.mjs +6 -6
- package/resources/mcp/mcp.mjs.map +1 -1
- package/resources/migration.js +1 -1
- package/resources/migration.js.map +1 -1
- package/resources/migration.mjs +1 -1
- package/resources/migration.mjs.map +1 -1
- package/resources/project/config.js +2 -2
- package/resources/project/config.js.map +1 -1
- package/resources/project/config.mjs +2 -2
- package/resources/project/config.mjs.map +1 -1
- package/resources/tool-router/index.d.mts +1 -1
- package/resources/tool-router/index.d.mts.map +1 -1
- package/resources/tool-router/index.d.ts +1 -1
- package/resources/tool-router/index.d.ts.map +1 -1
- package/resources/tool-router/index.js.map +1 -1
- package/resources/tool-router/index.mjs.map +1 -1
- package/resources/tool-router/session/files.js +4 -7
- package/resources/tool-router/session/files.js.map +1 -1
- package/resources/tool-router/session/files.mjs +4 -7
- package/resources/tool-router/session/files.mjs.map +1 -1
- package/resources/tool-router/session/index.d.mts +1 -1
- package/resources/tool-router/session/index.d.mts.map +1 -1
- package/resources/tool-router/session/index.d.ts +1 -1
- package/resources/tool-router/session/index.d.ts.map +1 -1
- package/resources/tool-router/session/index.js.map +1 -1
- package/resources/tool-router/session/index.mjs.map +1 -1
- package/resources/tool-router/session/session.d.mts +2124 -556
- package/resources/tool-router/session/session.d.mts.map +1 -1
- package/resources/tool-router/session/session.d.ts +2124 -556
- package/resources/tool-router/session/session.d.ts.map +1 -1
- package/resources/tool-router/session/session.js +65 -29
- package/resources/tool-router/session/session.js.map +1 -1
- package/resources/tool-router/session/session.mjs +65 -29
- package/resources/tool-router/session/session.mjs.map +1 -1
- package/resources/tool-router/tool-router.d.mts +2 -2
- package/resources/tool-router/tool-router.d.mts.map +1 -1
- package/resources/tool-router/tool-router.d.ts +2 -2
- package/resources/tool-router/tool-router.d.ts.map +1 -1
- package/resources/tool-router/tool-router.js +1 -1
- package/resources/tool-router/tool-router.js.map +1 -1
- package/resources/tool-router/tool-router.mjs +1 -1
- package/resources/tool-router/tool-router.mjs.map +1 -1
- package/resources/toolkits.js +3 -3
- package/resources/toolkits.js.map +1 -1
- package/resources/toolkits.mjs +3 -3
- package/resources/toolkits.mjs.map +1 -1
- package/resources/tools.js +6 -6
- package/resources/tools.js.map +1 -1
- package/resources/tools.mjs +6 -6
- package/resources/tools.mjs.map +1 -1
- package/resources/trigger-instances/manage.js +2 -2
- package/resources/trigger-instances/manage.js.map +1 -1
- package/resources/trigger-instances/manage.mjs +2 -2
- package/resources/trigger-instances/manage.mjs.map +1 -1
- package/resources/trigger-instances/trigger-instances.js +2 -2
- package/resources/trigger-instances/trigger-instances.js.map +1 -1
- package/resources/trigger-instances/trigger-instances.mjs +2 -2
- package/resources/trigger-instances/trigger-instances.mjs.map +1 -1
- package/resources/triggers-types.js +3 -3
- package/resources/triggers-types.js.map +1 -1
- package/resources/triggers-types.mjs +3 -3
- package/resources/triggers-types.mjs.map +1 -1
- package/src/resources/auth-configs.ts +6 -6
- package/src/resources/cli/cli.ts +2 -2
- package/src/resources/cli/realtime.ts +2 -2
- package/src/resources/connected-accounts.ts +285 -18
- package/src/resources/files.ts +2 -2
- package/src/resources/link.ts +122 -61
- package/src/resources/logs/tools.ts +2 -2
- package/src/resources/logs/triggers.ts +2 -2
- package/src/resources/mcp/custom.ts +1 -1
- package/src/resources/mcp/generate.ts +1 -1
- package/src/resources/mcp/mcp.ts +6 -6
- package/src/resources/migration.ts +1 -1
- package/src/resources/project/config.ts +2 -2
- package/src/resources/tool-router/index.ts +6 -0
- package/src/resources/tool-router/session/files.ts +7 -7
- package/src/resources/tool-router/session/index.ts +6 -0
- package/src/resources/tool-router/session/session.ts +2556 -724
- package/src/resources/tool-router/tool-router.ts +13 -1
- package/src/resources/toolkits.ts +3 -3
- package/src/resources/tools.ts +6 -6
- package/src/resources/trigger-instances/manage.ts +2 -2
- package/src/resources/trigger-instances/trigger-instances.ts +2 -2
- package/src/resources/triggers-types.ts +3 -3
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -35,16 +35,32 @@ export declare class Session extends APIResource {
|
|
|
35
35
|
*/
|
|
36
36
|
retrieve(sessionID: string, options?: RequestOptions): APIPromise<SessionRetrieveResponse>;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
|
|
47
|
-
|
|
38
|
+
* Fetch an existing tool router session by ID.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const response = await client.toolRouter.session.attach(
|
|
43
|
+
* 'trs_1a2b3c4d5e6f',
|
|
44
|
+
* );
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
attach(sessionID: string, body?: SessionAttachParams | null | undefined, options?: RequestOptions): APIPromise<SessionAttachResponse>;
|
|
48
|
+
/**
|
|
49
|
+
* Returns the session config history ordered by version DESC (newest first). The
|
|
50
|
+
* live (current) config appears once, on the first page only, with
|
|
51
|
+
* `is_current: true`; archived versions have `is_current: false`.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* const response =
|
|
56
|
+
* await client.toolRouter.session.configHistory(
|
|
57
|
+
* 'trs_1a2b3c4d5e6f',
|
|
58
|
+
* );
|
|
59
|
+
* ```
|
|
60
|
+
*/
|
|
61
|
+
configHistory(sessionID: string, query?: SessionConfigHistoryParams | null | undefined, options?: RequestOptions): APIPromise<SessionConfigHistoryResponse>;
|
|
62
|
+
/**
|
|
63
|
+
* Execute a tool (meta or app) within an existing tool router session.
|
|
48
64
|
*
|
|
49
65
|
* @example
|
|
50
66
|
* ```ts
|
|
@@ -56,9 +72,8 @@ export declare class Session extends APIResource {
|
|
|
56
72
|
*/
|
|
57
73
|
execute(sessionID: string, body: SessionExecuteParams, options?: RequestOptions): APIPromise<SessionExecuteResponse>;
|
|
58
74
|
/**
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
* /execute endpoint.
|
|
75
|
+
* Execute a Composio meta tool (COMPOSIO\_\*) within an existing tool router
|
|
76
|
+
* session.
|
|
62
77
|
*
|
|
63
78
|
* @example
|
|
64
79
|
* ```ts
|
|
@@ -84,6 +99,20 @@ export declare class Session extends APIResource {
|
|
|
84
99
|
* ```
|
|
85
100
|
*/
|
|
86
101
|
link(sessionID: string, body: SessionLinkParams, options?: RequestOptions): APIPromise<SessionLinkResponse>;
|
|
102
|
+
/**
|
|
103
|
+
* Partially updates the configuration of an existing tool router session. Only the
|
|
104
|
+
* fields provided in the request body will be updated. Uses optimistic concurrency
|
|
105
|
+
* control to prevent lost updates. The previous config is stored in config
|
|
106
|
+
* history.
|
|
107
|
+
*
|
|
108
|
+
* @example
|
|
109
|
+
* ```ts
|
|
110
|
+
* const response = await client.toolRouter.session.patch(
|
|
111
|
+
* 'trs_1a2b3c4d5e6f',
|
|
112
|
+
* );
|
|
113
|
+
* ```
|
|
114
|
+
*/
|
|
115
|
+
patch(sessionID: string, body?: SessionPatchParams | null | undefined, options?: RequestOptions): APIPromise<SessionPatchResponse>;
|
|
87
116
|
/**
|
|
88
117
|
* Execute any native API call on a toolkit with authentication automatically
|
|
89
118
|
* injected from Composio. This endpoint proxies HTTP requests to third-party APIs
|
|
@@ -108,9 +137,8 @@ export declare class Session extends APIResource {
|
|
|
108
137
|
*/
|
|
109
138
|
proxyExecute(sessionID: string, body: SessionProxyExecuteParams, options?: RequestOptions): APIPromise<SessionProxyExecuteResponse>;
|
|
110
139
|
/**
|
|
111
|
-
* Search for tools matching a
|
|
112
|
-
*
|
|
113
|
-
* workflow guidance in a predictable format.
|
|
140
|
+
* Search for tools matching a use case query within an existing tool router
|
|
141
|
+
* session.
|
|
114
142
|
*
|
|
115
143
|
* @example
|
|
116
144
|
* ```ts
|
|
@@ -139,9 +167,8 @@ export declare class Session extends APIResource {
|
|
|
139
167
|
*/
|
|
140
168
|
toolkits(sessionID: string, query?: SessionToolkitsParams | null | undefined, options?: RequestOptions): APIPromise<SessionToolkitsResponse>;
|
|
141
169
|
/**
|
|
142
|
-
* Returns
|
|
143
|
-
*
|
|
144
|
-
* the session.
|
|
170
|
+
* Returns tools available in a tool router session with complete schemas. Results
|
|
171
|
+
* are paginated; use `next_cursor` to fetch the next page.
|
|
145
172
|
*
|
|
146
173
|
* @example
|
|
147
174
|
* ```ts
|
|
@@ -154,7 +181,7 @@ export declare class Session extends APIResource {
|
|
|
154
181
|
}
|
|
155
182
|
export interface SessionCreateResponse {
|
|
156
183
|
/**
|
|
157
|
-
* The
|
|
184
|
+
* The configuration used to create this session
|
|
158
185
|
*/
|
|
159
186
|
config: SessionCreateResponse.Config;
|
|
160
187
|
/**
|
|
@@ -184,17 +211,22 @@ export interface SessionCreateResponse {
|
|
|
184
211
|
}
|
|
185
212
|
export declare namespace SessionCreateResponse {
|
|
186
213
|
/**
|
|
187
|
-
* The
|
|
214
|
+
* The configuration used to create this session
|
|
188
215
|
*/
|
|
189
216
|
interface Config {
|
|
190
217
|
/**
|
|
191
|
-
*
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
*
|
|
218
|
+
* Execute helper configuration
|
|
219
|
+
*/
|
|
220
|
+
execute: Config.Execute;
|
|
221
|
+
/**
|
|
222
|
+
* Preload configuration. Explicit slugs are returned as an array; dynamic preload
|
|
223
|
+
* is returned as "all".
|
|
196
224
|
*/
|
|
197
225
|
preload: Config.Preload;
|
|
226
|
+
/**
|
|
227
|
+
* Search helper configuration
|
|
228
|
+
*/
|
|
229
|
+
search: Config.Search;
|
|
198
230
|
/**
|
|
199
231
|
* User identifier for this session
|
|
200
232
|
*/
|
|
@@ -243,19 +275,27 @@ export declare namespace SessionCreateResponse {
|
|
|
243
275
|
}
|
|
244
276
|
namespace Config {
|
|
245
277
|
/**
|
|
246
|
-
*
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
278
|
+
* Execute helper configuration
|
|
279
|
+
*/
|
|
280
|
+
interface Execute {
|
|
281
|
+
enable_multi_execute?: boolean;
|
|
282
|
+
}
|
|
283
|
+
/**
|
|
284
|
+
* Preload configuration. Explicit slugs are returned as an array; dynamic preload
|
|
285
|
+
* is returned as "all".
|
|
251
286
|
*/
|
|
252
287
|
interface Preload {
|
|
253
288
|
/**
|
|
254
|
-
*
|
|
255
|
-
*
|
|
256
|
-
* when no preload was configured.
|
|
289
|
+
* Explicit preloaded tool slugs, or "all" when the session dynamically exposes all
|
|
290
|
+
* app tools allowed by its filters.
|
|
257
291
|
*/
|
|
258
|
-
tools: Array<string
|
|
292
|
+
tools: Array<string> | 'all';
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* Search helper configuration
|
|
296
|
+
*/
|
|
297
|
+
interface Search {
|
|
298
|
+
enable?: boolean;
|
|
259
299
|
}
|
|
260
300
|
/**
|
|
261
301
|
* Manage connections configuration
|
|
@@ -455,7 +495,7 @@ export declare namespace SessionCreateResponse {
|
|
|
455
495
|
}
|
|
456
496
|
export interface SessionRetrieveResponse {
|
|
457
497
|
/**
|
|
458
|
-
* The
|
|
498
|
+
* The configuration used to create this session
|
|
459
499
|
*/
|
|
460
500
|
config: SessionRetrieveResponse.Config;
|
|
461
501
|
/**
|
|
@@ -484,17 +524,22 @@ export interface SessionRetrieveResponse {
|
|
|
484
524
|
}
|
|
485
525
|
export declare namespace SessionRetrieveResponse {
|
|
486
526
|
/**
|
|
487
|
-
* The
|
|
527
|
+
* The configuration used to create this session
|
|
488
528
|
*/
|
|
489
529
|
interface Config {
|
|
490
530
|
/**
|
|
491
|
-
*
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
*
|
|
531
|
+
* Execute helper configuration
|
|
532
|
+
*/
|
|
533
|
+
execute: Config.Execute;
|
|
534
|
+
/**
|
|
535
|
+
* Preload configuration. Explicit slugs are returned as an array; dynamic preload
|
|
536
|
+
* is returned as "all".
|
|
496
537
|
*/
|
|
497
538
|
preload: Config.Preload;
|
|
539
|
+
/**
|
|
540
|
+
* Search helper configuration
|
|
541
|
+
*/
|
|
542
|
+
search: Config.Search;
|
|
498
543
|
/**
|
|
499
544
|
* User identifier for this session
|
|
500
545
|
*/
|
|
@@ -543,19 +588,27 @@ export declare namespace SessionRetrieveResponse {
|
|
|
543
588
|
}
|
|
544
589
|
namespace Config {
|
|
545
590
|
/**
|
|
546
|
-
*
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
591
|
+
* Execute helper configuration
|
|
592
|
+
*/
|
|
593
|
+
interface Execute {
|
|
594
|
+
enable_multi_execute?: boolean;
|
|
595
|
+
}
|
|
596
|
+
/**
|
|
597
|
+
* Preload configuration. Explicit slugs are returned as an array; dynamic preload
|
|
598
|
+
* is returned as "all".
|
|
551
599
|
*/
|
|
552
600
|
interface Preload {
|
|
553
601
|
/**
|
|
554
|
-
*
|
|
555
|
-
*
|
|
556
|
-
* when no preload was configured.
|
|
602
|
+
* Explicit preloaded tool slugs, or "all" when the session dynamically exposes all
|
|
603
|
+
* app tools allowed by its filters.
|
|
557
604
|
*/
|
|
558
|
-
tools: Array<string
|
|
605
|
+
tools: Array<string> | 'all';
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
* Search helper configuration
|
|
609
|
+
*/
|
|
610
|
+
interface Search {
|
|
611
|
+
enable?: boolean;
|
|
559
612
|
}
|
|
560
613
|
/**
|
|
561
614
|
* Manage connections configuration
|
|
@@ -752,222 +805,1073 @@ export declare namespace SessionRetrieveResponse {
|
|
|
752
805
|
message: string;
|
|
753
806
|
}
|
|
754
807
|
}
|
|
755
|
-
export interface
|
|
756
|
-
/**
|
|
757
|
-
* The data returned by the tool execution
|
|
758
|
-
*/
|
|
759
|
-
data: {
|
|
760
|
-
[key: string]: unknown;
|
|
761
|
-
};
|
|
762
|
-
/**
|
|
763
|
-
* Error message if the execution failed, null otherwise
|
|
764
|
-
*/
|
|
765
|
-
error: string | null;
|
|
766
|
-
/**
|
|
767
|
-
* Unique identifier for the execution log
|
|
768
|
-
*/
|
|
769
|
-
log_id: string;
|
|
770
|
-
}
|
|
771
|
-
export interface SessionExecuteMetaResponse {
|
|
772
|
-
/**
|
|
773
|
-
* The data returned by the tool execution
|
|
774
|
-
*/
|
|
775
|
-
data: {
|
|
776
|
-
[key: string]: unknown;
|
|
777
|
-
};
|
|
778
|
-
/**
|
|
779
|
-
* Error message if the execution failed, null otherwise
|
|
780
|
-
*/
|
|
781
|
-
error: string | null;
|
|
782
|
-
/**
|
|
783
|
-
* Unique identifier for the execution log
|
|
784
|
-
*/
|
|
785
|
-
log_id: string;
|
|
786
|
-
}
|
|
787
|
-
export interface SessionLinkResponse {
|
|
788
|
-
/**
|
|
789
|
-
* The unique identifier for the connected account
|
|
790
|
-
*/
|
|
791
|
-
connected_account_id: string;
|
|
808
|
+
export interface SessionAttachResponse {
|
|
792
809
|
/**
|
|
793
|
-
*
|
|
810
|
+
* The configuration used to create this session
|
|
794
811
|
*/
|
|
795
|
-
|
|
812
|
+
config: SessionAttachResponse.Config;
|
|
796
813
|
/**
|
|
797
|
-
*
|
|
814
|
+
* Monotonic version of the config. Incremented on each PATCH. Use for optimistic
|
|
815
|
+
* concurrency control.
|
|
798
816
|
*/
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
export interface SessionProxyExecuteResponse {
|
|
817
|
+
config_version: number;
|
|
818
|
+
mcp: SessionAttachResponse.Mcp;
|
|
802
819
|
/**
|
|
803
|
-
* The
|
|
820
|
+
* The identifier of the session
|
|
804
821
|
*/
|
|
805
|
-
|
|
822
|
+
session_id: string;
|
|
806
823
|
/**
|
|
807
|
-
*
|
|
824
|
+
* List of available tools in this session
|
|
808
825
|
*/
|
|
809
|
-
|
|
826
|
+
tool_router_tools: Array<string>;
|
|
810
827
|
/**
|
|
811
|
-
*
|
|
828
|
+
* Experimental features
|
|
812
829
|
*/
|
|
813
|
-
|
|
830
|
+
experimental?: SessionAttachResponse.Experimental;
|
|
814
831
|
/**
|
|
815
|
-
*
|
|
832
|
+
* Advisory list — the session exists and is usable, but the listed issues may
|
|
833
|
+
* warrant attention.
|
|
816
834
|
*/
|
|
817
|
-
|
|
818
|
-
[key: string]: string;
|
|
819
|
-
};
|
|
835
|
+
warnings?: Array<SessionAttachResponse.Warning>;
|
|
820
836
|
}
|
|
821
|
-
export declare namespace
|
|
837
|
+
export declare namespace SessionAttachResponse {
|
|
822
838
|
/**
|
|
823
|
-
*
|
|
839
|
+
* The configuration used to create this session
|
|
824
840
|
*/
|
|
825
|
-
interface
|
|
826
|
-
/**
|
|
827
|
-
* Content-Type of the binary data
|
|
828
|
-
*/
|
|
829
|
-
content_type: string;
|
|
830
|
-
/**
|
|
831
|
-
* File size in bytes
|
|
832
|
-
*/
|
|
833
|
-
size: number;
|
|
834
|
-
/**
|
|
835
|
-
* URL to download binary content
|
|
836
|
-
*/
|
|
837
|
-
url: string;
|
|
841
|
+
interface Config {
|
|
838
842
|
/**
|
|
839
|
-
*
|
|
843
|
+
* Execute helper configuration
|
|
840
844
|
*/
|
|
841
|
-
|
|
842
|
-
}
|
|
843
|
-
}
|
|
844
|
-
export interface SessionSearchResponse {
|
|
845
|
-
/**
|
|
846
|
-
* Error message if any searches failed, null if all succeeded. Format: "X out of Y
|
|
847
|
-
* searches failed, reasons: <details>"
|
|
848
|
-
*/
|
|
849
|
-
error: string | null;
|
|
850
|
-
/**
|
|
851
|
-
* Combined workflow guidance covering connections, planner, and memory usage. Each
|
|
852
|
-
* element is a step instruction.
|
|
853
|
-
*/
|
|
854
|
-
next_steps_guidance: Array<string>;
|
|
855
|
-
/**
|
|
856
|
-
* Per-query search results with tools, reasoning, and memory. One entry per query
|
|
857
|
-
* in request order.
|
|
858
|
-
*/
|
|
859
|
-
results: Array<SessionSearchResponse.Result>;
|
|
860
|
-
/**
|
|
861
|
-
* Session info for correlating meta tool calls
|
|
862
|
-
*/
|
|
863
|
-
session: SessionSearchResponse.Session;
|
|
864
|
-
/**
|
|
865
|
-
* Whether all searches completed successfully. False if any query failed.
|
|
866
|
-
*/
|
|
867
|
-
success: boolean;
|
|
868
|
-
/**
|
|
869
|
-
* Time information for the query
|
|
870
|
-
*/
|
|
871
|
-
time_info: SessionSearchResponse.TimeInfo;
|
|
872
|
-
/**
|
|
873
|
-
* Deduplicated tool definitions keyed by tool_slug for O(1) lookup. Each tool
|
|
874
|
-
* appears once even if used in multiple queries.
|
|
875
|
-
*/
|
|
876
|
-
tool_schemas: {
|
|
877
|
-
[key: string]: SessionSearchResponse.ToolSchemas;
|
|
878
|
-
};
|
|
879
|
-
/**
|
|
880
|
-
* Connection status for all toolkits mentioned across all queries, with
|
|
881
|
-
* descriptions merged in.
|
|
882
|
-
*/
|
|
883
|
-
toolkit_connection_statuses: Array<SessionSearchResponse.ToolkitConnectionStatus>;
|
|
884
|
-
}
|
|
885
|
-
export declare namespace SessionSearchResponse {
|
|
886
|
-
interface Result {
|
|
845
|
+
execute: Config.Execute;
|
|
887
846
|
/**
|
|
888
|
-
*
|
|
847
|
+
* Preload configuration. Explicit slugs are returned as an array; dynamic preload
|
|
848
|
+
* is returned as "all".
|
|
889
849
|
*/
|
|
890
|
-
|
|
850
|
+
preload: Config.Preload;
|
|
891
851
|
/**
|
|
892
|
-
*
|
|
852
|
+
* Search helper configuration
|
|
893
853
|
*/
|
|
894
|
-
|
|
854
|
+
search: Config.Search;
|
|
895
855
|
/**
|
|
896
|
-
*
|
|
856
|
+
* User identifier for this session
|
|
897
857
|
*/
|
|
898
|
-
|
|
858
|
+
user_id: string;
|
|
899
859
|
/**
|
|
900
|
-
*
|
|
860
|
+
* Auth config overrides per toolkit
|
|
901
861
|
*/
|
|
902
|
-
|
|
862
|
+
auth_configs?: {
|
|
863
|
+
[key: string]: string;
|
|
864
|
+
};
|
|
903
865
|
/**
|
|
904
|
-
*
|
|
866
|
+
* Connected account overrides per toolkit. Each connected account must belong to
|
|
867
|
+
* the same user_id as the session.
|
|
905
868
|
*/
|
|
906
|
-
|
|
869
|
+
connected_accounts?: {
|
|
870
|
+
[key: string]: string;
|
|
871
|
+
};
|
|
907
872
|
/**
|
|
908
|
-
*
|
|
909
|
-
* known parameters")
|
|
873
|
+
* Manage connections configuration
|
|
910
874
|
*/
|
|
911
|
-
|
|
875
|
+
manage_connections?: Config.ManageConnections;
|
|
912
876
|
/**
|
|
913
|
-
*
|
|
914
|
-
* present for failed queries.
|
|
877
|
+
* Multi-account configuration for this session.
|
|
915
878
|
*/
|
|
916
|
-
|
|
879
|
+
multi_account?: Config.MultiAccount;
|
|
917
880
|
/**
|
|
918
|
-
*
|
|
919
|
-
*
|
|
881
|
+
* MCP tool annotation hints for filtering tools with enabled/disabled support.
|
|
882
|
+
* enabled: tags that the tool must have at least one of. disabled: tags that the
|
|
883
|
+
* tool must NOT have any of. Both conditions must be satisfied.
|
|
920
884
|
*/
|
|
921
|
-
|
|
885
|
+
tags?: Config.Tags;
|
|
922
886
|
/**
|
|
923
|
-
*
|
|
887
|
+
* Toolkit configuration - either enabled list or disabled list
|
|
924
888
|
*/
|
|
925
|
-
|
|
889
|
+
toolkits?: Config.Enabled | Config.Disabled;
|
|
926
890
|
/**
|
|
927
|
-
*
|
|
928
|
-
* search results.
|
|
891
|
+
* Tool-level configuration per toolkit
|
|
929
892
|
*/
|
|
930
|
-
|
|
931
|
-
[key: string]:
|
|
893
|
+
tools?: {
|
|
894
|
+
[key: string]: Config.Enabled | Config.Disabled | Config.Tags;
|
|
932
895
|
};
|
|
933
896
|
/**
|
|
934
|
-
*
|
|
897
|
+
* Workbench configuration
|
|
935
898
|
*/
|
|
936
|
-
|
|
899
|
+
workbench?: Config.Workbench;
|
|
900
|
+
}
|
|
901
|
+
namespace Config {
|
|
937
902
|
/**
|
|
938
|
-
*
|
|
903
|
+
* Execute helper configuration
|
|
939
904
|
*/
|
|
940
|
-
|
|
905
|
+
interface Execute {
|
|
906
|
+
enable_multi_execute?: boolean;
|
|
907
|
+
}
|
|
941
908
|
/**
|
|
942
|
-
*
|
|
943
|
-
*
|
|
909
|
+
* Preload configuration. Explicit slugs are returned as an array; dynamic preload
|
|
910
|
+
* is returned as "all".
|
|
944
911
|
*/
|
|
945
|
-
|
|
946
|
-
}
|
|
947
|
-
namespace Result {
|
|
948
|
-
interface ReferenceWorkbenchSnippet {
|
|
949
|
-
/**
|
|
950
|
-
* Python code snippet for the workbench
|
|
951
|
-
*/
|
|
952
|
-
code: string;
|
|
912
|
+
interface Preload {
|
|
953
913
|
/**
|
|
954
|
-
*
|
|
914
|
+
* Explicit preloaded tool slugs, or "all" when the session dynamically exposes all
|
|
915
|
+
* app tools allowed by its filters.
|
|
955
916
|
*/
|
|
956
|
-
|
|
917
|
+
tools: Array<string> | 'all';
|
|
957
918
|
}
|
|
958
|
-
}
|
|
959
|
-
/**
|
|
960
|
-
* Session info for correlating meta tool calls
|
|
961
|
-
*/
|
|
962
|
-
interface Session {
|
|
963
919
|
/**
|
|
964
|
-
*
|
|
920
|
+
* Search helper configuration
|
|
965
921
|
*/
|
|
966
|
-
|
|
922
|
+
interface Search {
|
|
923
|
+
enable?: boolean;
|
|
924
|
+
}
|
|
967
925
|
/**
|
|
968
|
-
*
|
|
926
|
+
* Manage connections configuration
|
|
969
927
|
*/
|
|
970
|
-
|
|
928
|
+
interface ManageConnections {
|
|
929
|
+
/**
|
|
930
|
+
* Custom callback URL for connected account auth flows
|
|
931
|
+
*/
|
|
932
|
+
callback_url?: string;
|
|
933
|
+
/**
|
|
934
|
+
* Enable the "remove" action in COMPOSIO_MANAGE_CONNECTIONS. Default true.
|
|
935
|
+
*/
|
|
936
|
+
enable_connection_removal?: boolean;
|
|
937
|
+
/**
|
|
938
|
+
* Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status.
|
|
939
|
+
* Default false. May not work reliably with GPT models.
|
|
940
|
+
*/
|
|
941
|
+
enable_wait_for_connections?: boolean;
|
|
942
|
+
/**
|
|
943
|
+
* Whether to enable the connection manager for automatic connection handling
|
|
944
|
+
*/
|
|
945
|
+
enabled?: boolean;
|
|
946
|
+
}
|
|
947
|
+
/**
|
|
948
|
+
* Multi-account configuration for this session.
|
|
949
|
+
*/
|
|
950
|
+
interface MultiAccount {
|
|
951
|
+
/**
|
|
952
|
+
* When true, enables multi-account mode for this session. When not set, falls back
|
|
953
|
+
* to org/project-level configuration.
|
|
954
|
+
*/
|
|
955
|
+
enable?: boolean;
|
|
956
|
+
/**
|
|
957
|
+
* Maximum number of connected accounts allowed per toolkit. Defaults to 5 when
|
|
958
|
+
* multi-account is enabled.
|
|
959
|
+
*/
|
|
960
|
+
max_accounts_per_toolkit?: number;
|
|
961
|
+
/**
|
|
962
|
+
* When true, require explicit account selection when multiple accounts are
|
|
963
|
+
* connected. When false (default), use the first/default account.
|
|
964
|
+
*/
|
|
965
|
+
require_explicit_selection?: boolean;
|
|
966
|
+
}
|
|
967
|
+
/**
|
|
968
|
+
* MCP tool annotation hints for filtering tools with enabled/disabled support.
|
|
969
|
+
* enabled: tags that the tool must have at least one of. disabled: tags that the
|
|
970
|
+
* tool must NOT have any of. Both conditions must be satisfied.
|
|
971
|
+
*/
|
|
972
|
+
interface Tags {
|
|
973
|
+
/**
|
|
974
|
+
* Tags that the tool must NOT have any of
|
|
975
|
+
*/
|
|
976
|
+
disabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
977
|
+
/**
|
|
978
|
+
* Tags that the tool must have at least one of
|
|
979
|
+
*/
|
|
980
|
+
enabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
981
|
+
}
|
|
982
|
+
interface Enabled {
|
|
983
|
+
enabled: Array<string>;
|
|
984
|
+
}
|
|
985
|
+
interface Disabled {
|
|
986
|
+
disabled: Array<string>;
|
|
987
|
+
}
|
|
988
|
+
interface Enabled {
|
|
989
|
+
enabled: Array<string>;
|
|
990
|
+
}
|
|
991
|
+
interface Disabled {
|
|
992
|
+
disabled: Array<string>;
|
|
993
|
+
}
|
|
994
|
+
interface Tags {
|
|
995
|
+
tags: Tags.Tags;
|
|
996
|
+
}
|
|
997
|
+
namespace Tags {
|
|
998
|
+
interface Tags {
|
|
999
|
+
/**
|
|
1000
|
+
* Tags that the tool must NOT have any of
|
|
1001
|
+
*/
|
|
1002
|
+
disabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1003
|
+
/**
|
|
1004
|
+
* Tags that the tool must have at least one of
|
|
1005
|
+
*/
|
|
1006
|
+
enabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1007
|
+
}
|
|
1008
|
+
}
|
|
1009
|
+
/**
|
|
1010
|
+
* Workbench configuration
|
|
1011
|
+
*/
|
|
1012
|
+
interface Workbench {
|
|
1013
|
+
/**
|
|
1014
|
+
* Character threshold after which tool execution response are saved to a file in
|
|
1015
|
+
* workbench. Default is 20k.
|
|
1016
|
+
*/
|
|
1017
|
+
auto_offload_threshold?: number;
|
|
1018
|
+
/**
|
|
1019
|
+
* Whether the workbench (code execution sandbox) is enabled. When false,
|
|
1020
|
+
* COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
|
|
1021
|
+
*/
|
|
1022
|
+
enable?: boolean;
|
|
1023
|
+
/**
|
|
1024
|
+
* Whether proxy execution is enabled in the workbench
|
|
1025
|
+
*/
|
|
1026
|
+
proxy_execution_enabled?: boolean;
|
|
1027
|
+
/**
|
|
1028
|
+
* Sandbox compute tier: standard (1 vCPU / 1 GB), medium (2 vCPU / 2 GB), large (4
|
|
1029
|
+
* vCPU / 4 GB), xlarge (8 vCPU / 8 GB). Defaults to standard.
|
|
1030
|
+
*/
|
|
1031
|
+
sandbox_size?: 'standard' | 'medium' | 'large' | 'xlarge';
|
|
1032
|
+
}
|
|
1033
|
+
}
|
|
1034
|
+
interface Mcp {
|
|
1035
|
+
/**
|
|
1036
|
+
* The type of the MCP server. Can be http
|
|
1037
|
+
*/
|
|
1038
|
+
type: 'http';
|
|
1039
|
+
/**
|
|
1040
|
+
* The URL of the MCP server
|
|
1041
|
+
*/
|
|
1042
|
+
url: string;
|
|
1043
|
+
}
|
|
1044
|
+
/**
|
|
1045
|
+
* Experimental features
|
|
1046
|
+
*/
|
|
1047
|
+
interface Experimental {
|
|
1048
|
+
/**
|
|
1049
|
+
* The assistive system prompt for the tool router session
|
|
1050
|
+
*/
|
|
1051
|
+
assistive_prompt?: string;
|
|
1052
|
+
/**
|
|
1053
|
+
* User-defined custom toolkits with grouped tools (no-auth)
|
|
1054
|
+
*/
|
|
1055
|
+
custom_toolkits?: Array<Experimental.CustomToolkit>;
|
|
1056
|
+
/**
|
|
1057
|
+
* Custom tools — standalone or extending Composio toolkits
|
|
1058
|
+
*/
|
|
1059
|
+
custom_tools?: Array<Experimental.CustomTool>;
|
|
1060
|
+
}
|
|
1061
|
+
namespace Experimental {
|
|
1062
|
+
interface CustomToolkit {
|
|
1063
|
+
description: string;
|
|
1064
|
+
name: string;
|
|
1065
|
+
slug: string;
|
|
1066
|
+
tools: Array<CustomToolkit.Tool>;
|
|
1067
|
+
}
|
|
1068
|
+
namespace CustomToolkit {
|
|
1069
|
+
interface Tool {
|
|
1070
|
+
description: string;
|
|
1071
|
+
input_schema: {
|
|
1072
|
+
[key: string]: unknown;
|
|
1073
|
+
};
|
|
1074
|
+
name: string;
|
|
1075
|
+
/**
|
|
1076
|
+
* Original tool slug as provided by the user
|
|
1077
|
+
*/
|
|
1078
|
+
original_slug: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)
|
|
1081
|
+
*/
|
|
1082
|
+
slug: string;
|
|
1083
|
+
output_schema?: {
|
|
1084
|
+
[key: string]: unknown;
|
|
1085
|
+
};
|
|
1086
|
+
}
|
|
1087
|
+
}
|
|
1088
|
+
interface CustomTool {
|
|
1089
|
+
description: string;
|
|
1090
|
+
input_schema: {
|
|
1091
|
+
[key: string]: unknown;
|
|
1092
|
+
};
|
|
1093
|
+
name: string;
|
|
1094
|
+
/**
|
|
1095
|
+
* Original tool slug as provided by the user
|
|
1096
|
+
*/
|
|
1097
|
+
original_slug: string;
|
|
1098
|
+
/**
|
|
1099
|
+
* Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)
|
|
1100
|
+
*/
|
|
1101
|
+
slug: string;
|
|
1102
|
+
extends_toolkit?: string;
|
|
1103
|
+
output_schema?: {
|
|
1104
|
+
[key: string]: unknown;
|
|
1105
|
+
};
|
|
1106
|
+
}
|
|
1107
|
+
}
|
|
1108
|
+
interface Warning {
|
|
1109
|
+
/**
|
|
1110
|
+
* Stable machine code identifying the advisory. Safe to switch on in client code.
|
|
1111
|
+
*/
|
|
1112
|
+
code: 'PRELOAD_TOOLS_HIGH_CONTEXT_USAGE';
|
|
1113
|
+
/**
|
|
1114
|
+
* Human-readable description of the advisory. Suitable for logging or surfacing to
|
|
1115
|
+
* end users.
|
|
1116
|
+
*/
|
|
1117
|
+
message: string;
|
|
1118
|
+
}
|
|
1119
|
+
}
|
|
1120
|
+
export interface SessionConfigHistoryResponse {
|
|
1121
|
+
current_page: number;
|
|
1122
|
+
items: Array<SessionConfigHistoryResponse.Item>;
|
|
1123
|
+
total_items: number;
|
|
1124
|
+
total_pages: number;
|
|
1125
|
+
next_cursor?: string | null;
|
|
1126
|
+
}
|
|
1127
|
+
export declare namespace SessionConfigHistoryResponse {
|
|
1128
|
+
interface Item {
|
|
1129
|
+
/**
|
|
1130
|
+
* The session configuration at this version
|
|
1131
|
+
*/
|
|
1132
|
+
config: Item.Config;
|
|
1133
|
+
/**
|
|
1134
|
+
* ISO timestamp. For history rows, when the entry was archived (i.e. the moment
|
|
1135
|
+
* the version was superseded by a PATCH).
|
|
1136
|
+
*/
|
|
1137
|
+
created_at: string;
|
|
1138
|
+
/**
|
|
1139
|
+
* True only for the live (current) session config, present on the first page.
|
|
1140
|
+
* False for archived history rows.
|
|
1141
|
+
*/
|
|
1142
|
+
is_current: boolean;
|
|
1143
|
+
/**
|
|
1144
|
+
* The config version this entry represents
|
|
1145
|
+
*/
|
|
1146
|
+
version: number;
|
|
1147
|
+
}
|
|
1148
|
+
namespace Item {
|
|
1149
|
+
/**
|
|
1150
|
+
* The session configuration at this version
|
|
1151
|
+
*/
|
|
1152
|
+
interface Config {
|
|
1153
|
+
/**
|
|
1154
|
+
* Execute helper configuration
|
|
1155
|
+
*/
|
|
1156
|
+
execute: Config.Execute;
|
|
1157
|
+
/**
|
|
1158
|
+
* Preload configuration. Explicit slugs are returned as an array; dynamic preload
|
|
1159
|
+
* is returned as "all".
|
|
1160
|
+
*/
|
|
1161
|
+
preload: Config.Preload;
|
|
1162
|
+
/**
|
|
1163
|
+
* Search helper configuration
|
|
1164
|
+
*/
|
|
1165
|
+
search: Config.Search;
|
|
1166
|
+
/**
|
|
1167
|
+
* User identifier for this session
|
|
1168
|
+
*/
|
|
1169
|
+
user_id: string;
|
|
1170
|
+
/**
|
|
1171
|
+
* Auth config overrides per toolkit
|
|
1172
|
+
*/
|
|
1173
|
+
auth_configs?: {
|
|
1174
|
+
[key: string]: string;
|
|
1175
|
+
};
|
|
1176
|
+
/**
|
|
1177
|
+
* Connected account overrides per toolkit. Each connected account must belong to
|
|
1178
|
+
* the same user_id as the session.
|
|
1179
|
+
*/
|
|
1180
|
+
connected_accounts?: {
|
|
1181
|
+
[key: string]: string;
|
|
1182
|
+
};
|
|
1183
|
+
/**
|
|
1184
|
+
* Manage connections configuration
|
|
1185
|
+
*/
|
|
1186
|
+
manage_connections?: Config.ManageConnections;
|
|
1187
|
+
/**
|
|
1188
|
+
* Multi-account configuration for this session.
|
|
1189
|
+
*/
|
|
1190
|
+
multi_account?: Config.MultiAccount;
|
|
1191
|
+
/**
|
|
1192
|
+
* MCP tool annotation hints for filtering tools with enabled/disabled support.
|
|
1193
|
+
* enabled: tags that the tool must have at least one of. disabled: tags that the
|
|
1194
|
+
* tool must NOT have any of. Both conditions must be satisfied.
|
|
1195
|
+
*/
|
|
1196
|
+
tags?: Config.Tags;
|
|
1197
|
+
/**
|
|
1198
|
+
* Toolkit configuration - either enabled list or disabled list
|
|
1199
|
+
*/
|
|
1200
|
+
toolkits?: Config.Enabled | Config.Disabled;
|
|
1201
|
+
/**
|
|
1202
|
+
* Tool-level configuration per toolkit
|
|
1203
|
+
*/
|
|
1204
|
+
tools?: {
|
|
1205
|
+
[key: string]: Config.Enabled | Config.Disabled | Config.Tags;
|
|
1206
|
+
};
|
|
1207
|
+
/**
|
|
1208
|
+
* Workbench configuration
|
|
1209
|
+
*/
|
|
1210
|
+
workbench?: Config.Workbench;
|
|
1211
|
+
}
|
|
1212
|
+
namespace Config {
|
|
1213
|
+
/**
|
|
1214
|
+
* Execute helper configuration
|
|
1215
|
+
*/
|
|
1216
|
+
interface Execute {
|
|
1217
|
+
enable_multi_execute?: boolean;
|
|
1218
|
+
}
|
|
1219
|
+
/**
|
|
1220
|
+
* Preload configuration. Explicit slugs are returned as an array; dynamic preload
|
|
1221
|
+
* is returned as "all".
|
|
1222
|
+
*/
|
|
1223
|
+
interface Preload {
|
|
1224
|
+
/**
|
|
1225
|
+
* Explicit preloaded tool slugs, or "all" when the session dynamically exposes all
|
|
1226
|
+
* app tools allowed by its filters.
|
|
1227
|
+
*/
|
|
1228
|
+
tools: Array<string> | 'all';
|
|
1229
|
+
}
|
|
1230
|
+
/**
|
|
1231
|
+
* Search helper configuration
|
|
1232
|
+
*/
|
|
1233
|
+
interface Search {
|
|
1234
|
+
enable?: boolean;
|
|
1235
|
+
}
|
|
1236
|
+
/**
|
|
1237
|
+
* Manage connections configuration
|
|
1238
|
+
*/
|
|
1239
|
+
interface ManageConnections {
|
|
1240
|
+
/**
|
|
1241
|
+
* Custom callback URL for connected account auth flows
|
|
1242
|
+
*/
|
|
1243
|
+
callback_url?: string;
|
|
1244
|
+
/**
|
|
1245
|
+
* Enable the "remove" action in COMPOSIO_MANAGE_CONNECTIONS. Default true.
|
|
1246
|
+
*/
|
|
1247
|
+
enable_connection_removal?: boolean;
|
|
1248
|
+
/**
|
|
1249
|
+
* Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status.
|
|
1250
|
+
* Default false. May not work reliably with GPT models.
|
|
1251
|
+
*/
|
|
1252
|
+
enable_wait_for_connections?: boolean;
|
|
1253
|
+
/**
|
|
1254
|
+
* Whether to enable the connection manager for automatic connection handling
|
|
1255
|
+
*/
|
|
1256
|
+
enabled?: boolean;
|
|
1257
|
+
}
|
|
1258
|
+
/**
|
|
1259
|
+
* Multi-account configuration for this session.
|
|
1260
|
+
*/
|
|
1261
|
+
interface MultiAccount {
|
|
1262
|
+
/**
|
|
1263
|
+
* When true, enables multi-account mode for this session. When not set, falls back
|
|
1264
|
+
* to org/project-level configuration.
|
|
1265
|
+
*/
|
|
1266
|
+
enable?: boolean;
|
|
1267
|
+
/**
|
|
1268
|
+
* Maximum number of connected accounts allowed per toolkit. Defaults to 5 when
|
|
1269
|
+
* multi-account is enabled.
|
|
1270
|
+
*/
|
|
1271
|
+
max_accounts_per_toolkit?: number;
|
|
1272
|
+
/**
|
|
1273
|
+
* When true, require explicit account selection when multiple accounts are
|
|
1274
|
+
* connected. When false (default), use the first/default account.
|
|
1275
|
+
*/
|
|
1276
|
+
require_explicit_selection?: boolean;
|
|
1277
|
+
}
|
|
1278
|
+
/**
|
|
1279
|
+
* MCP tool annotation hints for filtering tools with enabled/disabled support.
|
|
1280
|
+
* enabled: tags that the tool must have at least one of. disabled: tags that the
|
|
1281
|
+
* tool must NOT have any of. Both conditions must be satisfied.
|
|
1282
|
+
*/
|
|
1283
|
+
interface Tags {
|
|
1284
|
+
/**
|
|
1285
|
+
* Tags that the tool must NOT have any of
|
|
1286
|
+
*/
|
|
1287
|
+
disabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1288
|
+
/**
|
|
1289
|
+
* Tags that the tool must have at least one of
|
|
1290
|
+
*/
|
|
1291
|
+
enabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1292
|
+
}
|
|
1293
|
+
interface Enabled {
|
|
1294
|
+
enabled: Array<string>;
|
|
1295
|
+
}
|
|
1296
|
+
interface Disabled {
|
|
1297
|
+
disabled: Array<string>;
|
|
1298
|
+
}
|
|
1299
|
+
interface Enabled {
|
|
1300
|
+
enabled: Array<string>;
|
|
1301
|
+
}
|
|
1302
|
+
interface Disabled {
|
|
1303
|
+
disabled: Array<string>;
|
|
1304
|
+
}
|
|
1305
|
+
interface Tags {
|
|
1306
|
+
tags: Tags.Tags;
|
|
1307
|
+
}
|
|
1308
|
+
namespace Tags {
|
|
1309
|
+
interface Tags {
|
|
1310
|
+
/**
|
|
1311
|
+
* Tags that the tool must NOT have any of
|
|
1312
|
+
*/
|
|
1313
|
+
disabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1314
|
+
/**
|
|
1315
|
+
* Tags that the tool must have at least one of
|
|
1316
|
+
*/
|
|
1317
|
+
enabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1318
|
+
}
|
|
1319
|
+
}
|
|
1320
|
+
/**
|
|
1321
|
+
* Workbench configuration
|
|
1322
|
+
*/
|
|
1323
|
+
interface Workbench {
|
|
1324
|
+
/**
|
|
1325
|
+
* Character threshold after which tool execution response are saved to a file in
|
|
1326
|
+
* workbench. Default is 20k.
|
|
1327
|
+
*/
|
|
1328
|
+
auto_offload_threshold?: number;
|
|
1329
|
+
/**
|
|
1330
|
+
* Whether the workbench (code execution sandbox) is enabled. When false,
|
|
1331
|
+
* COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
|
|
1332
|
+
*/
|
|
1333
|
+
enable?: boolean;
|
|
1334
|
+
/**
|
|
1335
|
+
* Whether proxy execution is enabled in the workbench
|
|
1336
|
+
*/
|
|
1337
|
+
proxy_execution_enabled?: boolean;
|
|
1338
|
+
/**
|
|
1339
|
+
* Sandbox compute tier: standard (1 vCPU / 1 GB), medium (2 vCPU / 2 GB), large (4
|
|
1340
|
+
* vCPU / 4 GB), xlarge (8 vCPU / 8 GB). Defaults to standard.
|
|
1341
|
+
*/
|
|
1342
|
+
sandbox_size?: 'standard' | 'medium' | 'large' | 'xlarge';
|
|
1343
|
+
}
|
|
1344
|
+
}
|
|
1345
|
+
}
|
|
1346
|
+
}
|
|
1347
|
+
export interface SessionExecuteResponse {
|
|
1348
|
+
/**
|
|
1349
|
+
* The data returned by the tool execution
|
|
1350
|
+
*/
|
|
1351
|
+
data: {
|
|
1352
|
+
[key: string]: unknown;
|
|
1353
|
+
};
|
|
1354
|
+
/**
|
|
1355
|
+
* Error message if the execution failed, null otherwise
|
|
1356
|
+
*/
|
|
1357
|
+
error: string | null;
|
|
1358
|
+
/**
|
|
1359
|
+
* Unique identifier for the execution log
|
|
1360
|
+
*/
|
|
1361
|
+
log_id: string;
|
|
1362
|
+
}
|
|
1363
|
+
export interface SessionExecuteMetaResponse {
|
|
1364
|
+
/**
|
|
1365
|
+
* The data returned by the tool execution
|
|
1366
|
+
*/
|
|
1367
|
+
data: {
|
|
1368
|
+
[key: string]: unknown;
|
|
1369
|
+
};
|
|
1370
|
+
/**
|
|
1371
|
+
* Error message if the execution failed, null otherwise
|
|
1372
|
+
*/
|
|
1373
|
+
error: string | null;
|
|
1374
|
+
/**
|
|
1375
|
+
* Unique identifier for the execution log
|
|
1376
|
+
*/
|
|
1377
|
+
log_id: string;
|
|
1378
|
+
}
|
|
1379
|
+
export interface SessionLinkResponse {
|
|
1380
|
+
/**
|
|
1381
|
+
* The unique identifier for the connected account
|
|
1382
|
+
*/
|
|
1383
|
+
connected_account_id: string;
|
|
1384
|
+
/**
|
|
1385
|
+
* Token used to complete the authentication flow
|
|
1386
|
+
*/
|
|
1387
|
+
link_token: string;
|
|
1388
|
+
/**
|
|
1389
|
+
* The URL where users should be redirected to complete OAuth
|
|
1390
|
+
*/
|
|
1391
|
+
redirect_url: string;
|
|
1392
|
+
}
|
|
1393
|
+
export interface SessionPatchResponse {
|
|
1394
|
+
/**
|
|
1395
|
+
* The configuration used to create this session
|
|
1396
|
+
*/
|
|
1397
|
+
config: SessionPatchResponse.Config;
|
|
1398
|
+
/**
|
|
1399
|
+
* Monotonic version of the config. Incremented on each PATCH. Use for optimistic
|
|
1400
|
+
* concurrency control.
|
|
1401
|
+
*/
|
|
1402
|
+
config_version: number;
|
|
1403
|
+
mcp: SessionPatchResponse.Mcp;
|
|
1404
|
+
/**
|
|
1405
|
+
* The identifier of the session
|
|
1406
|
+
*/
|
|
1407
|
+
session_id: string;
|
|
1408
|
+
/**
|
|
1409
|
+
* List of available tools in this session
|
|
1410
|
+
*/
|
|
1411
|
+
tool_router_tools: Array<string>;
|
|
1412
|
+
/**
|
|
1413
|
+
* Experimental features
|
|
1414
|
+
*/
|
|
1415
|
+
experimental?: SessionPatchResponse.Experimental;
|
|
1416
|
+
/**
|
|
1417
|
+
* Advisory list — the session exists and is usable, but the listed issues may
|
|
1418
|
+
* warrant attention.
|
|
1419
|
+
*/
|
|
1420
|
+
warnings?: Array<SessionPatchResponse.Warning>;
|
|
1421
|
+
}
|
|
1422
|
+
export declare namespace SessionPatchResponse {
|
|
1423
|
+
/**
|
|
1424
|
+
* The configuration used to create this session
|
|
1425
|
+
*/
|
|
1426
|
+
interface Config {
|
|
1427
|
+
/**
|
|
1428
|
+
* Execute helper configuration
|
|
1429
|
+
*/
|
|
1430
|
+
execute: Config.Execute;
|
|
1431
|
+
/**
|
|
1432
|
+
* Preload configuration. Explicit slugs are returned as an array; dynamic preload
|
|
1433
|
+
* is returned as "all".
|
|
1434
|
+
*/
|
|
1435
|
+
preload: Config.Preload;
|
|
1436
|
+
/**
|
|
1437
|
+
* Search helper configuration
|
|
1438
|
+
*/
|
|
1439
|
+
search: Config.Search;
|
|
1440
|
+
/**
|
|
1441
|
+
* User identifier for this session
|
|
1442
|
+
*/
|
|
1443
|
+
user_id: string;
|
|
1444
|
+
/**
|
|
1445
|
+
* Auth config overrides per toolkit
|
|
1446
|
+
*/
|
|
1447
|
+
auth_configs?: {
|
|
1448
|
+
[key: string]: string;
|
|
1449
|
+
};
|
|
1450
|
+
/**
|
|
1451
|
+
* Connected account overrides per toolkit. Each connected account must belong to
|
|
1452
|
+
* the same user_id as the session.
|
|
1453
|
+
*/
|
|
1454
|
+
connected_accounts?: {
|
|
1455
|
+
[key: string]: string;
|
|
1456
|
+
};
|
|
1457
|
+
/**
|
|
1458
|
+
* Manage connections configuration
|
|
1459
|
+
*/
|
|
1460
|
+
manage_connections?: Config.ManageConnections;
|
|
1461
|
+
/**
|
|
1462
|
+
* Multi-account configuration for this session.
|
|
1463
|
+
*/
|
|
1464
|
+
multi_account?: Config.MultiAccount;
|
|
1465
|
+
/**
|
|
1466
|
+
* MCP tool annotation hints for filtering tools with enabled/disabled support.
|
|
1467
|
+
* enabled: tags that the tool must have at least one of. disabled: tags that the
|
|
1468
|
+
* tool must NOT have any of. Both conditions must be satisfied.
|
|
1469
|
+
*/
|
|
1470
|
+
tags?: Config.Tags;
|
|
1471
|
+
/**
|
|
1472
|
+
* Toolkit configuration - either enabled list or disabled list
|
|
1473
|
+
*/
|
|
1474
|
+
toolkits?: Config.Enabled | Config.Disabled;
|
|
1475
|
+
/**
|
|
1476
|
+
* Tool-level configuration per toolkit
|
|
1477
|
+
*/
|
|
1478
|
+
tools?: {
|
|
1479
|
+
[key: string]: Config.Enabled | Config.Disabled | Config.Tags;
|
|
1480
|
+
};
|
|
1481
|
+
/**
|
|
1482
|
+
* Workbench configuration
|
|
1483
|
+
*/
|
|
1484
|
+
workbench?: Config.Workbench;
|
|
1485
|
+
}
|
|
1486
|
+
namespace Config {
|
|
1487
|
+
/**
|
|
1488
|
+
* Execute helper configuration
|
|
1489
|
+
*/
|
|
1490
|
+
interface Execute {
|
|
1491
|
+
enable_multi_execute?: boolean;
|
|
1492
|
+
}
|
|
1493
|
+
/**
|
|
1494
|
+
* Preload configuration. Explicit slugs are returned as an array; dynamic preload
|
|
1495
|
+
* is returned as "all".
|
|
1496
|
+
*/
|
|
1497
|
+
interface Preload {
|
|
1498
|
+
/**
|
|
1499
|
+
* Explicit preloaded tool slugs, or "all" when the session dynamically exposes all
|
|
1500
|
+
* app tools allowed by its filters.
|
|
1501
|
+
*/
|
|
1502
|
+
tools: Array<string> | 'all';
|
|
1503
|
+
}
|
|
1504
|
+
/**
|
|
1505
|
+
* Search helper configuration
|
|
1506
|
+
*/
|
|
1507
|
+
interface Search {
|
|
1508
|
+
enable?: boolean;
|
|
1509
|
+
}
|
|
1510
|
+
/**
|
|
1511
|
+
* Manage connections configuration
|
|
1512
|
+
*/
|
|
1513
|
+
interface ManageConnections {
|
|
1514
|
+
/**
|
|
1515
|
+
* Custom callback URL for connected account auth flows
|
|
1516
|
+
*/
|
|
1517
|
+
callback_url?: string;
|
|
1518
|
+
/**
|
|
1519
|
+
* Enable the "remove" action in COMPOSIO_MANAGE_CONNECTIONS. Default true.
|
|
1520
|
+
*/
|
|
1521
|
+
enable_connection_removal?: boolean;
|
|
1522
|
+
/**
|
|
1523
|
+
* Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status.
|
|
1524
|
+
* Default false. May not work reliably with GPT models.
|
|
1525
|
+
*/
|
|
1526
|
+
enable_wait_for_connections?: boolean;
|
|
1527
|
+
/**
|
|
1528
|
+
* Whether to enable the connection manager for automatic connection handling
|
|
1529
|
+
*/
|
|
1530
|
+
enabled?: boolean;
|
|
1531
|
+
}
|
|
1532
|
+
/**
|
|
1533
|
+
* Multi-account configuration for this session.
|
|
1534
|
+
*/
|
|
1535
|
+
interface MultiAccount {
|
|
1536
|
+
/**
|
|
1537
|
+
* When true, enables multi-account mode for this session. When not set, falls back
|
|
1538
|
+
* to org/project-level configuration.
|
|
1539
|
+
*/
|
|
1540
|
+
enable?: boolean;
|
|
1541
|
+
/**
|
|
1542
|
+
* Maximum number of connected accounts allowed per toolkit. Defaults to 5 when
|
|
1543
|
+
* multi-account is enabled.
|
|
1544
|
+
*/
|
|
1545
|
+
max_accounts_per_toolkit?: number;
|
|
1546
|
+
/**
|
|
1547
|
+
* When true, require explicit account selection when multiple accounts are
|
|
1548
|
+
* connected. When false (default), use the first/default account.
|
|
1549
|
+
*/
|
|
1550
|
+
require_explicit_selection?: boolean;
|
|
1551
|
+
}
|
|
1552
|
+
/**
|
|
1553
|
+
* MCP tool annotation hints for filtering tools with enabled/disabled support.
|
|
1554
|
+
* enabled: tags that the tool must have at least one of. disabled: tags that the
|
|
1555
|
+
* tool must NOT have any of. Both conditions must be satisfied.
|
|
1556
|
+
*/
|
|
1557
|
+
interface Tags {
|
|
1558
|
+
/**
|
|
1559
|
+
* Tags that the tool must NOT have any of
|
|
1560
|
+
*/
|
|
1561
|
+
disabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1562
|
+
/**
|
|
1563
|
+
* Tags that the tool must have at least one of
|
|
1564
|
+
*/
|
|
1565
|
+
enabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1566
|
+
}
|
|
1567
|
+
interface Enabled {
|
|
1568
|
+
enabled: Array<string>;
|
|
1569
|
+
}
|
|
1570
|
+
interface Disabled {
|
|
1571
|
+
disabled: Array<string>;
|
|
1572
|
+
}
|
|
1573
|
+
interface Enabled {
|
|
1574
|
+
enabled: Array<string>;
|
|
1575
|
+
}
|
|
1576
|
+
interface Disabled {
|
|
1577
|
+
disabled: Array<string>;
|
|
1578
|
+
}
|
|
1579
|
+
interface Tags {
|
|
1580
|
+
tags: Tags.Tags;
|
|
1581
|
+
}
|
|
1582
|
+
namespace Tags {
|
|
1583
|
+
interface Tags {
|
|
1584
|
+
/**
|
|
1585
|
+
* Tags that the tool must NOT have any of
|
|
1586
|
+
*/
|
|
1587
|
+
disabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1588
|
+
/**
|
|
1589
|
+
* Tags that the tool must have at least one of
|
|
1590
|
+
*/
|
|
1591
|
+
enabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1592
|
+
}
|
|
1593
|
+
}
|
|
1594
|
+
/**
|
|
1595
|
+
* Workbench configuration
|
|
1596
|
+
*/
|
|
1597
|
+
interface Workbench {
|
|
1598
|
+
/**
|
|
1599
|
+
* Character threshold after which tool execution response are saved to a file in
|
|
1600
|
+
* workbench. Default is 20k.
|
|
1601
|
+
*/
|
|
1602
|
+
auto_offload_threshold?: number;
|
|
1603
|
+
/**
|
|
1604
|
+
* Whether the workbench (code execution sandbox) is enabled. When false,
|
|
1605
|
+
* COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
|
|
1606
|
+
*/
|
|
1607
|
+
enable?: boolean;
|
|
1608
|
+
/**
|
|
1609
|
+
* Whether proxy execution is enabled in the workbench
|
|
1610
|
+
*/
|
|
1611
|
+
proxy_execution_enabled?: boolean;
|
|
1612
|
+
/**
|
|
1613
|
+
* Sandbox compute tier: standard (1 vCPU / 1 GB), medium (2 vCPU / 2 GB), large (4
|
|
1614
|
+
* vCPU / 4 GB), xlarge (8 vCPU / 8 GB). Defaults to standard.
|
|
1615
|
+
*/
|
|
1616
|
+
sandbox_size?: 'standard' | 'medium' | 'large' | 'xlarge';
|
|
1617
|
+
}
|
|
1618
|
+
}
|
|
1619
|
+
interface Mcp {
|
|
1620
|
+
/**
|
|
1621
|
+
* The type of the MCP server. Can be http
|
|
1622
|
+
*/
|
|
1623
|
+
type: 'http';
|
|
1624
|
+
/**
|
|
1625
|
+
* The URL of the MCP server
|
|
1626
|
+
*/
|
|
1627
|
+
url: string;
|
|
1628
|
+
}
|
|
1629
|
+
/**
|
|
1630
|
+
* Experimental features
|
|
1631
|
+
*/
|
|
1632
|
+
interface Experimental {
|
|
1633
|
+
/**
|
|
1634
|
+
* The assistive system prompt for the tool router session
|
|
1635
|
+
*/
|
|
1636
|
+
assistive_prompt?: string;
|
|
1637
|
+
/**
|
|
1638
|
+
* User-defined custom toolkits with grouped tools (no-auth)
|
|
1639
|
+
*/
|
|
1640
|
+
custom_toolkits?: Array<Experimental.CustomToolkit>;
|
|
1641
|
+
/**
|
|
1642
|
+
* Custom tools — standalone or extending Composio toolkits
|
|
1643
|
+
*/
|
|
1644
|
+
custom_tools?: Array<Experimental.CustomTool>;
|
|
1645
|
+
}
|
|
1646
|
+
namespace Experimental {
|
|
1647
|
+
interface CustomToolkit {
|
|
1648
|
+
description: string;
|
|
1649
|
+
name: string;
|
|
1650
|
+
slug: string;
|
|
1651
|
+
tools: Array<CustomToolkit.Tool>;
|
|
1652
|
+
}
|
|
1653
|
+
namespace CustomToolkit {
|
|
1654
|
+
interface Tool {
|
|
1655
|
+
description: string;
|
|
1656
|
+
input_schema: {
|
|
1657
|
+
[key: string]: unknown;
|
|
1658
|
+
};
|
|
1659
|
+
name: string;
|
|
1660
|
+
/**
|
|
1661
|
+
* Original tool slug as provided by the user
|
|
1662
|
+
*/
|
|
1663
|
+
original_slug: string;
|
|
1664
|
+
/**
|
|
1665
|
+
* Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)
|
|
1666
|
+
*/
|
|
1667
|
+
slug: string;
|
|
1668
|
+
output_schema?: {
|
|
1669
|
+
[key: string]: unknown;
|
|
1670
|
+
};
|
|
1671
|
+
}
|
|
1672
|
+
}
|
|
1673
|
+
interface CustomTool {
|
|
1674
|
+
description: string;
|
|
1675
|
+
input_schema: {
|
|
1676
|
+
[key: string]: unknown;
|
|
1677
|
+
};
|
|
1678
|
+
name: string;
|
|
1679
|
+
/**
|
|
1680
|
+
* Original tool slug as provided by the user
|
|
1681
|
+
*/
|
|
1682
|
+
original_slug: string;
|
|
1683
|
+
/**
|
|
1684
|
+
* Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)
|
|
1685
|
+
*/
|
|
1686
|
+
slug: string;
|
|
1687
|
+
extends_toolkit?: string;
|
|
1688
|
+
output_schema?: {
|
|
1689
|
+
[key: string]: unknown;
|
|
1690
|
+
};
|
|
1691
|
+
}
|
|
1692
|
+
}
|
|
1693
|
+
interface Warning {
|
|
1694
|
+
/**
|
|
1695
|
+
* Stable machine code identifying the advisory. Safe to switch on in client code.
|
|
1696
|
+
*/
|
|
1697
|
+
code: 'PRELOAD_TOOLS_HIGH_CONTEXT_USAGE';
|
|
1698
|
+
/**
|
|
1699
|
+
* Human-readable description of the advisory. Suitable for logging or surfacing to
|
|
1700
|
+
* end users.
|
|
1701
|
+
*/
|
|
1702
|
+
message: string;
|
|
1703
|
+
}
|
|
1704
|
+
}
|
|
1705
|
+
export interface SessionProxyExecuteResponse {
|
|
1706
|
+
/**
|
|
1707
|
+
* The HTTP status code returned from the proxied API
|
|
1708
|
+
*/
|
|
1709
|
+
status: number;
|
|
1710
|
+
/**
|
|
1711
|
+
* Binary body response data. Present when the response is a binary file.
|
|
1712
|
+
*/
|
|
1713
|
+
binary_data?: SessionProxyExecuteResponse.BinaryData;
|
|
1714
|
+
/**
|
|
1715
|
+
* The response data returned from the proxied API
|
|
1716
|
+
*/
|
|
1717
|
+
data?: unknown;
|
|
1718
|
+
/**
|
|
1719
|
+
* The HTTP headers returned from the proxied API
|
|
1720
|
+
*/
|
|
1721
|
+
headers?: {
|
|
1722
|
+
[key: string]: string;
|
|
1723
|
+
};
|
|
1724
|
+
}
|
|
1725
|
+
export declare namespace SessionProxyExecuteResponse {
|
|
1726
|
+
/**
|
|
1727
|
+
* Binary body response data. Present when the response is a binary file.
|
|
1728
|
+
*/
|
|
1729
|
+
interface BinaryData {
|
|
1730
|
+
/**
|
|
1731
|
+
* Content-Type of the binary data
|
|
1732
|
+
*/
|
|
1733
|
+
content_type: string;
|
|
1734
|
+
/**
|
|
1735
|
+
* File size in bytes
|
|
1736
|
+
*/
|
|
1737
|
+
size: number;
|
|
1738
|
+
/**
|
|
1739
|
+
* URL to download binary content
|
|
1740
|
+
*/
|
|
1741
|
+
url: string;
|
|
1742
|
+
/**
|
|
1743
|
+
* ISO 8601 timestamp when the URL expires
|
|
1744
|
+
*/
|
|
1745
|
+
expires_at?: string;
|
|
1746
|
+
}
|
|
1747
|
+
}
|
|
1748
|
+
export interface SessionSearchResponse {
|
|
1749
|
+
/**
|
|
1750
|
+
* Error message if any searches failed, null if all succeeded. Format: "X out of Y
|
|
1751
|
+
* searches failed, reasons: <details>"
|
|
1752
|
+
*/
|
|
1753
|
+
error: string | null;
|
|
1754
|
+
/**
|
|
1755
|
+
* Combined workflow guidance covering connections, planner, and memory usage. Each
|
|
1756
|
+
* element is a step instruction.
|
|
1757
|
+
*/
|
|
1758
|
+
next_steps_guidance: Array<string>;
|
|
1759
|
+
/**
|
|
1760
|
+
* Per-query search results with tools, reasoning, and memory. One entry per query
|
|
1761
|
+
* in request order.
|
|
1762
|
+
*/
|
|
1763
|
+
results: Array<SessionSearchResponse.Result>;
|
|
1764
|
+
/**
|
|
1765
|
+
* Session info for correlating meta tool calls
|
|
1766
|
+
*/
|
|
1767
|
+
session: SessionSearchResponse.Session;
|
|
1768
|
+
/**
|
|
1769
|
+
* Whether all searches completed successfully. False if any query failed.
|
|
1770
|
+
*/
|
|
1771
|
+
success: boolean;
|
|
1772
|
+
/**
|
|
1773
|
+
* Time information for the query
|
|
1774
|
+
*/
|
|
1775
|
+
time_info: SessionSearchResponse.TimeInfo;
|
|
1776
|
+
/**
|
|
1777
|
+
* Deduplicated tool definitions keyed by tool_slug for O(1) lookup. Each tool
|
|
1778
|
+
* appears once even if used in multiple queries.
|
|
1779
|
+
*/
|
|
1780
|
+
tool_schemas: {
|
|
1781
|
+
[key: string]: SessionSearchResponse.ToolSchemas;
|
|
1782
|
+
};
|
|
1783
|
+
/**
|
|
1784
|
+
* Connection status for all toolkits mentioned across all queries, with
|
|
1785
|
+
* descriptions merged in.
|
|
1786
|
+
*/
|
|
1787
|
+
toolkit_connection_statuses: Array<SessionSearchResponse.ToolkitConnectionStatus>;
|
|
1788
|
+
}
|
|
1789
|
+
export declare namespace SessionSearchResponse {
|
|
1790
|
+
interface Result {
|
|
1791
|
+
/**
|
|
1792
|
+
* 1-based index of the query in the request
|
|
1793
|
+
*/
|
|
1794
|
+
index: number;
|
|
1795
|
+
/**
|
|
1796
|
+
* List of main tool slugs matching the search criteria
|
|
1797
|
+
*/
|
|
1798
|
+
primary_tool_slugs: Array<string>;
|
|
1799
|
+
/**
|
|
1800
|
+
* List of related tool slugs that might be useful
|
|
1801
|
+
*/
|
|
1802
|
+
related_tool_slugs: Array<string>;
|
|
1803
|
+
/**
|
|
1804
|
+
* List of unique toolkit slugs used by tools in this query
|
|
1805
|
+
*/
|
|
1806
|
+
toolkits: Array<string>;
|
|
1807
|
+
/**
|
|
1808
|
+
* The use case that was searched
|
|
1809
|
+
*/
|
|
1810
|
+
use_case: string;
|
|
1811
|
+
/**
|
|
1812
|
+
* Task difficulty assessment (e.g., "easy - Simple single-tool operation with
|
|
1813
|
+
* known parameters")
|
|
1814
|
+
*/
|
|
1815
|
+
difficulty?: string;
|
|
1816
|
+
/**
|
|
1817
|
+
* Error message if the search for this query failed, null otherwise. Always
|
|
1818
|
+
* present for failed queries.
|
|
1819
|
+
*/
|
|
1820
|
+
error?: string | null;
|
|
1821
|
+
/**
|
|
1822
|
+
* Guidance message about the search results, particularly when a cached plan is
|
|
1823
|
+
* available
|
|
1824
|
+
*/
|
|
1825
|
+
execution_guidance?: string;
|
|
1826
|
+
/**
|
|
1827
|
+
* Common pitfalls and considerations (only present when cached plan is available)
|
|
1828
|
+
*/
|
|
1829
|
+
known_pitfalls?: Array<string>;
|
|
1830
|
+
/**
|
|
1831
|
+
* Memory data relevant to this query, grouped by app. Only present for non-cached
|
|
1832
|
+
* search results.
|
|
1833
|
+
*/
|
|
1834
|
+
memory?: {
|
|
1835
|
+
[key: string]: Array<string>;
|
|
1836
|
+
};
|
|
1837
|
+
/**
|
|
1838
|
+
* ID of cached plan if available
|
|
1839
|
+
*/
|
|
1840
|
+
plan_id?: string;
|
|
1841
|
+
/**
|
|
1842
|
+
* Workflow steps from cached plan (only present when cached plan is available)
|
|
1843
|
+
*/
|
|
1844
|
+
recommended_plan_steps?: Array<string>;
|
|
1845
|
+
/**
|
|
1846
|
+
* Reference Python code snippets for processing tool responses in the workbench
|
|
1847
|
+
* (only present when cached plan is available)
|
|
1848
|
+
*/
|
|
1849
|
+
reference_workbench_snippets?: Array<Result.ReferenceWorkbenchSnippet>;
|
|
1850
|
+
}
|
|
1851
|
+
namespace Result {
|
|
1852
|
+
interface ReferenceWorkbenchSnippet {
|
|
1853
|
+
/**
|
|
1854
|
+
* Python code snippet for the workbench
|
|
1855
|
+
*/
|
|
1856
|
+
code: string;
|
|
1857
|
+
/**
|
|
1858
|
+
* Description of what the code snippet does
|
|
1859
|
+
*/
|
|
1860
|
+
description: string;
|
|
1861
|
+
}
|
|
1862
|
+
}
|
|
1863
|
+
/**
|
|
1864
|
+
* Session info for correlating meta tool calls
|
|
1865
|
+
*/
|
|
1866
|
+
interface Session {
|
|
1867
|
+
/**
|
|
1868
|
+
* Session identifier to be passed to subsequent meta tool calls as session_id.
|
|
1869
|
+
*/
|
|
1870
|
+
id: string;
|
|
1871
|
+
/**
|
|
1872
|
+
* Whether a fresh session id was generated in this call.
|
|
1873
|
+
*/
|
|
1874
|
+
generate_id: boolean;
|
|
971
1875
|
/**
|
|
972
1876
|
* LLM-facing guidance on how to reuse this session id
|
|
973
1877
|
*/
|
|
@@ -1059,381 +1963,932 @@ export declare namespace SessionSearchResponse {
|
|
|
1059
1963
|
/**
|
|
1060
1964
|
* Description of what the toolkit does and its capabilities
|
|
1061
1965
|
*/
|
|
1062
|
-
description: string;
|
|
1966
|
+
description: string;
|
|
1967
|
+
/**
|
|
1968
|
+
* Whether an active connection exists for this toolkit
|
|
1969
|
+
*/
|
|
1970
|
+
has_active_connection: boolean;
|
|
1971
|
+
/**
|
|
1972
|
+
* Human-readable message about the connection status and next steps
|
|
1973
|
+
*/
|
|
1974
|
+
status_message: string;
|
|
1975
|
+
/**
|
|
1976
|
+
* The toolkit slug identifier (e.g., "gmail", "slack")
|
|
1977
|
+
*/
|
|
1978
|
+
toolkit: string;
|
|
1979
|
+
/**
|
|
1980
|
+
* When "required", the agent must specify which account to use. Present only when
|
|
1981
|
+
* multiple accounts exist.
|
|
1982
|
+
*/
|
|
1983
|
+
account_selection?: 'required';
|
|
1984
|
+
/**
|
|
1985
|
+
* List of connected accounts for this toolkit. Present when multi-account is
|
|
1986
|
+
* enabled.
|
|
1987
|
+
*/
|
|
1988
|
+
accounts?: Array<ToolkitConnectionStatus.Account>;
|
|
1989
|
+
/**
|
|
1990
|
+
* Connection details including auth config and connected account IDs. Only present
|
|
1991
|
+
* when has_active_connection is true.
|
|
1992
|
+
*/
|
|
1993
|
+
connection_details?: {
|
|
1994
|
+
[key: string]: unknown;
|
|
1995
|
+
};
|
|
1996
|
+
/**
|
|
1997
|
+
* Information about the currently connected user (email, name, etc.)
|
|
1998
|
+
*/
|
|
1999
|
+
current_user_info?: {
|
|
2000
|
+
[key: string]: unknown;
|
|
2001
|
+
};
|
|
2002
|
+
}
|
|
2003
|
+
namespace ToolkitConnectionStatus {
|
|
2004
|
+
interface Account {
|
|
2005
|
+
/**
|
|
2006
|
+
* Unique identifier for this account
|
|
2007
|
+
*/
|
|
2008
|
+
id: string;
|
|
2009
|
+
/**
|
|
2010
|
+
* ISO 8601 timestamp of when the account was connected
|
|
2011
|
+
*/
|
|
2012
|
+
created_at: string;
|
|
2013
|
+
/**
|
|
2014
|
+
* Whether this is the default account for the toolkit
|
|
2015
|
+
*/
|
|
2016
|
+
is_default: boolean;
|
|
2017
|
+
/**
|
|
2018
|
+
* Connection status (e.g., "active")
|
|
2019
|
+
*/
|
|
2020
|
+
status: string;
|
|
2021
|
+
/**
|
|
2022
|
+
* User-assigned alias for this account
|
|
2023
|
+
*/
|
|
2024
|
+
alias?: string;
|
|
2025
|
+
/**
|
|
2026
|
+
* Information about the connected user (email, name, etc.)
|
|
2027
|
+
*/
|
|
2028
|
+
user_info?: {
|
|
2029
|
+
[key: string]: unknown;
|
|
2030
|
+
};
|
|
2031
|
+
}
|
|
2032
|
+
}
|
|
2033
|
+
}
|
|
2034
|
+
export interface SessionToolkitsResponse {
|
|
2035
|
+
current_page: number;
|
|
2036
|
+
items: Array<SessionToolkitsResponse.Item>;
|
|
2037
|
+
total_items: number;
|
|
2038
|
+
total_pages: number;
|
|
2039
|
+
next_cursor?: string | null;
|
|
2040
|
+
}
|
|
2041
|
+
export declare namespace SessionToolkitsResponse {
|
|
2042
|
+
interface Item {
|
|
2043
|
+
/**
|
|
2044
|
+
* Available Composio-managed auth schemes
|
|
2045
|
+
*/
|
|
2046
|
+
composio_managed_auth_schemes: Array<string>;
|
|
2047
|
+
/**
|
|
2048
|
+
* Connected account if available
|
|
2049
|
+
*/
|
|
2050
|
+
connected_account: Item.ConnectedAccount | null;
|
|
2051
|
+
/**
|
|
2052
|
+
* Whether the toolkit is enabled
|
|
2053
|
+
*/
|
|
2054
|
+
enabled: boolean;
|
|
2055
|
+
/**
|
|
2056
|
+
* Whether the toolkit is no-auth
|
|
2057
|
+
*/
|
|
2058
|
+
is_no_auth: boolean;
|
|
2059
|
+
/**
|
|
2060
|
+
* Toolkit metadata
|
|
2061
|
+
*/
|
|
2062
|
+
meta: Item.Meta;
|
|
2063
|
+
/**
|
|
2064
|
+
* Display name of the toolkit
|
|
2065
|
+
*/
|
|
2066
|
+
name: string;
|
|
2067
|
+
/**
|
|
2068
|
+
* Unique slug identifier
|
|
2069
|
+
*/
|
|
2070
|
+
slug: string;
|
|
2071
|
+
}
|
|
2072
|
+
namespace Item {
|
|
2073
|
+
/**
|
|
2074
|
+
* Connected account if available
|
|
2075
|
+
*/
|
|
2076
|
+
interface ConnectedAccount {
|
|
2077
|
+
/**
|
|
2078
|
+
* Connected account identifier
|
|
2079
|
+
*/
|
|
2080
|
+
id: string;
|
|
2081
|
+
/**
|
|
2082
|
+
* Auth config details
|
|
2083
|
+
*/
|
|
2084
|
+
auth_config: ConnectedAccount.AuthConfig;
|
|
2085
|
+
/**
|
|
2086
|
+
* Creation timestamp
|
|
2087
|
+
*/
|
|
2088
|
+
created_at: string;
|
|
2089
|
+
/**
|
|
2090
|
+
* Connection status
|
|
2091
|
+
*/
|
|
2092
|
+
status: string;
|
|
2093
|
+
/**
|
|
2094
|
+
* User identifier
|
|
2095
|
+
*/
|
|
2096
|
+
user_id: string;
|
|
2097
|
+
}
|
|
2098
|
+
namespace ConnectedAccount {
|
|
2099
|
+
/**
|
|
2100
|
+
* Auth config details
|
|
2101
|
+
*/
|
|
2102
|
+
interface AuthConfig {
|
|
2103
|
+
/**
|
|
2104
|
+
* Auth config identifier
|
|
2105
|
+
*/
|
|
2106
|
+
id: string;
|
|
2107
|
+
/**
|
|
2108
|
+
* Authentication scheme type
|
|
2109
|
+
*/
|
|
2110
|
+
auth_scheme: string;
|
|
2111
|
+
/**
|
|
2112
|
+
* Whether this is a Composio-managed auth config
|
|
2113
|
+
*/
|
|
2114
|
+
is_composio_managed: boolean;
|
|
2115
|
+
}
|
|
2116
|
+
}
|
|
2117
|
+
/**
|
|
2118
|
+
* Toolkit metadata
|
|
2119
|
+
*/
|
|
2120
|
+
interface Meta {
|
|
2121
|
+
/**
|
|
2122
|
+
* Description of the toolkit
|
|
2123
|
+
*/
|
|
2124
|
+
description: string;
|
|
2125
|
+
/**
|
|
2126
|
+
* URL to the toolkit logo
|
|
2127
|
+
*/
|
|
2128
|
+
logo: string;
|
|
2129
|
+
}
|
|
2130
|
+
}
|
|
2131
|
+
}
|
|
2132
|
+
export interface SessionToolsResponse {
|
|
2133
|
+
current_page: number;
|
|
2134
|
+
items: Array<SessionToolsResponse.Item>;
|
|
2135
|
+
total_items: number;
|
|
2136
|
+
total_pages: number;
|
|
2137
|
+
next_cursor?: string | null;
|
|
2138
|
+
}
|
|
2139
|
+
export declare namespace SessionToolsResponse {
|
|
2140
|
+
interface Item {
|
|
2141
|
+
/**
|
|
2142
|
+
* List of all available versions for this tool
|
|
2143
|
+
*/
|
|
2144
|
+
available_versions: Array<string>;
|
|
2145
|
+
deprecated: Item.Deprecated;
|
|
2146
|
+
/**
|
|
2147
|
+
* Detailed explanation of the tool's functionality and purpose
|
|
2148
|
+
*/
|
|
2149
|
+
description: string;
|
|
2150
|
+
/**
|
|
2151
|
+
* Schema definition of required input parameters for the tool
|
|
2152
|
+
*/
|
|
2153
|
+
input_parameters: {
|
|
2154
|
+
[key: string]: unknown;
|
|
2155
|
+
};
|
|
2156
|
+
/**
|
|
2157
|
+
* Indicates if this tool is deprecated and may be removed in the future
|
|
2158
|
+
*/
|
|
2159
|
+
is_deprecated: boolean;
|
|
2160
|
+
/**
|
|
2161
|
+
* Human-readable display name of the tool
|
|
2162
|
+
*/
|
|
2163
|
+
name: string;
|
|
2164
|
+
/**
|
|
2165
|
+
* Indicates if the tool can be used without authentication
|
|
2166
|
+
*/
|
|
2167
|
+
no_auth: boolean;
|
|
1063
2168
|
/**
|
|
1064
|
-
*
|
|
2169
|
+
* Schema definition of return values from the tool
|
|
1065
2170
|
*/
|
|
1066
|
-
|
|
2171
|
+
output_parameters: {
|
|
2172
|
+
[key: string]: unknown;
|
|
2173
|
+
};
|
|
1067
2174
|
/**
|
|
1068
|
-
*
|
|
2175
|
+
* Structured scope requirements for the tool. Null means the tool is legacy and
|
|
2176
|
+
* only exposes flat scopes.
|
|
1069
2177
|
*/
|
|
1070
|
-
|
|
2178
|
+
scope_requirements: Item.ScopeRequirements | null;
|
|
1071
2179
|
/**
|
|
1072
|
-
*
|
|
2180
|
+
* List of scopes associated with the tool
|
|
1073
2181
|
*/
|
|
1074
|
-
|
|
2182
|
+
scopes: Array<string>;
|
|
1075
2183
|
/**
|
|
1076
|
-
*
|
|
1077
|
-
* multiple accounts exist.
|
|
2184
|
+
* Unique identifier for the tool
|
|
1078
2185
|
*/
|
|
1079
|
-
|
|
2186
|
+
slug: string;
|
|
1080
2187
|
/**
|
|
1081
|
-
* List of
|
|
1082
|
-
* enabled.
|
|
2188
|
+
* List of tags associated with the tool for categorization and filtering
|
|
1083
2189
|
*/
|
|
1084
|
-
|
|
2190
|
+
tags: Array<string>;
|
|
2191
|
+
toolkit: Item.Toolkit;
|
|
1085
2192
|
/**
|
|
1086
|
-
*
|
|
1087
|
-
* when has_active_connection is true.
|
|
2193
|
+
* Current version of the tool
|
|
1088
2194
|
*/
|
|
1089
|
-
|
|
1090
|
-
[key: string]: unknown;
|
|
1091
|
-
};
|
|
2195
|
+
version: string;
|
|
1092
2196
|
/**
|
|
1093
|
-
*
|
|
2197
|
+
* Human-friendly description of the tool, if available
|
|
1094
2198
|
*/
|
|
1095
|
-
|
|
1096
|
-
[key: string]: unknown;
|
|
1097
|
-
};
|
|
2199
|
+
human_description?: string;
|
|
1098
2200
|
}
|
|
1099
|
-
namespace
|
|
1100
|
-
interface
|
|
2201
|
+
namespace Item {
|
|
2202
|
+
interface Deprecated {
|
|
1101
2203
|
/**
|
|
1102
|
-
*
|
|
2204
|
+
* List of all available versions for this tool
|
|
1103
2205
|
*/
|
|
1104
|
-
|
|
2206
|
+
available_versions: Array<string>;
|
|
1105
2207
|
/**
|
|
1106
|
-
*
|
|
2208
|
+
* The display name of the tool
|
|
1107
2209
|
*/
|
|
1108
|
-
|
|
2210
|
+
displayName: string;
|
|
1109
2211
|
/**
|
|
1110
|
-
*
|
|
2212
|
+
* Indicates if this tool is deprecated and may be removed in the future
|
|
1111
2213
|
*/
|
|
1112
|
-
|
|
2214
|
+
is_deprecated: boolean;
|
|
2215
|
+
toolkit: Deprecated.Toolkit;
|
|
1113
2216
|
/**
|
|
1114
|
-
*
|
|
2217
|
+
* Current version identifier of the tool
|
|
1115
2218
|
*/
|
|
1116
|
-
|
|
2219
|
+
version: string;
|
|
2220
|
+
}
|
|
2221
|
+
namespace Deprecated {
|
|
2222
|
+
interface Toolkit {
|
|
2223
|
+
/**
|
|
2224
|
+
* URL to the toolkit logo image
|
|
2225
|
+
*/
|
|
2226
|
+
logo: string;
|
|
2227
|
+
}
|
|
2228
|
+
}
|
|
2229
|
+
/**
|
|
2230
|
+
* Structured scope requirements for the tool. Null means the tool is legacy and
|
|
2231
|
+
* only exposes flat scopes.
|
|
2232
|
+
*/
|
|
2233
|
+
interface ScopeRequirements {
|
|
2234
|
+
all_of: Array<string | ScopeRequirements.AnyOf>;
|
|
2235
|
+
}
|
|
2236
|
+
namespace ScopeRequirements {
|
|
2237
|
+
interface AnyOf {
|
|
2238
|
+
any_of: Array<string>;
|
|
2239
|
+
}
|
|
2240
|
+
}
|
|
2241
|
+
interface Toolkit {
|
|
1117
2242
|
/**
|
|
1118
|
-
*
|
|
2243
|
+
* URL to the toolkit logo image
|
|
1119
2244
|
*/
|
|
1120
|
-
|
|
2245
|
+
logo: string;
|
|
1121
2246
|
/**
|
|
1122
|
-
*
|
|
2247
|
+
* Human-readable name of the parent toolkit
|
|
1123
2248
|
*/
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
2249
|
+
name: string;
|
|
2250
|
+
/**
|
|
2251
|
+
* Unique identifier of the parent toolkit
|
|
2252
|
+
*/
|
|
2253
|
+
slug: string;
|
|
1127
2254
|
}
|
|
1128
2255
|
}
|
|
1129
2256
|
}
|
|
1130
|
-
export interface
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
2257
|
+
export interface SessionCreateParams {
|
|
2258
|
+
/**
|
|
2259
|
+
* The identifier of the user who is initiating the session, ideally a unique
|
|
2260
|
+
* identifier from your database like a user ID or email address
|
|
2261
|
+
*/
|
|
2262
|
+
user_id: string;
|
|
2263
|
+
/**
|
|
2264
|
+
* The auth configs to use for the session. This will override the default behavior
|
|
2265
|
+
* and use the given auth config when specific toolkits are being executed
|
|
2266
|
+
*/
|
|
2267
|
+
auth_configs?: {
|
|
2268
|
+
[key: string]: string;
|
|
2269
|
+
};
|
|
2270
|
+
/**
|
|
2271
|
+
* The connected accounts to use for the session. This will override the default
|
|
2272
|
+
* behaviour and use the given connected account when specific toolkits are being
|
|
2273
|
+
* executed. Each connected account must exist (not deleted or disabled) and belong
|
|
2274
|
+
* to the same `user_id` as the session — otherwise session creation fails with a
|
|
2275
|
+
* clear error explaining which account didn't match.
|
|
2276
|
+
*/
|
|
2277
|
+
connected_accounts?: {
|
|
2278
|
+
[key: string]: string;
|
|
2279
|
+
};
|
|
2280
|
+
execute?: SessionCreateParams.Execute;
|
|
2281
|
+
/**
|
|
2282
|
+
* Experimental features - not stable, may be modified or removed in future
|
|
2283
|
+
* versions.
|
|
2284
|
+
*/
|
|
2285
|
+
experimental?: SessionCreateParams.Experimental;
|
|
2286
|
+
/**
|
|
2287
|
+
* Configuration for connection management settings
|
|
2288
|
+
*/
|
|
2289
|
+
manage_connections?: SessionCreateParams.ManageConnections;
|
|
2290
|
+
/**
|
|
2291
|
+
* Configure multi-account behavior. When enabled, users can connect multiple
|
|
2292
|
+
* accounts per toolkit.
|
|
2293
|
+
*/
|
|
2294
|
+
multi_account?: SessionCreateParams.MultiAccount;
|
|
2295
|
+
/**
|
|
2296
|
+
* Preload configuration. Use an explicit list for frequently used tool slugs, or
|
|
2297
|
+
* "all" to dynamically expose every app tool allowed by positive
|
|
2298
|
+
* toolkits/tools/tags filters.
|
|
2299
|
+
*/
|
|
2300
|
+
preload?: SessionCreateParams.Preload;
|
|
2301
|
+
search?: SessionCreateParams.Search;
|
|
2302
|
+
/**
|
|
2303
|
+
* Global MCP tool annotation hints for filtering. Array format is treated as
|
|
2304
|
+
* enabled list. Object format supports both enabled (tool must have at least one)
|
|
2305
|
+
* and disabled (tool must NOT have any) lists. Toolkit-level tags override this.
|
|
2306
|
+
* Toolkit enabled/disabled lists take precedence over tag filtering.
|
|
2307
|
+
*/
|
|
2308
|
+
tags?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'> | SessionCreateParams.UnionMember1;
|
|
2309
|
+
/**
|
|
2310
|
+
* Toolkit configuration - specify either enable toolkits (allowlist) or disable
|
|
2311
|
+
* toolkits (denylist). Mutually exclusive.
|
|
2312
|
+
*/
|
|
2313
|
+
toolkits?: SessionCreateParams.Enable | SessionCreateParams.Disable;
|
|
2314
|
+
/**
|
|
2315
|
+
* Tool-level configuration per toolkit. Allows you to enable, disable, or filter
|
|
2316
|
+
* by tags for specific tools within each toolkit. Every slug passed in `enable` /
|
|
2317
|
+
* `disable` must be a valid Composio tool slug for that toolkit — invalid or
|
|
2318
|
+
* typo'd slugs fail session creation with a clear error listing which ones didn't
|
|
2319
|
+
* match.
|
|
2320
|
+
*/
|
|
2321
|
+
tools?: {
|
|
2322
|
+
[key: string]: SessionCreateParams.Enable | SessionCreateParams.Disable | SessionCreateParams.Tags;
|
|
2323
|
+
};
|
|
2324
|
+
/**
|
|
2325
|
+
* Configuration for workbench behavior
|
|
2326
|
+
*/
|
|
2327
|
+
workbench?: SessionCreateParams.Workbench;
|
|
1136
2328
|
}
|
|
1137
|
-
export declare namespace
|
|
1138
|
-
interface
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
connected_account: Item.ConnectedAccount | null;
|
|
1147
|
-
/**
|
|
1148
|
-
* Whether the toolkit is enabled
|
|
1149
|
-
*/
|
|
1150
|
-
enabled: boolean;
|
|
2329
|
+
export declare namespace SessionCreateParams {
|
|
2330
|
+
interface Execute {
|
|
2331
|
+
enable_multi_execute?: boolean;
|
|
2332
|
+
}
|
|
2333
|
+
/**
|
|
2334
|
+
* Experimental features - not stable, may be modified or removed in future
|
|
2335
|
+
* versions.
|
|
2336
|
+
*/
|
|
2337
|
+
interface Experimental {
|
|
1151
2338
|
/**
|
|
1152
|
-
*
|
|
2339
|
+
* Customize assistive prompt generation (e.g., timezone).
|
|
1153
2340
|
*/
|
|
1154
|
-
|
|
2341
|
+
assistive_prompt_config?: Experimental.AssistivePromptConfig;
|
|
1155
2342
|
/**
|
|
1156
|
-
* Toolkit
|
|
2343
|
+
* Custom toolkits with grouped tools. Toolkit slugs must not conflict with
|
|
2344
|
+
* existing Composio toolkits. All tools are no-auth.
|
|
1157
2345
|
*/
|
|
1158
|
-
|
|
2346
|
+
custom_toolkits?: Array<Experimental.CustomToolkit>;
|
|
1159
2347
|
/**
|
|
1160
|
-
*
|
|
2348
|
+
* Custom tools to include in search. Standalone tools need no auth. Tools with
|
|
2349
|
+
* extends_toolkit inherit the Composio toolkit's connection.
|
|
1161
2350
|
*/
|
|
1162
|
-
|
|
2351
|
+
custom_tools?: Array<Experimental.CustomTool>;
|
|
1163
2352
|
/**
|
|
1164
|
-
*
|
|
2353
|
+
* Per-tool elicitation permission config. Default behavior + per-tool
|
|
2354
|
+
* always_allow/always_deny overrides. Mutation via PATCH.
|
|
1165
2355
|
*/
|
|
1166
|
-
|
|
2356
|
+
permissions?: Experimental.Permissions;
|
|
1167
2357
|
}
|
|
1168
|
-
namespace
|
|
2358
|
+
namespace Experimental {
|
|
1169
2359
|
/**
|
|
1170
|
-
*
|
|
2360
|
+
* Customize assistive prompt generation (e.g., timezone).
|
|
1171
2361
|
*/
|
|
1172
|
-
interface
|
|
2362
|
+
interface AssistivePromptConfig {
|
|
2363
|
+
/**
|
|
2364
|
+
* IANA timezone identifier (e.g., 'America/New_York', 'Europe/London'). Used to
|
|
2365
|
+
* customize the system prompt with timezone-aware instructions.
|
|
2366
|
+
*/
|
|
2367
|
+
user_timezone?: string;
|
|
2368
|
+
}
|
|
2369
|
+
interface CustomToolkit {
|
|
2370
|
+
/**
|
|
2371
|
+
* Used for BM25 search matching and shown in toolkit connection statuses.
|
|
2372
|
+
*/
|
|
2373
|
+
description: string;
|
|
2374
|
+
/**
|
|
2375
|
+
* Display name shown to the LLM and in search results.
|
|
2376
|
+
*/
|
|
2377
|
+
name: string;
|
|
2378
|
+
/**
|
|
2379
|
+
* Unique slug for the toolkit. Must not conflict with existing Composio toolkit
|
|
2380
|
+
* slugs. Alphanumeric, underscores, and hyphens only.
|
|
2381
|
+
*/
|
|
2382
|
+
slug: string;
|
|
2383
|
+
/**
|
|
2384
|
+
* Tools in this custom toolkit
|
|
2385
|
+
*/
|
|
2386
|
+
tools: Array<CustomToolkit.Tool>;
|
|
2387
|
+
}
|
|
2388
|
+
namespace CustomToolkit {
|
|
2389
|
+
interface Tool {
|
|
2390
|
+
/**
|
|
2391
|
+
* Used for BM25 search matching and shown to the LLM.
|
|
2392
|
+
*/
|
|
2393
|
+
description: string;
|
|
2394
|
+
/**
|
|
2395
|
+
* Must have type: "object" and a properties field.
|
|
2396
|
+
*/
|
|
2397
|
+
input_schema: {
|
|
2398
|
+
[key: string]: unknown;
|
|
2399
|
+
};
|
|
2400
|
+
/**
|
|
2401
|
+
* Human-readable display name
|
|
2402
|
+
*/
|
|
2403
|
+
name: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* Tool slug. Combined with toolkit slug to form LOCAL*<TOOLKIT>*<TOOL> (max 60
|
|
2406
|
+
* chars total).
|
|
2407
|
+
*/
|
|
2408
|
+
slug: string;
|
|
2409
|
+
/**
|
|
2410
|
+
* Optional output schema for the tool response.
|
|
2411
|
+
*/
|
|
2412
|
+
output_schema?: {
|
|
2413
|
+
[key: string]: unknown;
|
|
2414
|
+
};
|
|
2415
|
+
}
|
|
2416
|
+
}
|
|
2417
|
+
interface CustomTool {
|
|
1173
2418
|
/**
|
|
1174
|
-
*
|
|
2419
|
+
* Used for BM25 search matching and shown to the LLM.
|
|
1175
2420
|
*/
|
|
1176
|
-
|
|
2421
|
+
description: string;
|
|
1177
2422
|
/**
|
|
1178
|
-
*
|
|
2423
|
+
* Must have type: "object" and a properties field.
|
|
1179
2424
|
*/
|
|
1180
|
-
|
|
2425
|
+
input_schema: {
|
|
2426
|
+
[key: string]: unknown;
|
|
2427
|
+
};
|
|
1181
2428
|
/**
|
|
1182
|
-
*
|
|
2429
|
+
* Human-readable display name
|
|
1183
2430
|
*/
|
|
1184
|
-
|
|
2431
|
+
name: string;
|
|
1185
2432
|
/**
|
|
1186
|
-
*
|
|
2433
|
+
* Tool slug. Forms LOCAL*<TOOL> (standalone) or LOCAL*<TOOLKIT>\_<TOOL>
|
|
2434
|
+
* (extending). Max 60 chars total.
|
|
1187
2435
|
*/
|
|
1188
|
-
|
|
2436
|
+
slug: string;
|
|
1189
2437
|
/**
|
|
1190
|
-
*
|
|
2438
|
+
* If set, must be a valid Composio toolkit slug. The tool inherits that toolkit's
|
|
2439
|
+
* auth/connection status. If omitted, the tool is standalone (no-auth).
|
|
1191
2440
|
*/
|
|
1192
|
-
|
|
1193
|
-
}
|
|
1194
|
-
namespace ConnectedAccount {
|
|
2441
|
+
extends_toolkit?: string;
|
|
1195
2442
|
/**
|
|
1196
|
-
*
|
|
2443
|
+
* JSON Schema describing tool output (optional)
|
|
1197
2444
|
*/
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
*/
|
|
1202
|
-
id: string;
|
|
1203
|
-
/**
|
|
1204
|
-
* Authentication scheme type
|
|
1205
|
-
*/
|
|
1206
|
-
auth_scheme: string;
|
|
1207
|
-
/**
|
|
1208
|
-
* Whether this is a Composio-managed auth config
|
|
1209
|
-
*/
|
|
1210
|
-
is_composio_managed: boolean;
|
|
1211
|
-
}
|
|
2445
|
+
output_schema?: {
|
|
2446
|
+
[key: string]: unknown;
|
|
2447
|
+
};
|
|
1212
2448
|
}
|
|
1213
2449
|
/**
|
|
1214
|
-
*
|
|
2450
|
+
* Per-tool elicitation permission config. Default behavior + per-tool
|
|
2451
|
+
* always_allow/always_deny overrides. Mutation via PATCH.
|
|
1215
2452
|
*/
|
|
1216
|
-
interface
|
|
2453
|
+
interface Permissions {
|
|
1217
2454
|
/**
|
|
1218
|
-
*
|
|
2455
|
+
* Default elicitation behavior when no override matches. `allow_all` runs every
|
|
2456
|
+
* tool without prompting; `ask_every_call` prompts on each invocation;
|
|
2457
|
+
* `ask_once_per_session` prompts once and remembers the answer for the rest of the
|
|
2458
|
+
* session.
|
|
1219
2459
|
*/
|
|
1220
|
-
|
|
2460
|
+
default: 'allow_all' | 'ask_every_call' | 'ask_once_per_session';
|
|
1221
2461
|
/**
|
|
1222
|
-
*
|
|
2462
|
+
* Per-tool overrides keyed by `${toolSlug}:${connectedAccountId ?? "__none__"}`,
|
|
2463
|
+
* plus account-wide overrides keyed by `*:${connectedAccountId ?? "__none__"}`.
|
|
2464
|
+
* Exact tool overrides take precedence over account-wide overrides. `always_allow`
|
|
2465
|
+
* skips the prompt and runs the tool; `always_deny` blocks the tool; `ask_once`
|
|
2466
|
+
* prompts once per session (allow/deny) and remembers; `ask_always` prompts on
|
|
2467
|
+
* every call with allow-once/allow-session/deny, ignoring any cached session
|
|
2468
|
+
* allow. Overrides take precedence over `default`.
|
|
1223
2469
|
*/
|
|
1224
|
-
|
|
2470
|
+
overrides?: {
|
|
2471
|
+
[key: string]: 'always_allow' | 'always_deny' | 'ask_once' | 'ask_always';
|
|
2472
|
+
};
|
|
1225
2473
|
}
|
|
1226
2474
|
}
|
|
1227
|
-
}
|
|
1228
|
-
export interface SessionToolsResponse {
|
|
1229
2475
|
/**
|
|
1230
|
-
*
|
|
2476
|
+
* Configuration for connection management settings
|
|
1231
2477
|
*/
|
|
1232
|
-
|
|
1233
|
-
}
|
|
1234
|
-
export declare namespace SessionToolsResponse {
|
|
1235
|
-
interface Item {
|
|
2478
|
+
interface ManageConnections {
|
|
1236
2479
|
/**
|
|
1237
|
-
*
|
|
2480
|
+
* The URL to redirect to after a user completes authentication for a connected
|
|
2481
|
+
* account. This allows you to handle the auth callback in your own application.
|
|
1238
2482
|
*/
|
|
1239
|
-
|
|
1240
|
-
deprecated: Item.Deprecated;
|
|
2483
|
+
callback_url?: string;
|
|
1241
2484
|
/**
|
|
1242
|
-
*
|
|
2485
|
+
* Whether to enable the connection manager for automatic connection handling. If
|
|
2486
|
+
* true, we will provide a tool your agent can use to initiate connections to
|
|
2487
|
+
* toolkits if it doesnt exist. If set to false, then you have to manage
|
|
2488
|
+
* connections manually.
|
|
1243
2489
|
*/
|
|
1244
|
-
|
|
2490
|
+
enable?: boolean | null;
|
|
1245
2491
|
/**
|
|
1246
|
-
*
|
|
2492
|
+
* Enable the "remove" action in COMPOSIO_MANAGE_CONNECTIONS to allow deleting
|
|
2493
|
+
* connected accounts. Default true.
|
|
1247
2494
|
*/
|
|
1248
|
-
|
|
1249
|
-
[key: string]: unknown;
|
|
1250
|
-
};
|
|
2495
|
+
enable_connection_removal?: boolean | null;
|
|
1251
2496
|
/**
|
|
1252
|
-
*
|
|
2497
|
+
* When true, the COMPOSIO_WAIT_FOR_CONNECTIONS tool is available for agents to
|
|
2498
|
+
* poll connection status after sharing auth URLs. Default is false (disabled). May
|
|
2499
|
+
* not work reliably with GPT models.
|
|
1253
2500
|
*/
|
|
1254
|
-
|
|
2501
|
+
enable_wait_for_connections?: boolean | null;
|
|
2502
|
+
}
|
|
2503
|
+
/**
|
|
2504
|
+
* Configure multi-account behavior. When enabled, users can connect multiple
|
|
2505
|
+
* accounts per toolkit.
|
|
2506
|
+
*/
|
|
2507
|
+
interface MultiAccount {
|
|
1255
2508
|
/**
|
|
1256
|
-
*
|
|
2509
|
+
* When true, enables multi-account mode for this session. When not set, falls back
|
|
2510
|
+
* to org/project-level configuration.
|
|
1257
2511
|
*/
|
|
1258
|
-
|
|
2512
|
+
enable?: boolean;
|
|
1259
2513
|
/**
|
|
1260
|
-
*
|
|
2514
|
+
* Maximum number of connected accounts allowed per toolkit. Must be between 2
|
|
2515
|
+
* and 10.
|
|
1261
2516
|
*/
|
|
1262
|
-
|
|
2517
|
+
max_accounts_per_toolkit?: number;
|
|
1263
2518
|
/**
|
|
1264
|
-
*
|
|
2519
|
+
* When true, the agent must explicitly select which account to use. When false
|
|
2520
|
+
* (default), the first/default account is used automatically.
|
|
1265
2521
|
*/
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
2522
|
+
require_explicit_selection?: boolean;
|
|
2523
|
+
}
|
|
2524
|
+
/**
|
|
2525
|
+
* Preload configuration. Use an explicit list for frequently used tool slugs, or
|
|
2526
|
+
* "all" to dynamically expose every app tool allowed by positive
|
|
2527
|
+
* toolkits/tools/tags filters.
|
|
2528
|
+
*/
|
|
2529
|
+
interface Preload {
|
|
1269
2530
|
/**
|
|
1270
|
-
*
|
|
1271
|
-
*
|
|
2531
|
+
* Explicit tool slugs to preload, or "all" to dynamically expose all current and
|
|
2532
|
+
* future app tools allowed by the positive session filters. "all" is capped at
|
|
2533
|
+
* 1000 tools and is not supported without a positive allowlist.
|
|
1272
2534
|
*/
|
|
1273
|
-
|
|
2535
|
+
tools?: Array<string> | string;
|
|
2536
|
+
}
|
|
2537
|
+
interface Search {
|
|
2538
|
+
enable?: boolean;
|
|
2539
|
+
}
|
|
2540
|
+
interface UnionMember1 {
|
|
2541
|
+
disable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
2542
|
+
enable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
2543
|
+
}
|
|
2544
|
+
/**
|
|
2545
|
+
* Enable only specific toolkits (allowlist)
|
|
2546
|
+
*/
|
|
2547
|
+
interface Enable {
|
|
1274
2548
|
/**
|
|
1275
|
-
*
|
|
2549
|
+
* Only these specific toolkits will be enabled
|
|
1276
2550
|
*/
|
|
1277
|
-
|
|
2551
|
+
enable: Array<string>;
|
|
2552
|
+
}
|
|
2553
|
+
/**
|
|
2554
|
+
* Disable specific toolkits (denylist)
|
|
2555
|
+
*/
|
|
2556
|
+
interface Disable {
|
|
1278
2557
|
/**
|
|
1279
|
-
*
|
|
2558
|
+
* These specific toolkits will be disabled
|
|
1280
2559
|
*/
|
|
1281
|
-
|
|
2560
|
+
disable: Array<string>;
|
|
2561
|
+
}
|
|
2562
|
+
interface Enable {
|
|
1282
2563
|
/**
|
|
1283
|
-
*
|
|
2564
|
+
* Only these specific tools will be available for this toolkit
|
|
1284
2565
|
*/
|
|
1285
|
-
|
|
1286
|
-
|
|
2566
|
+
enable: Array<string>;
|
|
2567
|
+
}
|
|
2568
|
+
interface Disable {
|
|
1287
2569
|
/**
|
|
1288
|
-
*
|
|
2570
|
+
* These specific tools will be disabled for this toolkit
|
|
1289
2571
|
*/
|
|
1290
|
-
|
|
2572
|
+
disable: Array<string>;
|
|
2573
|
+
}
|
|
2574
|
+
interface Tags {
|
|
1291
2575
|
/**
|
|
1292
|
-
*
|
|
2576
|
+
* MCP tags to filter tools. Array format is treated as enabled list. Object format
|
|
2577
|
+
* supports both enabled and disabled lists.
|
|
1293
2578
|
*/
|
|
1294
|
-
|
|
2579
|
+
tags: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'> | Tags.UnionMember1;
|
|
1295
2580
|
}
|
|
1296
|
-
namespace
|
|
1297
|
-
interface
|
|
2581
|
+
namespace Tags {
|
|
2582
|
+
interface UnionMember1 {
|
|
2583
|
+
disable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
2584
|
+
enable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
2585
|
+
}
|
|
2586
|
+
}
|
|
2587
|
+
/**
|
|
2588
|
+
* Configuration for workbench behavior
|
|
2589
|
+
*/
|
|
2590
|
+
interface Workbench {
|
|
2591
|
+
/**
|
|
2592
|
+
* Character threshold for automatic offloading. When workbench response exceeds
|
|
2593
|
+
* this threshold, it will be automatically offloaded. Default is picked
|
|
2594
|
+
* automatically based on the response size.
|
|
2595
|
+
*/
|
|
2596
|
+
auto_offload_threshold?: number;
|
|
2597
|
+
/**
|
|
2598
|
+
* Set to false to disable the workbench entirely. When disabled, no code execution
|
|
2599
|
+
* tools are available in the session.
|
|
2600
|
+
*/
|
|
2601
|
+
enable?: boolean;
|
|
2602
|
+
/**
|
|
2603
|
+
* Whether proxy execution is enabled. When enabled, workbench can call URLs and
|
|
2604
|
+
* APIs directly.
|
|
2605
|
+
*/
|
|
2606
|
+
enable_proxy_execution?: boolean;
|
|
2607
|
+
/**
|
|
2608
|
+
* Sandbox compute tier: standard (1 vCPU / 1 GB), medium (2 vCPU / 2 GB), large (4
|
|
2609
|
+
* vCPU / 4 GB), xlarge (8 vCPU / 8 GB). Defaults to standard.
|
|
2610
|
+
*/
|
|
2611
|
+
sandbox_size?: 'standard' | 'medium' | 'large' | 'xlarge';
|
|
2612
|
+
}
|
|
2613
|
+
}
|
|
2614
|
+
export interface SessionAttachParams {
|
|
2615
|
+
/**
|
|
2616
|
+
* Inline custom tools and toolkits for this request. v3.1 sessions do not persist
|
|
2617
|
+
* customs — pass them on every request that needs them.
|
|
2618
|
+
*/
|
|
2619
|
+
experimental?: SessionAttachParams.Experimental;
|
|
2620
|
+
}
|
|
2621
|
+
export declare namespace SessionAttachParams {
|
|
2622
|
+
/**
|
|
2623
|
+
* Inline custom tools and toolkits for this request. v3.1 sessions do not persist
|
|
2624
|
+
* customs — pass them on every request that needs them.
|
|
2625
|
+
*/
|
|
2626
|
+
interface Experimental {
|
|
2627
|
+
/**
|
|
2628
|
+
* Custom toolkits with grouped tools. Toolkit slugs must not conflict with
|
|
2629
|
+
* existing Composio toolkits. All tools are no-auth.
|
|
2630
|
+
*/
|
|
2631
|
+
custom_toolkits?: Array<Experimental.CustomToolkit>;
|
|
2632
|
+
/**
|
|
2633
|
+
* Custom tools to include in search. Standalone tools need no auth. Tools with
|
|
2634
|
+
* extends_toolkit inherit the Composio toolkit's connection.
|
|
2635
|
+
*/
|
|
2636
|
+
custom_tools?: Array<Experimental.CustomTool>;
|
|
2637
|
+
}
|
|
2638
|
+
namespace Experimental {
|
|
2639
|
+
interface CustomToolkit {
|
|
1298
2640
|
/**
|
|
1299
|
-
*
|
|
2641
|
+
* Used for BM25 search matching and shown in toolkit connection statuses.
|
|
1300
2642
|
*/
|
|
1301
|
-
|
|
2643
|
+
description: string;
|
|
1302
2644
|
/**
|
|
1303
|
-
*
|
|
2645
|
+
* Display name shown to the LLM and in search results.
|
|
1304
2646
|
*/
|
|
1305
|
-
|
|
2647
|
+
name: string;
|
|
1306
2648
|
/**
|
|
1307
|
-
*
|
|
2649
|
+
* Unique slug for the toolkit. Must not conflict with existing Composio toolkit
|
|
2650
|
+
* slugs. Alphanumeric, underscores, and hyphens only.
|
|
1308
2651
|
*/
|
|
1309
|
-
|
|
1310
|
-
toolkit: Deprecated.Toolkit;
|
|
2652
|
+
slug: string;
|
|
1311
2653
|
/**
|
|
1312
|
-
*
|
|
2654
|
+
* Tools in this custom toolkit
|
|
1313
2655
|
*/
|
|
1314
|
-
|
|
2656
|
+
tools: Array<CustomToolkit.Tool>;
|
|
1315
2657
|
}
|
|
1316
|
-
namespace
|
|
1317
|
-
interface
|
|
2658
|
+
namespace CustomToolkit {
|
|
2659
|
+
interface Tool {
|
|
1318
2660
|
/**
|
|
1319
|
-
*
|
|
2661
|
+
* Used for BM25 search matching and shown to the LLM.
|
|
1320
2662
|
*/
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
2663
|
+
description: string;
|
|
2664
|
+
/**
|
|
2665
|
+
* Must have type: "object" and a properties field.
|
|
2666
|
+
*/
|
|
2667
|
+
input_schema: {
|
|
2668
|
+
[key: string]: unknown;
|
|
2669
|
+
};
|
|
2670
|
+
/**
|
|
2671
|
+
* Human-readable display name
|
|
2672
|
+
*/
|
|
2673
|
+
name: string;
|
|
2674
|
+
/**
|
|
2675
|
+
* Tool slug. Combined with toolkit slug to form LOCAL*<TOOLKIT>*<TOOL> (max 60
|
|
2676
|
+
* chars total).
|
|
2677
|
+
*/
|
|
2678
|
+
slug: string;
|
|
2679
|
+
/**
|
|
2680
|
+
* Optional output schema for the tool response.
|
|
2681
|
+
*/
|
|
2682
|
+
output_schema?: {
|
|
2683
|
+
[key: string]: unknown;
|
|
2684
|
+
};
|
|
1334
2685
|
}
|
|
1335
2686
|
}
|
|
1336
|
-
interface
|
|
2687
|
+
interface CustomTool {
|
|
1337
2688
|
/**
|
|
1338
|
-
*
|
|
2689
|
+
* Used for BM25 search matching and shown to the LLM.
|
|
1339
2690
|
*/
|
|
1340
|
-
|
|
2691
|
+
description: string;
|
|
1341
2692
|
/**
|
|
1342
|
-
*
|
|
2693
|
+
* Must have type: "object" and a properties field.
|
|
2694
|
+
*/
|
|
2695
|
+
input_schema: {
|
|
2696
|
+
[key: string]: unknown;
|
|
2697
|
+
};
|
|
2698
|
+
/**
|
|
2699
|
+
* Human-readable display name
|
|
1343
2700
|
*/
|
|
1344
2701
|
name: string;
|
|
1345
2702
|
/**
|
|
1346
|
-
*
|
|
2703
|
+
* Tool slug. Forms LOCAL*<TOOL> (standalone) or LOCAL*<TOOLKIT>\_<TOOL>
|
|
2704
|
+
* (extending). Max 60 chars total.
|
|
1347
2705
|
*/
|
|
1348
2706
|
slug: string;
|
|
2707
|
+
/**
|
|
2708
|
+
* If set, must be a valid Composio toolkit slug. The tool inherits that toolkit's
|
|
2709
|
+
* auth/connection status. If omitted, the tool is standalone (no-auth).
|
|
2710
|
+
*/
|
|
2711
|
+
extends_toolkit?: string;
|
|
2712
|
+
/**
|
|
2713
|
+
* JSON Schema describing tool output (optional)
|
|
2714
|
+
*/
|
|
2715
|
+
output_schema?: {
|
|
2716
|
+
[key: string]: unknown;
|
|
2717
|
+
};
|
|
1349
2718
|
}
|
|
1350
2719
|
}
|
|
1351
2720
|
}
|
|
1352
|
-
export interface
|
|
2721
|
+
export interface SessionConfigHistoryParams {
|
|
1353
2722
|
/**
|
|
1354
|
-
* The
|
|
1355
|
-
*
|
|
2723
|
+
* Cursor for pagination. The cursor is a base64 encoded string of the page and
|
|
2724
|
+
* limit. The page is the page number and the limit is the number of items per
|
|
2725
|
+
* page. The cursor is used to paginate through the items. The cursor is not
|
|
2726
|
+
* required for the first page.
|
|
1356
2727
|
*/
|
|
1357
|
-
|
|
2728
|
+
cursor?: string;
|
|
1358
2729
|
/**
|
|
1359
|
-
*
|
|
1360
|
-
* and use the given auth config when specific toolkits are being executed
|
|
2730
|
+
* Number of items per page, max allowed is 100
|
|
1361
2731
|
*/
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
2732
|
+
limit?: number;
|
|
2733
|
+
}
|
|
2734
|
+
export interface SessionExecuteParams {
|
|
1365
2735
|
/**
|
|
1366
|
-
* The
|
|
1367
|
-
*
|
|
1368
|
-
* executed. Each connected account must exist (not deleted or disabled) and belong
|
|
1369
|
-
* to the same `user_id` as the session — otherwise session creation fails with a
|
|
1370
|
-
* clear error explaining which account didn't match.
|
|
2736
|
+
* The unique slug identifier of the tool to execute. Supports both meta tools and
|
|
2737
|
+
* app tools exposed by the session.
|
|
1371
2738
|
*/
|
|
1372
|
-
|
|
1373
|
-
[key: string]: string;
|
|
1374
|
-
};
|
|
2739
|
+
tool_slug: string;
|
|
1375
2740
|
/**
|
|
1376
|
-
*
|
|
1377
|
-
*
|
|
2741
|
+
* Account identifier to specify which connected account to use for direct tool
|
|
2742
|
+
* execution. Use the account ID (e.g. "coup_hurricane_dal_analytical") or an
|
|
2743
|
+
* alias. When omitted with a single account, the default is used. When omitted
|
|
2744
|
+
* with multiple accounts, an error lists available accounts. Meta/helper tools
|
|
2745
|
+
* either ignore this top-level field or define their own account-selection fields,
|
|
2746
|
+
* for example COMPOSIO_MULTI_EXECUTE_TOOL.tools[].account.
|
|
1378
2747
|
*/
|
|
1379
|
-
|
|
2748
|
+
account?: string;
|
|
1380
2749
|
/**
|
|
1381
|
-
*
|
|
2750
|
+
* The arguments required by the tool
|
|
1382
2751
|
*/
|
|
1383
|
-
|
|
2752
|
+
arguments?: {
|
|
2753
|
+
[key: string]: unknown;
|
|
2754
|
+
};
|
|
1384
2755
|
/**
|
|
1385
|
-
*
|
|
1386
|
-
*
|
|
2756
|
+
* When true, direct non-meta tool execution may return a workbench offload preview
|
|
2757
|
+
* if the response exceeds the configured threshold and the session workbench is
|
|
2758
|
+
* enabled. When omitted or false, direct tool execution returns the normal inline
|
|
2759
|
+
* response. Meta/helper tools are unaffected, and COMPOSIO_MULTI_EXECUTE_TOOL uses
|
|
2760
|
+
* session.workbench configuration for its own batch-level offload behavior.
|
|
1387
2761
|
*/
|
|
1388
|
-
|
|
2762
|
+
enable_auto_workbench_offload?: boolean;
|
|
1389
2763
|
/**
|
|
1390
|
-
*
|
|
1391
|
-
*
|
|
1392
|
-
* search first — useful for frequently used tools. Each slug must be allowed by
|
|
1393
|
-
* the session filters (`toolkits`, `tools`, `tags`), otherwise session creation
|
|
1394
|
-
* fails with a 400. Custom tools declared in `custom_tools` / `custom_toolkits`
|
|
1395
|
-
* can also be preloaded. Not supported when multi-account is enabled. Each
|
|
1396
|
-
* preloaded tool adds to the agent context window, so keep the list at or under
|
|
1397
|
-
* ~20 tools.
|
|
2764
|
+
* Inline custom tools and toolkits for this request. v3.1 sessions do not persist
|
|
2765
|
+
* customs — pass them on every request that needs them.
|
|
1398
2766
|
*/
|
|
1399
|
-
|
|
2767
|
+
experimental?: SessionExecuteParams.Experimental;
|
|
2768
|
+
}
|
|
2769
|
+
export declare namespace SessionExecuteParams {
|
|
1400
2770
|
/**
|
|
1401
|
-
*
|
|
1402
|
-
*
|
|
1403
|
-
* and disabled (tool must NOT have any) lists. Toolkit-level tags override this.
|
|
1404
|
-
* Toolkit enabled/disabled lists take precedence over tag filtering.
|
|
2771
|
+
* Inline custom tools and toolkits for this request. v3.1 sessions do not persist
|
|
2772
|
+
* customs — pass them on every request that needs them.
|
|
1405
2773
|
*/
|
|
1406
|
-
|
|
2774
|
+
interface Experimental {
|
|
2775
|
+
/**
|
|
2776
|
+
* Custom toolkits with grouped tools. Toolkit slugs must not conflict with
|
|
2777
|
+
* existing Composio toolkits. All tools are no-auth.
|
|
2778
|
+
*/
|
|
2779
|
+
custom_toolkits?: Array<Experimental.CustomToolkit>;
|
|
2780
|
+
/**
|
|
2781
|
+
* Custom tools to include in search. Standalone tools need no auth. Tools with
|
|
2782
|
+
* extends_toolkit inherit the Composio toolkit's connection.
|
|
2783
|
+
*/
|
|
2784
|
+
custom_tools?: Array<Experimental.CustomTool>;
|
|
2785
|
+
}
|
|
2786
|
+
namespace Experimental {
|
|
2787
|
+
interface CustomToolkit {
|
|
2788
|
+
/**
|
|
2789
|
+
* Used for BM25 search matching and shown in toolkit connection statuses.
|
|
2790
|
+
*/
|
|
2791
|
+
description: string;
|
|
2792
|
+
/**
|
|
2793
|
+
* Display name shown to the LLM and in search results.
|
|
2794
|
+
*/
|
|
2795
|
+
name: string;
|
|
2796
|
+
/**
|
|
2797
|
+
* Unique slug for the toolkit. Must not conflict with existing Composio toolkit
|
|
2798
|
+
* slugs. Alphanumeric, underscores, and hyphens only.
|
|
2799
|
+
*/
|
|
2800
|
+
slug: string;
|
|
2801
|
+
/**
|
|
2802
|
+
* Tools in this custom toolkit
|
|
2803
|
+
*/
|
|
2804
|
+
tools: Array<CustomToolkit.Tool>;
|
|
2805
|
+
}
|
|
2806
|
+
namespace CustomToolkit {
|
|
2807
|
+
interface Tool {
|
|
2808
|
+
/**
|
|
2809
|
+
* Used for BM25 search matching and shown to the LLM.
|
|
2810
|
+
*/
|
|
2811
|
+
description: string;
|
|
2812
|
+
/**
|
|
2813
|
+
* Must have type: "object" and a properties field.
|
|
2814
|
+
*/
|
|
2815
|
+
input_schema: {
|
|
2816
|
+
[key: string]: unknown;
|
|
2817
|
+
};
|
|
2818
|
+
/**
|
|
2819
|
+
* Human-readable display name
|
|
2820
|
+
*/
|
|
2821
|
+
name: string;
|
|
2822
|
+
/**
|
|
2823
|
+
* Tool slug. Combined with toolkit slug to form LOCAL*<TOOLKIT>*<TOOL> (max 60
|
|
2824
|
+
* chars total).
|
|
2825
|
+
*/
|
|
2826
|
+
slug: string;
|
|
2827
|
+
/**
|
|
2828
|
+
* Optional output schema for the tool response.
|
|
2829
|
+
*/
|
|
2830
|
+
output_schema?: {
|
|
2831
|
+
[key: string]: unknown;
|
|
2832
|
+
};
|
|
2833
|
+
}
|
|
2834
|
+
}
|
|
2835
|
+
interface CustomTool {
|
|
2836
|
+
/**
|
|
2837
|
+
* Used for BM25 search matching and shown to the LLM.
|
|
2838
|
+
*/
|
|
2839
|
+
description: string;
|
|
2840
|
+
/**
|
|
2841
|
+
* Must have type: "object" and a properties field.
|
|
2842
|
+
*/
|
|
2843
|
+
input_schema: {
|
|
2844
|
+
[key: string]: unknown;
|
|
2845
|
+
};
|
|
2846
|
+
/**
|
|
2847
|
+
* Human-readable display name
|
|
2848
|
+
*/
|
|
2849
|
+
name: string;
|
|
2850
|
+
/**
|
|
2851
|
+
* Tool slug. Forms LOCAL*<TOOL> (standalone) or LOCAL*<TOOLKIT>\_<TOOL>
|
|
2852
|
+
* (extending). Max 60 chars total.
|
|
2853
|
+
*/
|
|
2854
|
+
slug: string;
|
|
2855
|
+
/**
|
|
2856
|
+
* If set, must be a valid Composio toolkit slug. The tool inherits that toolkit's
|
|
2857
|
+
* auth/connection status. If omitted, the tool is standalone (no-auth).
|
|
2858
|
+
*/
|
|
2859
|
+
extends_toolkit?: string;
|
|
2860
|
+
/**
|
|
2861
|
+
* JSON Schema describing tool output (optional)
|
|
2862
|
+
*/
|
|
2863
|
+
output_schema?: {
|
|
2864
|
+
[key: string]: unknown;
|
|
2865
|
+
};
|
|
2866
|
+
}
|
|
2867
|
+
}
|
|
2868
|
+
}
|
|
2869
|
+
export interface SessionExecuteMetaParams {
|
|
1407
2870
|
/**
|
|
1408
|
-
*
|
|
1409
|
-
* toolkits (denylist). Mutually exclusive.
|
|
2871
|
+
* The unique slug identifier of the meta tool to execute
|
|
1410
2872
|
*/
|
|
1411
|
-
|
|
2873
|
+
slug: 'COMPOSIO_SEARCH_TOOLS' | 'COMPOSIO_MULTI_EXECUTE_TOOL' | 'COMPOSIO_MANAGE_CONNECTIONS' | 'COMPOSIO_WAIT_FOR_CONNECTIONS' | 'COMPOSIO_REMOTE_WORKBENCH' | 'COMPOSIO_REMOTE_BASH_TOOL' | 'COMPOSIO_GET_TOOL_SCHEMAS' | 'COMPOSIO_UPSERT_RECIPE' | 'COMPOSIO_GET_RECIPE';
|
|
1412
2874
|
/**
|
|
1413
|
-
*
|
|
1414
|
-
* by tags for specific tools within each toolkit. Every slug passed in `enable` /
|
|
1415
|
-
* `disable` must be a valid Composio tool slug for that toolkit — invalid or
|
|
1416
|
-
* typo'd slugs fail session creation with a clear error listing which ones didn't
|
|
1417
|
-
* match.
|
|
2875
|
+
* The arguments required by the meta tool
|
|
1418
2876
|
*/
|
|
1419
|
-
|
|
1420
|
-
[key: string]:
|
|
2877
|
+
arguments?: {
|
|
2878
|
+
[key: string]: unknown;
|
|
1421
2879
|
};
|
|
1422
2880
|
/**
|
|
1423
|
-
*
|
|
2881
|
+
* Inline custom tools and toolkits for this request. v3.1 sessions do not persist
|
|
2882
|
+
* customs — pass them on every request that needs them.
|
|
1424
2883
|
*/
|
|
1425
|
-
|
|
2884
|
+
experimental?: SessionExecuteMetaParams.Experimental;
|
|
1426
2885
|
}
|
|
1427
|
-
export declare namespace
|
|
2886
|
+
export declare namespace SessionExecuteMetaParams {
|
|
1428
2887
|
/**
|
|
1429
|
-
*
|
|
1430
|
-
*
|
|
2888
|
+
* Inline custom tools and toolkits for this request. v3.1 sessions do not persist
|
|
2889
|
+
* customs — pass them on every request that needs them.
|
|
1431
2890
|
*/
|
|
1432
2891
|
interface Experimental {
|
|
1433
|
-
/**
|
|
1434
|
-
* Customize assistive prompt generation (e.g., timezone).
|
|
1435
|
-
*/
|
|
1436
|
-
assistive_prompt_config?: Experimental.AssistivePromptConfig;
|
|
1437
2892
|
/**
|
|
1438
2893
|
* Custom toolkits with grouped tools. Toolkit slugs must not conflict with
|
|
1439
2894
|
* existing Composio toolkits. All tools are no-auth.
|
|
@@ -1441,26 +2896,11 @@ export declare namespace SessionCreateParams {
|
|
|
1441
2896
|
custom_toolkits?: Array<Experimental.CustomToolkit>;
|
|
1442
2897
|
/**
|
|
1443
2898
|
* Custom tools to include in search. Standalone tools need no auth. Tools with
|
|
1444
|
-
* extends_toolkit inherit the Composio toolkit's connection.
|
|
1445
|
-
*/
|
|
1446
|
-
custom_tools?: Array<Experimental.CustomTool>;
|
|
1447
|
-
/**
|
|
1448
|
-
* Per-tool elicitation permission config. Default behavior + per-tool
|
|
1449
|
-
* always_allow/always_deny overrides. Mutation via PATCH.
|
|
2899
|
+
* extends_toolkit inherit the Composio toolkit's connection.
|
|
1450
2900
|
*/
|
|
1451
|
-
|
|
2901
|
+
custom_tools?: Array<Experimental.CustomTool>;
|
|
1452
2902
|
}
|
|
1453
2903
|
namespace Experimental {
|
|
1454
|
-
/**
|
|
1455
|
-
* Customize assistive prompt generation (e.g., timezone).
|
|
1456
|
-
*/
|
|
1457
|
-
interface AssistivePromptConfig {
|
|
1458
|
-
/**
|
|
1459
|
-
* IANA timezone identifier (e.g., 'America/New_York', 'Europe/London'). Used to
|
|
1460
|
-
* customize the system prompt with timezone-aware instructions.
|
|
1461
|
-
*/
|
|
1462
|
-
user_timezone?: string;
|
|
1463
|
-
}
|
|
1464
2904
|
interface CustomToolkit {
|
|
1465
2905
|
/**
|
|
1466
2906
|
* Used for BM25 search matching and shown in toolkit connection statuses.
|
|
@@ -1541,9 +2981,89 @@ export declare namespace SessionCreateParams {
|
|
|
1541
2981
|
[key: string]: unknown;
|
|
1542
2982
|
};
|
|
1543
2983
|
}
|
|
2984
|
+
}
|
|
2985
|
+
}
|
|
2986
|
+
export interface SessionLinkParams {
|
|
2987
|
+
/**
|
|
2988
|
+
* The unique slug identifier of the toolkit to connect
|
|
2989
|
+
*/
|
|
2990
|
+
toolkit: string;
|
|
2991
|
+
/**
|
|
2992
|
+
* A human-readable alias for this connected account. Must be unique per entity and
|
|
2993
|
+
* toolkit within the project.
|
|
2994
|
+
*/
|
|
2995
|
+
alias?: string;
|
|
2996
|
+
/**
|
|
2997
|
+
* URL where users will be redirected after completing auth
|
|
2998
|
+
*/
|
|
2999
|
+
callback_url?: string;
|
|
3000
|
+
}
|
|
3001
|
+
export interface SessionPatchParams {
|
|
3002
|
+
/**
|
|
3003
|
+
* The auth configs to use for the session. This will override the default behavior
|
|
3004
|
+
* and use the given auth config when specific toolkits are being executed
|
|
3005
|
+
*/
|
|
3006
|
+
auth_configs?: {
|
|
3007
|
+
[key: string]: string;
|
|
3008
|
+
};
|
|
3009
|
+
/**
|
|
3010
|
+
* The connected accounts to use for the session. This will override the default
|
|
3011
|
+
* behaviour and use the given connected account when specific toolkits are being
|
|
3012
|
+
* executed. Each connected account must exist (not deleted or disabled) and belong
|
|
3013
|
+
* to the same `user_id` as the session — otherwise session creation fails with a
|
|
3014
|
+
* clear error explaining which account didn't match.
|
|
3015
|
+
*/
|
|
3016
|
+
connected_accounts?: {
|
|
3017
|
+
[key: string]: string;
|
|
3018
|
+
};
|
|
3019
|
+
execute?: SessionPatchParams.Execute;
|
|
3020
|
+
experimental?: SessionPatchParams.Experimental | null;
|
|
3021
|
+
manage_connections?: SessionPatchParams.ManageConnections | null;
|
|
3022
|
+
multi_account?: SessionPatchParams.MultiAccount | null;
|
|
3023
|
+
/**
|
|
3024
|
+
* Preload configuration. Use an explicit list for frequently used tool slugs, or
|
|
3025
|
+
* "all" to dynamically expose every app tool allowed by positive
|
|
3026
|
+
* toolkits/tools/tags filters.
|
|
3027
|
+
*/
|
|
3028
|
+
preload?: SessionPatchParams.Preload;
|
|
3029
|
+
search?: SessionPatchParams.Search;
|
|
3030
|
+
/**
|
|
3031
|
+
* Global MCP tool annotation hints for filtering. Array format is treated as
|
|
3032
|
+
* enabled list. Object format supports both enabled (tool must have at least one)
|
|
3033
|
+
* and disabled (tool must NOT have any) lists. Toolkit-level tags override this.
|
|
3034
|
+
* Toolkit enabled/disabled lists take precedence over tag filtering.
|
|
3035
|
+
*/
|
|
3036
|
+
tags?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'> | SessionPatchParams.UnionMember1;
|
|
3037
|
+
/**
|
|
3038
|
+
* Toolkit configuration - specify either enable toolkits (allowlist) or disable
|
|
3039
|
+
* toolkits (denylist). Mutually exclusive.
|
|
3040
|
+
*/
|
|
3041
|
+
toolkits?: SessionPatchParams.Enable | SessionPatchParams.Disable;
|
|
3042
|
+
/**
|
|
3043
|
+
* Tool-level configuration per toolkit. Allows you to enable, disable, or filter
|
|
3044
|
+
* by tags for specific tools within each toolkit. Every slug passed in `enable` /
|
|
3045
|
+
* `disable` must be a valid Composio tool slug for that toolkit — invalid or
|
|
3046
|
+
* typo'd slugs fail session creation with a clear error listing which ones didn't
|
|
3047
|
+
* match.
|
|
3048
|
+
*/
|
|
3049
|
+
tools?: {
|
|
3050
|
+
[key: string]: SessionPatchParams.Enable | SessionPatchParams.Disable | SessionPatchParams.Tags;
|
|
3051
|
+
};
|
|
3052
|
+
workbench?: SessionPatchParams.Workbench | null;
|
|
3053
|
+
}
|
|
3054
|
+
export declare namespace SessionPatchParams {
|
|
3055
|
+
interface Execute {
|
|
3056
|
+
enable_multi_execute?: boolean;
|
|
3057
|
+
}
|
|
3058
|
+
interface Experimental {
|
|
1544
3059
|
/**
|
|
1545
|
-
* Per-tool elicitation permission config.
|
|
1546
|
-
|
|
3060
|
+
* Per-tool elicitation permission config. Replaces the stored block when provided.
|
|
3061
|
+
*/
|
|
3062
|
+
permissions?: Experimental.Permissions;
|
|
3063
|
+
}
|
|
3064
|
+
namespace Experimental {
|
|
3065
|
+
/**
|
|
3066
|
+
* Per-tool elicitation permission config. Replaces the stored block when provided.
|
|
1547
3067
|
*/
|
|
1548
3068
|
interface Permissions {
|
|
1549
3069
|
/**
|
|
@@ -1554,18 +3074,19 @@ export declare namespace SessionCreateParams {
|
|
|
1554
3074
|
*/
|
|
1555
3075
|
default: 'allow_all' | 'ask_every_call' | 'ask_once_per_session';
|
|
1556
3076
|
/**
|
|
1557
|
-
* Per-tool overrides keyed by `${toolSlug}:${connectedAccountId ?? "__none__"}
|
|
1558
|
-
*
|
|
1559
|
-
* tool
|
|
3077
|
+
* Per-tool overrides keyed by `${toolSlug}:${connectedAccountId ?? "__none__"}`,
|
|
3078
|
+
* plus account-wide overrides keyed by `*:${connectedAccountId ?? "__none__"}`.
|
|
3079
|
+
* Exact tool overrides take precedence over account-wide overrides. `always_allow`
|
|
3080
|
+
* skips the prompt and runs the tool; `always_deny` blocks the tool; `ask_once`
|
|
3081
|
+
* prompts once per session (allow/deny) and remembers; `ask_always` prompts on
|
|
3082
|
+
* every call with allow-once/allow-session/deny, ignoring any cached session
|
|
3083
|
+
* allow. Overrides take precedence over `default`.
|
|
1560
3084
|
*/
|
|
1561
3085
|
overrides?: {
|
|
1562
|
-
[key: string]: 'always_allow' | 'always_deny';
|
|
3086
|
+
[key: string]: 'always_allow' | 'always_deny' | 'ask_once' | 'ask_always';
|
|
1563
3087
|
};
|
|
1564
3088
|
}
|
|
1565
3089
|
}
|
|
1566
|
-
/**
|
|
1567
|
-
* Configuration for connection management settings
|
|
1568
|
-
*/
|
|
1569
3090
|
interface ManageConnections {
|
|
1570
3091
|
/**
|
|
1571
3092
|
* The URL to redirect to after a user completes authentication for a connected
|
|
@@ -1591,10 +3112,6 @@ export declare namespace SessionCreateParams {
|
|
|
1591
3112
|
*/
|
|
1592
3113
|
enable_wait_for_connections?: boolean | null;
|
|
1593
3114
|
}
|
|
1594
|
-
/**
|
|
1595
|
-
* Configure multi-account behavior. When enabled, users can connect multiple
|
|
1596
|
-
* accounts per toolkit.
|
|
1597
|
-
*/
|
|
1598
3115
|
interface MultiAccount {
|
|
1599
3116
|
/**
|
|
1600
3117
|
* When true, enables multi-account mode for this session. When not set, falls back
|
|
@@ -1613,23 +3130,20 @@ export declare namespace SessionCreateParams {
|
|
|
1613
3130
|
require_explicit_selection?: boolean;
|
|
1614
3131
|
}
|
|
1615
3132
|
/**
|
|
1616
|
-
* Preload configuration.
|
|
1617
|
-
*
|
|
1618
|
-
*
|
|
1619
|
-
* the session filters (`toolkits`, `tools`, `tags`), otherwise session creation
|
|
1620
|
-
* fails with a 400. Custom tools declared in `custom_tools` / `custom_toolkits`
|
|
1621
|
-
* can also be preloaded. Not supported when multi-account is enabled. Each
|
|
1622
|
-
* preloaded tool adds to the agent context window, so keep the list at or under
|
|
1623
|
-
* ~20 tools.
|
|
3133
|
+
* Preload configuration. Use an explicit list for frequently used tool slugs, or
|
|
3134
|
+
* "all" to dynamically expose every app tool allowed by positive
|
|
3135
|
+
* toolkits/tools/tags filters.
|
|
1624
3136
|
*/
|
|
1625
3137
|
interface Preload {
|
|
1626
3138
|
/**
|
|
1627
|
-
*
|
|
1628
|
-
*
|
|
1629
|
-
*
|
|
1630
|
-
* session creation.
|
|
3139
|
+
* Explicit tool slugs to preload, or "all" to dynamically expose all current and
|
|
3140
|
+
* future app tools allowed by the positive session filters. "all" is capped at
|
|
3141
|
+
* 1000 tools and is not supported without a positive allowlist.
|
|
1631
3142
|
*/
|
|
1632
|
-
tools?: Array<string
|
|
3143
|
+
tools?: Array<string> | string;
|
|
3144
|
+
}
|
|
3145
|
+
interface Search {
|
|
3146
|
+
enable?: boolean;
|
|
1633
3147
|
}
|
|
1634
3148
|
interface UnionMember1 {
|
|
1635
3149
|
disable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
@@ -1678,9 +3192,6 @@ export declare namespace SessionCreateParams {
|
|
|
1678
3192
|
enable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
|
|
1679
3193
|
}
|
|
1680
3194
|
}
|
|
1681
|
-
/**
|
|
1682
|
-
* Configuration for workbench behavior
|
|
1683
|
-
*/
|
|
1684
3195
|
interface Workbench {
|
|
1685
3196
|
/**
|
|
1686
3197
|
* Character threshold for automatic offloading. When workbench response exceeds
|
|
@@ -1700,68 +3211,12 @@ export declare namespace SessionCreateParams {
|
|
|
1700
3211
|
enable_proxy_execution?: boolean;
|
|
1701
3212
|
/**
|
|
1702
3213
|
* Sandbox compute tier: standard (1 vCPU / 1 GB), medium (2 vCPU / 2 GB), large (4
|
|
1703
|
-
* vCPU / 4 GB), xlarge (8 vCPU / 8 GB).
|
|
3214
|
+
* vCPU / 4 GB), xlarge (8 vCPU / 8 GB). Patching this value recreates the sandbox
|
|
3215
|
+
* on next access — sandbox FS state is lost, but /mnt/files/ R2 mount persists.
|
|
1704
3216
|
*/
|
|
1705
3217
|
sandbox_size?: 'standard' | 'medium' | 'large' | 'xlarge';
|
|
1706
3218
|
}
|
|
1707
3219
|
}
|
|
1708
|
-
export interface SessionExecuteParams {
|
|
1709
|
-
/**
|
|
1710
|
-
* The unique slug identifier of the tool to execute. Supports both meta tools and
|
|
1711
|
-
* app tools exposed by the session.
|
|
1712
|
-
*/
|
|
1713
|
-
tool_slug: string;
|
|
1714
|
-
/**
|
|
1715
|
-
* Account identifier to specify which connected account to use for direct tool
|
|
1716
|
-
* execution. Use the account ID (e.g. "coup_hurricane_dal_analytical") or an
|
|
1717
|
-
* alias. When omitted with a single account, the default is used. When omitted
|
|
1718
|
-
* with multiple accounts, an error lists available accounts. Meta/helper tools
|
|
1719
|
-
* either ignore this top-level field or define their own account-selection fields,
|
|
1720
|
-
* for example COMPOSIO_MULTI_EXECUTE_TOOL.tools[].account.
|
|
1721
|
-
*/
|
|
1722
|
-
account?: string;
|
|
1723
|
-
/**
|
|
1724
|
-
* The arguments required by the tool
|
|
1725
|
-
*/
|
|
1726
|
-
arguments?: {
|
|
1727
|
-
[key: string]: unknown;
|
|
1728
|
-
};
|
|
1729
|
-
/**
|
|
1730
|
-
* When true, direct non-meta tool execution may return a workbench offload preview
|
|
1731
|
-
* if the response exceeds the configured threshold and the session workbench is
|
|
1732
|
-
* enabled. When omitted or false, direct tool execution returns the normal inline
|
|
1733
|
-
* response. Meta/helper tools are unaffected, and COMPOSIO_MULTI_EXECUTE_TOOL uses
|
|
1734
|
-
* session.workbench configuration for its own batch-level offload behavior.
|
|
1735
|
-
*/
|
|
1736
|
-
enable_auto_workbench_offload?: boolean;
|
|
1737
|
-
}
|
|
1738
|
-
export interface SessionExecuteMetaParams {
|
|
1739
|
-
/**
|
|
1740
|
-
* The unique slug identifier of the meta tool to execute
|
|
1741
|
-
*/
|
|
1742
|
-
slug: 'COMPOSIO_SEARCH_TOOLS' | 'COMPOSIO_MULTI_EXECUTE_TOOL' | 'COMPOSIO_MANAGE_CONNECTIONS' | 'COMPOSIO_WAIT_FOR_CONNECTIONS' | 'COMPOSIO_REMOTE_WORKBENCH' | 'COMPOSIO_REMOTE_BASH_TOOL' | 'COMPOSIO_GET_TOOL_SCHEMAS' | 'COMPOSIO_UPSERT_RECIPE' | 'COMPOSIO_GET_RECIPE';
|
|
1743
|
-
/**
|
|
1744
|
-
* The arguments required by the meta tool
|
|
1745
|
-
*/
|
|
1746
|
-
arguments?: {
|
|
1747
|
-
[key: string]: unknown;
|
|
1748
|
-
};
|
|
1749
|
-
}
|
|
1750
|
-
export interface SessionLinkParams {
|
|
1751
|
-
/**
|
|
1752
|
-
* The unique slug identifier of the toolkit to connect
|
|
1753
|
-
*/
|
|
1754
|
-
toolkit: string;
|
|
1755
|
-
/**
|
|
1756
|
-
* A human-readable alias for this connected account. Must be unique per entity and
|
|
1757
|
-
* toolkit within the project.
|
|
1758
|
-
*/
|
|
1759
|
-
alias?: string;
|
|
1760
|
-
/**
|
|
1761
|
-
* URL where users will be redirected after completing auth
|
|
1762
|
-
*/
|
|
1763
|
-
callback_url?: string;
|
|
1764
|
-
}
|
|
1765
3220
|
export interface SessionProxyExecuteParams {
|
|
1766
3221
|
/**
|
|
1767
3222
|
* The API endpoint to call (absolute URL or path relative to base URL of the
|
|
@@ -2260,12 +3715,16 @@ export declare namespace SessionProxyExecuteParams {
|
|
|
2260
3715
|
}
|
|
2261
3716
|
export interface SessionSearchParams {
|
|
2262
3717
|
/**
|
|
2263
|
-
* List of search queries to execute in parallel.
|
|
3718
|
+
* List of search queries to execute in parallel.
|
|
2264
3719
|
*/
|
|
2265
3720
|
queries: Array<SessionSearchParams.Query>;
|
|
2266
3721
|
/**
|
|
2267
|
-
*
|
|
2268
|
-
*
|
|
3722
|
+
* Inline custom tools and toolkits for this request. v3.1 sessions do not persist
|
|
3723
|
+
* customs — pass them on every request that needs them.
|
|
3724
|
+
*/
|
|
3725
|
+
experimental?: SessionSearchParams.Experimental;
|
|
3726
|
+
/**
|
|
3727
|
+
* Optional model hint for search/planning behavior (e.g., "gpt-4o").
|
|
2269
3728
|
*/
|
|
2270
3729
|
model?: string;
|
|
2271
3730
|
}
|
|
@@ -2282,6 +3741,104 @@ export declare namespace SessionSearchParams {
|
|
|
2282
3741
|
*/
|
|
2283
3742
|
known_fields?: string;
|
|
2284
3743
|
}
|
|
3744
|
+
/**
|
|
3745
|
+
* Inline custom tools and toolkits for this request. v3.1 sessions do not persist
|
|
3746
|
+
* customs — pass them on every request that needs them.
|
|
3747
|
+
*/
|
|
3748
|
+
interface Experimental {
|
|
3749
|
+
/**
|
|
3750
|
+
* Custom toolkits with grouped tools. Toolkit slugs must not conflict with
|
|
3751
|
+
* existing Composio toolkits. All tools are no-auth.
|
|
3752
|
+
*/
|
|
3753
|
+
custom_toolkits?: Array<Experimental.CustomToolkit>;
|
|
3754
|
+
/**
|
|
3755
|
+
* Custom tools to include in search. Standalone tools need no auth. Tools with
|
|
3756
|
+
* extends_toolkit inherit the Composio toolkit's connection.
|
|
3757
|
+
*/
|
|
3758
|
+
custom_tools?: Array<Experimental.CustomTool>;
|
|
3759
|
+
}
|
|
3760
|
+
namespace Experimental {
|
|
3761
|
+
interface CustomToolkit {
|
|
3762
|
+
/**
|
|
3763
|
+
* Used for BM25 search matching and shown in toolkit connection statuses.
|
|
3764
|
+
*/
|
|
3765
|
+
description: string;
|
|
3766
|
+
/**
|
|
3767
|
+
* Display name shown to the LLM and in search results.
|
|
3768
|
+
*/
|
|
3769
|
+
name: string;
|
|
3770
|
+
/**
|
|
3771
|
+
* Unique slug for the toolkit. Must not conflict with existing Composio toolkit
|
|
3772
|
+
* slugs. Alphanumeric, underscores, and hyphens only.
|
|
3773
|
+
*/
|
|
3774
|
+
slug: string;
|
|
3775
|
+
/**
|
|
3776
|
+
* Tools in this custom toolkit
|
|
3777
|
+
*/
|
|
3778
|
+
tools: Array<CustomToolkit.Tool>;
|
|
3779
|
+
}
|
|
3780
|
+
namespace CustomToolkit {
|
|
3781
|
+
interface Tool {
|
|
3782
|
+
/**
|
|
3783
|
+
* Used for BM25 search matching and shown to the LLM.
|
|
3784
|
+
*/
|
|
3785
|
+
description: string;
|
|
3786
|
+
/**
|
|
3787
|
+
* Must have type: "object" and a properties field.
|
|
3788
|
+
*/
|
|
3789
|
+
input_schema: {
|
|
3790
|
+
[key: string]: unknown;
|
|
3791
|
+
};
|
|
3792
|
+
/**
|
|
3793
|
+
* Human-readable display name
|
|
3794
|
+
*/
|
|
3795
|
+
name: string;
|
|
3796
|
+
/**
|
|
3797
|
+
* Tool slug. Combined with toolkit slug to form LOCAL*<TOOLKIT>*<TOOL> (max 60
|
|
3798
|
+
* chars total).
|
|
3799
|
+
*/
|
|
3800
|
+
slug: string;
|
|
3801
|
+
/**
|
|
3802
|
+
* Optional output schema for the tool response.
|
|
3803
|
+
*/
|
|
3804
|
+
output_schema?: {
|
|
3805
|
+
[key: string]: unknown;
|
|
3806
|
+
};
|
|
3807
|
+
}
|
|
3808
|
+
}
|
|
3809
|
+
interface CustomTool {
|
|
3810
|
+
/**
|
|
3811
|
+
* Used for BM25 search matching and shown to the LLM.
|
|
3812
|
+
*/
|
|
3813
|
+
description: string;
|
|
3814
|
+
/**
|
|
3815
|
+
* Must have type: "object" and a properties field.
|
|
3816
|
+
*/
|
|
3817
|
+
input_schema: {
|
|
3818
|
+
[key: string]: unknown;
|
|
3819
|
+
};
|
|
3820
|
+
/**
|
|
3821
|
+
* Human-readable display name
|
|
3822
|
+
*/
|
|
3823
|
+
name: string;
|
|
3824
|
+
/**
|
|
3825
|
+
* Tool slug. Forms LOCAL*<TOOL> (standalone) or LOCAL*<TOOLKIT>\_<TOOL>
|
|
3826
|
+
* (extending). Max 60 chars total.
|
|
3827
|
+
*/
|
|
3828
|
+
slug: string;
|
|
3829
|
+
/**
|
|
3830
|
+
* If set, must be a valid Composio toolkit slug. The tool inherits that toolkit's
|
|
3831
|
+
* auth/connection status. If omitted, the tool is standalone (no-auth).
|
|
3832
|
+
*/
|
|
3833
|
+
extends_toolkit?: string;
|
|
3834
|
+
/**
|
|
3835
|
+
* JSON Schema describing tool output (optional)
|
|
3836
|
+
*/
|
|
3837
|
+
output_schema?: {
|
|
3838
|
+
[key: string]: unknown;
|
|
3839
|
+
};
|
|
3840
|
+
}
|
|
3841
|
+
}
|
|
2285
3842
|
}
|
|
2286
3843
|
export interface SessionToolkitsParams {
|
|
2287
3844
|
/**
|
|
@@ -2311,9 +3868,20 @@ export interface SessionToolkitsParams {
|
|
|
2311
3868
|
toolkits?: Array<string> | null;
|
|
2312
3869
|
}
|
|
2313
3870
|
export interface SessionToolsParams {
|
|
3871
|
+
/**
|
|
3872
|
+
* Cursor for pagination. The cursor is a base64 encoded string of the page and
|
|
3873
|
+
* limit. The page is the page number and the limit is the number of items per
|
|
3874
|
+
* page. The cursor is used to paginate through the items. The cursor is not
|
|
3875
|
+
* required for the first page.
|
|
3876
|
+
*/
|
|
3877
|
+
cursor?: string;
|
|
3878
|
+
/**
|
|
3879
|
+
* Number of items per page, max allowed is 500
|
|
3880
|
+
*/
|
|
3881
|
+
limit?: number;
|
|
2314
3882
|
}
|
|
2315
3883
|
export declare namespace Session {
|
|
2316
|
-
export { type SessionCreateResponse as SessionCreateResponse, type SessionRetrieveResponse as SessionRetrieveResponse, type SessionExecuteResponse as SessionExecuteResponse, type SessionExecuteMetaResponse as SessionExecuteMetaResponse, type SessionLinkResponse as SessionLinkResponse, type SessionProxyExecuteResponse as SessionProxyExecuteResponse, type SessionSearchResponse as SessionSearchResponse, type SessionToolkitsResponse as SessionToolkitsResponse, type SessionToolsResponse as SessionToolsResponse, type SessionCreateParams as SessionCreateParams, type SessionExecuteParams as SessionExecuteParams, type SessionExecuteMetaParams as SessionExecuteMetaParams, type SessionLinkParams as SessionLinkParams, type SessionProxyExecuteParams as SessionProxyExecuteParams, type SessionSearchParams as SessionSearchParams, type SessionToolkitsParams as SessionToolkitsParams, type SessionToolsParams as SessionToolsParams, };
|
|
3884
|
+
export { type SessionCreateResponse as SessionCreateResponse, type SessionRetrieveResponse as SessionRetrieveResponse, type SessionAttachResponse as SessionAttachResponse, type SessionConfigHistoryResponse as SessionConfigHistoryResponse, type SessionExecuteResponse as SessionExecuteResponse, type SessionExecuteMetaResponse as SessionExecuteMetaResponse, type SessionLinkResponse as SessionLinkResponse, type SessionPatchResponse as SessionPatchResponse, type SessionProxyExecuteResponse as SessionProxyExecuteResponse, type SessionSearchResponse as SessionSearchResponse, type SessionToolkitsResponse as SessionToolkitsResponse, type SessionToolsResponse as SessionToolsResponse, type SessionCreateParams as SessionCreateParams, type SessionAttachParams as SessionAttachParams, type SessionConfigHistoryParams as SessionConfigHistoryParams, type SessionExecuteParams as SessionExecuteParams, type SessionExecuteMetaParams as SessionExecuteMetaParams, type SessionLinkParams as SessionLinkParams, type SessionPatchParams as SessionPatchParams, type SessionProxyExecuteParams as SessionProxyExecuteParams, type SessionSearchParams as SessionSearchParams, type SessionToolkitsParams as SessionToolkitsParams, type SessionToolsParams as SessionToolsParams, };
|
|
2317
3885
|
export { Files as Files, type FileListResponse as FileListResponse, type FileDeleteResponse as FileDeleteResponse, type FileCreateDownloadURLResponse as FileCreateDownloadURLResponse, type FileCreateUploadURLResponse as FileCreateUploadURLResponse, type FileListParams as FileListParams, type FileDeleteParams as FileDeleteParams, type FileCreateDownloadURLParams as FileCreateDownloadURLParams, type FileCreateUploadURLParams as FileCreateUploadURLParams, };
|
|
2318
3886
|
}
|
|
2319
3887
|
//# sourceMappingURL=session.d.mts.map
|