Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Bidsketch

Scalekit connector
Open markdown

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

Tools
39
What they doRead · write · destructive
18 · 14 · 718 read14 write7 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 Bidsketch connection

    In AgentKit > Connections, create a Bidsketch 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 = 'bidsketch'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Bidsketch:', 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: 'bidsketch_clients_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Bidsketch 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
  • bidsketch_client_getGet one Bidsketch client by ID.Read-only

    Get Client

    Get one Bidsketch client by ID. Returns the client's name, email, phones, website, address, notes and secondary contact. Use List Clients to find IDs.

    Inputs

    client_idintegerrequired
    Bidsketch client ID. Get it from List Clients. Example: 4815162342.
  • bidsketch_client_proposals_listList the proposals for one client.Read-only

    List Client Proposals

    List the proposals for one client. Returns proposals with id, name, status, draft flag, totals and timestamps. Use List Proposals for every proposal on the account.

    Inputs

    client_idintegerrequired
    Bidsketch client ID. Get it from List Clients. Example: 4815162342.
    pageinteger
    Page number, starting at 1. Each page holds per_page records (default 100). Example: 2.
    per_pageinteger
    Records per page. Defaults to 100. Example: 50.
  • bidsketch_clients_listList the clients on the Bidsketch account, 100 per page by default.Read-only

    List Clients

    List the clients on the Bidsketch account, 100 per page by default. Returns clients with id, name, contact details, address and timestamps. Use Get Client for one client.

    Inputs

    pageinteger
    Page number, starting at 1. Each page holds per_page records (default 100). Example: 2.
    per_pageinteger
    Records per page. Defaults to 100. Example: 50.
  • bidsketch_fee_getGet one saved fee by ID.Read-only

    Get Fee

    Get one saved fee by ID. Returns its name, type, amount, quantity, unit, category, HTML description and total. Use List Fees to find IDs.

    Inputs

    fee_idintegerrequired
    Bidsketch saved fee ID. Get it from List Fees. Example: 187375.
  • bidsketch_fees_listList the reusable fees saved on the account.Read-only

    List Fees

    List the reusable fees saved on the account. Returns fees with id, name, type, amount, quantity, unit, category, total and details. Use List Proposal Fees for the fees on one proposal.

    Inputs

    pageinteger
    Page number, starting at 1. Each page holds per_page records (default 100). Example: 2.
    per_pageinteger
    Records per page. Defaults to 100. Example: 50.
  • bidsketch_proposal_content_getGet a proposal with all its content in one call.Read-only

    Get Proposal Content

    Get a proposal with all its content in one call. Returns the proposal with its sections and fees collections, in proposal order (opening sections, fees, closing sections). Use Get Proposal for the proposal fields alone.

    Inputs

    proposal_idintegerrequired
    Bidsketch proposal ID. Get it from List Proposals. Example: 11051955.
  • bidsketch_proposal_fee_getGet one fee on a proposal.Read-only

    Get Proposal Fee

    Get one fee on a proposal. Returns its name, type, amount, quantity, unit, optional flag, description and total. Use List Proposal Fees to find IDs.

    Inputs

    fee_idintegerrequired
    Bidsketch proposal fee ID. Get it from List Proposal Fees. Example: 187376.
    proposal_idintegerrequired
    Bidsketch proposal ID. Get it from List Proposals. Example: 11051955.
  • bidsketch_proposal_fees_listList the fees on one proposal.Read-only

    List Proposal Fees

    List the fees on one proposal. Returns fees with id, name, type, amount, quantity, optional flag, total and details. Use List Fees for the account's saved fees.

    Inputs

    proposal_idintegerrequired
    Bidsketch proposal ID. Get it from List Proposals. Example: 11051955.