Composio Python SDK Reference

This is the comprehensive SDK reference for the Composio Python SDK.

Main SDK Class

The main entry point for the Composio SDK.

composio.Composio

View source

1
composio.Composio(provider: TProvider = <composio.core.provider._openai.OpenAIProvider object at 0x7f8f73dada90>, **kwargs: te.Unpack[SDKConfig])

Composio SDK for Python.

Core Models

Tools

composio.core.models.Tools

View source

1
composio.core.models.Tools(client: HttpClient, provider: TProvider)

Tools class definition

This class is used to manage tools in the Composio SDK. It provides methods to list, get, and execute tools.

execute

View source

1
execute(slug: str, arguments: t.Dict, connected_account_id: t.Optional[str] = None, custom_auth_params: t.Optional[tool_execute_params.CustomAuthParams] = None, user_id: t.Optional[str] = None, text: t.Optional[str] = None, version: t.Optional[str] = None, modifiers: t.Optional[Modifiers] = None)

Execute a tool with the provided parameters.

This method calls the Composio API or a custom tool handler to execute the tool and returns the response. It automatically determines whether to use a custom tool or a Composio API tool based on the slug.

Returns: The response from the tool.

get

View source

1
get(user_id: str, slug: t.Optional[str] = None, tools: t.Optional[list[str]] = None, search: t.Optional[str] = None, toolkits: t.Optional[list[str]] = None, scopes: t.Optional[t.List[str]] = None, modifiers: t.Optional[Modifiers] = None, limit: t.Optional[int] = None)

Get a tool or list of tools based on the provided arguments.

get_raw_composio_tool_by_slug

View source

1
get_raw_composio_tool_by_slug(slug: str)

Returns schema for the given tool slug.

get_raw_composio_tools

View source

1
get_raw_composio_tools(tools: t.Optional[list[str]] = None, search: t.Optional[str] = None, toolkits: t.Optional[list[str]] = None, scopes: t.Optional[t.List[str]] = None, limit: t.Optional[int] = None)

Get a list of tool schemas based on the provided filters.

proxy

View source

1
proxy(**options: te.Unpack[tool_proxy_params.ToolProxyParams])

Proxy a tool call to the Composio API

Toolkits

composio.core.models.Toolkits

View source

1
composio.core.models.Toolkits(client: HttpClient)

Toolkits are a collectiono of tools that can be used to perform various tasks. They’re conceptualized as a set of tools. Ex: Github toolkit can perform Github actions via its collection of tools. This is a replacement of the apps concept in the earlier versions of the SDK.

authorize

View source

1
authorize(user_id: str, toolkit: str)

Authorize a user to a toolkit

If auth config is not found, it will be created using composio managed auth.

Returns: The connection request.

get_auth_config_creation_fields

View source

1
get_auth_config_creation_fields(toolkit: str, auth_scheme: AuthSchemeL, required_only: bool = False)

Get the required property for a given toolkit and auth scheme.

get_connected_account_initiation_fields

View source

1
get_connected_account_initiation_fields(toolkit: str, auth_scheme: AuthSchemeL, required_only: bool = False)

Get the required property for a given toolkit and auth scheme.

list_categories

View source

List all categories of toolkits.

Connected Accounts

composio.core.models.ConnectedAccounts

View source

1
composio.core.models.ConnectedAccounts(client: HttpClient)

Manage connected accounts.

This class is used to manage connected accounts in the Composio SDK. These are used to authenticate with third-party services.

initiate

View source

1
initiate(user_id: str, auth_config_id: str, callback_url: t.Optional[str] = None, config: t.Optional[connected_account_create_params.ConnectionState] = None)

Compound function to create a new coneected account. This function creates a new connected account and returns a connection request.

Users can then wait for the connection to be established using the wait_for_connection method.

Returns: The connection request.

wait_for_connection

View source

1
wait_for_connection(id: str, timeout: t.Optional[float] = None)

Wait for connected account with given ID to be active

Auth Configs

composio.core.models.AuthConfigs

View source

1
composio.core.models.AuthConfigs(client: HttpClient)

Manage authentication configurations.

create

View source

1
create(toolkit: str, options: auth_config_create_params.AuthConfig)

Create a new auth config

Returns: The created auth config.

delete

View source

1
delete(nanoid: str)

Deletes an existing authentication configuration.

Returns: The deleted auth config.

disable

View source

1
disable(nanoid: str)

Disables an existing authentication configuration.

Returns: The disabled auth config.

enable

View source

1
enable(nanoid: str)

Enables an existing authentication configuration.

Returns: The enabled auth config.

get

View source

1
get(nanoid: str)

Retrieves a specific authentication configuration by its ID

Returns: The retrieved auth config.

list

View source

1
list(**query: te.Unpack[auth_config_list_params.AuthConfigListParams])

Lists authentication configurations based on provided filter criteria.

update

View source

1
update(nanoid: str, options: auth_config_update_params.AuthConfigUpdateParams)

Updates an existing authentication configuration.

This method allows you to modify properties of an auth config such as credentials, scopes, or tool restrictions. The update type (custom or default) determines which fields can be updated.

Returns: The updated auth config.

Triggers

composio.core.models.Triggers

View source

1
composio.core.models.Triggers(client: HttpClient)

Triggers (instance) class

create

View source

1
create(slug: str, user_id: t.Optional[str] = None, connected_account_id: t.Optional[str] = None, trigger_config: t.Optional[t.Dict[str, t.Any]] = None)

Create a trigger instance

Returns: The trigger instance

list_active

View source

1
list_active(trigger_ids: t.Optional[list[str]] = None, trigger_names: t.Optional[list[str]] = None, auth_config_ids: t.Optional[list[str]] = None, connected_account_ids: t.Optional[list[str]] = None, show_disabled: t.Optional[bool] = None, limit: t.Optional[int] = None, page: t.Optional[int] = None)

List all active triggers

Returns: List of active triggers

subscribe

View source

1
subscribe(timeout: float = 15.0)

Subscribe to a trigger and receive trigger events.

Returns: The trigger subscription handler.

Decorators

before_execute

composio.before_execute

View source

1
composio.before_execute(modifier: t.Optional[BeforeExecute] = None, tools: t.Optional[t.List[str]] = None, toolkits: t.Optional[t.List[str]] = None)

after_execute

composio.after_execute

View source

1
composio.after_execute(modifier: t.Optional[AfterExecute] = None, tools: t.Optional[t.List[str]] = None, toolkits: t.Optional[t.List[str]] = None)

schema_modifier

composio.schema_modifier

View source

1
composio.schema_modifier(modifier: t.Optional[SchemaModifier] = None, tools: t.Optional[t.List[str]] = None, toolkits: t.Optional[t.List[str]] = None)

Cross References

The Composio class is the main entry point for all SDK operations. It provides access to:

• Tools for tool management and execution
• Toolkits for toolkit operations
• ConnectedAccounts for managing authentication
• Triggers for webhook and event handling

When you call Tools.execute, it can use the before_execute() and after_execute() decorators to modify behavior.