Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Breeze

Scalekit connector
Open markdown

The Breeze connector lets your AI agent act in each user's Breeze account. Each user connects their own Breeze API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

Tools
60
What they doRead · write · destructive
25 · 24 · 1125 read24 write11 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Breeze connection

    In AgentKit > Connections, create a Breeze connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'breeze'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Breeze:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'breeze_activities_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Breeze credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • breeze_activities_listList the activity log across all Breeze projects, 50 entries per page.Read-only

    List Activity

    List the activity log across all Breeze projects, 50 entries per page. Returns each entry's action, user, project, card and time. Use the project or user variants to narrow it.

    Inputs

    pageinteger
    Page number for paginated results, starting at 1. Example: 1.
    team_idinteger
    Breeze team ID. Needed only when your user belongs to several teams; find team IDs with Get Me. Example: 5612.
  • breeze_card_getGet one Breeze card (task) by ID.Read-only

    Get Card

    Get one Breeze card (task) by ID. Returns its name, description, list, swimlane, dates, planned and tracked time, assignees, tags, todo lists, comments and time entries. Use List Project Cards to find the ID.

    Inputs

    card_idintegerrequired
    Card (task) ID, from List Project Cards. Example: 4521.
    project_idintegerrequired
    Breeze project ID, from List Projects. Example: 189.
    team_idinteger
    Breeze team ID. Needed only when your user belongs to several teams; find team IDs with Get Me. Example: 5612.
  • breeze_cards_listList cards across all Breeze projects created by or assigned to a user.Read-only

    List All Cards

    List cards across all Breeze projects created by or assigned to a user. Returns a page of cards with project, list, dates and assignees. Use List Project Cards for one project.

    Inputs

    assigned_idinteger
    Only cards assigned to this user ID. Example: 2.
    creator_idinteger
    Only cards created by this user ID. Example: 2.
    pageinteger
    Page number for paginated results, starting at 1. Example: 1.
    team_idinteger
    Breeze team ID. Needed only when your user belongs to several teams; find team IDs with Get Me. Example: 5612.
  • breeze_comments_listList the comments on a Breeze card.Read-only

    List Comments

    List the comments on a Breeze card. Returns each comment's id, text, author and time. Use Create Comment to add one.

    Inputs

    card_idintegerrequired
    Card (task) ID, from List Project Cards. Example: 4521.
    project_idintegerrequired
    Breeze project ID, from List Projects. Example: 189.
    team_idinteger
    Breeze team ID. Needed only when your user belongs to several teams; find team IDs with Get Me. Example: 5612.
  • breeze_list_cards_listList the cards in one Breeze list (stage), 100 per page.Read-only

    List Cards In List

    List the cards in one Breeze list (stage), 100 per page. Returns the cards with dates, assignees and tags. Use List Lists to find the list ID.

    Inputs

    project_idintegerrequired
    Breeze project ID, from List Projects. Example: 189.
    stage_idintegerrequired
    List (stage) ID, from List Lists. Example: 9.
    archivedboolean
    true to include archived cards. Example: false.
    only_archivedboolean
    true to return only archived cards. Example: false.
    pageinteger
    Page number for paginated results, starting at 1. Example: 1.
    team_idinteger
    Breeze team ID. Needed only when your user belongs to several teams; find team IDs with Get Me. Example: 5612.
  • breeze_lists_listList the lists (stages, the board columns) in a Breeze project.Read-only

    List Lists

    List the lists (stages, the board columns) in a Breeze project. Returns each list's id, name and position. Use a list ID to create or move cards.

    Inputs

    project_idintegerrequired
    Breeze project ID, from List Projects. Example: 189.
    team_idinteger
    Breeze team ID. Needed only when your user belongs to several teams; find team IDs with Get Me. Example: 5612.
  • breeze_me_getGet the Breeze user that owns the API token.Read-only

    Get Me

    Get the Breeze user that owns the API token. Returns the user's id, name, email and the teams they belong to. Use it to find your user ID and team IDs.

    Inputs

    team_idinteger
    Breeze team ID. Needed only when your user belongs to several teams; find team IDs with Get Me. Example: 5612.
  • breeze_notifications_listList your unread Breeze notifications and mentions, 50 per page.Read-only

    List Notifications

    List your unread Breeze notifications and mentions, 50 per page. Returns each notification's text, card, project and time. Use this to see what needs your attention.

    Inputs

    pageinteger
    Page number for paginated results, starting at 1. Example: 1.
    team_idinteger
    Breeze team ID. Needed only when your user belongs to several teams; find team IDs with Get Me. Example: 5612.