@composio/client 0.1.0-alpha.60 → 0.1.0-alpha.62

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (229) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/client.d.mts +34 -1
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +34 -1
  5. package/client.d.ts.map +1 -1
  6. package/client.js +41 -7
  7. package/client.js.map +1 -1
  8. package/client.mjs +41 -7
  9. package/client.mjs.map +1 -1
  10. package/internal/utils/query.d.mts +2 -0
  11. package/internal/utils/query.d.mts.map +1 -0
  12. package/internal/utils/query.d.ts +2 -0
  13. package/internal/utils/query.d.ts.map +1 -0
  14. package/internal/utils/query.js +10 -0
  15. package/internal/utils/query.js.map +1 -0
  16. package/internal/utils/query.mjs +6 -0
  17. package/internal/utils/query.mjs.map +1 -0
  18. package/internal/utils.d.mts +1 -0
  19. package/internal/utils.d.ts +1 -0
  20. package/internal/utils.js +1 -0
  21. package/internal/utils.js.map +1 -1
  22. package/internal/utils.mjs +1 -0
  23. package/package.json +12 -1
  24. package/resources/auth-configs.d.mts +20 -1
  25. package/resources/auth-configs.d.mts.map +1 -1
  26. package/resources/auth-configs.d.ts +20 -1
  27. package/resources/auth-configs.d.ts.map +1 -1
  28. package/resources/auth-configs.js +3 -0
  29. package/resources/auth-configs.js.map +1 -1
  30. package/resources/auth-configs.mjs +3 -0
  31. package/resources/auth-configs.mjs.map +1 -1
  32. package/resources/cli/realtime.d.mts +3 -0
  33. package/resources/cli/realtime.d.mts.map +1 -1
  34. package/resources/cli/realtime.d.ts +3 -0
  35. package/resources/cli/realtime.d.ts.map +1 -1
  36. package/resources/cli/realtime.js +3 -0
  37. package/resources/cli/realtime.js.map +1 -1
  38. package/resources/cli/realtime.mjs +3 -0
  39. package/resources/cli/realtime.mjs.map +1 -1
  40. package/resources/connected-accounts.d.mts +899 -174
  41. package/resources/connected-accounts.d.mts.map +1 -1
  42. package/resources/connected-accounts.d.ts +899 -174
  43. package/resources/connected-accounts.d.ts.map +1 -1
  44. package/resources/connected-accounts.js +3 -0
  45. package/resources/connected-accounts.js.map +1 -1
  46. package/resources/connected-accounts.mjs +3 -0
  47. package/resources/connected-accounts.mjs.map +1 -1
  48. package/resources/files.d.mts +3 -0
  49. package/resources/files.d.mts.map +1 -1
  50. package/resources/files.d.ts +3 -0
  51. package/resources/files.d.ts.map +1 -1
  52. package/resources/files.js +3 -0
  53. package/resources/files.js.map +1 -1
  54. package/resources/files.mjs +3 -0
  55. package/resources/files.mjs.map +1 -1
  56. package/resources/link.d.mts +171 -1
  57. package/resources/link.d.mts.map +1 -1
  58. package/resources/link.d.ts +171 -1
  59. package/resources/link.d.ts.map +1 -1
  60. package/resources/link.js +3 -0
  61. package/resources/link.js.map +1 -1
  62. package/resources/link.mjs +3 -0
  63. package/resources/link.mjs.map +1 -1
  64. package/resources/logs/tools.d.mts +3 -0
  65. package/resources/logs/tools.d.mts.map +1 -1
  66. package/resources/logs/tools.d.ts +3 -0
  67. package/resources/logs/tools.d.ts.map +1 -1
  68. package/resources/logs/tools.js +3 -0
  69. package/resources/logs/tools.js.map +1 -1
  70. package/resources/logs/tools.mjs +3 -0
  71. package/resources/logs/tools.mjs.map +1 -1
  72. package/resources/logs/triggers.d.mts +3 -0
  73. package/resources/logs/triggers.d.mts.map +1 -1
  74. package/resources/logs/triggers.d.ts +3 -0
  75. package/resources/logs/triggers.d.ts.map +1 -1
  76. package/resources/logs/triggers.js +3 -0
  77. package/resources/logs/triggers.js.map +1 -1
  78. package/resources/logs/triggers.mjs +3 -0
  79. package/resources/logs/triggers.mjs.map +1 -1
  80. package/resources/mcp/custom.d.mts +3 -0
  81. package/resources/mcp/custom.d.mts.map +1 -1
  82. package/resources/mcp/custom.d.ts +3 -0
  83. package/resources/mcp/custom.d.ts.map +1 -1
  84. package/resources/mcp/custom.js +3 -0
  85. package/resources/mcp/custom.js.map +1 -1
  86. package/resources/mcp/custom.mjs +3 -0
  87. package/resources/mcp/custom.mjs.map +1 -1
  88. package/resources/mcp/generate.d.mts +3 -0
  89. package/resources/mcp/generate.d.mts.map +1 -1
  90. package/resources/mcp/generate.d.ts +3 -0
  91. package/resources/mcp/generate.d.ts.map +1 -1
  92. package/resources/mcp/generate.js +3 -0
  93. package/resources/mcp/generate.js.map +1 -1
  94. package/resources/mcp/generate.mjs +3 -0
  95. package/resources/mcp/generate.mjs.map +1 -1
  96. package/resources/mcp/mcp.d.mts +3 -0
  97. package/resources/mcp/mcp.d.mts.map +1 -1
  98. package/resources/mcp/mcp.d.ts +3 -0
  99. package/resources/mcp/mcp.d.ts.map +1 -1
  100. package/resources/mcp/mcp.js +3 -0
  101. package/resources/mcp/mcp.js.map +1 -1
  102. package/resources/mcp/mcp.mjs +3 -0
  103. package/resources/mcp/mcp.mjs.map +1 -1
  104. package/resources/migration.d.mts +3 -0
  105. package/resources/migration.d.mts.map +1 -1
  106. package/resources/migration.d.ts +3 -0
  107. package/resources/migration.d.ts.map +1 -1
  108. package/resources/migration.js +3 -0
  109. package/resources/migration.js.map +1 -1
  110. package/resources/migration.mjs +3 -0
  111. package/resources/migration.mjs.map +1 -1
  112. package/resources/tool-router/index.d.mts +1 -1
  113. package/resources/tool-router/index.d.mts.map +1 -1
  114. package/resources/tool-router/index.d.ts +1 -1
  115. package/resources/tool-router/index.d.ts.map +1 -1
  116. package/resources/tool-router/index.js +2 -2
  117. package/resources/tool-router/index.js.map +1 -1
  118. package/resources/tool-router/index.mjs +1 -1
  119. package/resources/tool-router/index.mjs.map +1 -1
  120. package/resources/tool-router/session/files.d.mts +205 -0
  121. package/resources/tool-router/session/files.d.mts.map +1 -0
  122. package/resources/tool-router/session/files.d.ts +205 -0
  123. package/resources/tool-router/session/files.d.ts.map +1 -0
  124. package/resources/tool-router/session/files.js +101 -0
  125. package/resources/tool-router/session/files.js.map +1 -0
  126. package/resources/tool-router/session/files.mjs +97 -0
  127. package/resources/tool-router/session/files.mjs.map +1 -0
  128. package/resources/tool-router/session/index.d.mts +3 -0
  129. package/resources/tool-router/session/index.d.mts.map +1 -0
  130. package/resources/tool-router/session/index.d.ts +3 -0
  131. package/resources/tool-router/session/index.d.ts.map +1 -0
  132. package/resources/tool-router/session/index.js +9 -0
  133. package/resources/tool-router/session/index.js.map +1 -0
  134. package/resources/tool-router/session/index.mjs +4 -0
  135. package/resources/tool-router/session/index.mjs.map +1 -0
  136. package/resources/tool-router/session/session.d.mts +1990 -0
  137. package/resources/tool-router/session/session.d.mts.map +1 -0
  138. package/resources/tool-router/session/session.d.ts +1990 -0
  139. package/resources/tool-router/session/session.d.ts.map +1 -0
  140. package/resources/tool-router/session/session.js +181 -0
  141. package/resources/tool-router/session/session.js.map +1 -0
  142. package/resources/tool-router/session/session.mjs +176 -0
  143. package/resources/tool-router/session/session.mjs.map +1 -0
  144. package/resources/tool-router/session.d.mts +1 -1193
  145. package/resources/tool-router/session.d.mts.map +1 -1
  146. package/resources/tool-router/session.d.ts +1 -1193
  147. package/resources/tool-router/session.d.ts.map +1 -1
  148. package/resources/tool-router/session.js +2 -138
  149. package/resources/tool-router/session.js.map +1 -1
  150. package/resources/tool-router/session.mjs +1 -136
  151. package/resources/tool-router/session.mjs.map +1 -1
  152. package/resources/tool-router/tool-router.d.mts +6 -3
  153. package/resources/tool-router/tool-router.d.mts.map +1 -1
  154. package/resources/tool-router/tool-router.d.ts +6 -3
  155. package/resources/tool-router/tool-router.d.ts.map +1 -1
  156. package/resources/tool-router/tool-router.js +5 -2
  157. package/resources/tool-router/tool-router.js.map +1 -1
  158. package/resources/tool-router/tool-router.mjs +5 -2
  159. package/resources/tool-router/tool-router.mjs.map +1 -1
  160. package/resources/toolkits.d.mts +16 -0
  161. package/resources/toolkits.d.mts.map +1 -1
  162. package/resources/toolkits.d.ts +16 -0
  163. package/resources/toolkits.d.ts.map +1 -1
  164. package/resources/toolkits.js +3 -0
  165. package/resources/toolkits.js.map +1 -1
  166. package/resources/toolkits.mjs +3 -0
  167. package/resources/toolkits.mjs.map +1 -1
  168. package/resources/tools.d.mts +83 -2
  169. package/resources/tools.d.mts.map +1 -1
  170. package/resources/tools.d.ts +83 -2
  171. package/resources/tools.d.ts.map +1 -1
  172. package/resources/tools.js +3 -0
  173. package/resources/tools.js.map +1 -1
  174. package/resources/tools.mjs +3 -0
  175. package/resources/tools.mjs.map +1 -1
  176. package/resources/trigger-instances/manage.d.mts +3 -0
  177. package/resources/trigger-instances/manage.d.mts.map +1 -1
  178. package/resources/trigger-instances/manage.d.ts +3 -0
  179. package/resources/trigger-instances/manage.d.ts.map +1 -1
  180. package/resources/trigger-instances/manage.js +3 -0
  181. package/resources/trigger-instances/manage.js.map +1 -1
  182. package/resources/trigger-instances/manage.mjs +3 -0
  183. package/resources/trigger-instances/manage.mjs.map +1 -1
  184. package/resources/trigger-instances/trigger-instances.d.mts +7 -0
  185. package/resources/trigger-instances/trigger-instances.d.mts.map +1 -1
  186. package/resources/trigger-instances/trigger-instances.d.ts +7 -0
  187. package/resources/trigger-instances/trigger-instances.d.ts.map +1 -1
  188. package/resources/trigger-instances/trigger-instances.js +3 -0
  189. package/resources/trigger-instances/trigger-instances.js.map +1 -1
  190. package/resources/trigger-instances/trigger-instances.mjs +3 -0
  191. package/resources/trigger-instances/trigger-instances.mjs.map +1 -1
  192. package/resources/triggers-types.d.mts +3 -0
  193. package/resources/triggers-types.d.mts.map +1 -1
  194. package/resources/triggers-types.d.ts +3 -0
  195. package/resources/triggers-types.d.ts.map +1 -1
  196. package/resources/triggers-types.js +3 -0
  197. package/resources/triggers-types.js.map +1 -1
  198. package/resources/triggers-types.mjs +3 -0
  199. package/resources/triggers-types.mjs.map +1 -1
  200. package/src/client.ts +44 -10
  201. package/src/internal/utils/query.ts +7 -0
  202. package/src/internal/utils.ts +1 -0
  203. package/src/resources/auth-configs.ts +24 -1
  204. package/src/resources/cli/realtime.ts +3 -0
  205. package/src/resources/connected-accounts.ts +3141 -1736
  206. package/src/resources/files.ts +3 -0
  207. package/src/resources/link.ts +332 -1
  208. package/src/resources/logs/tools.ts +3 -0
  209. package/src/resources/logs/triggers.ts +3 -0
  210. package/src/resources/mcp/custom.ts +3 -0
  211. package/src/resources/mcp/generate.ts +3 -0
  212. package/src/resources/mcp/mcp.ts +3 -0
  213. package/src/resources/migration.ts +3 -0
  214. package/src/resources/tool-router/index.ts +3 -1
  215. package/src/resources/tool-router/session/files.ts +284 -0
  216. package/src/resources/tool-router/session/index.ts +33 -0
  217. package/src/resources/tool-router/session/session.ts +2669 -0
  218. package/src/resources/tool-router/session.ts +1 -1432
  219. package/src/resources/tool-router/tool-router.ts +9 -2
  220. package/src/resources/toolkits.ts +19 -0
  221. package/src/resources/tools.ts +151 -2
  222. package/src/resources/trigger-instances/manage.ts +3 -0
  223. package/src/resources/trigger-instances/trigger-instances.ts +8 -0
  224. package/src/resources/triggers-types.ts +3 -0
  225. package/src/version.ts +1 -1
  226. package/version.d.mts +1 -1
  227. package/version.d.ts +1 -1
  228. package/version.js +1 -1
  229. package/version.mjs +1 -1
@@ -0,0 +1,1990 @@
1
+ import { APIResource } from "../../../core/resource.js";
2
+ import * as FilesAPI from "./files.js";
3
+ import { FileCreateDownloadURLParams, FileCreateDownloadURLResponse, FileCreateUploadURLParams, FileCreateUploadURLResponse, FileDeleteParams, FileDeleteResponse, FileListParams, FileListResponse, Files } from "./files.js";
4
+ import { APIPromise } from "../../../core/api-promise.js";
5
+ import { RequestOptions } from "../../../internal/request-options.js";
6
+ /**
7
+ * (Labs) Tool router endpoints
8
+ */
9
+ export declare class Session extends APIResource {
10
+ files: FilesAPI.Files;
11
+ /**
12
+ * Creates a new session for the tool router feature. This endpoint initializes a
13
+ * new session with specified toolkits and their authentication configurations. The
14
+ * session provides an isolated environment for testing and managing tool routing
15
+ * logic with scoped MCP server access.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * const session = await client.toolRouter.session.create({
20
+ * user_id: 'user_123456789',
21
+ * });
22
+ * ```
23
+ */
24
+ create(body: SessionCreateParams, options?: RequestOptions): APIPromise<SessionCreateResponse>;
25
+ /**
26
+ * Retrieves an existing tool router session by its ID. Returns the session
27
+ * configuration, MCP server URL, and available tools.
28
+ *
29
+ * @example
30
+ * ```ts
31
+ * const session = await client.toolRouter.session.retrieve(
32
+ * 'trs_123456789',
33
+ * );
34
+ * ```
35
+ */
36
+ retrieve(sessionID: string, options?: RequestOptions): APIPromise<SessionRetrieveResponse>;
37
+ /**
38
+ * Executes a specific tool within a tool router session. The toolkit is
39
+ * automatically inferred from the tool slug. The tool must belong to an allowed
40
+ * toolkit and must not be disabled in the session configuration. This endpoint
41
+ * validates permissions, resolves connected accounts, and executes the tool with
42
+ * the session context.
43
+ *
44
+ * @example
45
+ * ```ts
46
+ * const response = await client.toolRouter.session.execute(
47
+ * 'trs_LX9uJKBinWWr',
48
+ * { tool_slug: 'GITHUB_CREATE_ISSUE' },
49
+ * );
50
+ * ```
51
+ */
52
+ execute(sessionID: string, body: SessionExecuteParams, options?: RequestOptions): APIPromise<SessionExecuteResponse>;
53
+ /**
54
+ * Executes a Composio meta tool (COMPOSIO\_\*) within a tool router session.
55
+ *
56
+ * @example
57
+ * ```ts
58
+ * const response =
59
+ * await client.toolRouter.session.executeMeta(
60
+ * 'trs_LX9uJKBinWWr',
61
+ * { slug: 'COMPOSIO_MANAGE_CONNECTIONS' },
62
+ * );
63
+ * ```
64
+ */
65
+ executeMeta(sessionID: string, body: SessionExecuteMetaParams, options?: RequestOptions): APIPromise<SessionExecuteMetaResponse>;
66
+ /**
67
+ * Initiates an authentication link session for a specific toolkit within a tool
68
+ * router session. Returns a link token and redirect URL that users can use to
69
+ * complete the OAuth flow.
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * const response = await client.toolRouter.session.link(
74
+ * 'trs_LX9uJKBinWWr',
75
+ * { toolkit: 'github' },
76
+ * );
77
+ * ```
78
+ */
79
+ link(sessionID: string, body: SessionLinkParams, options?: RequestOptions): APIPromise<SessionLinkResponse>;
80
+ /**
81
+ * Execute any native API call on a toolkit with authentication automatically
82
+ * injected from Composio. This endpoint proxies HTTP requests to third-party APIs
83
+ * using connected account credentials resolved from the session context. Provide
84
+ * the toolkit slug, API endpoint, and HTTP method — Composio handles
85
+ * authentication injection, abstracting away credential management. Supports all
86
+ * HTTP methods, custom headers/query parameters, and binary request/response
87
+ * bodies.
88
+ *
89
+ * @example
90
+ * ```ts
91
+ * const response =
92
+ * await client.toolRouter.session.proxyExecute(
93
+ * 'trs_LX9uJKBinWWr',
94
+ * {
95
+ * endpoint: '/api/v1/resources',
96
+ * method: 'GET',
97
+ * toolkit_slug: 'gmail',
98
+ * },
99
+ * );
100
+ * ```
101
+ */
102
+ proxyExecute(sessionID: string, body: SessionProxyExecuteParams, options?: RequestOptions): APIPromise<SessionProxyExecuteResponse>;
103
+ /**
104
+ * Search for tools matching a given use case query within a tool router session.
105
+ * Returns matching tool slugs, full tool schemas, toolkit connection statuses, and
106
+ * workflow guidance in a predictable format.
107
+ *
108
+ * @example
109
+ * ```ts
110
+ * const response = await client.toolRouter.session.search(
111
+ * 'trs_LX9uJKBinWWr',
112
+ * {
113
+ * queries: [
114
+ * { use_case: 'Send a slack message to a channel' },
115
+ * ],
116
+ * },
117
+ * );
118
+ * ```
119
+ */
120
+ search(sessionID: string, body: SessionSearchParams, options?: RequestOptions): APIPromise<SessionSearchResponse>;
121
+ /**
122
+ * Retrieves a cursor-paginated list of toolkits available in the tool router
123
+ * session. Includes toolkit metadata, composio-managed auth schemes, and connected
124
+ * accounts if available. Optionally filter by specific toolkit slugs.
125
+ *
126
+ * @example
127
+ * ```ts
128
+ * const response = await client.toolRouter.session.toolkits(
129
+ * 'trs_123456789',
130
+ * );
131
+ * ```
132
+ */
133
+ toolkits(sessionID: string, query?: SessionToolkitsParams | null | undefined, options?: RequestOptions): APIPromise<SessionToolkitsResponse>;
134
+ /**
135
+ * Returns the meta tools available in a tool router session with their complete
136
+ * schemas. This includes request and response schemas specific to the session
137
+ * context.
138
+ *
139
+ * @example
140
+ * ```ts
141
+ * const response = await client.toolRouter.session.tools(
142
+ * 'session_id',
143
+ * );
144
+ * ```
145
+ */
146
+ tools(sessionID: string, query?: SessionToolsParams | null | undefined, options?: RequestOptions): APIPromise<SessionToolsResponse>;
147
+ }
148
+ export interface SessionCreateResponse {
149
+ /**
150
+ * The session configuration including user, toolkits, and overrides
151
+ */
152
+ config: SessionCreateResponse.Config;
153
+ mcp: SessionCreateResponse.Mcp;
154
+ /**
155
+ * The identifier of the session
156
+ */
157
+ session_id: string;
158
+ /**
159
+ * List of available tools in this session
160
+ */
161
+ tool_router_tools: Array<string>;
162
+ /**
163
+ * Experimental features including the generated system prompt. Only returned on
164
+ * session creation, not on GET.
165
+ */
166
+ experimental?: SessionCreateResponse.Experimental;
167
+ }
168
+ export declare namespace SessionCreateResponse {
169
+ /**
170
+ * The session configuration including user, toolkits, and overrides
171
+ */
172
+ interface Config {
173
+ /**
174
+ * User identifier for this session
175
+ */
176
+ user_id: string;
177
+ /**
178
+ * Auth config overrides per toolkit
179
+ */
180
+ auth_configs?: {
181
+ [key: string]: string;
182
+ };
183
+ /**
184
+ * Connected account overrides per toolkit
185
+ */
186
+ connected_accounts?: {
187
+ [key: string]: string;
188
+ };
189
+ /**
190
+ * Manage connections configuration
191
+ */
192
+ manage_connections?: Config.ManageConnections;
193
+ /**
194
+ * MCP tool annotation hints for filtering tools with enabled/disabled support.
195
+ * enabled: tags that the tool must have at least one of. disabled: tags that the
196
+ * tool must NOT have any of. Both conditions must be satisfied.
197
+ */
198
+ tags?: Config.Tags;
199
+ /**
200
+ * Toolkit configuration - either enabled list or disabled list
201
+ */
202
+ toolkits?: Config.Enabled | Config.Disabled;
203
+ /**
204
+ * Tool-level configuration per toolkit
205
+ */
206
+ tools?: {
207
+ [key: string]: Config.Enabled | Config.Disabled | Config.Tags;
208
+ };
209
+ /**
210
+ * Workbench configuration
211
+ */
212
+ workbench?: Config.Workbench;
213
+ }
214
+ namespace Config {
215
+ /**
216
+ * Manage connections configuration
217
+ */
218
+ interface ManageConnections {
219
+ /**
220
+ * Custom callback URL for connected account auth flows
221
+ */
222
+ callback_url?: string;
223
+ /**
224
+ * Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status.
225
+ * Default false. May not work reliably with GPT models.
226
+ */
227
+ enable_wait_for_connections?: boolean;
228
+ /**
229
+ * Whether to enable the connection manager for automatic connection handling
230
+ */
231
+ enabled?: boolean;
232
+ }
233
+ /**
234
+ * MCP tool annotation hints for filtering tools with enabled/disabled support.
235
+ * enabled: tags that the tool must have at least one of. disabled: tags that the
236
+ * tool must NOT have any of. Both conditions must be satisfied.
237
+ */
238
+ interface Tags {
239
+ /**
240
+ * Tags that the tool must NOT have any of
241
+ */
242
+ disabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
243
+ /**
244
+ * Tags that the tool must have at least one of
245
+ */
246
+ enabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
247
+ }
248
+ interface Enabled {
249
+ enabled: Array<string>;
250
+ }
251
+ interface Disabled {
252
+ disabled: Array<string>;
253
+ }
254
+ interface Enabled {
255
+ enabled: Array<string>;
256
+ }
257
+ interface Disabled {
258
+ disabled: Array<string>;
259
+ }
260
+ interface Tags {
261
+ tags: Tags.Tags;
262
+ }
263
+ namespace Tags {
264
+ interface Tags {
265
+ /**
266
+ * Tags that the tool must NOT have any of
267
+ */
268
+ disabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
269
+ /**
270
+ * Tags that the tool must have at least one of
271
+ */
272
+ enabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
273
+ }
274
+ }
275
+ /**
276
+ * Workbench configuration
277
+ */
278
+ interface Workbench {
279
+ /**
280
+ * Character threshold after which tool execution response are saved to a file in
281
+ * workbench. Default is 20k.
282
+ */
283
+ auto_offload_threshold?: number;
284
+ /**
285
+ * Whether the workbench (code execution sandbox) is enabled. When false,
286
+ * COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
287
+ */
288
+ enable?: boolean;
289
+ /**
290
+ * Whether proxy execution is enabled in the workbench
291
+ */
292
+ proxy_execution_enabled?: boolean;
293
+ }
294
+ }
295
+ interface Mcp {
296
+ /**
297
+ * The type of the MCP server. Can be http
298
+ */
299
+ type: 'http';
300
+ /**
301
+ * The URL of the MCP server
302
+ */
303
+ url: string;
304
+ }
305
+ /**
306
+ * Experimental features including the generated system prompt. Only returned on
307
+ * session creation, not on GET.
308
+ */
309
+ interface Experimental {
310
+ /**
311
+ * The assistive system prompt for the tool router session
312
+ */
313
+ assistive_prompt?: string;
314
+ /**
315
+ * User-defined custom toolkits with grouped tools (no-auth)
316
+ */
317
+ custom_toolkits?: Array<Experimental.CustomToolkit>;
318
+ /**
319
+ * Custom tools — standalone or extending Composio toolkits
320
+ */
321
+ custom_tools?: Array<Experimental.CustomTool>;
322
+ }
323
+ namespace Experimental {
324
+ interface CustomToolkit {
325
+ description: string;
326
+ name: string;
327
+ slug: string;
328
+ tools: Array<CustomToolkit.Tool>;
329
+ }
330
+ namespace CustomToolkit {
331
+ interface Tool {
332
+ description: string;
333
+ input_schema: {
334
+ [key: string]: unknown;
335
+ };
336
+ name: string;
337
+ /**
338
+ * Original tool slug as provided by the user
339
+ */
340
+ original_slug: string;
341
+ /**
342
+ * Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)
343
+ */
344
+ slug: string;
345
+ output_schema?: {
346
+ [key: string]: unknown;
347
+ };
348
+ }
349
+ }
350
+ interface CustomTool {
351
+ description: string;
352
+ input_schema: {
353
+ [key: string]: unknown;
354
+ };
355
+ name: string;
356
+ /**
357
+ * Original tool slug as provided by the user
358
+ */
359
+ original_slug: string;
360
+ /**
361
+ * Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)
362
+ */
363
+ slug: string;
364
+ extends_toolkit?: string;
365
+ output_schema?: {
366
+ [key: string]: unknown;
367
+ };
368
+ }
369
+ }
370
+ }
371
+ export interface SessionRetrieveResponse {
372
+ /**
373
+ * The session configuration including user, toolkits, and overrides
374
+ */
375
+ config: SessionRetrieveResponse.Config;
376
+ mcp: SessionRetrieveResponse.Mcp;
377
+ /**
378
+ * The identifier of the session
379
+ */
380
+ session_id: string;
381
+ /**
382
+ * List of available tools in this session
383
+ */
384
+ tool_router_tools: Array<string>;
385
+ /**
386
+ * Experimental features
387
+ */
388
+ experimental?: SessionRetrieveResponse.Experimental;
389
+ }
390
+ export declare namespace SessionRetrieveResponse {
391
+ /**
392
+ * The session configuration including user, toolkits, and overrides
393
+ */
394
+ interface Config {
395
+ /**
396
+ * User identifier for this session
397
+ */
398
+ user_id: string;
399
+ /**
400
+ * Auth config overrides per toolkit
401
+ */
402
+ auth_configs?: {
403
+ [key: string]: string;
404
+ };
405
+ /**
406
+ * Connected account overrides per toolkit
407
+ */
408
+ connected_accounts?: {
409
+ [key: string]: string;
410
+ };
411
+ /**
412
+ * Manage connections configuration
413
+ */
414
+ manage_connections?: Config.ManageConnections;
415
+ /**
416
+ * MCP tool annotation hints for filtering tools with enabled/disabled support.
417
+ * enabled: tags that the tool must have at least one of. disabled: tags that the
418
+ * tool must NOT have any of. Both conditions must be satisfied.
419
+ */
420
+ tags?: Config.Tags;
421
+ /**
422
+ * Toolkit configuration - either enabled list or disabled list
423
+ */
424
+ toolkits?: Config.Enabled | Config.Disabled;
425
+ /**
426
+ * Tool-level configuration per toolkit
427
+ */
428
+ tools?: {
429
+ [key: string]: Config.Enabled | Config.Disabled | Config.Tags;
430
+ };
431
+ /**
432
+ * Workbench configuration
433
+ */
434
+ workbench?: Config.Workbench;
435
+ }
436
+ namespace Config {
437
+ /**
438
+ * Manage connections configuration
439
+ */
440
+ interface ManageConnections {
441
+ /**
442
+ * Custom callback URL for connected account auth flows
443
+ */
444
+ callback_url?: string;
445
+ /**
446
+ * Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status.
447
+ * Default false. May not work reliably with GPT models.
448
+ */
449
+ enable_wait_for_connections?: boolean;
450
+ /**
451
+ * Whether to enable the connection manager for automatic connection handling
452
+ */
453
+ enabled?: boolean;
454
+ }
455
+ /**
456
+ * MCP tool annotation hints for filtering tools with enabled/disabled support.
457
+ * enabled: tags that the tool must have at least one of. disabled: tags that the
458
+ * tool must NOT have any of. Both conditions must be satisfied.
459
+ */
460
+ interface Tags {
461
+ /**
462
+ * Tags that the tool must NOT have any of
463
+ */
464
+ disabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
465
+ /**
466
+ * Tags that the tool must have at least one of
467
+ */
468
+ enabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
469
+ }
470
+ interface Enabled {
471
+ enabled: Array<string>;
472
+ }
473
+ interface Disabled {
474
+ disabled: Array<string>;
475
+ }
476
+ interface Enabled {
477
+ enabled: Array<string>;
478
+ }
479
+ interface Disabled {
480
+ disabled: Array<string>;
481
+ }
482
+ interface Tags {
483
+ tags: Tags.Tags;
484
+ }
485
+ namespace Tags {
486
+ interface Tags {
487
+ /**
488
+ * Tags that the tool must NOT have any of
489
+ */
490
+ disabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
491
+ /**
492
+ * Tags that the tool must have at least one of
493
+ */
494
+ enabled?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
495
+ }
496
+ }
497
+ /**
498
+ * Workbench configuration
499
+ */
500
+ interface Workbench {
501
+ /**
502
+ * Character threshold after which tool execution response are saved to a file in
503
+ * workbench. Default is 20k.
504
+ */
505
+ auto_offload_threshold?: number;
506
+ /**
507
+ * Whether the workbench (code execution sandbox) is enabled. When false,
508
+ * COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.
509
+ */
510
+ enable?: boolean;
511
+ /**
512
+ * Whether proxy execution is enabled in the workbench
513
+ */
514
+ proxy_execution_enabled?: boolean;
515
+ }
516
+ }
517
+ interface Mcp {
518
+ /**
519
+ * The type of the MCP server. Can be http
520
+ */
521
+ type: 'http';
522
+ /**
523
+ * The URL of the MCP server
524
+ */
525
+ url: string;
526
+ }
527
+ /**
528
+ * Experimental features
529
+ */
530
+ interface Experimental {
531
+ /**
532
+ * The assistive system prompt for the tool router session
533
+ */
534
+ assistive_prompt?: string;
535
+ /**
536
+ * User-defined custom toolkits with grouped tools (no-auth)
537
+ */
538
+ custom_toolkits?: Array<Experimental.CustomToolkit>;
539
+ /**
540
+ * Custom tools — standalone or extending Composio toolkits
541
+ */
542
+ custom_tools?: Array<Experimental.CustomTool>;
543
+ }
544
+ namespace Experimental {
545
+ interface CustomToolkit {
546
+ description: string;
547
+ name: string;
548
+ slug: string;
549
+ tools: Array<CustomToolkit.Tool>;
550
+ }
551
+ namespace CustomToolkit {
552
+ interface Tool {
553
+ description: string;
554
+ input_schema: {
555
+ [key: string]: unknown;
556
+ };
557
+ name: string;
558
+ /**
559
+ * Original tool slug as provided by the user
560
+ */
561
+ original_slug: string;
562
+ /**
563
+ * Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)
564
+ */
565
+ slug: string;
566
+ output_schema?: {
567
+ [key: string]: unknown;
568
+ };
569
+ }
570
+ }
571
+ interface CustomTool {
572
+ description: string;
573
+ input_schema: {
574
+ [key: string]: unknown;
575
+ };
576
+ name: string;
577
+ /**
578
+ * Original tool slug as provided by the user
579
+ */
580
+ original_slug: string;
581
+ /**
582
+ * Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)
583
+ */
584
+ slug: string;
585
+ extends_toolkit?: string;
586
+ output_schema?: {
587
+ [key: string]: unknown;
588
+ };
589
+ }
590
+ }
591
+ }
592
+ export interface SessionExecuteResponse {
593
+ /**
594
+ * The data returned by the tool execution
595
+ */
596
+ data: {
597
+ [key: string]: unknown;
598
+ };
599
+ /**
600
+ * Error message if the execution failed, null otherwise
601
+ */
602
+ error: string | null;
603
+ /**
604
+ * Unique identifier for the execution log
605
+ */
606
+ log_id: string;
607
+ }
608
+ export interface SessionExecuteMetaResponse {
609
+ /**
610
+ * The data returned by the tool execution
611
+ */
612
+ data: {
613
+ [key: string]: unknown;
614
+ };
615
+ /**
616
+ * Error message if the execution failed, null otherwise
617
+ */
618
+ error: string | null;
619
+ /**
620
+ * Unique identifier for the execution log
621
+ */
622
+ log_id: string;
623
+ }
624
+ export interface SessionLinkResponse {
625
+ /**
626
+ * The unique identifier for the connected account
627
+ */
628
+ connected_account_id: string;
629
+ /**
630
+ * Token used to complete the authentication flow
631
+ */
632
+ link_token: string;
633
+ /**
634
+ * The URL where users should be redirected to complete OAuth
635
+ */
636
+ redirect_url: string;
637
+ }
638
+ export interface SessionProxyExecuteResponse {
639
+ /**
640
+ * The HTTP status code returned from the proxied API
641
+ */
642
+ status: number;
643
+ /**
644
+ * Binary body response data. Present when the response is a binary file.
645
+ */
646
+ binary_data?: SessionProxyExecuteResponse.BinaryData;
647
+ /**
648
+ * The response data returned from the proxied API
649
+ */
650
+ data?: unknown;
651
+ /**
652
+ * The HTTP headers returned from the proxied API
653
+ */
654
+ headers?: {
655
+ [key: string]: string;
656
+ };
657
+ }
658
+ export declare namespace SessionProxyExecuteResponse {
659
+ /**
660
+ * Binary body response data. Present when the response is a binary file.
661
+ */
662
+ interface BinaryData {
663
+ /**
664
+ * Content-Type of the binary data
665
+ */
666
+ content_type: string;
667
+ /**
668
+ * File size in bytes
669
+ */
670
+ size: number;
671
+ /**
672
+ * URL to download binary content
673
+ */
674
+ url: string;
675
+ /**
676
+ * ISO 8601 timestamp when the URL expires
677
+ */
678
+ expires_at?: string;
679
+ }
680
+ }
681
+ export interface SessionSearchResponse {
682
+ /**
683
+ * Error message if any searches failed, null if all succeeded. Format: "X out of Y
684
+ * searches failed, reasons: <details>"
685
+ */
686
+ error: string | null;
687
+ /**
688
+ * Combined workflow guidance covering connections, planner, and memory usage. Each
689
+ * element is a step instruction.
690
+ */
691
+ next_steps_guidance: Array<string>;
692
+ /**
693
+ * Per-query search results with tools, reasoning, and memory. One entry per query
694
+ * in request order.
695
+ */
696
+ results: Array<SessionSearchResponse.Result>;
697
+ /**
698
+ * Session info for correlating meta tool calls
699
+ */
700
+ session: SessionSearchResponse.Session;
701
+ /**
702
+ * Whether all searches completed successfully. False if any query failed.
703
+ */
704
+ success: boolean;
705
+ /**
706
+ * Time information for the query
707
+ */
708
+ time_info: SessionSearchResponse.TimeInfo;
709
+ /**
710
+ * Deduplicated tool definitions keyed by tool_slug for O(1) lookup. Each tool
711
+ * appears once even if used in multiple queries.
712
+ */
713
+ tool_schemas: {
714
+ [key: string]: SessionSearchResponse.ToolSchemas;
715
+ };
716
+ /**
717
+ * Connection status for all toolkits mentioned across all queries, with
718
+ * descriptions merged in.
719
+ */
720
+ toolkit_connection_statuses: Array<SessionSearchResponse.ToolkitConnectionStatus>;
721
+ }
722
+ export declare namespace SessionSearchResponse {
723
+ interface Result {
724
+ /**
725
+ * 1-based index of the query in the request
726
+ */
727
+ index: number;
728
+ /**
729
+ * List of main tool slugs matching the search criteria
730
+ */
731
+ primary_tool_slugs: Array<string>;
732
+ /**
733
+ * List of related tool slugs that might be useful
734
+ */
735
+ related_tool_slugs: Array<string>;
736
+ /**
737
+ * List of unique toolkit slugs used by tools in this query
738
+ */
739
+ toolkits: Array<string>;
740
+ /**
741
+ * The use case that was searched
742
+ */
743
+ use_case: string;
744
+ /**
745
+ * Task difficulty assessment (e.g., "easy - Simple single-tool operation with
746
+ * known parameters")
747
+ */
748
+ difficulty?: string;
749
+ /**
750
+ * Error message if the search for this query failed, null otherwise. Always
751
+ * present for failed queries.
752
+ */
753
+ error?: string | null;
754
+ /**
755
+ * Guidance message about the search results, particularly when a cached plan is
756
+ * available
757
+ */
758
+ execution_guidance?: string;
759
+ /**
760
+ * Common pitfalls and considerations (only present when cached plan is available)
761
+ */
762
+ known_pitfalls?: Array<string>;
763
+ /**
764
+ * Memory data relevant to this query, grouped by app. Only present for non-cached
765
+ * search results.
766
+ */
767
+ memory?: {
768
+ [key: string]: Array<string>;
769
+ };
770
+ /**
771
+ * ID of cached plan if available
772
+ */
773
+ plan_id?: string;
774
+ /**
775
+ * Workflow steps from cached plan (only present when cached plan is available)
776
+ */
777
+ recommended_plan_steps?: Array<string>;
778
+ /**
779
+ * Reference Python code snippets for processing tool responses in the workbench
780
+ * (only present when cached plan is available)
781
+ */
782
+ reference_workbench_snippets?: Array<Result.ReferenceWorkbenchSnippet>;
783
+ }
784
+ namespace Result {
785
+ interface ReferenceWorkbenchSnippet {
786
+ /**
787
+ * Python code snippet for the workbench
788
+ */
789
+ code: string;
790
+ /**
791
+ * Description of what the code snippet does
792
+ */
793
+ description: string;
794
+ }
795
+ }
796
+ /**
797
+ * Session info for correlating meta tool calls
798
+ */
799
+ interface Session {
800
+ /**
801
+ * Session identifier to be passed to subsequent meta tool calls as session_id.
802
+ */
803
+ id: string;
804
+ /**
805
+ * Whether a fresh session id was generated in this call.
806
+ */
807
+ generate_id: boolean;
808
+ /**
809
+ * LLM-facing guidance on how to reuse this session id
810
+ */
811
+ instructions: string;
812
+ }
813
+ /**
814
+ * Time information for the query
815
+ */
816
+ interface TimeInfo {
817
+ /**
818
+ * Current time in ISO format (UTC)
819
+ */
820
+ current_time_utc: string;
821
+ /**
822
+ * Current time as Unix epoch timestamp in seconds
823
+ */
824
+ current_time_utc_epoch_seconds: number;
825
+ /**
826
+ * Important message about time handling and timezone considerations
827
+ */
828
+ message: string;
829
+ }
830
+ interface ToolSchemas {
831
+ /**
832
+ * The slug of the tool
833
+ */
834
+ tool_slug: string;
835
+ /**
836
+ * The slug of the toolkit that provides this tool
837
+ */
838
+ toolkit: string;
839
+ /**
840
+ * Description of the tool
841
+ */
842
+ description?: string;
843
+ /**
844
+ * Whether the full input_schema is included in this response
845
+ */
846
+ hasFullSchema?: boolean;
847
+ /**
848
+ * Input schema for the tool (only present when hasFullSchema is true)
849
+ */
850
+ input_schema?: {
851
+ [key: string]: unknown;
852
+ };
853
+ /**
854
+ * Output/response schema for the tool
855
+ */
856
+ output_schema?: {
857
+ [key: string]: unknown;
858
+ };
859
+ /**
860
+ * Reference to fetch full schema when hasFullSchema is false
861
+ */
862
+ schemaRef?: ToolSchemas.SchemaRef;
863
+ }
864
+ namespace ToolSchemas {
865
+ /**
866
+ * Reference to fetch full schema when hasFullSchema is false
867
+ */
868
+ interface SchemaRef {
869
+ /**
870
+ * Arguments to pass to the tool
871
+ */
872
+ args: SchemaRef.Args;
873
+ /**
874
+ * Instruction message for the LLM
875
+ */
876
+ message: string;
877
+ /**
878
+ * Tool to call
879
+ */
880
+ tool: 'COMPOSIO_GET_TOOL_SCHEMAS';
881
+ }
882
+ namespace SchemaRef {
883
+ /**
884
+ * Arguments to pass to the tool
885
+ */
886
+ interface Args {
887
+ /**
888
+ * Tool slugs to fetch schemas for
889
+ */
890
+ tool_slugs: Array<string>;
891
+ }
892
+ }
893
+ }
894
+ interface ToolkitConnectionStatus {
895
+ /**
896
+ * Description of what the toolkit does and its capabilities
897
+ */
898
+ description: string;
899
+ /**
900
+ * Whether an active connection exists for this toolkit
901
+ */
902
+ has_active_connection: boolean;
903
+ /**
904
+ * Human-readable message about the connection status and next steps
905
+ */
906
+ status_message: string;
907
+ /**
908
+ * The toolkit slug identifier (e.g., "gmail", "slack")
909
+ */
910
+ toolkit: string;
911
+ /**
912
+ * Connection details including auth config and connected account IDs. Only present
913
+ * when has_active_connection is true.
914
+ */
915
+ connection_details?: {
916
+ [key: string]: unknown;
917
+ };
918
+ /**
919
+ * Information about the currently connected user (email, name, etc.)
920
+ */
921
+ current_user_info?: {
922
+ [key: string]: unknown;
923
+ };
924
+ }
925
+ }
926
+ export interface SessionToolkitsResponse {
927
+ current_page: number;
928
+ items: Array<SessionToolkitsResponse.Item>;
929
+ total_items: number;
930
+ total_pages: number;
931
+ next_cursor?: string | null;
932
+ }
933
+ export declare namespace SessionToolkitsResponse {
934
+ interface Item {
935
+ /**
936
+ * Available Composio-managed auth schemes
937
+ */
938
+ composio_managed_auth_schemes: Array<string>;
939
+ /**
940
+ * Connected account if available
941
+ */
942
+ connected_account: Item.ConnectedAccount | null;
943
+ /**
944
+ * Whether the toolkit is enabled
945
+ */
946
+ enabled: boolean;
947
+ /**
948
+ * Whether the toolkit is no-auth
949
+ */
950
+ is_no_auth: boolean;
951
+ /**
952
+ * Toolkit metadata
953
+ */
954
+ meta: Item.Meta;
955
+ /**
956
+ * Display name of the toolkit
957
+ */
958
+ name: string;
959
+ /**
960
+ * Unique slug identifier
961
+ */
962
+ slug: string;
963
+ }
964
+ namespace Item {
965
+ /**
966
+ * Connected account if available
967
+ */
968
+ interface ConnectedAccount {
969
+ /**
970
+ * Connected account identifier
971
+ */
972
+ id: string;
973
+ /**
974
+ * Auth config details
975
+ */
976
+ auth_config: ConnectedAccount.AuthConfig;
977
+ /**
978
+ * Creation timestamp
979
+ */
980
+ created_at: string;
981
+ /**
982
+ * Connection status
983
+ */
984
+ status: string;
985
+ /**
986
+ * User identifier
987
+ */
988
+ user_id: string;
989
+ }
990
+ namespace ConnectedAccount {
991
+ /**
992
+ * Auth config details
993
+ */
994
+ interface AuthConfig {
995
+ /**
996
+ * Auth config identifier
997
+ */
998
+ id: string;
999
+ /**
1000
+ * Authentication scheme type
1001
+ */
1002
+ auth_scheme: string;
1003
+ /**
1004
+ * Whether this is a Composio-managed auth config
1005
+ */
1006
+ is_composio_managed: boolean;
1007
+ }
1008
+ }
1009
+ /**
1010
+ * Toolkit metadata
1011
+ */
1012
+ interface Meta {
1013
+ /**
1014
+ * Description of the toolkit
1015
+ */
1016
+ description: string;
1017
+ /**
1018
+ * URL to the toolkit logo
1019
+ */
1020
+ logo: string;
1021
+ }
1022
+ }
1023
+ }
1024
+ export interface SessionToolsResponse {
1025
+ /**
1026
+ * List of tools with their complete schemas
1027
+ */
1028
+ items: Array<SessionToolsResponse.Item>;
1029
+ }
1030
+ export declare namespace SessionToolsResponse {
1031
+ interface Item {
1032
+ /**
1033
+ * List of all available versions for this tool
1034
+ */
1035
+ available_versions: Array<string>;
1036
+ deprecated: Item.Deprecated;
1037
+ /**
1038
+ * Detailed explanation of the tool's functionality and purpose
1039
+ */
1040
+ description: string;
1041
+ /**
1042
+ * Schema definition of required input parameters for the tool
1043
+ */
1044
+ input_parameters: {
1045
+ [key: string]: unknown;
1046
+ };
1047
+ /**
1048
+ * Indicates if this tool is deprecated and may be removed in the future
1049
+ */
1050
+ is_deprecated: boolean;
1051
+ /**
1052
+ * Human-readable display name of the tool
1053
+ */
1054
+ name: string;
1055
+ /**
1056
+ * Indicates if the tool can be used without authentication
1057
+ */
1058
+ no_auth: boolean;
1059
+ /**
1060
+ * Schema definition of return values from the tool
1061
+ */
1062
+ output_parameters: {
1063
+ [key: string]: unknown;
1064
+ };
1065
+ /**
1066
+ * List of scopes associated with the tool
1067
+ */
1068
+ scopes: Array<string>;
1069
+ /**
1070
+ * Unique identifier for the tool
1071
+ */
1072
+ slug: string;
1073
+ /**
1074
+ * List of tags associated with the tool for categorization and filtering
1075
+ */
1076
+ tags: Array<string>;
1077
+ toolkit: Item.Toolkit;
1078
+ /**
1079
+ * Current version of the tool
1080
+ */
1081
+ version: string;
1082
+ /**
1083
+ * Human-friendly description of the tool, if available
1084
+ */
1085
+ human_description?: string;
1086
+ }
1087
+ namespace Item {
1088
+ interface Deprecated {
1089
+ /**
1090
+ * List of all available versions for this tool
1091
+ */
1092
+ available_versions: Array<string>;
1093
+ /**
1094
+ * The display name of the tool
1095
+ */
1096
+ displayName: string;
1097
+ /**
1098
+ * Indicates if this tool is deprecated and may be removed in the future
1099
+ */
1100
+ is_deprecated: boolean;
1101
+ toolkit: Deprecated.Toolkit;
1102
+ /**
1103
+ * Current version identifier of the tool
1104
+ */
1105
+ version: string;
1106
+ }
1107
+ namespace Deprecated {
1108
+ interface Toolkit {
1109
+ /**
1110
+ * URL to the toolkit logo image
1111
+ */
1112
+ logo: string;
1113
+ }
1114
+ }
1115
+ interface Toolkit {
1116
+ /**
1117
+ * URL to the toolkit logo image
1118
+ */
1119
+ logo: string;
1120
+ /**
1121
+ * Human-readable name of the parent toolkit
1122
+ */
1123
+ name: string;
1124
+ /**
1125
+ * Unique identifier of the parent toolkit
1126
+ */
1127
+ slug: string;
1128
+ }
1129
+ }
1130
+ }
1131
+ export interface SessionCreateParams {
1132
+ /**
1133
+ * The identifier of the user who is initiating the session, ideally a unique
1134
+ * identifier from your database like a user ID or email address
1135
+ */
1136
+ user_id: string;
1137
+ /**
1138
+ * The auth configs to use for the session. This will override the default behavior
1139
+ * and use the given auth config when specific toolkits are being executed
1140
+ */
1141
+ auth_configs?: {
1142
+ [key: string]: string;
1143
+ };
1144
+ /**
1145
+ * The connected accounts to use for the session. This will override the default
1146
+ * behaviour and use the given connected account when specific toolkits are being
1147
+ * executed
1148
+ */
1149
+ connected_accounts?: {
1150
+ [key: string]: string;
1151
+ };
1152
+ /**
1153
+ * Experimental features - not stable, may be modified or removed in future
1154
+ * versions.
1155
+ */
1156
+ experimental?: SessionCreateParams.Experimental;
1157
+ /**
1158
+ * Configuration for connection management settings
1159
+ */
1160
+ manage_connections?: SessionCreateParams.ManageConnections;
1161
+ /**
1162
+ * Global MCP tool annotation hints for filtering. Array format is treated as
1163
+ * enabled list. Object format supports both enabled (tool must have at least one)
1164
+ * and disabled (tool must NOT have any) lists. Toolkit-level tags override this.
1165
+ * Toolkit enabled/disabled lists take precedence over tag filtering.
1166
+ */
1167
+ tags?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'> | SessionCreateParams.UnionMember1;
1168
+ /**
1169
+ * Toolkit configuration - specify either enable toolkits (allowlist) or disable
1170
+ * toolkits (denylist). Mutually exclusive.
1171
+ */
1172
+ toolkits?: SessionCreateParams.Enable | SessionCreateParams.Disable;
1173
+ /**
1174
+ * Tool-level configuration per toolkit - either specify enable tools (whitelist),
1175
+ * disable tools (blacklist), or filter by MCP tags for each toolkit
1176
+ */
1177
+ tools?: {
1178
+ [key: string]: SessionCreateParams.Enable | SessionCreateParams.Disable | SessionCreateParams.Tags;
1179
+ };
1180
+ /**
1181
+ * Configuration for workbench behavior
1182
+ */
1183
+ workbench?: SessionCreateParams.Workbench;
1184
+ }
1185
+ export declare namespace SessionCreateParams {
1186
+ /**
1187
+ * Experimental features - not stable, may be modified or removed in future
1188
+ * versions.
1189
+ */
1190
+ interface Experimental {
1191
+ /**
1192
+ * Customize assistive prompt generation (e.g., timezone).
1193
+ */
1194
+ assistive_prompt_config?: Experimental.AssistivePromptConfig;
1195
+ /**
1196
+ * Custom toolkits with grouped tools. Toolkit slugs must not conflict with
1197
+ * existing Composio toolkits. All tools are no-auth.
1198
+ */
1199
+ custom_toolkits?: Array<Experimental.CustomToolkit>;
1200
+ /**
1201
+ * Custom tools to include in search. Standalone tools need no auth. Tools with
1202
+ * extends_toolkit inherit the Composio toolkit's connection.
1203
+ */
1204
+ custom_tools?: Array<Experimental.CustomTool>;
1205
+ }
1206
+ namespace Experimental {
1207
+ /**
1208
+ * Customize assistive prompt generation (e.g., timezone).
1209
+ */
1210
+ interface AssistivePromptConfig {
1211
+ /**
1212
+ * IANA timezone identifier (e.g., 'America/New_York', 'Europe/London'). Used to
1213
+ * customize the system prompt with timezone-aware instructions.
1214
+ */
1215
+ user_timezone?: string;
1216
+ }
1217
+ interface CustomToolkit {
1218
+ /**
1219
+ * Used for BM25 search matching and shown in toolkit connection statuses.
1220
+ */
1221
+ description: string;
1222
+ /**
1223
+ * Display name shown to the LLM and in search results.
1224
+ */
1225
+ name: string;
1226
+ /**
1227
+ * Unique slug for the toolkit. Must not conflict with existing Composio toolkit
1228
+ * slugs. Alphanumeric, underscores, and hyphens only.
1229
+ */
1230
+ slug: string;
1231
+ /**
1232
+ * Tools in this custom toolkit
1233
+ */
1234
+ tools: Array<CustomToolkit.Tool>;
1235
+ }
1236
+ namespace CustomToolkit {
1237
+ interface Tool {
1238
+ /**
1239
+ * Used for BM25 search matching and shown to the LLM.
1240
+ */
1241
+ description: string;
1242
+ /**
1243
+ * Must have type: "object" and a properties field.
1244
+ */
1245
+ input_schema: {
1246
+ [key: string]: unknown;
1247
+ };
1248
+ /**
1249
+ * Human-readable display name
1250
+ */
1251
+ name: string;
1252
+ /**
1253
+ * Tool slug. Combined with toolkit slug to form LOCAL*<TOOLKIT>*<TOOL> (max 60
1254
+ * chars total).
1255
+ */
1256
+ slug: string;
1257
+ /**
1258
+ * Optional output schema for the tool response.
1259
+ */
1260
+ output_schema?: {
1261
+ [key: string]: unknown;
1262
+ };
1263
+ }
1264
+ }
1265
+ interface CustomTool {
1266
+ /**
1267
+ * Used for BM25 search matching and shown to the LLM.
1268
+ */
1269
+ description: string;
1270
+ /**
1271
+ * Must have type: "object" and a properties field.
1272
+ */
1273
+ input_schema: {
1274
+ [key: string]: unknown;
1275
+ };
1276
+ /**
1277
+ * Human-readable display name
1278
+ */
1279
+ name: string;
1280
+ /**
1281
+ * Tool slug. Forms LOCAL*<TOOL> (standalone) or LOCAL*<TOOLKIT>\_<TOOL>
1282
+ * (extending). Max 60 chars total.
1283
+ */
1284
+ slug: string;
1285
+ /**
1286
+ * If set, must be a valid Composio toolkit slug. The tool inherits that toolkit's
1287
+ * auth/connection status. If omitted, the tool is standalone (no-auth).
1288
+ */
1289
+ extends_toolkit?: string;
1290
+ /**
1291
+ * JSON Schema describing tool output (optional)
1292
+ */
1293
+ output_schema?: {
1294
+ [key: string]: unknown;
1295
+ };
1296
+ }
1297
+ }
1298
+ /**
1299
+ * Configuration for connection management settings
1300
+ */
1301
+ interface ManageConnections {
1302
+ /**
1303
+ * The URL to redirect to after a user completes authentication for a connected
1304
+ * account. This allows you to handle the auth callback in your own application.
1305
+ */
1306
+ callback_url?: string;
1307
+ /**
1308
+ * Whether to enable the connection manager for automatic connection handling. If
1309
+ * true, we will provide a tool your agent can use to initiate connections to
1310
+ * toolkits if it doesnt exist. If set to false, then you have to manage
1311
+ * connections manually.
1312
+ */
1313
+ enable?: boolean | null;
1314
+ /**
1315
+ * When true, the COMPOSIO_WAIT_FOR_CONNECTIONS tool is available for agents to
1316
+ * poll connection status after sharing auth URLs. Default is false (disabled). May
1317
+ * not work reliably with GPT models.
1318
+ */
1319
+ enable_wait_for_connections?: boolean | null;
1320
+ }
1321
+ interface UnionMember1 {
1322
+ /**
1323
+ * Tags that the tool must NOT have any of
1324
+ */
1325
+ disable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
1326
+ /**
1327
+ * Tags that the tool must have at least one of
1328
+ */
1329
+ enable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
1330
+ }
1331
+ /**
1332
+ * Enable only specific toolkits (allowlist)
1333
+ */
1334
+ interface Enable {
1335
+ /**
1336
+ * Only these specific toolkits will be enabled
1337
+ */
1338
+ enable: Array<string>;
1339
+ }
1340
+ /**
1341
+ * Disable specific toolkits (denylist)
1342
+ */
1343
+ interface Disable {
1344
+ /**
1345
+ * These specific toolkits will be disabled
1346
+ */
1347
+ disable: Array<string>;
1348
+ }
1349
+ interface Enable {
1350
+ /**
1351
+ * Only these specific tools will be available for this toolkit
1352
+ */
1353
+ enable: Array<string>;
1354
+ }
1355
+ interface Disable {
1356
+ /**
1357
+ * These specific tools will be disabled for this toolkit
1358
+ */
1359
+ disable: Array<string>;
1360
+ }
1361
+ interface Tags {
1362
+ /**
1363
+ * MCP tags to filter tools. Array format is treated as enabled list. Object format
1364
+ * supports both enabled and disabled lists.
1365
+ */
1366
+ tags: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'> | Tags.UnionMember1;
1367
+ }
1368
+ namespace Tags {
1369
+ interface UnionMember1 {
1370
+ /**
1371
+ * Tags that the tool must NOT have any of
1372
+ */
1373
+ disable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
1374
+ /**
1375
+ * Tags that the tool must have at least one of
1376
+ */
1377
+ enable?: Array<'readOnlyHint' | 'destructiveHint' | 'idempotentHint' | 'openWorldHint'>;
1378
+ }
1379
+ }
1380
+ /**
1381
+ * Configuration for workbench behavior
1382
+ */
1383
+ interface Workbench {
1384
+ /**
1385
+ * Character threshold for automatic offloading. When workbench response exceeds
1386
+ * this threshold, it will be automatically offloaded. Default is picked
1387
+ * automatically based on the response size.
1388
+ */
1389
+ auto_offload_threshold?: number;
1390
+ /**
1391
+ * Set to false to disable the workbench entirely. When disabled, no code execution
1392
+ * tools are available in the session.
1393
+ */
1394
+ enable?: boolean;
1395
+ /**
1396
+ * Whether proxy execution is enabled. When enabled, workbench can call URLs and
1397
+ * APIs directly.
1398
+ */
1399
+ enable_proxy_execution?: boolean;
1400
+ }
1401
+ }
1402
+ export interface SessionExecuteParams {
1403
+ /**
1404
+ * The unique slug identifier of the tool to execute
1405
+ */
1406
+ tool_slug: string;
1407
+ /**
1408
+ * The arguments required by the tool
1409
+ */
1410
+ arguments?: {
1411
+ [key: string]: unknown;
1412
+ };
1413
+ }
1414
+ export interface SessionExecuteMetaParams {
1415
+ /**
1416
+ * The unique slug identifier of the meta tool to execute
1417
+ */
1418
+ 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';
1419
+ /**
1420
+ * The arguments required by the meta tool
1421
+ */
1422
+ arguments?: {
1423
+ [key: string]: unknown;
1424
+ };
1425
+ }
1426
+ export interface SessionLinkParams {
1427
+ /**
1428
+ * The unique slug identifier of the toolkit to connect
1429
+ */
1430
+ toolkit: string;
1431
+ /**
1432
+ * URL where users will be redirected after completing auth
1433
+ */
1434
+ callback_url?: string;
1435
+ }
1436
+ export interface SessionProxyExecuteParams {
1437
+ /**
1438
+ * The API endpoint to call (absolute URL or path relative to base URL of the
1439
+ * connected account)
1440
+ */
1441
+ endpoint: string;
1442
+ /**
1443
+ * The HTTP method to use for the request
1444
+ */
1445
+ method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD';
1446
+ /**
1447
+ * The slug of the toolkit to use for the request
1448
+ */
1449
+ toolkit_slug: string;
1450
+ /**
1451
+ * Binary body to send. For binary upload via URL: use {url: "https://...",
1452
+ * content_type?: "..."}. For binary upload via base64: use {base64: "...",
1453
+ * content_type?: "..."}.
1454
+ */
1455
+ binary_body?: SessionProxyExecuteParams.UnionMember0 | SessionProxyExecuteParams.UnionMember1;
1456
+ /**
1457
+ * The request body (for POST, PUT, and PATCH requests)
1458
+ */
1459
+ body?: unknown;
1460
+ custom_connection_data?: SessionProxyExecuteParams.UnionMember0 | SessionProxyExecuteParams.UnionMember1 | SessionProxyExecuteParams.UnionMember2 | SessionProxyExecuteParams.UnionMember3 | SessionProxyExecuteParams.UnionMember4 | SessionProxyExecuteParams.UnionMember5 | SessionProxyExecuteParams.UnionMember6 | SessionProxyExecuteParams.UnionMember7 | SessionProxyExecuteParams.UnionMember8 | SessionProxyExecuteParams.UnionMember9 | SessionProxyExecuteParams.UnionMember10;
1461
+ /**
1462
+ * Additional HTTP headers or query parameters to include in the request
1463
+ */
1464
+ parameters?: Array<SessionProxyExecuteParams.Parameter>;
1465
+ }
1466
+ export declare namespace SessionProxyExecuteParams {
1467
+ interface UnionMember0 {
1468
+ /**
1469
+ * URL to fetch binary content from
1470
+ */
1471
+ url: string;
1472
+ /**
1473
+ * Content-Type header to use for the request
1474
+ */
1475
+ content_type?: string;
1476
+ }
1477
+ interface UnionMember1 {
1478
+ /**
1479
+ * Base64-encoded binary data
1480
+ */
1481
+ base64: string;
1482
+ /**
1483
+ * Content-Type header to use for the request
1484
+ */
1485
+ content_type?: string;
1486
+ }
1487
+ interface UnionMember0 {
1488
+ authScheme: 'OAUTH2';
1489
+ toolkitSlug: string;
1490
+ val: UnionMember0.Val;
1491
+ }
1492
+ namespace UnionMember0 {
1493
+ interface Val {
1494
+ access_token: string;
1495
+ account_id?: string;
1496
+ account_url?: string;
1497
+ api_url?: string;
1498
+ /**
1499
+ * for slack user scopes
1500
+ */
1501
+ authed_user?: Val.AuthedUser;
1502
+ base_url?: string;
1503
+ borneo_dashboard_url?: string;
1504
+ COMPANYDOMAIN?: string;
1505
+ dc?: string;
1506
+ domain?: string;
1507
+ expires_in?: number | string | null;
1508
+ extension?: string;
1509
+ form_api_base_url?: string;
1510
+ id_token?: string;
1511
+ instanceEndpoint?: string;
1512
+ instanceName?: string;
1513
+ /**
1514
+ * Whether to return the redirect url without shortening
1515
+ */
1516
+ long_redirect_url?: boolean;
1517
+ proxy_password?: string;
1518
+ proxy_username?: string;
1519
+ refresh_token?: string | null;
1520
+ region?: string;
1521
+ scope?: string | Array<string> | null;
1522
+ server_location?: string;
1523
+ shop?: string;
1524
+ site_name?: string;
1525
+ /**
1526
+ * The oauth2 state prefix for the connection
1527
+ */
1528
+ state_prefix?: string;
1529
+ subdomain?: string;
1530
+ token_type?: string;
1531
+ version?: string;
1532
+ webhook_signature?: string;
1533
+ your_server?: string;
1534
+ 'your-domain'?: string;
1535
+ [k: string]: unknown;
1536
+ }
1537
+ namespace Val {
1538
+ /**
1539
+ * for slack user scopes
1540
+ */
1541
+ interface AuthedUser {
1542
+ access_token?: string;
1543
+ scope?: string;
1544
+ }
1545
+ }
1546
+ }
1547
+ interface UnionMember1 {
1548
+ authScheme: 'DCR_OAUTH';
1549
+ toolkitSlug: string;
1550
+ val: UnionMember1.Val;
1551
+ }
1552
+ namespace UnionMember1 {
1553
+ interface Val {
1554
+ access_token: string;
1555
+ /**
1556
+ * Dynamically registered client ID
1557
+ */
1558
+ client_id: string;
1559
+ account_id?: string;
1560
+ account_url?: string;
1561
+ api_url?: string;
1562
+ base_url?: string;
1563
+ borneo_dashboard_url?: string;
1564
+ client_id_issued_at?: number;
1565
+ /**
1566
+ * Dynamically registered client secret
1567
+ */
1568
+ client_secret?: string;
1569
+ client_secret_expires_at?: number;
1570
+ COMPANYDOMAIN?: string;
1571
+ dc?: string;
1572
+ domain?: string;
1573
+ expires_in?: number | string | null;
1574
+ extension?: string;
1575
+ form_api_base_url?: string;
1576
+ id_token?: string;
1577
+ instanceEndpoint?: string;
1578
+ instanceName?: string;
1579
+ /**
1580
+ * Whether to return the redirect url without shortening
1581
+ */
1582
+ long_redirect_url?: boolean;
1583
+ proxy_password?: string;
1584
+ proxy_username?: string;
1585
+ refresh_token?: string | null;
1586
+ region?: string;
1587
+ scope?: string | Array<string> | null;
1588
+ server_location?: string;
1589
+ shop?: string;
1590
+ site_name?: string;
1591
+ /**
1592
+ * The oauth2 state prefix for the connection
1593
+ */
1594
+ state_prefix?: string;
1595
+ subdomain?: string;
1596
+ token_type?: string;
1597
+ version?: string;
1598
+ your_server?: string;
1599
+ 'your-domain'?: string;
1600
+ [k: string]: unknown;
1601
+ }
1602
+ }
1603
+ interface UnionMember2 {
1604
+ authScheme: 'API_KEY';
1605
+ toolkitSlug: string;
1606
+ val: UnionMember2.Val;
1607
+ }
1608
+ namespace UnionMember2 {
1609
+ interface Val {
1610
+ account_id?: string;
1611
+ account_url?: string;
1612
+ api_key?: string;
1613
+ api_url?: string;
1614
+ base_url?: string;
1615
+ basic_encoded?: string;
1616
+ bearer_token?: string;
1617
+ borneo_dashboard_url?: string;
1618
+ COMPANYDOMAIN?: string;
1619
+ dc?: string;
1620
+ domain?: string;
1621
+ extension?: string;
1622
+ form_api_base_url?: string;
1623
+ generic_api_key?: string;
1624
+ instanceEndpoint?: string;
1625
+ instanceName?: string;
1626
+ proxy_password?: string;
1627
+ proxy_username?: string;
1628
+ region?: string;
1629
+ server_location?: string;
1630
+ shop?: string;
1631
+ site_name?: string;
1632
+ subdomain?: string;
1633
+ version?: string;
1634
+ your_server?: string;
1635
+ 'your-domain'?: string;
1636
+ [k: string]: unknown;
1637
+ }
1638
+ }
1639
+ interface UnionMember3 {
1640
+ authScheme: 'BASIC_WITH_JWT';
1641
+ toolkitSlug: string;
1642
+ val: UnionMember3.Val;
1643
+ }
1644
+ namespace UnionMember3 {
1645
+ interface Val {
1646
+ password: string;
1647
+ username: string;
1648
+ account_id?: string;
1649
+ account_url?: string;
1650
+ api_url?: string;
1651
+ base_url?: string;
1652
+ borneo_dashboard_url?: string;
1653
+ COMPANYDOMAIN?: string;
1654
+ dc?: string;
1655
+ domain?: string;
1656
+ extension?: string;
1657
+ form_api_base_url?: string;
1658
+ instanceEndpoint?: string;
1659
+ instanceName?: string;
1660
+ proxy_password?: string;
1661
+ proxy_username?: string;
1662
+ region?: string;
1663
+ server_location?: string;
1664
+ shop?: string;
1665
+ site_name?: string;
1666
+ subdomain?: string;
1667
+ version?: string;
1668
+ your_server?: string;
1669
+ 'your-domain'?: string;
1670
+ [k: string]: unknown;
1671
+ }
1672
+ }
1673
+ interface UnionMember4 {
1674
+ authScheme: 'BASIC';
1675
+ toolkitSlug: string;
1676
+ val: UnionMember4.Val;
1677
+ }
1678
+ namespace UnionMember4 {
1679
+ interface Val {
1680
+ username: string;
1681
+ account_id?: string;
1682
+ account_url?: string;
1683
+ api_url?: string;
1684
+ base_url?: string;
1685
+ borneo_dashboard_url?: string;
1686
+ COMPANYDOMAIN?: string;
1687
+ dc?: string;
1688
+ domain?: string;
1689
+ extension?: string;
1690
+ form_api_base_url?: string;
1691
+ instanceEndpoint?: string;
1692
+ instanceName?: string;
1693
+ password?: string;
1694
+ proxy_password?: string;
1695
+ proxy_username?: string;
1696
+ region?: string;
1697
+ server_location?: string;
1698
+ shop?: string;
1699
+ site_name?: string;
1700
+ subdomain?: string;
1701
+ version?: string;
1702
+ your_server?: string;
1703
+ 'your-domain'?: string;
1704
+ [k: string]: unknown;
1705
+ }
1706
+ }
1707
+ interface UnionMember5 {
1708
+ authScheme: 'BEARER_TOKEN';
1709
+ toolkitSlug: string;
1710
+ val: UnionMember5.Val;
1711
+ }
1712
+ namespace UnionMember5 {
1713
+ interface Val {
1714
+ token: string;
1715
+ account_id?: string;
1716
+ account_url?: string;
1717
+ api_url?: string;
1718
+ base_url?: string;
1719
+ borneo_dashboard_url?: string;
1720
+ COMPANYDOMAIN?: string;
1721
+ dc?: string;
1722
+ domain?: string;
1723
+ extension?: string;
1724
+ form_api_base_url?: string;
1725
+ instanceEndpoint?: string;
1726
+ instanceName?: string;
1727
+ proxy_password?: string;
1728
+ proxy_username?: string;
1729
+ region?: string;
1730
+ server_location?: string;
1731
+ shop?: string;
1732
+ site_name?: string;
1733
+ subdomain?: string;
1734
+ version?: string;
1735
+ your_server?: string;
1736
+ 'your-domain'?: string;
1737
+ [k: string]: unknown;
1738
+ }
1739
+ }
1740
+ interface UnionMember6 {
1741
+ authScheme: 'OAUTH1';
1742
+ toolkitSlug: string;
1743
+ val: UnionMember6.Val;
1744
+ }
1745
+ namespace UnionMember6 {
1746
+ interface Val {
1747
+ oauth_token: string;
1748
+ oauth_token_secret: string;
1749
+ account_id?: string;
1750
+ account_url?: string;
1751
+ api_url?: string;
1752
+ base_url?: string;
1753
+ borneo_dashboard_url?: string;
1754
+ callback_url?: string;
1755
+ COMPANYDOMAIN?: string;
1756
+ consumer_key?: string;
1757
+ dc?: string;
1758
+ domain?: string;
1759
+ extension?: string;
1760
+ form_api_base_url?: string;
1761
+ instanceEndpoint?: string;
1762
+ instanceName?: string;
1763
+ oauth_verifier?: string;
1764
+ proxy_password?: string;
1765
+ proxy_username?: string;
1766
+ redirectUrl?: string;
1767
+ region?: string;
1768
+ server_location?: string;
1769
+ shop?: string;
1770
+ site_name?: string;
1771
+ subdomain?: string;
1772
+ version?: string;
1773
+ your_server?: string;
1774
+ 'your-domain'?: string;
1775
+ [k: string]: unknown;
1776
+ }
1777
+ }
1778
+ interface UnionMember7 {
1779
+ authScheme: 'NO_AUTH';
1780
+ toolkitSlug: string;
1781
+ val: UnionMember7.Val;
1782
+ }
1783
+ namespace UnionMember7 {
1784
+ interface Val {
1785
+ account_id?: string;
1786
+ account_url?: string;
1787
+ api_url?: string;
1788
+ base_url?: string;
1789
+ borneo_dashboard_url?: string;
1790
+ COMPANYDOMAIN?: string;
1791
+ dc?: string;
1792
+ domain?: string;
1793
+ extension?: string;
1794
+ form_api_base_url?: string;
1795
+ instanceEndpoint?: string;
1796
+ instanceName?: string;
1797
+ proxy_password?: string;
1798
+ proxy_username?: string;
1799
+ region?: string;
1800
+ server_location?: string;
1801
+ shop?: string;
1802
+ site_name?: string;
1803
+ subdomain?: string;
1804
+ version?: string;
1805
+ your_server?: string;
1806
+ 'your-domain'?: string;
1807
+ [k: string]: unknown;
1808
+ }
1809
+ }
1810
+ interface UnionMember8 {
1811
+ authScheme: 'SERVICE_ACCOUNT';
1812
+ toolkitSlug: string;
1813
+ val: UnionMember8.Val;
1814
+ }
1815
+ namespace UnionMember8 {
1816
+ interface Val {
1817
+ application_id: string;
1818
+ installation_id: string;
1819
+ private_key: string;
1820
+ account_id?: string;
1821
+ account_url?: string;
1822
+ api_url?: string;
1823
+ base_url?: string;
1824
+ borneo_dashboard_url?: string;
1825
+ COMPANYDOMAIN?: string;
1826
+ dc?: string;
1827
+ domain?: string;
1828
+ extension?: string;
1829
+ form_api_base_url?: string;
1830
+ instanceEndpoint?: string;
1831
+ instanceName?: string;
1832
+ proxy_password?: string;
1833
+ proxy_username?: string;
1834
+ region?: string;
1835
+ server_location?: string;
1836
+ shop?: string;
1837
+ site_name?: string;
1838
+ subdomain?: string;
1839
+ version?: string;
1840
+ your_server?: string;
1841
+ 'your-domain'?: string;
1842
+ [k: string]: unknown;
1843
+ }
1844
+ }
1845
+ interface UnionMember9 {
1846
+ authScheme: 'GOOGLE_SERVICE_ACCOUNT';
1847
+ toolkitSlug: string;
1848
+ val: UnionMember9.Val;
1849
+ }
1850
+ namespace UnionMember9 {
1851
+ interface Val {
1852
+ credentials_json: string;
1853
+ account_id?: string;
1854
+ account_url?: string;
1855
+ api_url?: string;
1856
+ base_url?: string;
1857
+ borneo_dashboard_url?: string;
1858
+ COMPANYDOMAIN?: string;
1859
+ dc?: string;
1860
+ domain?: string;
1861
+ extension?: string;
1862
+ form_api_base_url?: string;
1863
+ instanceEndpoint?: string;
1864
+ instanceName?: string;
1865
+ proxy_password?: string;
1866
+ proxy_username?: string;
1867
+ region?: string;
1868
+ server_location?: string;
1869
+ shop?: string;
1870
+ site_name?: string;
1871
+ subdomain?: string;
1872
+ version?: string;
1873
+ your_server?: string;
1874
+ 'your-domain'?: string;
1875
+ [k: string]: unknown;
1876
+ }
1877
+ }
1878
+ interface UnionMember10 {
1879
+ authScheme: 'S2S_OAUTH2';
1880
+ toolkitSlug: string;
1881
+ val: UnionMember10.Val;
1882
+ }
1883
+ namespace UnionMember10 {
1884
+ interface Val {
1885
+ access_token: string;
1886
+ client_id: string;
1887
+ client_secret: string;
1888
+ account_id?: string;
1889
+ account_url?: string;
1890
+ api_url?: string;
1891
+ base_url?: string;
1892
+ borneo_dashboard_url?: string;
1893
+ COMPANYDOMAIN?: string;
1894
+ dc?: string;
1895
+ domain?: string;
1896
+ expires_at?: string;
1897
+ expires_in?: number | string | null;
1898
+ extension?: string;
1899
+ form_api_base_url?: string;
1900
+ instanceEndpoint?: string;
1901
+ instanceName?: string;
1902
+ proxy_password?: string;
1903
+ proxy_username?: string;
1904
+ region?: string;
1905
+ scope?: string | Array<string> | null;
1906
+ server_location?: string;
1907
+ shop?: string;
1908
+ site_name?: string;
1909
+ subdomain?: string;
1910
+ token_type?: string;
1911
+ version?: string;
1912
+ your_server?: string;
1913
+ 'your-domain'?: string;
1914
+ [k: string]: unknown;
1915
+ }
1916
+ }
1917
+ interface Parameter {
1918
+ /**
1919
+ * Parameter name
1920
+ */
1921
+ name: string;
1922
+ /**
1923
+ * Parameter type (header or query)
1924
+ */
1925
+ type: 'header' | 'query';
1926
+ /**
1927
+ * Parameter value
1928
+ */
1929
+ value: string;
1930
+ }
1931
+ }
1932
+ export interface SessionSearchParams {
1933
+ /**
1934
+ * List of search queries to execute in parallel. Up to 7 queries supported.
1935
+ */
1936
+ queries: Array<SessionSearchParams.Query>;
1937
+ /**
1938
+ * Optional model hint for search/planning behavior (e.g., "gpt-4o"). Ignored if
1939
+ * invalid.
1940
+ */
1941
+ model?: string;
1942
+ }
1943
+ export declare namespace SessionSearchParams {
1944
+ interface Query {
1945
+ /**
1946
+ * The task or use case to search tools for. Provide a detailed description to get
1947
+ * the best results.
1948
+ */
1949
+ use_case: string;
1950
+ /**
1951
+ * Known field hints as key:value pairs (e.g., "channel_name:general,
1952
+ * user_email:john@example.com")
1953
+ */
1954
+ known_fields?: string;
1955
+ }
1956
+ }
1957
+ export interface SessionToolkitsParams {
1958
+ /**
1959
+ * Cursor for pagination. The cursor is a base64 encoded string of the page and
1960
+ * limit. The page is the page number and the limit is the number of items per
1961
+ * page. The cursor is used to paginate through the items. The cursor is not
1962
+ * required for the first page.
1963
+ */
1964
+ cursor?: string;
1965
+ /**
1966
+ * Whether to filter by connected toolkits. If provided, only connected toolkits
1967
+ * will be returned.
1968
+ */
1969
+ is_connected?: boolean | null;
1970
+ /**
1971
+ * Number of items per page, max allowed is 1000
1972
+ */
1973
+ limit?: number | null;
1974
+ /**
1975
+ * Search query to filter toolkits by name, slug, or description
1976
+ */
1977
+ search?: string;
1978
+ /**
1979
+ * Optional comma-separated list of toolkit slugs to filter by. If provided, only
1980
+ * these toolkits will be returned, overriding the session configuration.
1981
+ */
1982
+ toolkits?: Array<string> | null;
1983
+ }
1984
+ export interface SessionToolsParams {
1985
+ }
1986
+ export declare namespace Session {
1987
+ 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, };
1988
+ 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, };
1989
+ }
1990
+ //# sourceMappingURL=session.d.ts.map