Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Gigasheet

Scalekit connector
Open markdown

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

Tools
57
What they doRead · write · destructive
28 · 24 · 528 read24 write5 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 Gigasheet connection

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

    Each user opens the link once and enters their Gigasheet 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
  • gigasheet_dataset_activity_listList the write actions made on a Gigasheet sheet.Read-only

    List Sheet Activity

    List the write actions made on a Gigasheet sheet. Returns actions with type, user and time. Use this to audit changes to a sheet.

    Inputs

    handlestringrequired
    Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
    pagestring
    Page of results, starting at 0. Example: 0.
    page_sizestring
    Results per page. Example: 25.
  • gigasheet_dataset_columns_listList the columns of a Gigasheet sheet.Read-only

    List Sheet Columns

    List the columns of a Gigasheet sheet. Returns each column's ID, name and type. Use this to get the column IDs other tools need.

    Inputs

    handlestringrequired
    Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
  • gigasheet_dataset_filterGet the rows of a Gigasheet sheet that match a filter written with column names, between a start and end row.Read-only

    Filter Sheet Rows

    Get the rows of a Gigasheet sheet that match a filter written with column names, between a start and end row. Returns the matching rows and the last row number. Use this for structured filtering. Use gigasheet_dataset_query for grouping, aggregation and sorting.

    Inputs

    handlestringrequired
    Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
    end_rowinteger
    Row to stop before. Example: 100.
    filter_modelobject
    Filter in the by-name form: an object whose _cnf_ key holds a list of OR-groups, each a list of conditions with colName, type (such as equals, contains, greaterThan) and filter (the value); the groups are ANDed. See the Filter Model Detail Guide. Example: {"_cnf_": [[{"colName": "Country", "type": "equals", "filter": "US"}]]}
    start_rowinteger
    First row to return, starting at 0. Example: 0.
  • gigasheet_dataset_getGet the metadata of a Gigasheet sheet: file name, column names and types, row count and modification time.Read-only

    Describe Sheet

    Get the metadata of a Gigasheet sheet: file name, column names and types, row count and modification time. Returns the sheet description. Use this before querying or editing a sheet. Use gigasheet_dataset_columns_list for column IDs.

    Inputs

    handlestringrequired
    Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
  • gigasheet_dataset_note_getGet the note attached to a Gigasheet sheet.Read-only

    Get Sheet Note

    Get the note attached to a Gigasheet sheet. Returns the note text. Use this to read a sheet's description.

    Inputs

    handlestringrequired
    Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
  • gigasheet_dataset_operation_status_getGet the status of the last operation on a Gigasheet sheet, such as an upload, formula or enrichment.Read-only

    Get Operation Status

    Get the status of the last operation on a Gigasheet sheet, such as an upload, formula or enrichment. Returns the operation type, state and progress. Use this to wait for a long operation to finish.

    Inputs

    handlestringrequired
    Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
  • gigasheet_dataset_queryRun a GigaScript program against a Gigasheet sheet without changing it, for example FILTER Country = US; ROWGROUPBY State; AGGREGATE sum(Revenue); SORT Revenue DESC; LIMIT 10; DISPLAY.Read-only

    Query Sheet with GigaScript

    Run a GigaScript program against a Gigasheet sheet without changing it, for example FILTER Country = US; ROWGROUPBY State; AGGREGATE sum(Revenue); SORT Revenue DESC; LIMIT 10; DISPLAY. Returns headers, types and rows (and counts when count is true), plus a permalink to the same view. Use this to read, filter, group and aggregate data. Send DISPLAY alone to see the first rows, or HELP for the language summary.

    Inputs

    handlestringrequired
    Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
    querystringrequired
    GigaScript program: statements separated by ; and ending in DISPLAY. Statements: COLUMN <col>, FILTER <clause>, SORT <col> ASC|DESC, ROWGROUPBY <col>, AGGREGATE <func>(<col>), LIMIT <n> (1-10000, default 10). Example: FILTER Country = US; LIMIT 25; DISPLAY.
    countboolean
    True adds row and group counts to the response. Example: true.
    omit_rowsboolean
    True returns only the schema and permalink without running the query; cannot be combined with count. Example: false.
    show_stateboolean
    True includes the compiled query state. Example: false.
  • gigasheet_dataset_rows_countCount the rows of a Gigasheet sheet that match a filter.Read-only

    Count Sheet Rows

    Count the rows of a Gigasheet sheet that match a filter. Returns the number of matching rows. Use this to size a result before reading it. Leave the filter empty to count all rows.

    Inputs

    handlestringrequired
    Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
    filter_modelobject
    Filter model by column ID, as the Gigasheet grid uses it; leave empty for all rows. Example: {"C": {"filterType": "text", "type": "equals", "filter": "US"}}