Class LangchainToolSet
Hierarchy
- ComposioToolSet
- LangchainToolSet
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Langchain Tool Set(config): LangchainToolSet Parameters
- config: {
    apiKey?: Optional<string>;
    baseUrl?: Optional<string>;
    entityId?: string;
}OptionalapiKey?: Optional<string> OptionalbaseUrl?: Optional<string> OptionalentityId?: string
Returns LangchainToolSet
- config: {
Properties
api
api
client
entity
entity
runtime
runtime: null | string
Methods
Private _wrap_
execute_
get_
- get_
actions(filters?, entityId?): Promise<Sequence<DynamicStructuredTool<ZodObject<any, any, any, any, {}>>>> Parameters
- filters: {
    actions?: Optional<Sequence<string>>;
} = {}Optionalactions?: Optional<Sequence<string>>
OptionalentityId: Optional<string>
Returns Promise<Sequence<DynamicStructuredTool<ZodObject<any, any, any, any, {}>>>>
- filters: {
get_
- get_
tools(filters, entityId?): Promise<Sequence<DynamicStructuredTool<ZodObject<any, any, any, any, {}>>>> Parameters
- filters: {
    apps: Sequence<string>;
    tags: Optional<string[]>;
}apps: Sequence<string>
tags: Optional<string[]>
- entityId: Optional<string> = null
Returns Promise<Sequence<DynamicStructuredTool<ZodObject<any, any, any, any, {}>>>>
- filters: {
Class OpenAIToolSet
Hierarchy
- ComposioToolSet
- OpenAIToolSet
Index
Constructors
Properties
Methods
Constructors
constructor
- new
OpenAITool Set(config): OpenAIToolSet Composio toolset for OpenAI framework.
+Example:
+
++Parameters
- config: {
    apiKey?: Optional<string>;
    baseUrl?: Optional<string>;
    entityId?: string;
}OptionalapiKey?: Optional<string> OptionalbaseUrl?: Optional<string> OptionalentityId?: string
Returns OpenAIToolSet
- config: {
Properties
api
api
client
entity
entity
runtime
runtime: null | string
Methods
execute_
execute_
get_
get_
handle_
handle_
wait_
Class Composio
Index
Constructors
Properties
Methods
Constructors
constructor
Properties
actions
active
Private api
api
apps
Private base
base
config
config: OpenAPIConfig
connected
Private http
http: AxiosInstance
integrations
triggers
Methods
Private get
get
Static generate
Static validate
Class Actions
The Actions class provides methods to interact with the Composio platform's actions.
+It allows fetching details of specific actions, listing all actions, and executing actions.
-
+
getmethod retrieves details of a specific action.
+listmethod retrieves a list of all actions.
+executemethod executes a specific action.
+
Each method returns a CancelablePromise which can be canceled. If canceled, the promise
+will reject with a Cancellation object.
Type Param: Composio
The client configuration object type.
+ Index
Constructors
Properties
client
+
Methods
The methods in this class are grouped under 'Actions Methods' and provide functionalities +to interact with actions in the Composio platform. This includes fetching, listing, and +executing actions.
+Constructors
constructor
Properties
Private Readonly client
Methods
execute
- execute(data): CancelablePromise<ExecuteActionResponse>
Executes a specific action in the Composio platform.
+This method allows you to trigger the execution of an action by providing its name and the necessary input parameters. The request includes the connected account ID to identify the app connection to use for the action, and the input parameters required by the action. The response provides details about the execution status and the response data returned by the action.
+Parameters
- data: ExecuteActionData
The data for the request.
+
Returns CancelablePromise<ExecuteActionResponse>
A promise that resolves to the execution status and response data.
+Throws
If the request fails.
+- data: ExecuteActionData
get
- get(data): Promise<{
    appId?: string;
    appKey?: string;
    appName?: string;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    logo?: string;
    name?: string;
    parameters?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    response?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
}> Retrieves details of a specific action in the Composio platform by providing its action name.
+The response includes the action's name, display name, description, input parameters, expected response, associated app information, and enabled status.
+Parameters
- data: GetActionData
The data for the request.
+
Returns Promise<{
    appId?: string;
    appKey?: string;
    appName?: string;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    logo?: string;
    name?: string;
    parameters?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    response?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
}>A promise that resolves to the details of the action.
+Throws
If the request fails.
+- data: GetActionData
list
- list(data?): CancelablePromise<GetListActionsResponse>
Retrieves a list of all actions in the Composio platform.
+This method allows you to fetch a list of all the available actions. It supports pagination to handle large numbers of actions. The response includes an array of action objects, each containing information such as the action's name, display name, description, input parameters, expected response, associated app information, and enabled status.
+Parameters
- data: GetListActionsData = {}
The data for the request.
+
Returns CancelablePromise<GetListActionsResponse>
A promise that resolves to the list of all actions.
+Throws
If the request fails.
+- data: GetListActionsData = {}
Class ActiveTriggers
Constructors
constructor
- new
Active Triggers(client): ActiveTriggers Parameters
- client: Composio
Returns ActiveTriggers
Properties
Private Readonly client
Methods
disable
- disable(data): CancelablePromise<PatchUpdateActiveTriggerStatusResponse>
Disables the previously disabled trigger.
+Parameters
- data: {
    triggerId: string;
}The data for the request.
+trigger
Id: string Id of the trigger
+
Returns CancelablePromise<PatchUpdateActiveTriggerStatusResponse>
A promise that resolves to the response of the enable request.
+Throws
If the request fails.
+- data: {
enable
- enable(data): CancelablePromise<PatchUpdateActiveTriggerStatusResponse>
Enables the previously disabled trigger.
+Parameters
- data: {
    triggerId: string;
}The data for the request.
+trigger
Id: string Id of the trigger
+
Returns CancelablePromise<PatchUpdateActiveTriggerStatusResponse>
A promise that resolves to the response of the enable request.
+Throws
If the request fails.
+- data: {
get
- get(data): CancelablePromise<GetActiveTriggerResponse>
Retrieves details of a specific active trigger in the Composio platform by providing its trigger name.
+The response includes the trigger's name, description, input parameters, expected response, associated app information, and enabled status.
+Parameters
- data: GetActiveTriggerData
The data for the request.
+
Returns CancelablePromise<GetActiveTriggerResponse>
A promise that resolves to the details of the active trigger.
+Throws
If the request fails.
+- data: GetActiveTriggerData
list
- list(data?): CancelablePromise<ListActiveTriggersResponse>
Retrieves a list of all active triggers in the Composio platform.
+This method allows you to fetch a list of all the available active triggers. It supports pagination to handle large numbers of triggers. The response includes an array of trigger objects, each containing information such as the trigger's name, description, input parameters, expected response, associated app information, and enabled status.
+Parameters
- data: ListActiveTriggersData = {}
The data for the request.
+
Returns CancelablePromise<ListActiveTriggersResponse>
A promise that resolves to the list of all active triggers.
+Throws
If the request fails.
+- data: ListActiveTriggersData = {}
Class Apps
Index
Constructors
constructor
Properties
Private Readonly client
Methods
get
- get(data): CancelablePromise<GetAppResponse>
Retrieves details of a specific app in the Composio platform.
+This method allows clients to fetch detailed information about a specific app by providing its unique key. The response includes the app's name, key, status, description, logo, categories, authentication schemes, and other metadata.
+Parameters
- data: GetAppData
The data for the request, including the app's unique key.
+
Returns CancelablePromise<GetAppResponse>
A promise that resolves to the details of the app.
+Throws
If the request fails.
+- data: GetAppData
list
- list(): CancelablePromise<ListAllAppsResponse>
Retrieves a list of all available apps in the Composio platform.
+This method allows clients to explore and discover the supported apps. It returns an array of app objects, each containing essential details such as the app's key, name, description, logo, categories, and unique identifier.
+Returns CancelablePromise<ListAllAppsResponse>
A promise that resolves to the list of all apps.
+Throws
If the request fails.
+
Class ConnectedAccounts
Constructors
constructor
- new
Connected Accounts(client): ConnectedAccounts Parameters
- client: Composio
Returns ConnectedAccounts
Properties
Private Readonly client
Methods
create
- create(data?): CancelablePromise<CreateConnectionResponse>
Connects an account to the Composio platform.
+This method allows you to connect an external app account with Composio. It requires the integration ID in the request body and returns the connection status, connection ID, and a redirect URL (if applicable) for completing the connection flow.
+Parameters
- data: CreateConnectionData = {}
The data for the request.
+
Returns CancelablePromise<CreateConnectionResponse>
A promise that resolves to the connection status and details.
+Throws
If the request fails.
+- data: CreateConnectionData = {}
get
- get(data): CancelablePromise<GetConnectedAccountResponse>
Retrieves details of a specific account connected to the Composio platform by providing its connected account ID.
+The response includes the integration ID, connection parameters (such as scope, base URL, client ID, token type, access token, etc.), connection ID, status, and creation/update timestamps.
+Parameters
- data: GetConnectedAccountData
The data for the request.
+
Returns CancelablePromise<GetConnectedAccountResponse>
A promise that resolves to the details of the connected account.
+Throws
If the request fails.
+- data: GetConnectedAccountData
initiate
- initiate(data): Promise<ConnectionRequest>
Initiates a new connected account on the Composio platform.
+This method allows you to start the process of connecting an external app account with Composio. It requires the integration ID and optionally the entity ID, additional parameters, and a redirect URL.
+Parameters
- data: undefined | {
    data?: {
        [key: string]: unknown;
    };
    integrationId: string;
    redirectUri?: string;
    userUuid?: string;
}The data for the request.
+
Returns Promise<ConnectionRequest>
A promise that resolves to the connection request model.
+Throws
If the request fails.
+- data: undefined | {
list
- list(data?): CancelablePromise<ListAllConnectionsResponse>
Retrieves a list of all connected accounts in the Composio platform.
+It supports pagination and filtering based on various parameters such as app ID, integration ID, and connected account ID. The response includes an array of connection objects, each containing details like the connector ID, connection parameters, status, creation/update timestamps, and associated app information.
+Parameters
- data: ListAllConnectionsData = {}
The data for the request.
+
Returns CancelablePromise<ListAllConnectionsResponse>
A promise that resolves to the list of all connected accounts.
+Throws
If the request fails.
+- data: ListAllConnectionsData = {}
Class ConnectionRequest
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Connection Request(connectionStatus, connectedAccountId, redirectUrl?, client): ConnectionRequest Connection request model.
+Parameters
- connectionStatus: string
The status of the connection.
+ - connectedAccountId: string
The unique identifier of the connected account.
+ OptionalredirectUrl: null | string = nullThe redirect URL for completing the connection flow.
+- client: Composio
Returns ConnectionRequest
- connectionStatus: string
Properties
Private Readonly client
connected
connected
connection
connection
redirect
redirect
Methods
save
- save
User Access Data(data): Promise<CreateConnectionResponse> Save user access data.
+Parameters
- data: {
    entityId?: string;
    fieldInputs: Record<string, string>;
    redirectUrl?: string;
}The data to save.
+OptionalentityId?: string The entity ID associated with the user.
+field
Inputs: Record<string, string> The field inputs to save.
+OptionalredirectUrl?: string The redirect URL for completing the connection flow.
+
Returns Promise<CreateConnectionResponse>
The response from the server.
+- data: {
wait
- wait
Until Active(timeout?): Promise<GetConnectedAccountResponse> Wait until the connection becomes active.
+Parameters
Optionaltimeout: number = 60The timeout period in seconds.
+
Returns Promise<GetConnectedAccountResponse>
The connected account model.
+Throws
If the connection does not become active within the timeout period.
+
Class Integrations
Index
Constructors
constructor
- new
Integrations(client): Integrations Parameters
- client: Composio
Returns Integrations
Properties
Private Readonly client
Methods
create
- create(data): CancelablePromise<CreateIntegrationResponse>
Creates a new integration in the Composio platform.
+This method allows clients to create a new integration by providing the necessary details such as app ID, name, authentication mode, and configuration.
+Parameters
- data: undefined | {
    appId?: string;
    authConfig?: {
        api_key?: string;
        base_url?: string;
        client_id?: string;
        client_secret?: string;
        consumer_key?: string;
        consumer_secret?: string;
        [key: string]: unknown;
    };
    authScheme?: AuthScheme;
    name?: string;
    useComposioAuth?: boolean;
}The data for the request.
+
Returns CancelablePromise<CreateIntegrationResponse>
A promise that resolves to the created integration model.
+Throws
If the request fails.
+- data: undefined | {
get
- get(data): CancelablePromise<GetIntegrationResponse>
Retrieves details of a specific integration in the Composio platform by providing its integration name.
+The response includes the integration's name, display name, description, input parameters, expected response, associated app information, and enabled status.
+Parameters
- data: GetIntegrationData
The data for the request.
+
Returns CancelablePromise<GetIntegrationResponse>
A promise that resolves to the details of the integration.
+Throws
If the request fails.
+- data: GetIntegrationData
list
- list(data?): CancelablePromise<ListAllIntegrationsResponse>
Retrieves a list of all available integrations in the Composio platform.
+This method allows clients to explore and discover the supported integrations. It returns an array of integration objects, each containing essential details such as the integration's key, name, description, logo, categories, and unique identifier.
+Parameters
- data: ListAllIntegrationsData = {}
Returns CancelablePromise<ListAllIntegrationsResponse>
A promise that resolves to the list of all integrations.
+Throws
If the request fails.
+
Class Triggers
Index
Constructors
constructor
Properties
Private client
Methods
list
- list(data?): CancelablePromise<ListTriggersResponse>
Retrieves a list of all triggers in the Composio platform.
+This method allows you to fetch a list of all the available triggers. It supports pagination to handle large numbers of triggers. The response includes an array of trigger objects, each containing information such as the trigger's name, description, input parameters, expected response, associated app information, and enabled status.
+Parameters
- data: ListTriggersData = {}
The data for the request.
+
Returns CancelablePromise<ListTriggersResponse>
A promise that resolves to the list of all triggers.
+Throws
If the request fails.
+- data: ListTriggersData = {}
setup
- setup(data): CancelablePromise<SetupTriggerResponse>
Setup a trigger for a connected account.
+Parameters
- data: SetupTriggerData
The data for the request.
+
Returns CancelablePromise<SetupTriggerResponse>
A promise that resolves to the setup trigger response.
+Throws
If the request fails.
+- data: SetupTriggerData
\ No newline at end of file
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 0000000..4ed1490
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,29 @@
+
composio-core
+ 
+
Composio SDK: Equip your agent with high-quality tools and
build your real-world usecase
+ + + +
+
+Composio provides a platform that seamlessly integrates over 200+ apps with your AI agents, enhancing their utility and interactivity. It supports all the features you'll ever need:
+-
+
- Compatibility with Major Agent Frameworks: Autogen, Langchain, CrewAI, Julep, Lyzr, and OpenAI are all compatible with Composio, giving you a simple experience for your workflows. +
- Full Support for Actions & Triggers: Composio provides full support for Actions & Triggers, to power your agents with a wide range of functionalities. +
- Authentication Management: Composio provides comprehensive management of all authentication types, including
OAuth2,OAuth1,Basic,API_KEY.
+ - Extensibility: Don't find a tool you need? Composio is highly extensible, allowing you to add your own set of custom tools. +
- Secure Environment: Every user has a secure compute environment, ensuring data protection and privacy. +
Getting started
To get started, install the Composio SDK using the following command:
+npm install composio-core
+Resources
-
+
- Docs: https://docs.composio.dev/ +
- Discord: https://discord.gg/composio +
- Twitter: https://twitter.com/composiohq +
Contributing
Checkout CONTRIBUTING.md to get started with contributing to SDK. Feel free to reach out to us on Discord for any questions or issues. We value your feedback!
Module frameworks/langchain
Index
Classes
Module frameworks/openai
Index
Classes
Module sdk
Index
Classes
Composio
+
Module sdk/client/types.gen
Index
Enumerations
Type Aliases
$
Module sdk/models/actions
Index
Classes
Actions
+
Module sdk/models/activeTriggers
Index
Classes
Module sdk/models/apps
Index
Classes
Apps
+
Module sdk/models/connectedAccounts
Index
Classes
Module sdk/models/integrations
Index
Classes
Module sdk/models/triggers
Index
Classes
Triggers
+
Type alias CreateConnectionData
Create
    requestBody?: {
        data?: {
            [key: string]: unknown;
        };
        integrationId: string;
        redirectUri?: string;
        userUuid?: string;
    };
}
    requestBody?: {
        data?: {
            [key: string]: unknown;
        };
        integrationId: string;
        redirectUri?: string;
        userUuid?: string;
    };
}
Type declaration
OptionalrequestBody?: {
    data?: {
        [key: string]: unknown;
    };
    integrationId: string;
    redirectUri?: string;
    userUuid?: string;
}Optionaldata?: {
    [key: string]: unknown;
}[key: string]: unknown
integration
Id: string OptionalredirectUri?: string OptionaluserUuid?: string
Type alias CreateConnectionResponse
Create
    connectedAccountId?: string;
    connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
    redirectUrl?: string;
}
    connectedAccountId?: string;
    connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
    redirectUrl?: string;
}
Type declaration
OptionalconnectedAccount Id?: string OptionalconnectionStatus?: "SUCCESS" | "INITIATED" | "FAILED" OptionalredirectUrl?: string
Type alias CreateIntegrationData
Create
    requestBody?: {
        appId?: string;
        authConfig?: {
            api_key?: string;
            base_url?: string;
            client_id?: string;
            client_secret?: string;
            consumer_key?: string;
            consumer_secret?: string;
            [key: string]: unknown;
        };
        authScheme?: AuthScheme;
        name?: string;
        useComposioAuth?: boolean;
    };
}
    requestBody?: {
        appId?: string;
        authConfig?: {
            api_key?: string;
            base_url?: string;
            client_id?: string;
            client_secret?: string;
            consumer_key?: string;
            consumer_secret?: string;
            [key: string]: unknown;
        };
        authScheme?: AuthScheme;
        name?: string;
        useComposioAuth?: boolean;
    };
}
Type declaration
OptionalrequestBody?: {
    appId?: string;
    authConfig?: {
        api_key?: string;
        base_url?: string;
        client_id?: string;
        client_secret?: string;
        consumer_key?: string;
        consumer_secret?: string;
        [key: string]: unknown;
    };
    authScheme?: AuthScheme;
    name?: string;
    useComposioAuth?: boolean;
}OptionalappId?: string The unique identifier of the app associated with the connector.
+OptionalauthConfig?: {
    api_key?: string;
    base_url?: string;
    client_id?: string;
    client_secret?: string;
    consumer_key?: string;
    consumer_secret?: string;
    [key: string]: unknown;
}An object containing the authentication configuration for the connector.
+[key: string]: unknown
Optionalapi_key?: string The API key used for authentication with the app - if authScheme is API_KEY
+Optionalbase_url?: string The base URL for making API requests to the app.
+Optionalclient_id?: string The client ID used for authentication with the app - if authScheme is OAUTH2
+Optionalclient_secret?: string The client secret used for authentication with the app - if authScheme is OAUTH2
+Optionalconsumer_key?: string The Consumer key used for authentication with the app - if authScheme is OAUTH1
+Optionalconsumer_secret?: string The Consumer secret used for authentication with the app - if authScheme is OAUTH1
+
OptionalauthScheme?: AuthScheme The authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").
+Optionalname?: stringThe name of the connector.
+OptionaluseComposio Auth?: boolean Use default Composio credentials to proceed. The developer app credentials will be of Composio.
+
Type alias CreateIntegrationResponse
Create
    appId?: string;
    appName?: string;
    authConfig?: {
        base_url?: string;
        client_id?: string;
        client_secret?: string;
    };
    authScheme?: string;
    createdAt?: string;
    enabled?: boolean;
    expectedInputFields?: {
        [key: string]: unknown;
    }[];
    id?: string;
    logo?: string;
    name?: string;
    updatedAt?: string;
}
    appId?: string;
    appName?: string;
    authConfig?: {
        base_url?: string;
        client_id?: string;
        client_secret?: string;
    };
    authScheme?: string;
    createdAt?: string;
    enabled?: boolean;
    expectedInputFields?: {
        [key: string]: unknown;
    }[];
    id?: string;
    logo?: string;
    name?: string;
    updatedAt?: string;
}
Type declaration
OptionalappId?: string The unique identifier of the app associated with the connector.
+OptionalappName?: string The name of the app associated with the connector.
+OptionalauthConfig?: {
    base_url?: string;
    client_id?: string;
    client_secret?: string;
}An object containing the authentication configuration for the connector.
+Optionalbase_url?: string The base URL for making API requests to the app.
+Optionalclient_id?: string The client ID used for authentication with the app.
+Optionalclient_secret?: string The client secret used for authentication with the app.
+
OptionalauthScheme?: string The authentication scheme used by the connector.
+OptionalcreatedAt?: string The timestamp indicating when the connector was created.
+Optionalenabled?: booleanA boolean indicating whether the connector is enabled or not.
+OptionalexpectedInput Fields?: {
    [key: string]: unknown;
}[]An array of input fields expected by the connector.
+Optionalid?: stringThe unique identifier of the newly created connector.
+Optionallogo?: stringThe URL of the logo of the app associated with the connector.
+Optionalname?: stringThe name of the connector.
+OptionalupdatedAt?: string The timestamp indicating when the connector was last updated.
+
Type alias DeleteConnectionData
Delete
    connectedAccountId: string;
}
    connectedAccountId: string;
}
Type declaration
connected
Account Id: string The unique identifier of the connection.
+
Type alias DeleteConnectionResponse
Delete
    status?: string;
}
    status?: string;
}
Type declaration
Optionalstatus?: stringStatus of the api call.
+
Type alias ExecuteActionData
Execute
    actionName: string;
    requestBody?: {
        appName?: string;
        connectedAccountId?: string;
        input?: {
            [key: string]: unknown;
        };
    };
}
    actionName: string;
    requestBody?: {
        appName?: string;
        connectedAccountId?: string;
        input?: {
            [key: string]: unknown;
        };
    };
}
Type declaration
action
Name: string The name of the action to execute.
+OptionalrequestBody?: {
    appName?: string;
    connectedAccountId?: string;
    input?: {
        [key: string]: unknown;
    };
}OptionalappName?: string OptionalconnectedAccount Id?: string The unique identifier of the connection to use for executing the action.
+Optionalinput?: {
    [key: string]: unknown;
}An object containing the input parameters for the action.
+[key: string]: unknown
Type alias ExecuteActionResponse
Execute
    execution_details?: {
        executed?: boolean;
    };
    response_data?: {
        [key: string]: unknown;
    };
}
    execution_details?: {
        executed?: boolean;
    };
    response_data?: {
        [key: string]: unknown;
    };
}
Type declaration
Optionalexecution_details?: {
    executed?: boolean;
}An object containing the details of the action execution.
+Optionalexecuted?: booleanA boolean indicating whether the action was executed successfully.
+
Optionalresponse_data?: {
    [key: string]: unknown;
}An object containing the response data from the action execution.
+[key: string]: unknown
Type alias GetActionData
Get
    actionName: string;
}
    actionName: string;
}
Type declaration
action
Name: string The unique identifier of the action.
+
Type alias GetActionResponse
Get
    appId?: string;
    appKey?: string;
    appName?: string;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    logo?: string;
    name?: string;
    parameters?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    response?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
}[]
    appId?: string;
    appKey?: string;
    appName?: string;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    logo?: string;
    name?: string;
    parameters?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    response?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
}[]
Type declaration
OptionalappId?: string The unique identifier of the app associated with the action.
+OptionalappKey?: string The key of the app associated with the action.
+OptionalappName?: string The name of the app associated with the action.
+Optionaldescription?: stringA description of the action.
+Optionaldisplay_name?: string The display name of the action.
+Optionalenabled?: booleanA boolean indicating whether the action is enabled or not.
+Optionallogo?: stringThe URL of the logo of the app associated with the action.
+Optionalname?: stringThe name of the action.
+Optionalparameters?: {
    properties?: {
        [key: string]: unknown;
    };
    required?: string[];
    title?: string;
    type?: string;
}An object describing the input parameters of the action.
+Optionalproperties?: {
    [key: string]: unknown;
}An object containing the properties of the input parameters.
+[key: string]: unknown
Optionalrequired?: string[]An array of required parameter names.
+Optionaltitle?: stringThe title of the input parameters.
+Optionaltype?: stringThe type of the input parameters (e.g., "object").
+
Optionalresponse?: {
    properties?: {
        [key: string]: unknown;
    };
    required?: string[];
    title?: string;
    type?: string;
}An object describing the response of the action.
+Optionalproperties?: {
    [key: string]: unknown;
}An object containing the properties of the response.
+[key: string]: unknown
Optionalrequired?: string[]An array of required response field names.
+Optionaltitle?: stringThe title of the response.
+Optionaltype?: stringThe type of the response (e.g., "object").
+
Type alias GetActiveTriggerData
Get
    triggerId: string;
}
    triggerId: string;
}
Type declaration
trigger
Id: string The ID of the trigger to retrieve.
+
Type alias GetActiveTriggerResponse
Get
    connectionId?: string;
    createdAt?: string;
    disabledAt?: string;
    id?: string;
    state?: {
        [key: string]: unknown;
    };
    triggerConfig?: {
        [key: string]: unknown;
    };
    triggerData?: string;
    triggerName?: string;
    updatedAt?: string;
}
    connectionId?: string;
    createdAt?: string;
    disabledAt?: string;
    id?: string;
    state?: {
        [key: string]: unknown;
    };
    triggerConfig?: {
        [key: string]: unknown;
    };
    triggerData?: string;
    triggerName?: string;
    updatedAt?: string;
}
Type declaration
OptionalconnectionId?: string Identifier for the connection associated with the trigger.
+OptionalcreatedAt?: string Timestamp when the trigger was created.
+OptionaldisabledAt?: string Timestamp when the trigger was disabled, if applicable.
+Optionalid?: stringUnique identifier for the trigger.
+Optionalstate?: {
    [key: string]: unknown;
}State information for the trigger.
+[key: string]: unknown
OptionaltriggerConfig?: {
    [key: string]: unknown;
}Configuration settings for the trigger.
+[key: string]: unknown
OptionaltriggerData?: string Data associated with the trigger.
+OptionaltriggerName?: string Name of the trigger.
+OptionalupdatedAt?: string Timestamp when the trigger was last updated.
+
Type alias GetAppData
Get
    appKey: string;
}
    appKey: string;
}
Type declaration
app
Key: string
Type alias GetAppResponse
Get
    appId: string;
    auth_schemes: {
        auth_mode: string;
        authorization_url?: string;
        client_id?: string;
        client_secret?: string;
        default_scopes?: string[];
        fields?: {
            default?: string;
            description: string;
            displayName: string;
            expected_from_customer: boolean;
            name: string;
            required: boolean;
            type: string;
        }[];
        proxy?: {
            base_url?: string;
        };
        scheme_name?: string;
        token_response_metadata?: string[];
        token_url?: string;
    }[];
    categories: string[];
    configuration_docs_text?: string;
    description?: string;
    docs?: string;
    documentation_doc_text?: string;
    group: string;
    key: string;
    logo?: string;
    meta: {
        actionsCount: number;
        is_custom_app: boolean;
        triggersCount: number;
    };
    name: string;
    status: string;
    testConnectors?: {
        authScheme: string;
        id: string;
        name: string;
    }[];
    yaml: any;
}
    appId: string;
    auth_schemes: {
        auth_mode: string;
        authorization_url?: string;
        client_id?: string;
        client_secret?: string;
        default_scopes?: string[];
        fields?: {
            default?: string;
            description: string;
            displayName: string;
            expected_from_customer: boolean;
            name: string;
            required: boolean;
            type: string;
        }[];
        proxy?: {
            base_url?: string;
        };
        scheme_name?: string;
        token_response_metadata?: string[];
        token_url?: string;
    }[];
    categories: string[];
    configuration_docs_text?: string;
    description?: string;
    docs?: string;
    documentation_doc_text?: string;
    group: string;
    key: string;
    logo?: string;
    meta: {
        actionsCount: number;
        is_custom_app: boolean;
        triggersCount: number;
    };
    name: string;
    status: string;
    testConnectors?: {
        authScheme: string;
        id: string;
        name: string;
    }[];
    yaml: any;
}
Type declaration
app
Id: string auth_
schemes: {
    auth_mode: string;
    authorization_url?: string;
    client_id?: string;
    client_secret?: string;
    default_scopes?: string[];
    fields?: {
        default?: string;
        description: string;
        displayName: string;
        expected_from_customer: boolean;
        name: string;
        required: boolean;
        type: string;
    }[];
    proxy?: {
        base_url?: string;
    };
    scheme_name?: string;
    token_response_metadata?: string[];
    token_url?: string;
}[]categories: string[]
Optionalconfiguration_docs_ text?: string Optionaldescription?: stringOptionaldocs?: stringOptionaldocumentation_doc_ text?: string group: string
key: string
Optionallogo?: stringmeta: {
    actionsCount: number;
    is_custom_app: boolean;
    triggersCount: number;
}actions
Count: number is_
custom_ app: boolean triggers
Count: number
name: string
status: string
OptionaltestConnectors?: {
    authScheme: string;
    id: string;
    name: string;
}[]yaml: any
Type alias GetConnectedAccountData
Get
    connectedAccountId: string;
}
    connectedAccountId: string;
}
Type declaration
connected
Account Id: string The unique identifier of the connection.
+
Type alias GetConnectedAccountResponse
Get
    connectionParams?: {
        access_token?: string;
        base_url?: string;
        client_id?: string;
        client_secret?: string;
        scope?: string;
        token_type?: string;
    };
    createdAt?: string;
    id?: string;
    integrationId: string;
    status?: "ACTIVE" | "INITIATED" | "FAILED";
    updatedAt?: string;
}
    connectionParams?: {
        access_token?: string;
        base_url?: string;
        client_id?: string;
        client_secret?: string;
        scope?: string;
        token_type?: string;
    };
    createdAt?: string;
    id?: string;
    integrationId: string;
    status?: "ACTIVE" | "INITIATED" | "FAILED";
    updatedAt?: string;
}
Type declaration
OptionalconnectionParams?: {
    access_token?: string;
    base_url?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
    token_type?: string;
}An object containing the parameters specific to the connection.
+Optionalaccess_token?: string The access token used for authentication with the connected app.
+Optionalbase_url?: string The base URL for making API requests to the connected app.
+Optionalclient_id?: string The client ID used for authentication with the connected app.
+Optionalclient_secret?: string The client secret used for authentication with the connected app.
+Optionalscope?: stringThe scope of permissions granted to the connection.
+Optionaltoken_type?: string The type of token used for authentication (e.g., "bearer").
+
OptionalcreatedAt?: string The timestamp indicating when the connection was created.
+Optionalid?: stringThe unique identifier of the connection.
+integration
Id: string The unique identifier of the connector associated with the connection.
+Optionalstatus?: "ACTIVE" | "INITIATED" | "FAILED"The status of the connection (e.g., "SUCCESS").
+OptionalupdatedAt?: string The timestamp indicating when the connection was last updated.
+
Type alias GetIntegrationData
Get
    integrationId: string;
}
    integrationId: string;
}
Type declaration
integration
Id: string The unique identifier of the integration.
+
Type alias GetIntegrationResponse
Get
    appId?: string;
    appName?: string;
    authConfig?: {
        base_url?: string;
        client_id?: string;
        client_secret?: string;
    };
    authScheme?: string;
    createdAt?: string;
    enabled?: boolean;
    expectedInputFields?: {
        [key: string]: unknown;
    }[];
    id?: string;
    logo?: string;
    name?: string;
    updatedAt?: string;
}
    appId?: string;
    appName?: string;
    authConfig?: {
        base_url?: string;
        client_id?: string;
        client_secret?: string;
    };
    authScheme?: string;
    createdAt?: string;
    enabled?: boolean;
    expectedInputFields?: {
        [key: string]: unknown;
    }[];
    id?: string;
    logo?: string;
    name?: string;
    updatedAt?: string;
}
Type declaration
OptionalappId?: string The unique identifier of the app associated with the connector.
+OptionalappName?: string The name of the app associated with the connector.
+OptionalauthConfig?: {
    base_url?: string;
    client_id?: string;
    client_secret?: string;
}An object containing the authentication configuration for the connector.
+Optionalbase_url?: string The base URL for making API requests to the app.
+Optionalclient_id?: string The client ID used for authentication with the app.
+Optionalclient_secret?: string The client secret used for authentication with the app.
+
OptionalauthScheme?: string The authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").
+OptionalcreatedAt?: string The timestamp indicating when the connector was created.
+Optionalenabled?: booleanA boolean indicating whether the connector is enabled or not.
+OptionalexpectedInput Fields?: {
    [key: string]: unknown;
}[]An array of input fields expected by the connector.
+Optionalid?: stringThe unique identifier of the connector.
+Optionallogo?: stringThe URL of the logo of the app associated with the connector.
+Optionalname?: stringThe name of the connector.
+OptionalupdatedAt?: string The timestamp indicating when the connector was last updated.
+
Type alias GetListActionsData
Get
    actions?: string;
    apps?: string;
    showAll?: boolean;
    showEnabledOnly?: boolean;
    tags?: string;
    useCase?: string;
    usecaseLimit?: string;
}
    actions?: string;
    apps?: string;
    showAll?: boolean;
    showEnabledOnly?: boolean;
    tags?: string;
    useCase?: string;
    usecaseLimit?: string;
}
Type declaration
Optionalactions?: stringFilter by Action names
+Optionalapps?: stringName of the apps like "github", "linear" seperated by a comma
+OptionalshowAll?: boolean Show all actions - i.e disable pagination
+OptionalshowEnabled Only?: boolean Show actions enabled for the API Key
+Optionaltags?: stringFilter by Action tags
+OptionaluseCase?: string Filter by use case
+OptionalusecaseLimit?: string Limit of use-cases based search
+
Type alias GetListActionsResponse
Get
    items?: {
        appId?: string;
        appName?: string;
        description?: string;
        display_name?: string;
        enabled?: boolean;
        logo?: string;
        name?: string;
        parameters?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
        response?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
    }[];
    page: number;
    totalPages: number;
}
    items?: {
        appId?: string;
        appName?: string;
        description?: string;
        display_name?: string;
        enabled?: boolean;
        logo?: string;
        name?: string;
        parameters?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
        response?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
    }[];
    page: number;
    totalPages: number;
}
Type declaration
Optionalitems?: {
    appId?: string;
    appName?: string;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    logo?: string;
    name?: string;
    parameters?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    response?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
}[]An array of action objects.
+page: number
total
Pages: number
Type alias ListActiveTriggersData
List
    connectedAccountIds?: string;
    integrationIds?: string;
    triggerIds?: string;
    triggerNames?: string;
}
    connectedAccountIds?: string;
    integrationIds?: string;
    triggerIds?: string;
    triggerNames?: string;
}
Type declaration
OptionalconnectedAccount Ids?: string Filter by Connected Account ids
+OptionalintegrationIds?: string Filter by Integration ids
+OptionaltriggerIds?: string Filter by Trigger ids
+OptionaltriggerNames?: string Filter by Trigger names
+
Type alias ListActiveTriggersResponse
List
    pageInfo?: {
        currentPage?: number;
        perPage?: number;
        totalPages?: number;
    };
    triggers?: {
        connectionId?: string;
        createdAt?: string;
        disabledAt?: string;
        id?: string;
        state?: {
            [key: string]: unknown;
        };
        triggerConfig?: {
            [key: string]: unknown;
        };
        triggerData?: string;
        triggerName?: string;
        updatedAt?: string;
    }[];
}
    pageInfo?: {
        currentPage?: number;
        perPage?: number;
        totalPages?: number;
    };
    triggers?: {
        connectionId?: string;
        createdAt?: string;
        disabledAt?: string;
        id?: string;
        state?: {
            [key: string]: unknown;
        };
        triggerConfig?: {
            [key: string]: unknown;
        };
        triggerData?: string;
        triggerName?: string;
        updatedAt?: string;
    }[];
}
Type declaration
OptionalpageInfo?: {
    currentPage?: number;
    perPage?: number;
    totalPages?: number;
}OptionalcurrentPage?: number The current page number.
+OptionalperPage?: number The number of items per page.
+OptionaltotalPages?: number The total number of pages.
+
Optionaltriggers?: {
    connectionId?: string;
    createdAt?: string;
    disabledAt?: string;
    id?: string;
    state?: {
        [key: string]: unknown;
    };
    triggerConfig?: {
        [key: string]: unknown;
    };
    triggerData?: string;
    triggerName?: string;
    updatedAt?: string;
}[]
Type alias ListAllAppsResponse
List
    items?: {
        appId?: string;
        categories?: string[];
        description?: string;
        key?: string;
        logo?: string;
        name?: string;
    }[];
}
    items?: {
        appId?: string;
        categories?: string[];
        description?: string;
        key?: string;
        logo?: string;
        name?: string;
    }[];
}
Type declaration
Optionalitems?: {
    appId?: string;
    categories?: string[];
    description?: string;
    key?: string;
    logo?: string;
    name?: string;
}[]An array of app objects.
+
Type alias ListAllConnectionsData
List
    integrationId?: string;
    page?: number;
    pageSize?: number;
    user_uuid?: string;
}
    integrationId?: string;
    page?: number;
    pageSize?: number;
    user_uuid?: string;
}
Type declaration
OptionalintegrationId?: string Filter by using specific Integration
+Optionalpage?: numberPage number to fetch
+OptionalpageSize?: number Page size to assume
+Optionaluser_uuid?: string Filter by using specific entity id, seperated by comma
+
Type alias ListAllConnectionsResponse
List
    items?: {
        appName?: string;
        connectionParams?: {
            access_token?: string;
            base_url?: string;
            bot_id?: string;
            client_id?: string;
            client_secret?: string;
            created_at?: number;
            duplicated_template_id?: string;
            expires_in?: number;
            organization?: string;
            owner?: {
                type?: string;
                user?: {
                    avatar_url?: string;
                    id?: string;
                    name?: string;
                    object?: string;
                    person?: {
                        email?: string;
                    };
                    type?: string;
                };
            } | string;
            refresh_token?: string;
            request_id?: string;
            scope?: string;
            token_type?: string;
            workspace_icon?: string;
            workspace_id?: string;
            workspace_name?: string;
        };
        connectorId?: string;
        createdAt?: string;
        id?: string;
        logo?: string;
        status?: "FAILED" | "INITIATED" | "ACTIVE";
        updatedAt?: string;
    }[];
    page?: number;
    totalPages?: number;
}
    items?: {
        appName?: string;
        connectionParams?: {
            access_token?: string;
            base_url?: string;
            bot_id?: string;
            client_id?: string;
            client_secret?: string;
            created_at?: number;
            duplicated_template_id?: string;
            expires_in?: number;
            organization?: string;
            owner?: {
                type?: string;
                user?: {
                    avatar_url?: string;
                    id?: string;
                    name?: string;
                    object?: string;
                    person?: {
                        email?: string;
                    };
                    type?: string;
                };
            } | string;
            refresh_token?: string;
            request_id?: string;
            scope?: string;
            token_type?: string;
            workspace_icon?: string;
            workspace_id?: string;
            workspace_name?: string;
        };
        connectorId?: string;
        createdAt?: string;
        id?: string;
        logo?: string;
        status?: "FAILED" | "INITIATED" | "ACTIVE";
        updatedAt?: string;
    }[];
    page?: number;
    totalPages?: number;
}
Type declaration
Optionalitems?: {
    appName?: string;
    connectionParams?: {
        access_token?: string;
        base_url?: string;
        bot_id?: string;
        client_id?: string;
        client_secret?: string;
        created_at?: number;
        duplicated_template_id?: string;
        expires_in?: number;
        organization?: string;
        owner?: {
            type?: string;
            user?: {
                avatar_url?: string;
                id?: string;
                name?: string;
                object?: string;
                person?: {
                    email?: string;
                };
                type?: string;
            };
        } | string;
        refresh_token?: string;
        request_id?: string;
        scope?: string;
        token_type?: string;
        workspace_icon?: string;
        workspace_id?: string;
        workspace_name?: string;
    };
    connectorId?: string;
    createdAt?: string;
    id?: string;
    logo?: string;
    status?: "FAILED" | "INITIATED" | "ACTIVE";
    updatedAt?: string;
}[]Optionalpage?: numberOptionaltotalPages?: number
Type alias ListAllIntegrationsData
List
    page?: number;
    pageSize?: number;
}
    page?: number;
    pageSize?: number;
}
Type declaration
Optionalpage?: numberPage number to fetch
+OptionalpageSize?: number Page Size to assume
+
Type alias ListAllIntegrationsResponse
List
    items?: {
        appId?: string;
        appName?: string;
        authScheme?: string;
        createdAt?: string;
        enabled?: boolean;
        id?: string;
        logo?: string;
        name?: string;
        updatedAt?: string;
    }[];
    page?: number;
    totalPages?: number;
}
    items?: {
        appId?: string;
        appName?: string;
        authScheme?: string;
        createdAt?: string;
        enabled?: boolean;
        id?: string;
        logo?: string;
        name?: string;
        updatedAt?: string;
    }[];
    page?: number;
    totalPages?: number;
}
Type declaration
Optionalitems?: {
    appId?: string;
    appName?: string;
    authScheme?: string;
    createdAt?: string;
    enabled?: boolean;
    id?: string;
    logo?: string;
    name?: string;
    updatedAt?: string;
}[]Optionalpage?: numberOptionaltotalPages?: number
Type alias ListTriggersData
List
    appNames?: string;
    connectedAccountIds?: string;
    showEnabledOnly?: boolean;
}
    appNames?: string;
    connectedAccountIds?: string;
    showEnabledOnly?: boolean;
}
Type declaration
OptionalappNames?: string Name of the apps like "github", "linear" seperated by a comma
+OptionalconnectedAccount Ids?: string Filter by Aonnected Account ids
+OptionalshowEnabled Only?: boolean Show triggers enabled for the API Key
+
Type alias ListTriggersResponse
List
    appId?: string;
    appKey?: string;
    appName?: string;
    config?: {
        properties?: {
            description?: string;
            required?: string[];
            title?: string;
            type?: string;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    count?: number;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    instructions?: string;
    logo?: string;
    name?: string;
    payload?: {
        properties?: {
            author: string;
            id: string;
            message: string;
            timestamp: string;
            url: string;
        };
    };
}[]
    appId?: string;
    appKey?: string;
    appName?: string;
    config?: {
        properties?: {
            description?: string;
            required?: string[];
            title?: string;
            type?: string;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    count?: number;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    instructions?: string;
    logo?: string;
    name?: string;
    payload?: {
        properties?: {
            author: string;
            id: string;
            message: string;
            timestamp: string;
            url: string;
        };
    };
}[]
Type declaration
OptionalappId?: string The unique ID of the app.
+OptionalappKey?: string The key of the app.
+OptionalappName?: string The name of the app.
+Optionalconfig?: {
    properties?: {
        description?: string;
        required?: string[];
        title?: string;
        type?: string;
    };
    required?: string[];
    title?: string;
    type?: string;
}Optionalproperties?: {
    description?: string;
    required?: string[];
    title?: string;
    type?: string;
}Optionaldescription?: stringstring
+Optionalrequired?: string[]Optionaltitle?: stringstring
+Optionaltype?: stringstring
+
Optionalrequired?: string[]Optionaltitle?: stringOptionaltype?: string
Optionalcount?: numberThe count of the event.
+Optionaldescription?: stringA brief description of the event.
+Optionaldisplay_name?: string The display name of the event.
+Optionalenabled?: booleanWhether the event is enabled.
+Optionalinstructions?: stringInstructions for the event.
+Optionallogo?: stringThe URL of the app's logo image.
+Optionalname?: stringThe name of the event.
+Optionalpayload?: {
    properties?: {
        author: string;
        id: string;
        message: string;
        timestamp: string;
        url: string;
    };
}Optionalproperties?: {
    author: string;
    id: string;
    message: string;
    timestamp: string;
    url: string;
}author: string
The GitHub username of the commit author.
+id: string
The SHA of the commit.
+message: string
The commit message.
+timestamp: string
The timestamp of the commit.
+url: string
The GitHub URL of the commit.
+
Type alias PatchUpdateActiveTriggerStatusData
Patch
    requestBody: {
        enabled: boolean;
    };
    triggerId: string;
}
    requestBody: {
        enabled: boolean;
    };
    triggerId: string;
}
Type declaration
request
Body: {
    enabled: boolean;
}enabled: boolean
trigger
Id: string The ID of the trigger to enable or disable.
+
Type alias PatchUpdateActiveTriggerStatusResponse
Patch
    status: "success";
}
    status: "success";
}
Type declaration
status: "success"
Type alias SetupTriggerData
Setup
    connectedAccountId: string;
    requestBody: {
        triggerConfig: any;
        verifyHost?: string;
    };
    triggerName: string;
}
    connectedAccountId: string;
    requestBody: {
        triggerConfig: any;
        verifyHost?: string;
    };
    triggerName: string;
}
Type declaration
connected
Account Id: string request
Body: {
    triggerConfig: any;
    verifyHost?: string;
}trigger
Config: any OptionalverifyHost?: string
trigger
Name: string
Type alias SetupTriggerResponse
Type declaration
status: "success"
trigger: GetActiveTriggerResponse
Type alias UpdateIntegrationData
Update
    integrationId: string;
    requestBody?: {
        enabled?: boolean;
    };
}
    integrationId: string;
    requestBody?: {
        enabled?: boolean;
    };
}
Type declaration
integration
Id: string The unique identifier of the integration.
+OptionalrequestBody?: {
    enabled?: boolean;
}Optionalenabled?: booleanAll the parameters that you see in the GET connector
+
Type alias UpdateIntegrationResponse
Update
    status?: string;
}
    status?: string;
}
Type declaration
Optionalstatus?: string
Type alias $OpenApiTs
$
    /v1/actions/{actionName}: {
        get: {
            req: GetActionData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    description?: string;
                    display_name?: string;
                    enabled?: boolean;
                    logo?: string;
                    name?: string;
                    parameters?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    response?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                };
                404: unknown;
            };
        };
    };
    /v1/actions/{actionName}/execute: {
        post: {
            req: ExecuteActionData;
            res: {
                200: {
                    execution_details?: {
                        executed?: boolean;
                    };
                    response_data?: {
                        [key: string]: unknown;
                    };
                };
                404: unknown;
            };
        };
    };
    /v1/apps: {
        get: {
            res: {
                200: {
                    items?: {
                        appId?: string;
                        categories?: string[];
                        description?: string;
                        key?: string;
                        logo?: string;
                        name?: string;
                    }[];
                };
            };
        };
    };
    /v1/connectedAccounts: {
        get: {
            req: ListAllConnectionsData;
            res: {
                200: {
                    items?: {
                        appName?: string;
                        connectionParams?: {
                            access_token?: string;
                            base_url?: string;
                            bot_id?: string;
                            client_id?: string;
                            client_secret?: string;
                            created_at?: number;
                            duplicated_template_id?: string;
                            expires_in?: number;
                            organization?: string;
                            owner?: {
                                type?: string;
                                user?: {
                                    avatar_url?: ...;
                                    id?: ...;
                                    name?: ...;
                                    object?: ...;
                                    person?: ...;
                                    type?: ...;
                                };
                            } | string;
                            refresh_token?: string;
                            request_id?: string;
                            scope?: string;
                            token_type?: string;
                            workspace_icon?: string;
                            workspace_id?: string;
                            workspace_name?: string;
                        };
                        connectorId?: string;
                        createdAt?: string;
                        id?: string;
                        logo?: string;
                        status?: "FAILED" | "INITIATED" | "ACTIVE";
                        updatedAt?: string;
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
        post: {
            req: CreateConnectionData;
            res: {
                200: {
                    connectionId?: string;
                    connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
                    redirectUrl?: string;
                };
                404: unknown;
            };
        };
    };
    /v1/connectedAccounts/{connectedAccountId}: {
        delete: {
            req: DeleteConnectionData;
            res: {
                200: {
                    status?: string;
                };
                404: unknown;
            };
        };
        get: {
            req: GetConnectedAccountData;
            res: {
                200: {
                    connectionParams?: {
                        access_token?: string;
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                        scope?: string;
                        token_type?: string;
                    };
                    createdAt?: string;
                    id?: string;
                    integrationId?: string;
                    status?: "ACTIVE" | "INITIATED" | "FAILED";
                    updatedAt?: string;
                };
                404: unknown;
            };
        };
    };
    /v1/integrations: {
        get: {
            req: ListAllIntegrationsData;
            res: {
                200: {
                    items?: {
                        appId?: string;
                        appName?: string;
                        authScheme?: string;
                        createdAt?: string;
                        enabled?: boolean;
                        id?: string;
                        logo?: string;
                        name?: string;
                        updatedAt?: string;
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
        post: {
            req: CreateIntegrationData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    authConfig?: {
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                    };
                    authScheme?: string;
                    createdAt?: string;
                    enabled?: boolean;
                    expectedInputFields?: {
                        [key: string]: unknown;
                    }[];
                    id?: string;
                    logo?: string;
                    name?: string;
                    updatedAt?: string;
                };
                400: unknown;
            };
        };
    };
    /v1/integrations/{integrationId}: {
        get: {
            req: GetIntegrationData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    authConfig?: {
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                    };
                    authScheme?: string;
                    createdAt?: string;
                    enabled?: boolean;
                    expectedInputFields?: {
                        [key: string]: unknown;
                    }[];
                    id?: string;
                    logo?: string;
                    name?: string;
                    updatedAt?: string;
                };
                404: unknown;
            };
        };
        patch: {
            req: UpdateIntegrationData;
            res: {
                200: {
                    status?: string;
                };
                404: unknown;
            };
        };
    };
    /v1/triggers: {
        get: {
            req: ListTriggersData;
            res: {
                200: {
                    appId?: string;
                    appKey?: string;
                    appName?: string;
                    config?: {
                        properties?: {
                            description?: string;
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    count?: number;
                    description?: string;
                    display_name?: string;
                    enabled?: boolean;
                    instructions?: string;
                    logo?: string;
                    name?: string;
                    payload?: {
                        properties?: {
                            author: string;
                            id: string;
                            message: string;
                            timestamp: string;
                            url: string;
                        };
                    };
                }[];
            };
        };
    };
    /v1/triggers/active_triggers: {
        get: {
            req: ListActiveTriggersData;
            res: {
                200: {
                    pageInfo?: {
                        currentPage?: number;
                        perPage?: number;
                        totalPages?: number;
                    };
                    triggers?: {
                        connectionId?: string;
                        createdAt?: string;
                        disabledAt?: string;
                        id?: string;
                        state?: {
                            [key: string]: unknown;
                        };
                        triggerConfig?: {
                            [key: string]: unknown;
                        };
                        triggerData?: string;
                        triggerName?: string;
                        updatedAt?: string;
                    }[];
                };
            };
        };
    };
    /v1/triggers/get/{triggerId}: {
        get: {
            req: GetActiveTriggerData;
            res: {
                200: {
                    connectionId?: string;
                    createdAt?: string;
                    disabledAt?: string;
                    id?: string;
                    state?: {
                        [key: string]: unknown;
                    };
                    triggerConfig?: {
                        [key: string]: unknown;
                    };
                    triggerData?: string;
                    triggerName?: string;
                    updatedAt?: string;
                };
                404: unknown;
                500: unknown;
            };
        };
    };
    /v2/actions: {
        get: {
            req: GetListActionsData;
            res: {
                200: {
                    items?: {
                        appId?: string;
                        appName?: string;
                        description?: string;
                        display_name?: string;
                        enabled?: boolean;
                        logo?: string;
                        name?: string;
                        parameters?: {
                            properties?: {
                                [key: string]: unknown;
                            };
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                        response?: {
                            properties?: {
                                [key: string]: unknown;
                            };
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
    };
}
    /v1/actions/{actionName}: {
        get: {
            req: GetActionData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    description?: string;
                    display_name?: string;
                    enabled?: boolean;
                    logo?: string;
                    name?: string;
                    parameters?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    response?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                };
                404: unknown;
            };
        };
    };
    /v1/actions/{actionName}/execute: {
        post: {
            req: ExecuteActionData;
            res: {
                200: {
                    execution_details?: {
                        executed?: boolean;
                    };
                    response_data?: {
                        [key: string]: unknown;
                    };
                };
                404: unknown;
            };
        };
    };
    /v1/apps: {
        get: {
            res: {
                200: {
                    items?: {
                        appId?: string;
                        categories?: string[];
                        description?: string;
                        key?: string;
                        logo?: string;
                        name?: string;
                    }[];
                };
            };
        };
    };
    /v1/connectedAccounts: {
        get: {
            req: ListAllConnectionsData;
            res: {
                200: {
                    items?: {
                        appName?: string;
                        connectionParams?: {
                            access_token?: string;
                            base_url?: string;
                            bot_id?: string;
                            client_id?: string;
                            client_secret?: string;
                            created_at?: number;
                            duplicated_template_id?: string;
                            expires_in?: number;
                            organization?: string;
                            owner?: {
                                type?: string;
                                user?: {
                                    avatar_url?: ...;
                                    id?: ...;
                                    name?: ...;
                                    object?: ...;
                                    person?: ...;
                                    type?: ...;
                                };
                            } | string;
                            refresh_token?: string;
                            request_id?: string;
                            scope?: string;
                            token_type?: string;
                            workspace_icon?: string;
                            workspace_id?: string;
                            workspace_name?: string;
                        };
                        connectorId?: string;
                        createdAt?: string;
                        id?: string;
                        logo?: string;
                        status?: "FAILED" | "INITIATED" | "ACTIVE";
                        updatedAt?: string;
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
        post: {
            req: CreateConnectionData;
            res: {
                200: {
                    connectionId?: string;
                    connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
                    redirectUrl?: string;
                };
                404: unknown;
            };
        };
    };
    /v1/connectedAccounts/{connectedAccountId}: {
        delete: {
            req: DeleteConnectionData;
            res: {
                200: {
                    status?: string;
                };
                404: unknown;
            };
        };
        get: {
            req: GetConnectedAccountData;
            res: {
                200: {
                    connectionParams?: {
                        access_token?: string;
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                        scope?: string;
                        token_type?: string;
                    };
                    createdAt?: string;
                    id?: string;
                    integrationId?: string;
                    status?: "ACTIVE" | "INITIATED" | "FAILED";
                    updatedAt?: string;
                };
                404: unknown;
            };
        };
    };
    /v1/integrations: {
        get: {
            req: ListAllIntegrationsData;
            res: {
                200: {
                    items?: {
                        appId?: string;
                        appName?: string;
                        authScheme?: string;
                        createdAt?: string;
                        enabled?: boolean;
                        id?: string;
                        logo?: string;
                        name?: string;
                        updatedAt?: string;
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
        post: {
            req: CreateIntegrationData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    authConfig?: {
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                    };
                    authScheme?: string;
                    createdAt?: string;
                    enabled?: boolean;
                    expectedInputFields?: {
                        [key: string]: unknown;
                    }[];
                    id?: string;
                    logo?: string;
                    name?: string;
                    updatedAt?: string;
                };
                400: unknown;
            };
        };
    };
    /v1/integrations/{integrationId}: {
        get: {
            req: GetIntegrationData;
            res: {
                200: {
                    appId?: string;
                    appName?: string;
                    authConfig?: {
                        base_url?: string;
                        client_id?: string;
                        client_secret?: string;
                    };
                    authScheme?: string;
                    createdAt?: string;
                    enabled?: boolean;
                    expectedInputFields?: {
                        [key: string]: unknown;
                    }[];
                    id?: string;
                    logo?: string;
                    name?: string;
                    updatedAt?: string;
                };
                404: unknown;
            };
        };
        patch: {
            req: UpdateIntegrationData;
            res: {
                200: {
                    status?: string;
                };
                404: unknown;
            };
        };
    };
    /v1/triggers: {
        get: {
            req: ListTriggersData;
            res: {
                200: {
                    appId?: string;
                    appKey?: string;
                    appName?: string;
                    config?: {
                        properties?: {
                            description?: string;
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    count?: number;
                    description?: string;
                    display_name?: string;
                    enabled?: boolean;
                    instructions?: string;
                    logo?: string;
                    name?: string;
                    payload?: {
                        properties?: {
                            author: string;
                            id: string;
                            message: string;
                            timestamp: string;
                            url: string;
                        };
                    };
                }[];
            };
        };
    };
    /v1/triggers/active_triggers: {
        get: {
            req: ListActiveTriggersData;
            res: {
                200: {
                    pageInfo?: {
                        currentPage?: number;
                        perPage?: number;
                        totalPages?: number;
                    };
                    triggers?: {
                        connectionId?: string;
                        createdAt?: string;
                        disabledAt?: string;
                        id?: string;
                        state?: {
                            [key: string]: unknown;
                        };
                        triggerConfig?: {
                            [key: string]: unknown;
                        };
                        triggerData?: string;
                        triggerName?: string;
                        updatedAt?: string;
                    }[];
                };
            };
        };
    };
    /v1/triggers/get/{triggerId}: {
        get: {
            req: GetActiveTriggerData;
            res: {
                200: {
                    connectionId?: string;
                    createdAt?: string;
                    disabledAt?: string;
                    id?: string;
                    state?: {
                        [key: string]: unknown;
                    };
                    triggerConfig?: {
                        [key: string]: unknown;
                    };
                    triggerData?: string;
                    triggerName?: string;
                    updatedAt?: string;
                };
                404: unknown;
                500: unknown;
            };
        };
    };
    /v2/actions: {
        get: {
            req: GetListActionsData;
            res: {
                200: {
                    items?: {
                        appId?: string;
                        appName?: string;
                        description?: string;
                        display_name?: string;
                        enabled?: boolean;
                        logo?: string;
                        name?: string;
                        parameters?: {
                            properties?: {
                                [key: string]: unknown;
                            };
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                        response?: {
                            properties?: {
                                [key: string]: unknown;
                            };
                            required?: string[];
                            title?: string;
                            type?: string;
                        };
                    }[];
                    page?: number;
                    totalPages?: number;
                };
            };
        };
    };
}
Type declaration
/v1/actions/{action
Name}: {
    get: {
        req: GetActionData;
        res: {
            200: {
                appId?: string;
                appName?: string;
                description?: string;
                display_name?: string;
                enabled?: boolean;
                logo?: string;
                name?: string;
                parameters?: {
                    properties?: {
                        [key: string]: unknown;
                    };
                    required?: string[];
                    title?: string;
                    type?: string;
                };
                response?: {
                    properties?: {
                        [key: string]: unknown;
                    };
                    required?: string[];
                    title?: string;
                    type?: string;
                };
            };
            404: unknown;
        };
    };
}get: {
    req: GetActionData;
    res: {
        200: {
            appId?: string;
            appName?: string;
            description?: string;
            display_name?: string;
            enabled?: boolean;
            logo?: string;
            name?: string;
            parameters?: {
                properties?: {
                    [key: string]: unknown;
                };
                required?: string[];
                title?: string;
                type?: string;
            };
            response?: {
                properties?: {
                    [key: string]: unknown;
                };
                required?: string[];
                title?: string;
                type?: string;
            };
        };
        404: unknown;
    };
}req: GetActionData
res: {
    200: {
        appId?: string;
        appName?: string;
        description?: string;
        display_name?: string;
        enabled?: boolean;
        logo?: string;
        name?: string;
        parameters?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
        response?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
    };
    404: unknown;
}200: {
    appId?: string;
    appName?: string;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    logo?: string;
    name?: string;
    parameters?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    response?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
}OK
+OptionalappId?: string The unique identifier of the app associated with the action.
+OptionalappName?: string The name of the app associated with the action.
+Optionaldescription?: stringA description of the action.
+Optionaldisplay_name?: string The display name of the action.
+Optionalenabled?: booleanA boolean indicating whether the action is enabled or not.
+Optionallogo?: stringThe URL of the logo of the app associated with the action.
+Optionalname?: stringThe name of the action.
+Optionalparameters?: {
    properties?: {
        [key: string]: unknown;
    };
    required?: string[];
    title?: string;
    type?: string;
}An object describing the input parameters of the action.
+Optionalproperties?: {
    [key: string]: unknown;
}An object containing the properties of the input parameters.
+[key: string]: unknown
Optionalrequired?: string[]An array of required parameter names.
+Optionaltitle?: stringThe title of the input parameters.
+Optionaltype?: stringThe type of the input parameters (e.g., "object").
+
Optionalresponse?: {
    properties?: {
        [key: string]: unknown;
    };
    required?: string[];
    title?: string;
    type?: string;
}An object describing the response of the action.
+Optionalproperties?: {
    [key: string]: unknown;
}An object containing the properties of the response.
+[key: string]: unknown
Optionalrequired?: string[]An array of required response field names.
+Optionaltitle?: stringThe title of the response.
+Optionaltype?: stringThe type of the response (e.g., "object").
+
404: unknown
Not Found
+
/v1/actions/{action
Name}/execute: {
    post: {
        req: ExecuteActionData;
        res: {
            200: {
                execution_details?: {
                    executed?: boolean;
                };
                response_data?: {
                    [key: string]: unknown;
                };
            };
            404: unknown;
        };
    };
}post: {
    req: ExecuteActionData;
    res: {
        200: {
            execution_details?: {
                executed?: boolean;
            };
            response_data?: {
                [key: string]: unknown;
            };
        };
        404: unknown;
    };
}req: ExecuteActionData
res: {
    200: {
        execution_details?: {
            executed?: boolean;
        };
        response_data?: {
            [key: string]: unknown;
        };
    };
    404: unknown;
}200: {
    execution_details?: {
        executed?: boolean;
    };
    response_data?: {
        [key: string]: unknown;
    };
}OK
+Optionalexecution_details?: {
    executed?: boolean;
}An object containing the details of the action execution.
+Optionalexecuted?: booleanA boolean indicating whether the action was executed successfully.
+
Optionalresponse_data?: {
    [key: string]: unknown;
}An object containing the response data from the action execution.
+[key: string]: unknown
404: unknown
Not Found
+
/v1/apps: {
    get: {
        res: {
            200: {
                items?: {
                    appId?: string;
                    categories?: string[];
                    description?: string;
                    key?: string;
                    logo?: string;
                    name?: string;
                }[];
            };
        };
    };
}get: {
    res: {
        200: {
            items?: {
                appId?: string;
                categories?: string[];
                description?: string;
                key?: string;
                logo?: string;
                name?: string;
            }[];
        };
    };
}res: {
    200: {
        items?: {
            appId?: string;
            categories?: string[];
            description?: string;
            key?: string;
            logo?: string;
            name?: string;
        }[];
    };
}200: {
    items?: {
        appId?: string;
        categories?: string[];
        description?: string;
        key?: string;
        logo?: string;
        name?: string;
    }[];
}OK
+Optionalitems?: {
    appId?: string;
    categories?: string[];
    description?: string;
    key?: string;
    logo?: string;
    name?: string;
}[]An array of app objects.
+
/v1/connected
Accounts: {
    get: {
        req: ListAllConnectionsData;
        res: {
            200: {
                items?: {
                    appName?: string;
                    connectionParams?: {
                        access_token?: string;
                        base_url?: string;
                        bot_id?: string;
                        client_id?: string;
                        client_secret?: string;
                        created_at?: number;
                        duplicated_template_id?: string;
                        expires_in?: number;
                        organization?: string;
                        owner?: {
                            type?: string;
                            user?: {
                                avatar_url?: ...;
                                id?: ...;
                                name?: ...;
                                object?: ...;
                                person?: ...;
                                type?: ...;
                            };
                        } | string;
                        refresh_token?: string;
                        request_id?: string;
                        scope?: string;
                        token_type?: string;
                        workspace_icon?: string;
                        workspace_id?: string;
                        workspace_name?: string;
                    };
                    connectorId?: string;
                    createdAt?: string;
                    id?: string;
                    logo?: string;
                    status?: "FAILED" | "INITIATED" | "ACTIVE";
                    updatedAt?: string;
                }[];
                page?: number;
                totalPages?: number;
            };
        };
    };
    post: {
        req: CreateConnectionData;
        res: {
            200: {
                connectionId?: string;
                connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
                redirectUrl?: string;
            };
            404: unknown;
        };
    };
}get: {
    req: ListAllConnectionsData;
    res: {
        200: {
            items?: {
                appName?: string;
                connectionParams?: {
                    access_token?: string;
                    base_url?: string;
                    bot_id?: string;
                    client_id?: string;
                    client_secret?: string;
                    created_at?: number;
                    duplicated_template_id?: string;
                    expires_in?: number;
                    organization?: string;
                    owner?: {
                        type?: string;
                        user?: {
                            avatar_url?: ...;
                            id?: ...;
                            name?: ...;
                            object?: ...;
                            person?: ...;
                            type?: ...;
                        };
                    } | string;
                    refresh_token?: string;
                    request_id?: string;
                    scope?: string;
                    token_type?: string;
                    workspace_icon?: string;
                    workspace_id?: string;
                    workspace_name?: string;
                };
                connectorId?: string;
                createdAt?: string;
                id?: string;
                logo?: string;
                status?: "FAILED" | "INITIATED" | "ACTIVE";
                updatedAt?: string;
            }[];
            page?: number;
            totalPages?: number;
        };
    };
}req: ListAllConnectionsData
res: {
    200: {
        items?: {
            appName?: string;
            connectionParams?: {
                access_token?: string;
                base_url?: string;
                bot_id?: string;
                client_id?: string;
                client_secret?: string;
                created_at?: number;
                duplicated_template_id?: string;
                expires_in?: number;
                organization?: string;
                owner?: {
                    type?: string;
                    user?: {
                        avatar_url?: ...;
                        id?: ...;
                        name?: ...;
                        object?: ...;
                        person?: ...;
                        type?: ...;
                    };
                } | string;
                refresh_token?: string;
                request_id?: string;
                scope?: string;
                token_type?: string;
                workspace_icon?: string;
                workspace_id?: string;
                workspace_name?: string;
            };
            connectorId?: string;
            createdAt?: string;
            id?: string;
            logo?: string;
            status?: "FAILED" | "INITIATED" | "ACTIVE";
            updatedAt?: string;
        }[];
        page?: number;
        totalPages?: number;
    };
}200: {
    items?: {
        appName?: string;
        connectionParams?: {
            access_token?: string;
            base_url?: string;
            bot_id?: string;
            client_id?: string;
            client_secret?: string;
            created_at?: number;
            duplicated_template_id?: string;
            expires_in?: number;
            organization?: string;
            owner?: {
                type?: string;
                user?: {
                    avatar_url?: ...;
                    id?: ...;
                    name?: ...;
                    object?: ...;
                    person?: ...;
                    type?: ...;
                };
            } | string;
            refresh_token?: string;
            request_id?: string;
            scope?: string;
            token_type?: string;
            workspace_icon?: string;
            workspace_id?: string;
            workspace_name?: string;
        };
        connectorId?: string;
        createdAt?: string;
        id?: string;
        logo?: string;
        status?: "FAILED" | "INITIATED" | "ACTIVE";
        updatedAt?: string;
    }[];
    page?: number;
    totalPages?: number;
}OK
+Optionalitems?: {
    appName?: string;
    connectionParams?: {
        access_token?: string;
        base_url?: string;
        bot_id?: string;
        client_id?: string;
        client_secret?: string;
        created_at?: number;
        duplicated_template_id?: string;
        expires_in?: number;
        organization?: string;
        owner?: {
            type?: string;
            user?: {
                avatar_url?: ...;
                id?: ...;
                name?: ...;
                object?: ...;
                person?: ...;
                type?: ...;
            };
        } | string;
        refresh_token?: string;
        request_id?: string;
        scope?: string;
        token_type?: string;
        workspace_icon?: string;
        workspace_id?: string;
        workspace_name?: string;
    };
    connectorId?: string;
    createdAt?: string;
    id?: string;
    logo?: string;
    status?: "FAILED" | "INITIATED" | "ACTIVE";
    updatedAt?: string;
}[]Optionalpage?: numberOptionaltotalPages?: number
post: {
    req: CreateConnectionData;
    res: {
        200: {
            connectionId?: string;
            connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
            redirectUrl?: string;
        };
        404: unknown;
    };
}req: CreateConnectionData
res: {
    200: {
        connectionId?: string;
        connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
        redirectUrl?: string;
    };
    404: unknown;
}200: {
    connectionId?: string;
    connectionStatus?: "SUCCESS" | "INITIATED" | "FAILED";
    redirectUrl?: string;
}OK
+OptionalconnectionId?: string OptionalconnectionStatus?: "SUCCESS" | "INITIATED" | "FAILED" OptionalredirectUrl?: string
404: unknown
{ +"message": "Connector not found" +}
+
/v1/connected
Accounts/{connected Account Id}: {
    delete: {
        req: DeleteConnectionData;
        res: {
            200: {
                status?: string;
            };
            404: unknown;
        };
    };
    get: {
        req: GetConnectedAccountData;
        res: {
            200: {
                connectionParams?: {
                    access_token?: string;
                    base_url?: string;
                    client_id?: string;
                    client_secret?: string;
                    scope?: string;
                    token_type?: string;
                };
                createdAt?: string;
                id?: string;
                integrationId?: string;
                status?: "ACTIVE" | "INITIATED" | "FAILED";
                updatedAt?: string;
            };
            404: unknown;
        };
    };
}delete: {
    req: DeleteConnectionData;
    res: {
        200: {
            status?: string;
        };
        404: unknown;
    };
}req: DeleteConnectionData
res: {
    200: {
        status?: string;
    };
    404: unknown;
}200: {
    status?: string;
}{ +"message": "Connection not found or already deleted" +}
+Optionalstatus?: stringStatus of the api call.
+
404: unknown
Not Found
+
get: {
    req: GetConnectedAccountData;
    res: {
        200: {
            connectionParams?: {
                access_token?: string;
                base_url?: string;
                client_id?: string;
                client_secret?: string;
                scope?: string;
                token_type?: string;
            };
            createdAt?: string;
            id?: string;
            integrationId?: string;
            status?: "ACTIVE" | "INITIATED" | "FAILED";
            updatedAt?: string;
        };
        404: unknown;
    };
}req: GetConnectedAccountData
res: {
    200: {
        connectionParams?: {
            access_token?: string;
            base_url?: string;
            client_id?: string;
            client_secret?: string;
            scope?: string;
            token_type?: string;
        };
        createdAt?: string;
        id?: string;
        integrationId?: string;
        status?: "ACTIVE" | "INITIATED" | "FAILED";
        updatedAt?: string;
    };
    404: unknown;
}200: {
    connectionParams?: {
        access_token?: string;
        base_url?: string;
        client_id?: string;
        client_secret?: string;
        scope?: string;
        token_type?: string;
    };
    createdAt?: string;
    id?: string;
    integrationId?: string;
    status?: "ACTIVE" | "INITIATED" | "FAILED";
    updatedAt?: string;
}OK
+OptionalconnectionParams?: {
    access_token?: string;
    base_url?: string;
    client_id?: string;
    client_secret?: string;
    scope?: string;
    token_type?: string;
}An object containing the parameters specific to the connection.
+Optionalaccess_token?: string The access token used for authentication with the connected app.
+Optionalbase_url?: string The base URL for making API requests to the connected app.
+Optionalclient_id?: string The client ID used for authentication with the connected app.
+Optionalclient_secret?: string The client secret used for authentication with the connected app.
+Optionalscope?: stringThe scope of permissions granted to the connection.
+Optionaltoken_type?: string The type of token used for authentication (e.g., "bearer").
+
OptionalcreatedAt?: string The timestamp indicating when the connection was created.
+Optionalid?: stringThe unique identifier of the connection.
+OptionalintegrationId?: string The unique identifier of the connector associated with the connection.
+Optionalstatus?: "ACTIVE" | "INITIATED" | "FAILED"The status of the connection (e.g., "SUCCESS").
+OptionalupdatedAt?: string The timestamp indicating when the connection was last updated.
+
404: unknown
{ +"message": "Connection not found or already deleted" +}
+
/v1/integrations: {
    get: {
        req: ListAllIntegrationsData;
        res: {
            200: {
                items?: {
                    appId?: string;
                    appName?: string;
                    authScheme?: string;
                    createdAt?: string;
                    enabled?: boolean;
                    id?: string;
                    logo?: string;
                    name?: string;
                    updatedAt?: string;
                }[];
                page?: number;
                totalPages?: number;
            };
        };
    };
    post: {
        req: CreateIntegrationData;
        res: {
            200: {
                appId?: string;
                appName?: string;
                authConfig?: {
                    base_url?: string;
                    client_id?: string;
                    client_secret?: string;
                };
                authScheme?: string;
                createdAt?: string;
                enabled?: boolean;
                expectedInputFields?: {
                    [key: string]: unknown;
                }[];
                id?: string;
                logo?: string;
                name?: string;
                updatedAt?: string;
            };
            400: unknown;
        };
    };
}get: {
    req: ListAllIntegrationsData;
    res: {
        200: {
            items?: {
                appId?: string;
                appName?: string;
                authScheme?: string;
                createdAt?: string;
                enabled?: boolean;
                id?: string;
                logo?: string;
                name?: string;
                updatedAt?: string;
            }[];
            page?: number;
            totalPages?: number;
        };
    };
}req: ListAllIntegrationsData
res: {
    200: {
        items?: {
            appId?: string;
            appName?: string;
            authScheme?: string;
            createdAt?: string;
            enabled?: boolean;
            id?: string;
            logo?: string;
            name?: string;
            updatedAt?: string;
        }[];
        page?: number;
        totalPages?: number;
    };
}200: {
    items?: {
        appId?: string;
        appName?: string;
        authScheme?: string;
        createdAt?: string;
        enabled?: boolean;
        id?: string;
        logo?: string;
        name?: string;
        updatedAt?: string;
    }[];
    page?: number;
    totalPages?: number;
}OK
+Optionalitems?: {
    appId?: string;
    appName?: string;
    authScheme?: string;
    createdAt?: string;
    enabled?: boolean;
    id?: string;
    logo?: string;
    name?: string;
    updatedAt?: string;
}[]Optionalpage?: numberOptionaltotalPages?: number
post: {
    req: CreateIntegrationData;
    res: {
        200: {
            appId?: string;
            appName?: string;
            authConfig?: {
                base_url?: string;
                client_id?: string;
                client_secret?: string;
            };
            authScheme?: string;
            createdAt?: string;
            enabled?: boolean;
            expectedInputFields?: {
                [key: string]: unknown;
            }[];
            id?: string;
            logo?: string;
            name?: string;
            updatedAt?: string;
        };
        400: unknown;
    };
}req: CreateIntegrationData
res: {
    200: {
        appId?: string;
        appName?: string;
        authConfig?: {
            base_url?: string;
            client_id?: string;
            client_secret?: string;
        };
        authScheme?: string;
        createdAt?: string;
        enabled?: boolean;
        expectedInputFields?: {
            [key: string]: unknown;
        }[];
        id?: string;
        logo?: string;
        name?: string;
        updatedAt?: string;
    };
    400: unknown;
}200: {
    appId?: string;
    appName?: string;
    authConfig?: {
        base_url?: string;
        client_id?: string;
        client_secret?: string;
    };
    authScheme?: string;
    createdAt?: string;
    enabled?: boolean;
    expectedInputFields?: {
        [key: string]: unknown;
    }[];
    id?: string;
    logo?: string;
    name?: string;
    updatedAt?: string;
}OK
+OptionalappId?: string The unique identifier of the app associated with the connector.
+OptionalappName?: string The name of the app associated with the connector.
+OptionalauthConfig?: {
    base_url?: string;
    client_id?: string;
    client_secret?: string;
}An object containing the authentication configuration for the connector.
+Optionalbase_url?: string The base URL for making API requests to the app.
+Optionalclient_id?: string The client ID used for authentication with the app.
+Optionalclient_secret?: string The client secret used for authentication with the app.
+
OptionalauthScheme?: string The authentication scheme used by the connector.
+OptionalcreatedAt?: string The timestamp indicating when the connector was created.
+Optionalenabled?: booleanA boolean indicating whether the connector is enabled or not.
+OptionalexpectedInput Fields?: {
    [key: string]: unknown;
}[]An array of input fields expected by the connector.
+Optionalid?: stringThe unique identifier of the newly created connector.
+Optionallogo?: stringThe URL of the logo of the app associated with the connector.
+Optionalname?: stringThe name of the connector.
+OptionalupdatedAt?: string The timestamp indicating when the connector was last updated.
+
400: unknown
Bad Request
+
/v1/integrations/{integration
Id}: {
    get: {
        req: GetIntegrationData;
        res: {
            200: {
                appId?: string;
                appName?: string;
                authConfig?: {
                    base_url?: string;
                    client_id?: string;
                    client_secret?: string;
                };
                authScheme?: string;
                createdAt?: string;
                enabled?: boolean;
                expectedInputFields?: {
                    [key: string]: unknown;
                }[];
                id?: string;
                logo?: string;
                name?: string;
                updatedAt?: string;
            };
            404: unknown;
        };
    };
    patch: {
        req: UpdateIntegrationData;
        res: {
            200: {
                status?: string;
            };
            404: unknown;
        };
    };
}get: {
    req: GetIntegrationData;
    res: {
        200: {
            appId?: string;
            appName?: string;
            authConfig?: {
                base_url?: string;
                client_id?: string;
                client_secret?: string;
            };
            authScheme?: string;
            createdAt?: string;
            enabled?: boolean;
            expectedInputFields?: {
                [key: string]: unknown;
            }[];
            id?: string;
            logo?: string;
            name?: string;
            updatedAt?: string;
        };
        404: unknown;
    };
}req: GetIntegrationData
res: {
    200: {
        appId?: string;
        appName?: string;
        authConfig?: {
            base_url?: string;
            client_id?: string;
            client_secret?: string;
        };
        authScheme?: string;
        createdAt?: string;
        enabled?: boolean;
        expectedInputFields?: {
            [key: string]: unknown;
        }[];
        id?: string;
        logo?: string;
        name?: string;
        updatedAt?: string;
    };
    404: unknown;
}200: {
    appId?: string;
    appName?: string;
    authConfig?: {
        base_url?: string;
        client_id?: string;
        client_secret?: string;
    };
    authScheme?: string;
    createdAt?: string;
    enabled?: boolean;
    expectedInputFields?: {
        [key: string]: unknown;
    }[];
    id?: string;
    logo?: string;
    name?: string;
    updatedAt?: string;
}OK
+OptionalappId?: string The unique identifier of the app associated with the connector.
+OptionalappName?: string The name of the app associated with the connector.
+OptionalauthConfig?: {
    base_url?: string;
    client_id?: string;
    client_secret?: string;
}An object containing the authentication configuration for the connector.
+Optionalbase_url?: string The base URL for making API requests to the app.
+Optionalclient_id?: string The client ID used for authentication with the app.
+Optionalclient_secret?: string The client secret used for authentication with the app.
+
OptionalauthScheme?: string The authentication scheme used by the connector (e.g., "OAUTH2", "API_KEY").
+OptionalcreatedAt?: string The timestamp indicating when the connector was created.
+Optionalenabled?: booleanA boolean indicating whether the connector is enabled or not.
+OptionalexpectedInput Fields?: {
    [key: string]: unknown;
}[]An array of input fields expected by the connector.
+Optionalid?: stringThe unique identifier of the connector.
+Optionallogo?: stringThe URL of the logo of the app associated with the connector.
+Optionalname?: stringThe name of the connector.
+OptionalupdatedAt?: string The timestamp indicating when the connector was last updated.
+
404: unknown
Not Found
+
patch: {
    req: UpdateIntegrationData;
    res: {
        200: {
            status?: string;
        };
        404: unknown;
    };
}req: UpdateIntegrationData
res: {
    200: {
        status?: string;
    };
    404: unknown;
}200: {
    status?: string;
}OK
+Optionalstatus?: string
404: unknown
Not Found
+
/v1/triggers: {
    get: {
        req: ListTriggersData;
        res: {
            200: {
                appId?: string;
                appKey?: string;
                appName?: string;
                config?: {
                    properties?: {
                        description?: string;
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    required?: string[];
                    title?: string;
                    type?: string;
                };
                count?: number;
                description?: string;
                display_name?: string;
                enabled?: boolean;
                instructions?: string;
                logo?: string;
                name?: string;
                payload?: {
                    properties?: {
                        author: string;
                        id: string;
                        message: string;
                        timestamp: string;
                        url: string;
                    };
                };
            }[];
        };
    };
}get: {
    req: ListTriggersData;
    res: {
        200: {
            appId?: string;
            appKey?: string;
            appName?: string;
            config?: {
                properties?: {
                    description?: string;
                    required?: string[];
                    title?: string;
                    type?: string;
                };
                required?: string[];
                title?: string;
                type?: string;
            };
            count?: number;
            description?: string;
            display_name?: string;
            enabled?: boolean;
            instructions?: string;
            logo?: string;
            name?: string;
            payload?: {
                properties?: {
                    author: string;
                    id: string;
                    message: string;
                    timestamp: string;
                    url: string;
                };
            };
        }[];
    };
}req: ListTriggersData
res: {
    200: {
        appId?: string;
        appKey?: string;
        appName?: string;
        config?: {
            properties?: {
                description?: string;
                required?: string[];
                title?: string;
                type?: string;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
        count?: number;
        description?: string;
        display_name?: string;
        enabled?: boolean;
        instructions?: string;
        logo?: string;
        name?: string;
        payload?: {
            properties?: {
                author: string;
                id: string;
                message: string;
                timestamp: string;
                url: string;
            };
        };
    }[];
}200: {
    appId?: string;
    appKey?: string;
    appName?: string;
    config?: {
        properties?: {
            description?: string;
            required?: string[];
            title?: string;
            type?: string;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    count?: number;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    instructions?: string;
    logo?: string;
    name?: string;
    payload?: {
        properties?: {
            author: string;
            id: string;
            message: string;
            timestamp: string;
            url: string;
        };
    };
}[]OK
+
/v1/triggers/active_
triggers: {
    get: {
        req: ListActiveTriggersData;
        res: {
            200: {
                pageInfo?: {
                    currentPage?: number;
                    perPage?: number;
                    totalPages?: number;
                };
                triggers?: {
                    connectionId?: string;
                    createdAt?: string;
                    disabledAt?: string;
                    id?: string;
                    state?: {
                        [key: string]: unknown;
                    };
                    triggerConfig?: {
                        [key: string]: unknown;
                    };
                    triggerData?: string;
                    triggerName?: string;
                    updatedAt?: string;
                }[];
            };
        };
    };
}get: {
    req: ListActiveTriggersData;
    res: {
        200: {
            pageInfo?: {
                currentPage?: number;
                perPage?: number;
                totalPages?: number;
            };
            triggers?: {
                connectionId?: string;
                createdAt?: string;
                disabledAt?: string;
                id?: string;
                state?: {
                    [key: string]: unknown;
                };
                triggerConfig?: {
                    [key: string]: unknown;
                };
                triggerData?: string;
                triggerName?: string;
                updatedAt?: string;
            }[];
        };
    };
}req: ListActiveTriggersData
res: {
    200: {
        pageInfo?: {
            currentPage?: number;
            perPage?: number;
            totalPages?: number;
        };
        triggers?: {
            connectionId?: string;
            createdAt?: string;
            disabledAt?: string;
            id?: string;
            state?: {
                [key: string]: unknown;
            };
            triggerConfig?: {
                [key: string]: unknown;
            };
            triggerData?: string;
            triggerName?: string;
            updatedAt?: string;
        }[];
    };
}200: {
    pageInfo?: {
        currentPage?: number;
        perPage?: number;
        totalPages?: number;
    };
    triggers?: {
        connectionId?: string;
        createdAt?: string;
        disabledAt?: string;
        id?: string;
        state?: {
            [key: string]: unknown;
        };
        triggerConfig?: {
            [key: string]: unknown;
        };
        triggerData?: string;
        triggerName?: string;
        updatedAt?: string;
    }[];
}A list of active triggers
+OptionalpageInfo?: {
    currentPage?: number;
    perPage?: number;
    totalPages?: number;
}OptionalcurrentPage?: number The current page number.
+OptionalperPage?: number The number of items per page.
+OptionaltotalPages?: number The total number of pages.
+
Optionaltriggers?: {
    connectionId?: string;
    createdAt?: string;
    disabledAt?: string;
    id?: string;
    state?: {
        [key: string]: unknown;
    };
    triggerConfig?: {
        [key: string]: unknown;
    };
    triggerData?: string;
    triggerName?: string;
    updatedAt?: string;
}[]
/v1/triggers/get/{trigger
Id}: {
    get: {
        req: GetActiveTriggerData;
        res: {
            200: {
                connectionId?: string;
                createdAt?: string;
                disabledAt?: string;
                id?: string;
                state?: {
                    [key: string]: unknown;
                };
                triggerConfig?: {
                    [key: string]: unknown;
                };
                triggerData?: string;
                triggerName?: string;
                updatedAt?: string;
            };
            404: unknown;
            500: unknown;
        };
    };
}get: {
    req: GetActiveTriggerData;
    res: {
        200: {
            connectionId?: string;
            createdAt?: string;
            disabledAt?: string;
            id?: string;
            state?: {
                [key: string]: unknown;
            };
            triggerConfig?: {
                [key: string]: unknown;
            };
            triggerData?: string;
            triggerName?: string;
            updatedAt?: string;
        };
        404: unknown;
        500: unknown;
    };
}req: GetActiveTriggerData
res: {
    200: {
        connectionId?: string;
        createdAt?: string;
        disabledAt?: string;
        id?: string;
        state?: {
            [key: string]: unknown;
        };
        triggerConfig?: {
            [key: string]: unknown;
        };
        triggerData?: string;
        triggerName?: string;
        updatedAt?: string;
    };
    404: unknown;
    500: unknown;
}200: {
    connectionId?: string;
    createdAt?: string;
    disabledAt?: string;
    id?: string;
    state?: {
        [key: string]: unknown;
    };
    triggerConfig?: {
        [key: string]: unknown;
    };
    triggerData?: string;
    triggerName?: string;
    updatedAt?: string;
}A successful response containing the details of the active trigger.
+OptionalconnectionId?: string Identifier for the connection associated with the trigger.
+OptionalcreatedAt?: string Timestamp when the trigger was created.
+OptionaldisabledAt?: string Timestamp when the trigger was disabled, if applicable.
+Optionalid?: stringUnique identifier for the trigger.
+Optionalstate?: {
    [key: string]: unknown;
}State information for the trigger.
+[key: string]: unknown
OptionaltriggerConfig?: {
    [key: string]: unknown;
}Configuration settings for the trigger.
+[key: string]: unknown
OptionaltriggerData?: string Data associated with the trigger.
+OptionaltriggerName?: string Name of the trigger.
+OptionalupdatedAt?: string Timestamp when the trigger was last updated.
+
404: unknown
Trigger not found
+500: unknown
Internal server error
+
/v2/actions: {
    get: {
        req: GetListActionsData;
        res: {
            200: {
                items?: {
                    appId?: string;
                    appName?: string;
                    description?: string;
                    display_name?: string;
                    enabled?: boolean;
                    logo?: string;
                    name?: string;
                    parameters?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                    response?: {
                        properties?: {
                            [key: string]: unknown;
                        };
                        required?: string[];
                        title?: string;
                        type?: string;
                    };
                }[];
                page?: number;
                totalPages?: number;
            };
        };
    };
}get: {
    req: GetListActionsData;
    res: {
        200: {
            items?: {
                appId?: string;
                appName?: string;
                description?: string;
                display_name?: string;
                enabled?: boolean;
                logo?: string;
                name?: string;
                parameters?: {
                    properties?: {
                        [key: string]: unknown;
                    };
                    required?: string[];
                    title?: string;
                    type?: string;
                };
                response?: {
                    properties?: {
                        [key: string]: unknown;
                    };
                    required?: string[];
                    title?: string;
                    type?: string;
                };
            }[];
            page?: number;
            totalPages?: number;
        };
    };
}req: GetListActionsData
res: {
    200: {
        items?: {
            appId?: string;
            appName?: string;
            description?: string;
            display_name?: string;
            enabled?: boolean;
            logo?: string;
            name?: string;
            parameters?: {
                properties?: {
                    [key: string]: unknown;
                };
                required?: string[];
                title?: string;
                type?: string;
            };
            response?: {
                properties?: {
                    [key: string]: unknown;
                };
                required?: string[];
                title?: string;
                type?: string;
            };
        }[];
        page?: number;
        totalPages?: number;
    };
}200: {
    items?: {
        appId?: string;
        appName?: string;
        description?: string;
        display_name?: string;
        enabled?: boolean;
        logo?: string;
        name?: string;
        parameters?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
        response?: {
            properties?: {
                [key: string]: unknown;
            };
            required?: string[];
            title?: string;
            type?: string;
        };
    }[];
    page?: number;
    totalPages?: number;
}OK
+Optionalitems?: {
    appId?: string;
    appName?: string;
    description?: string;
    display_name?: string;
    enabled?: boolean;
    logo?: string;
    name?: string;
    parameters?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
    response?: {
        properties?: {
            [key: string]: unknown;
        };
        required?: string[];
        title?: string;
        type?: string;
    };
}[]An array of action objects.
+Optionalpage?: numberThe current page number of the action list.
+OptionaltotalPages?: number The total number of pages available for the action list.
+
Composio toolset for Langchain framework.
+Example:
+ +