Python SDK Reference | Composio Docs

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

Main SDK Class

The main entry point for the Composio SDK.

`composio.Composio`

1 composio.Composio(provider: TProvider = <composio.core.provider._openai.OpenAIProvider object at 0x104f8ec30>, **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.

Parameter	Description
`slug`	The slug of the tool to execute
`arguments`	The arguments to pass to the tool
`connected_account_id`	The ID of the connected account to use for the tool
`custom_auth_params`	The custom auth params to use for the tool
`user_id`	The ID of the user to execute the tool for
`text`	The text to pass to the tool
`version`	The version of the tool to execute
`modifiers`	The modifiers to apply to the tool

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, modifiers: t.Optional[Modifiers] = None)

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

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.

Parameter	Description
`user_id`	The ID of the user to authorize
`toolkit`	The slug of the toolkit to authorize

Returns: The connection request.

`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, 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.

Parameter	Description
`user_id`	The user ID to create the connected account for
`auth_config_id`	The auth config ID to create the connected account for
`options`	The options to create the connected account with

Returns: The connection request.

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: typing.Union[composio_client.types.auth_config_create_params.AuthConfigUnionMember0, composio_client.types.auth_config_create_params.AuthConfigUnionMember1])

Create a new auth config

Parameter	Description
`toolkit`	The toolkit to create the auth config for
`options`	The options to create the auth config with

Returns: The created auth config.

`delete`

View source

1 delete(nanoid: str)

Deletes an existing authentication configuration.

Parameter	Description
`nanoid`	The ID of the auth config to delete

Returns: The deleted auth config.

`disable`

View source

1 disable(nanoid: str)

Disables an existing authentication configuration.

Parameter	Description
`nanoid`	The ID of the auth config to disable

Returns: The disabled auth config.

`enable`

View source

1 enable(nanoid: str)

Enables an existing authentication configuration.

Parameter	Description
`nanoid`	The ID of the auth config to enable

Returns: The enabled auth config.

`get`

View source

1 get(nanoid: str)

Retrieves a specific authentication configuration by its ID

Parameter	Description
`nanoid`	The ID of the auth config to retrieve

Returns: The retrieved auth config.

`list`

View source

1 list(**query: typing.Unpack[composio_client.types.auth_config_list_params.AuthConfigListParams])

Lists authentication configurations based on provided filter criteria.

`update`

View source

1 update(nanoid: str, options: typing.Union[composio_client.types.auth_config_update_params.Variant0, composio_client.types.auth_config_update_params.Variant1])

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.

Parameter	Description
`nanoid`	The ID of the auth config to update
`options`	The options to update the auth config with

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, connected_account_id: str, trigger_config: t.Optional[t.Dict[str, t.Any]] = None)

Create a trigger instance

Parameter	Description
`slug`	The slug of the trigger
`connected_account_id`	The ID of the connected account
`trigger_config`	The configuration of the trigger

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

Parameter	Description
`trigger_ids`	List of trigger IDs to filter by
`trigger_names`	List of trigger names to filter by
`auth_config_ids`	List of auth config IDs to filter by
`connected_account_ids`	List of connected account IDs to filter by
`show_disabled`	Whether to show disabled triggers
`limit`	Limit the number of triggers to return
`page`	Page number to return

Returns: List of active triggers

`subscribe`

View source

1 subscribe(timeout: float = 15.0)

Subscribe to a trigger and receive trigger events.

Parameter	Description
`timeout`	The timeout to wait for the subscription to be established

Returns: The trigger subscription handler.

Decorators

before_execute

`composio.before_execute`

View source

1 composio.before_execute(modifier: t.Optional[ExecuteModifier] = 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[ExecuteModifier] = 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.