Breeze

Learn how to use Breeze with Composio

Overview

SLUG: BREEZE

Description

Breeze is a project management software that helps teams plan, track, and collaborate on projects efficiently.

Authentication Details

generic_api_key
stringRequired

Connecting to Breeze

Create an auth config

Use the dashboard to create an auth config for the Breeze toolkit. This allows you to connect multiple Breeze accounts to Composio for agents to use.

1

Select App

Navigate to the Breeze toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Integration”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5breeze_auth_config_id = "ac_YOUR_BREEZE_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000" # UUID from database/app
7
8composio = Composio()
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 # Replace this with a method to retrieve an API key from the user.
12 # Or supply your own.
13 user_api_key = input("[!] Enter API key")
14
15 connection_request = composio.connected_accounts.initiate(
16 user_id=user_id,
17 auth_config_id=auth_config_id,
18 config={"auth_scheme": "API_KEY", "val": user_api_key}
19 )
20
21 # API Key authentication is immediate - no redirect needed
22 print(f"Successfully connected Breeze for user {user_id}")
23 print(f"Connection status: {connection_request.status}")
24
25 return connection_request.id
26
27
28connection_id = authenticate_toolkit(user_id, breeze_auth_config_id)
29
30# You can verify the connection using:
31connected_account = composio.connected_accounts.get(connection_id)
32print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Breeze toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["BREEZE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add Project People

Description

Tool to add people to a project. use when you have a valid project id and one or more email addresses to invite them.

Action Parameters

invitees
arrayRequired
project_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Archive Project

Description

Tool to archive a specific project. use when you need to hide a completed or inactive project from active views after confirming its details.

Action Parameters

project_id
integerRequired
team_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Card

Description

Tool to create a new card in a project. use after confirming the project id. creates a task with details like name, due date, and assignees.

Action Parameters

custom_fields
array
description
string
duedate
invitees
array
name
stringRequired
planned_time
integer
project_id
integerRequired
stage_id
integer
startdate
swimlane_id
integer
tags
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: CREATE_LIST

Description

Tool to create a new list (stage) in a breeze project. use when you've selected a project and need to add a new stage. example: "create a new todo list for project 42."

Action Parameters

name
stringRequired
project_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Project

Description

Tool to create a new project in breeze. use when you have the project name and want to initialize it via the api.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Workspace

Description

Tool to create a new workspace. use after deciding on the workspace name.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Card

Description

Tool to delete a specific card (task) by its id. use when you need to remove a task permanently; deletions cannot be undone.

Action Parameters

card_id
integerRequired
project_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Project

Description

Tool to delete a specific project by id. use when you need to remove a project after confirming its id.

Action Parameters

project_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Person from Project

Description

Tool to delete a person from a project by user id. use after confirming the project and user details. example: "delete user 456 from project 123".

Action Parameters

project_id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Workspace

Description

Tool to delete a specific workspace by id. use when permanently removing a workspace after confirming the correct workspace id.

Action Parameters

workspace_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Card

Description

Tool to retrieve detailed info for a specific card (task) in a project. use when you know the project id and card id and need all metadata like tags, users, todos, and time entries.

Action Parameters

card_id
integerRequired
project_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: GET_CARDS

Description

Tool to get all cards (tasks) for a specific project. use after confirming the project exists. example: "list all cards in project 42."

Action Parameters

archived
boolean
project_id
integerRequired

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Project

Description

Tool to get a specific project by id. use when you need detailed project information after confirming the project id. example: "get project 123 details".

Action Parameters

project_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Projects

Description

Tool to get all active projects. use when you need an overview of your team's current projects after confirming authentication.

Action Parameters

team_id
integer

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Project People

Description

Tool to get all users in a project. use when you have a valid project id and need to list its users.

Action Parameters

project_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Workspace

Description

Tool to get a specific workspace by id. use when you need workspace details including projects after confirming the workspace id.

Action Parameters

workspace_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Workspaces

Description

Tool to get all workspaces. use when you need to list available workspaces for the authenticated user.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Move Card

Description

Tool to move a card to a different stage or position. use after confirming stage id and prev id.

Action Parameters

card_id
integerRequired
prev_id
integer
project_id
integerRequired
stage_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired