Composio Client

1.33.0 · active · verified Tue Apr 14

Composio Client is the official Python library for interacting with the Composio API. It enables developers to integrate and automate actions across various tools and platforms. The library maintains a rapid release cadence, with frequent updates to its API surface to reflect changes and additions in the underlying Composio platform.

Warnings

gotcha The Composio API client is frequently updated, often multiple times a week. While semantic versioning (v1.x.y) is used, rapid 'api update' commits can sometimes introduce subtle changes to method signatures or return types within minor versions, requiring careful attention during upgrades.
Fix: Always check the latest changelog or GitHub releases when upgrading, especially before deploying to production. Pinning exact minor versions (`composio-client==1.x.y`) can help, but regular updates are recommended for new features and bug fixes.
gotcha Authentication requires a `COMPOSIO_API_KEY`. The client expects this to be provided either as an environment variable or explicitly passed during client instantiation. Failing to provide a valid key will result in authentication errors.
Fix: Set the `COMPOSIO_API_KEY` environment variable (e.g., `export COMPOSIO_API_KEY="your_key"`) or pass it directly: `client = ComposioClient(api_key="your_key")`.
gotcha The library primarily interacts with 'tools' registered within the Composio platform. To perform meaningful actions (e.g., calling `client.action.run_action`), you must have corresponding tools configured and installed in your Composio account.
Fix: Before using the client to interact with specific tools, ensure they are set up in your Composio dashboard. Use `client.tool.get_installed_tools()` to verify available tools and their IDs.

Install

pip install composio-client Install Composio Client

Imports

ComposioClient

from composio_client import ComposioClient

ActionType
```
from composio_client.enums import ActionType
```
Commonly imported enum for specifying action types.

Quickstart

Initializes the ComposioClient and fetches a list of currently installed tools. This demonstrates basic connectivity and authentication. Ensure `COMPOSIO_API_KEY` is set in your environment variables.

import os
from composio_client import ComposioClient

# Ensure COMPOSIO_API_KEY is set in your environment
# Example: export COMPOSIO_API_KEY="your_api_key_here"
api_key = os.environ.get('COMPOSIO_API_KEY', '')

if not api_key:
    print("Error: COMPOSIO_API_KEY environment variable not set.")
    print("Please set it before running the quickstart.")
else:
    try:
        client = ComposioClient(api_key=api_key)
        # Fetch a list of installed tools
        tools = client.tool.get_installed_tools()
        print(f"Successfully initialized ComposioClient. Found {len(tools)} installed tools:")
        for tool in tools:
            print(f"- {tool.name} (ID: {tool.id})")

    except Exception as e:
        print(f"An error occurred: {e}")

view raw JSON →