Usage
Access this class through thecomposio.toolkits property:
Methods
authorize()
Authorizes a user to use a toolkit. This method will create an auth config if one doesn’t exist and initiate a connection request.
Returns
Promise<ConnectionRequest> — The connection request object
Example
changelog()
Retrieves the version changelog of every toolkit (the last 10 versions per toolkit).
Returns
Promise<ToolkitChangelogResponse> — Toolkits with their recent version changelogs
Example
get()
Retrieves a specific toolkit by its slug identifier. Overload 1
Returns
Promise<ToolkitRetrieveResponse> — The toolkit object with detailed information
Overload 2
Returns
Promise<ToolKitListResponse> — A paginated list of toolkits matching the query criteria
Example
getAuthConfigCreationFields()
Retrieves the fields required for creating an auth config for a toolkit.
Returns
Promise<ToolkitAuthFieldsResponse> — The fields required for creating an auth config
getConnectedAccountInitiationFields()
Retrieves the fields required for initiating a connected account for a toolkit.
Returns
Promise<ToolkitAuthFieldsResponse> — The fields required for initiating a connected account
getMany()
Retrieves several toolkits by slug in a single request. Returns the same transformed shape ascomposio.toolkits.get({ ... }). Unknown slugs are simply absent from the result.
Returns
Promise<ToolKitListResponse> — The matching toolkits
Example
listCategories()
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<ToolkitRetrieveCategoriesResponse> — The list of toolkit categories
Example
listGrantContexts()
Lists the grant-context dimensions a toolkit’s scope recommendation depends on (for example the Google account type), with their allowed values and the default the API assumes. Experimental — the API marks this endpoint beta; shape may change. Pass a dimension and a value asgrantContext to composio.toolkits.recommendScopes() to tailor the recommendation.
Returns
Promise<ToolkitListGrantContextsResponse> — The dimensions and the default grant context
Example
recommendScopes()
Recommends the OAuth scopes to request so a connection can run the given tools. Experimental — the API marks this endpoint beta; shape may change. The answer comes in two variants:leastPrivilege (narrowest documented scope per requirement) and fewest (smallest set covering everything). Pass toolkitVersion from a previous answer to pin the computation.
Returns
Promise<ToolkitRecommendScopesResponse> — The recommended scope sets
Example