Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
docs: auto-generate TypeScript SDK reference
jkomyno committed
Nov 3, 2026 at 12:19 UTC
3b925c2eabb5dd7015fb25cb6ac49546531050b7
4 files changed
+91
-4
docs/content/reference/sdk-reference/typescript/custom-toolkits.mdx
+84
-1
@@ -14,6 +14,47 @@ const result = await composio.customToolkits.list();
14
15
## Methods
16
17
+### create()
18
+
19
+Creates a custom MCP toolkit and returns its generated slug.
20
+**Experimental — custom toolkits are in pilot; shape may change.**
21
+
22
+Set `userId` to `'all'` to share the toolkit with every user in the
23
+project, or to a user ID to make it private to that user. `appUrl`,
24
+`authSchemes` and `userId` cannot change later: delete and re-create the
25
+toolkit instead. For a private toolkit, `connectLink` is where to send
26
+that user to connect.
27
+
28
+```typescript
29
+async create(params: CustomToolkitCreateParams, requestOptions?: ComposioRequestOptions): Promise<CustomToolkitCreateResponse>
30
+```
31
+
32
+**Parameters**
33
+
34
+| Name | Type | Description |
35
+|------|------|-------------|
36
+| `params` | `CustomToolkitCreateParams` | The toolkit to create |
37
+| `requestOptions?` | `ComposioRequestOptions` | |
38
+
39
+**Returns**
40
+
41
+`Promise<CustomToolkitCreateResponse>` — The toolkit's slug and, for a private toolkit, a connect link
42
+
43
+**Example**
44
+
45
+```typescript
46
+const { slug, connectLink } = await composio.experimental.customToolkits.create({
47
+ name: 'Internal API',
48
+ appUrl: 'https://mcp.internal.example.com/mcp',
49
+ authSchemes: [
50
+ { mode: 'API_KEY', headers: { Authorization: 'Bearer {{generic_api_key}}' } },
51
+ ],
52
+ userId: 'user_123',
53
+});
54
+```
55
+
56
+---
57
+
58
### delete()
59
60
Deletes a custom toolkit owned by the project, with its tools, auth
@@ -80,7 +121,49 @@ const { version, syncedCount } = await composio.experimental.customToolkits.sync
121
122
---
123
83
-### upsert()
124
+### update()
125
+
126
+Updates a custom toolkit's name, logo or API key field copy. Omitted
127
+fields keep their current value.
128
+**Experimental — custom toolkits are in pilot; shape may change.**
129
+
130
+On a project with 2FA enabled, updating a private toolkit requires the
131
+`userId` it is private to.
132
+
133
+```typescript
134
+async update(slug: string, params: CustomToolkitUpdateParams, requestOptions?: ComposioRequestOptions): Promise<CustomToolkitUpdateResponse>
135
+```
136
+
137
+**Parameters**
138
+
139
+| Name | Type | Description |
140
+|------|------|-------------|
141
+| `slug` | `string` | The custom toolkit slug returned by `create()` |
142
+| `params` | `CustomToolkitUpdateParams` | At least one of `name`, `logoFile`, `apiKeyField` |
143
+| `requestOptions?` | `ComposioRequestOptions` | |
144
+
145
+**Returns**
146
+
147
+`Promise<CustomToolkitUpdateResponse>` — `\{ success: true \}`
148
+
149
+**Example**
150
+
151
+```typescript
152
+await composio.experimental.customToolkits.update('CUSTOM_INTERNAL_API_K7F2Q', {
153
+ name: 'Internal API (prod)',
154
+ userId: 'user_123',
155
+});
156
+```
157
+
158
+---
159
+
160
+### upsert() (deprecated)
161
+
162
+<Callout type="warn" title="Deprecated">
163
+Use `create()` for a new toolkit and `update(slug, ...)` to change
164
+ its name, logo or API key field. `create()` generates the slug, so store the
165
+ slug it returns.
166
+</Callout>
167
168
Creates a custom toolkit, or updates its display metadata (name, API key
169
field copy) when the project already owns a toolkit with this slug.
docs/content/reference/sdk-reference/typescript/experimental.mdx
+1
-1
@@ -16,7 +16,7 @@ const result = await composio.experimental.list();
16
17
| Name | Type | Description |
18
|------|------|-------------|
19
-| `customToolkits` | `CustomToolkits` | Register and manage project-owned custom toolkits (`upsert()` / `sync()` / `delete()`). **Experimental — custom toolkits are in pilot; shape may change.** |
19
+| `customToolkits` | `CustomToolkits` | Register and manage project-owned custom toolkits (`create()` / `update()` / `sync()` / `delete()`). **Experimental — custom toolkits are in pilot; shape may change.** |
20
| `usage` | `Usage` | Project-scoped usage metering (`summary()` / `breakdown()`). **Experimental — shape may change in future releases.** |
21
22
## Methods
docs/content/reference/sdk-reference/typescript/session-configs.mdx
+1
-1
@@ -62,7 +62,7 @@ async list(params?: SessionConfigListParams, requestOptions?: ComposioRequestOpt
62
63
| Name | Type | Description |
64
|------|------|-------------|
65
-| `params?` | `SessionConfigListParams` | `search`, `archived`, `limit` and `cursor` |
65
+| `params?` | `SessionConfigListParams` | `archived`, `limit` and `cursor`; the deprecated `search` is ignored |
66
| `requestOptions?` | `ComposioRequestOptions` | |
67
68
**Returns**
docs/content/reference/sdk-reference/typescript/triggers.mdx
+5
-1
@@ -19,6 +19,9 @@ const result = await composio.triggers.list();
19
Create a new trigger instance for a user
20
If the connected account id is not provided, the first connected account for the user and toolkit will be used
21
22
+For a trigger that supports both webhook and polling, `body.type` picks one; omit it to let Composio choose.
23
+`body.pollingInterval` sets the minutes between polls and wins over `triggerConfig.interval`.
24
+
25
```typescript
26
async create(userId: string, slug: string, body?: TriggerInstanceUpsertParams, requestOptions?: ComposioRequestOptions): Promise<TriggerInstanceUpsertResponse>
27
```
@@ -34,7 +37,8 @@ async create(userId: string, slug: string, body?: TriggerInstanceUpsertParams, r
37
38
**Returns**
39
37
-`Promise<TriggerInstanceUpsertResponse>` — The created trigger instance
40
+`Promise<TriggerInstanceUpsertResponse>` — The trigger instance, with the type it uses, why it polls
41
+when it fell back from a webhook, and its polling interval
42
43
---
44