@composio/core / models/Toolkits / Toolkits

Class: Toolkits

Defined in: ts/packages/core/src/models/Toolkits.ts:30

Toolkits class

Toolkits are a collection of tools that can be used to perform various tasks. This is similar/replacement of apps in the Composio API.

Constructors

Constructor

new Toolkits(client): Toolkits

Defined in: ts/packages/core/src/models/Toolkits.ts:33

Parameters

client

Composio

Returns

Toolkits

Methods

authorize()

authorize(userId, toolkitSlug): Promise<ConnectionRequest>

Defined in: ts/packages/core/src/models/Toolkits.ts:376

Authorizes a user to use a toolkit. This method will create an auth config if one doesn’t exist and initiate a connection request.

Parameters

userId

string

The user id of the user to authorize

toolkitSlug

string

The slug of the toolkit to authorize

Returns

Promise<ConnectionRequest>

The connection request object

Example

1 const connectionRequest = await composio.toolkits.authorize(userId, 'github');

get()

Implementation method that handles both overloads for retrieving toolkits.

Param

Either a toolkit slug or query parameters

Call Signature

get(slug): Promise<{ }>

Defined in: ts/packages/core/src/models/Toolkits.ts:186

Retrieves a specific toolkit by its slug identifier.

Parameters

slug

string

The unique slug identifier of the toolkit to retrieve

Returns

Promise<{ }>

The toolkit or list of toolkits

Param

Either a toolkit slug or query parameters

Throws

If no toolkit with the given slug exists

Example

1 // Get a specific toolkit
2 const githubToolkit = await composio.toolkits.get('github');
3 console.log(githubToolkit.name); // GitHub
4 console.log(githubToolkit.authConfigDetails); // Authentication configuration details

Call Signature

get(query): Promise<object[]>

Defined in: ts/packages/core/src/models/Toolkits.ts:210

Retrieves a list of toolkits based on the provided query parameters.

Parameters

query

The query parameters to filter toolkits

Returns

Promise<object[]>

The toolkit or list of toolkits

Param

Either a toolkit slug or query parameters

Example

1 // Get all toolkits
2 const allToolkits = await composio.toolkits.get({});
3 
4 // Get toolkits by category
5 const devToolkits = await composio.toolkits.get({
6   category: 'developer-tools'
7 });
8 
9 // Get local toolkits
10 const localToolkits = await composio.toolkits.get({
11   isLocal: true
12 });

getAuthConfigCreationFields()

getAuthConfigCreationFields(toolkitSlug, authScheme, __namedParameters): Promise<object[]>

Defined in: ts/packages/core/src/models/Toolkits.ts:295

Retrieves the fields required for creating an auth config for a toolkit.

Parameters

toolkitSlug

string

The slug of the toolkit to retrieve the fields for

authScheme

AuthSchemeType

The auth scheme to retrieve the fields for

__namedParameters

requiredOnly?

boolean = false

Returns

Promise<object[]>

The fields required for creating an auth config

getConnectedAccountInitiationFields()

getConnectedAccountInitiationFields(toolkitSlug, authScheme, __namedParameters): Promise<object[]>

Defined in: ts/packages/core/src/models/Toolkits.ts:315

Retrieves the fields required for initiating a connected account for a toolkit.

Parameters

toolkitSlug

string

The slug of the toolkit to retrieve the fields for

authScheme

AuthSchemeType

The auth scheme to retrieve the fields for

__namedParameters

requiredOnly?

boolean = false

Returns

Promise<object[]>

The fields required for initiating a connected account

listCategories(): Promise<{ }>

Defined in: ts/packages/core/src/models/Toolkits.ts:343

Retrieves all toolkit categories available in the Composio SDK.

This method fetches the complete list of categories from the Composio API and transforms the response to use camelCase property naming.

Returns

Promise<{ }>

The list of toolkit categories

Example

1 // Get all toolkit categories
2 const categories = await composio.toolkits.listCategories();
3 console.log(categories.items); // Array of category objects