ComposioToolSet
composio-core / index / ComposioToolSet
Class: ComposioToolSet
Defined in: js/src/sdk/base.toolset.ts:41
Extended by
Constructors
Constructor
new ComposioToolSet(
config
):ComposioToolSet
Defined in: js/src/sdk/base.toolset.ts:84
Creates a new instance of ComposioToolSet
Parameters
config
Configuration object
allowTracing?
boolean
Whether to allow tracing for the SDK
apiKey?
string
API key for authentication
baseUrl?
string
Base URL for API requests
connectedAccountIds?
Record
<string
, string
>
Map of app names to their connected account IDs
entityId?
string
Entity ID for operations
runtime?
string
Runtime environment
Returns
ComposioToolSet
Properties
actions
actions:
Actions
Defined in: js/src/sdk/base.toolset.ts:51
activeTriggers
activeTriggers:
ActiveTriggers
Defined in: js/src/sdk/base.toolset.ts:54
apiKey
apiKey:
string
Defined in: js/src/sdk/base.toolset.ts:43
apps
apps:
Apps
Defined in: js/src/sdk/base.toolset.ts:50
backendClient
backendClient:
AxiosBackendClient
Defined in: js/src/sdk/base.toolset.ts:48
client
client:
Composio
Defined in: js/src/sdk/base.toolset.ts:42
connectedAccountIds
connectedAccountIds:
Record
<string
,string
> ={}
Defined in: js/src/sdk/base.toolset.ts:46
connectedAccounts
connectedAccounts:
ConnectedAccounts
Defined in: js/src/sdk/base.toolset.ts:49
entityId
entityId:
string
="default"
Defined in: js/src/sdk/base.toolset.ts:45
integrations
integrations:
Integrations
Defined in: js/src/sdk/base.toolset.ts:53
runtime
runtime:
string
Defined in: js/src/sdk/base.toolset.ts:44
triggers
triggers:
Triggers
Defined in: js/src/sdk/base.toolset.ts:52
userActionRegistry
userActionRegistry:
ActionRegistry
Defined in: js/src/sdk/base.toolset.ts:56
Methods
addPostProcessor()
addPostProcessor(
processor
):Promise
<ComposioToolSet
>
Defined in: js/src/sdk/base.toolset.ts:369
Parameters
processor
TPostProcessor
Returns
Promise
<ComposioToolSet
>
addPreProcessor()
addPreProcessor(
processor
):Promise
<ComposioToolSet
>
Defined in: js/src/sdk/base.toolset.ts:359
Parameters
processor
TPreProcessor
Returns
Promise
<ComposioToolSet
>
addSchemaProcessor()
addSchemaProcessor(
processor
):Promise
<ComposioToolSet
>
Defined in: js/src/sdk/base.toolset.ts:349
Parameters
processor
TSchemaProcessor
Returns
Promise
<ComposioToolSet
>
createAction()
createAction<
P
>(options
):Promise
<{appId
:string
;appKey
:string
;appName
:string
;description
:string
;display_name
:string
;enabled
:boolean
;logo
:string
;metadata
: {name
:string
;toolName
:string
; };name
:string
;parameters
: {description
:string
;properties
:Record
<string
,any
>;required
:string
[];title
:string
;type
:string
; };response
:Record
<string
,any
>;tags
:string
[]; }>
Defined in: js/src/sdk/base.toolset.ts:225
Type Parameters
P
P
extends Parameters
= ZodObject
<{}, UnknownKeysParam
, ZodTypeAny
, {}, {}>
Parameters
options
CreateActionOptions
<P
>
Returns
Promise
<{ appId
: string
; appKey
: string
; appName
: string
; description
: string
; display_name
: string
; enabled
: boolean
; logo
: string
; metadata
: { name
: string
; toolName
: string
; }; name
: string
; parameters
: { description
: string
; properties
: Record
<string
, any
>; required
: string
[]; title
: string
; type
: string
; }; response
: Record
<string
, any
>; tags
: string
[]; }>
executeAction()
executeAction(
functionParams
):Promise
<ActionExecutionResDto
>
Defined in: js/src/sdk/base.toolset.ts:241
Parameters
functionParams
ExecuteActionParams
Returns
Promise
<ActionExecutionResDto
>
getActionsSchema()
getActionsSchema(
filters
,_entityId
?):Promise
<object
[]>
Defined in: js/src/sdk/base.toolset.ts:138
Parameters
filters
actions?
Sequence
<string
>
_entityId?
string
Returns
Promise
<object
[]>
getEntity()
getEntity(
entityId
):Promise
<Entity
>
Defined in: js/src/sdk/base.toolset.ts:237
Parameters
entityId
string
Returns
Promise
<Entity
>
getToolsSchema()
getToolsSchema(
filters
,_entityId
?,_integrationId
?):Promise
<object
[]>
Defined in: js/src/sdk/base.toolset.ts:150
Parameters
filters
actions?
string
[] = ...
apps?
string
[] = ...
filterByAvailableApps?
boolean
= ...
integrationId?
string
= ...
tags?
string
[] = ...
useCase?
string
= ...
useCaseLimit?
number
= ...
_entityId?
string
_integrationId?
string
Returns
Promise
<object
[]>
removePostProcessor()
removePostProcessor():
Promise
<void
>
Defined in: js/src/sdk/base.toolset.ts:383
Returns
Promise
<void
>
removePreProcessor()
removePreProcessor():
Promise
<void
>
Defined in: js/src/sdk/base.toolset.ts:379
Returns
Promise
<void
>
removeSchemaProcessor()
removeSchemaProcessor():
Promise
<void
>
Defined in: js/src/sdk/base.toolset.ts:387
Returns
Promise
<void
>