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.

  • get method retrieves details of a specific action.
  • list method retrieves a list of all actions.
  • execute method 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.

Constructors

constructor

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.

execute get list

Constructors

constructor

Properties

Private Readonly client

client: Composio

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

    Returns CancelablePromise<ExecuteActionResponse>

    A promise that resolves to the execution status and response data.

    Throws

    If the request fails.

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

    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.

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

    Returns CancelablePromise<GetListActionsResponse>

    A promise that resolves to the list of all actions.

    Throws

    If the request fails.

Settings

Member Visibility

Theme

On This Page

constructorclientexecutegetlist