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
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the Gigasheet connection
In AgentKit > Connections, create a Gigasheet connection. The name you give it is the
connection_nameyour code passes. See Configure connections.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.actionsconst connector = 'gigasheet'const identifier = 'user_123'// Generate an authorization link for the userconst { 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 callconst result = await actions.executeTool({connector,identifier,toolName: 'gigasheet_whoami_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "gigasheet"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Gigasheet:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="gigasheet_whoami_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach 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 toexecute_toolgigasheet_dataset_activity_listList the write actions made on a Gigasheet sheet.Read-onlyList 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-onlyList 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-onlyFilter 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-onlyDescribe 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-onlyGet 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-onlyGet 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-onlyQuery 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-onlyCount 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"}}
gigasheet_duplicates_countCount how many duplicate rows a Gigasheet sheet has across the given columns, and how many rows would remain after deduplication.Read-onlyCount Duplicate Rows
Count how many duplicate rows a Gigasheet sheet has across the given columns, and how many rows would remain after deduplication. Returns the duplicate and remaining counts. Use this to check data quality.
Inputs
columnsarrayrequired- IDs of the columns whose value combination defines a duplicate. Example: ["B", "D"]
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_enrichment_credits_getGet the user's remaining Gigasheet enrichment credits.Read-onlyGet Enrichment Credits
Get the user's remaining Gigasheet enrichment credits. Returns the credit balance. Use this before running enrichments.
Inputs
This tool takes no inputs.
gigasheet_export_download_getGet a presigned download URL for a finished Gigasheet export.Read-onlyGet Export Download URL
Get a presigned download URL for a finished Gigasheet export. Returns the URL of the export file. Use this after gigasheet_export_create once its state is processed.
Inputs
handlestringrequired- Handle of the export, from gigasheet_export_create or gigasheet_exports_list. Example: e_4b5c6d7e_8f90.
gigasheet_exports_listList the exports the Gigasheet user has created.Read-onlyList Exports
List the exports the Gigasheet user has created. Returns exports with handle, file name, state and dates. Use this to find an export to download with gigasheet_export_download_get.
Inputs
pageinteger- Page of results, starting at 0. Example: 0.
page_sizeinteger- Results per page. Example: 25.
gigasheet_formula_functions_listList the functions Gigasheet formulas support, with documentation.Read-onlyList Formula Functions
List the functions Gigasheet formulas support, with documentation. Returns each function's name, syntax and description. Use this before writing a formula for gigasheet_formula_run.
Inputs
dialectstring- SQL dialect (default ClickHouse). Example: ClickHouse.
gigasheet_library_folder_listList the files and folders the user owns inside a Gigasheet library folder (not nested deeper).Read-onlyList Library Folder
List the files and folders the user owns inside a Gigasheet library folder (not nested deeper). Returns items with handle, file name, type, size, row count and dates. Use this to browse a folder.
Inputs
handlestringrequired- Handle of the folder. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_library_home_listList the suggested recent files shown on the Gigasheet home page.Read-onlyList Recent Files
List the suggested recent files shown on the Gigasheet home page. Returns recent sheets with handle, file name and dates. Use this to find what the user worked on lately.
Inputs
This tool takes no inputs.
gigasheet_library_path_getGet the chain of parent folders of a Gigasheet file or folder, including the item itself.Read-onlyGet File Path
Get the chain of parent folders of a Gigasheet file or folder, including the item itself. Returns the folders from the root down, with handle and name. Use this to show where a file lives.
Inputs
handlestringrequired- Handle of the file or folder. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_library_root_listList the files and folders at the root of the user's Gigasheet library.Read-onlyList Library Root
List the files and folders at the root of the user's Gigasheet library. Returns items with handle, file name, type, size, row count, owner and dates. Use this to find sheet handles. Use gigasheet_library_folder_list for a folder and gigasheet_library_search to search.
Inputs
This tool takes no inputs.
gigasheet_library_searchSearch the Gigasheet library by file metadata: owner, file name, column headers and note by default.Read-onlySearch Library
Search the Gigasheet library by file metadata: owner, file name, column headers and note by default. Returns matching files with handle, name and owner. Use this to find a sheet by name or column. Use gigasheet_library_root_list to browse.
Inputs
search_termstringrequired- Text to search for. Example: customers.
fieldsarray- Fields to search: owner, file_name, headers or note. All four by default. Example: ["file_name", "headers"]
gigasheet_saved_filter_applyTurn a saved Gigasheet filter into a filter model for a specific sheet.Read-onlyGet Saved Filter for Sheet
Turn a saved Gigasheet filter into a filter model for a specific sheet. Returns the filter model with that sheet's column IDs. Use the result as filter_model in gigasheet_dataset_rows_count.
Inputs
filter_handlestringrequired- Handle of the saved filter, from gigasheet_saved_filters_list. Example: f_1a2b3c4d5e6f.
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_saved_filter_getGet one saved Gigasheet filter.Read-onlyGet Saved Filter
Get one saved Gigasheet filter. Returns the filter's name and conditions. Use this to inspect a saved filter.
Inputs
filter_handlestringrequired- Handle of the saved filter, from gigasheet_saved_filters_list. Example: f_1a2b3c4d5e6f.
gigasheet_saved_filters_listList the user's saved Gigasheet filters.Read-onlyList Saved Filters
List the user's saved Gigasheet filters. Returns saved filters with handle, name and the columns they use. Use this to reuse a filter on a sheet with gigasheet_saved_filter_apply.
Inputs
pageinteger- Page of results, starting at 0. Example: 0.
gigasheet_space_used_getGet how much storage the Gigasheet user has used.Read-onlyGet Space Used
Get how much storage the Gigasheet user has used. Returns the space used and the plan limit. Use this before uploading large files.
Inputs
This tool takes no inputs.
gigasheet_user_details_getGet detailed information about the Gigasheet user, such as name, email, plan and team.Read-onlyGet User Details
Get detailed information about the Gigasheet user, such as name, email, plan and team. Returns the user's profile and account details. Use this for plan and team information.
Inputs
This tool takes no inputs.
gigasheet_view_getGet one saved view of a Gigasheet sheet.Read-onlyGet View
Get one saved view of a Gigasheet sheet. Returns the view's name and client state. Use this for a view's details.
Inputs
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
viewstringrequired- Handle of the view, from gigasheet_views_list. Example: v_8a1b2c3d4e5f.
gigasheet_views_listList the saved views of a Gigasheet sheet.Read-onlyList Views
List the saved views of a Gigasheet sheet. Returns views with handle, name and client state version. Use this to find a view.
Inputs
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_whoami_getGet the Gigasheet user the API key belongs to.Read-onlyGet Current User
Get the Gigasheet user the API key belongs to. Returns the username and whether the request is authenticated. Use this to check the connection.
Inputs
This tool takes no inputs.
gigasheet_blank_rows_insertInsert empty rows into a Gigasheet sheet at a row index.WriteInsert Blank Rows
Insert empty rows into a Gigasheet sheet at a row index. Returns the new row. Use this to make room for manual entries.
Inputs
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
indexintegerrequired- Row index to insert at. Example: 0.
num_rowsinteger- Number of rows to insert (default 1). Example: 1.
gigasheet_blank_sheet_createCreate an empty Gigasheet sheet with a set number of rows and columns.WriteCreate Blank Sheet
Create an empty Gigasheet sheet with a set number of rows and columns. Returns the new sheet with its handle. Use this to start a sheet you fill with gigasheet_rows_append or gigasheet_cell_update.
Inputs
filenamestringrequired- Sheet name. Example: Lead tracker.
folder_handlestring- Folder to create it in. Example: 9e8d7c6b_5a4f_4e3d_2c1b_0a9f8e7d6c5b.
num_colsinteger- Number of columns. Example: 5.
num_rowsinteger- Number of rows. Example: 10.
gigasheet_cell_updateUpdate one cell of a Gigasheet sheet, found by column name and row number.WriteUpdate Cell
Update one cell of a Gigasheet sheet, found by column name and row number. Returns a success acknowledgement. Use this for single edits. The call fails if the column name is missing or appears more than once.
- Idempotent
Inputs
column_namestringrequired- Name of the column. Example: Status.
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
rowstringrequired- Row number of the cell. Example: 12.
valuestringrequired- New cell value. Example: Closed.
gigasheet_column_castChange the data type of a Gigasheet column.WriteChange Column Type
Change the data type of a Gigasheet column. Returns a success acknowledgement. Use this to make numbers, dates or IP addresses sortable and filterable as such.
Inputs
cast_formatstringrequired- Format of the values: ipv4, ipv6, integer, decimal, email_address or zip_code. Example: decimal.one of
ipv4ipv6integerdecimalemail_addresszip_code cast_typestringrequired- Target type: ip_address, plain_text, number or date. Example: number.one of
ip_addressplain_textnumberdate column_idstringrequired- Column ID (such as B), from gigasheet_dataset_columns_list. Example: B.
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_column_change_caseChange the text case of a Gigasheet column to uppercase, lowercase, capitalized or proper case.WriteChange Column Case
Change the text case of a Gigasheet column to uppercase, lowercase, capitalized or proper case. Returns a success acknowledgement. Use this to normalize names.
Inputs
casestringrequired- New case: Uppercase, Lowercase, Capitalize or Proper. Example: Proper.one of
UppercaseLowercaseCapitalizeProper column_idstringrequired- Column ID (such as B), from gigasheet_dataset_columns_list. Example: B.
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_column_extract_domainExtract the domain from a Gigasheet column of URLs into a new column.WriteExtract Domain
Extract the domain from a Gigasheet column of URLs into a new column. Returns a success acknowledgement. Use this to group web data by site.
Inputs
column_idstringrequired- ID of the column that holds URLs. Example: B.
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_column_splitSplit the values of a Gigasheet column into two or more columns at a separator.WriteSplit Column
Split the values of a Gigasheet column into two or more columns at a separator. Returns a success acknowledgement. Use this to break apart combined values.
Inputs
columnstringrequired- ID of the column to split. Example: B.
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
separatorstringrequired- Separator to split at. Example: ,.
gigasheet_column_trim_whitespaceTrim leading and trailing whitespace from the values of a Gigasheet column.WriteTrim Column Whitespace
Trim leading and trailing whitespace from the values of a Gigasheet column. Returns a success acknowledgement. Use this to clean imported data.
Inputs
column_idstringrequired- Column ID (such as B), from gigasheet_dataset_columns_list. Example: B.
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_columns_combineCombine several columns of a Gigasheet sheet into a new column with a separator.WriteCombine Columns
Combine several columns of a Gigasheet sheet into a new column with a separator. Returns a success acknowledgement. Use this to build full names or addresses.
Inputs
columnsarrayrequired- IDs of the columns to combine, in order. Example: ["B", "C"]
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
namestringrequired- Name of the new column. Example: Full Name.
separatorstringrequired- Text placed between the values, such as a space, comma or dash. Example: - .
gigasheet_columns_rename_by_nameRename columns of a Gigasheet sheet by their current names.WriteRename Columns
Rename columns of a Gigasheet sheet by their current names. Returns a success acknowledgement. Use this to clean up headers.
- Idempotent
Inputs
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
rename_columnsarrayrequired- Renames, each an object with current_name and new_name. Example: [{"current_name": "cust_nm", "new_name": "Customer Name"}]
gigasheet_dataset_note_setSet the note of a Gigasheet sheet, up to 20,000 characters.WriteSet Sheet Note
Set the note of a Gigasheet sheet, up to 20,000 characters. Returns a success acknowledgement. Use this to document a sheet.
- Idempotent
Inputs
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
notestringrequired- Note text, up to 20,000 characters. Example: Weekly export of CRM leads; refreshed every Monday.
gigasheet_export_createQueue an export of a Gigasheet sheet to a downloadable file.WriteCreate Export
Queue an export of a Gigasheet sheet to a downloadable file. Returns the export handle immediately. Use gigasheet_export_download_get with that handle once the export is processed.
Inputs
filenamestringrequired- Name of the export file. Example: customers-us.csv.
grid_stateobjectrequired- Grid state to export, such as a filterModel and sortModel; an empty object exports the whole sheet. Example: {}
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
folder_handlestring- Folder to put the export in. Example: 9e8d7c6b_5a4f_4e3d_2c1b_0a9f8e7d6c5b.
gigasheet_file_copyCopy a Gigasheet sheet (or a folder with recursive) into the user's library.WriteCopy File
Copy a Gigasheet sheet (or a folder with recursive) into the user's library. Returns a success acknowledgement with the new handle. Use this to duplicate a sheet before editing.
Inputs
handlestringrequired- Handle of the sheet or folder to copy. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
file_namestring- Name of the copy. Example: Customers (copy)
folder_handlestring- Folder to put the copy in. Example: 9e8d7c6b_5a4f_4e3d_2c1b_0a9f8e7d6c5b.
recursiveboolean- True copies a folder with its contents. Example: false.
gigasheet_file_moveMove a Gigasheet sheet or folder into another folder or to the library root.WriteMove File
Move a Gigasheet sheet or folder into another folder or to the library root. Returns a success acknowledgement. Use this to organize the library. The destination folder must exist.
- Idempotent
Inputs
dest_dir_handlestringrequired- Handle of the destination folder; empty string for the root. Example: 9e8d7c6b_5a4f_4e3d_2c1b_0a9f8e7d6c5b.
handlestringrequired- Handle of the sheet or folder to move. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_file_renameRename a Gigasheet sheet or folder.WriteRename File
Rename a Gigasheet sheet or folder. Returns a success acknowledgement. Use this to change a file's name.
- Idempotent
Inputs
filenamestringrequired- New name. Example: Customers 2026.
handlestringrequired- Handle of the sheet or folder. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_find_and_replaceFind and replace values in columns of a Gigasheet sheet; the original values are kept in a column renamed Original Values - <name>.WriteFind and Replace
Find and replace values in columns of a Gigasheet sheet; the original values are kept in a column renamed Original Values - <name>. Returns the updated column. Use this for bulk text fixes.
Inputs
col_idsarrayrequired- IDs of the columns to search. Example: ["B"]
findstringrequired- Text to find. Example: N/A.
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
replacestringrequired- Replacement text; an empty string clears the matches. Example: Unknown.
case_sensitiveboolean- True matches case. Example: false.
whole_cell_matchboolean- True replaces only cells that match entirely. Example: true.
gigasheet_folder_createCreate a folder in the Gigasheet library.WriteCreate Folder
Create a folder in the Gigasheet library. Returns the created folder with its handle. Use this to organize sheets.
Inputs
filenamestringrequired- Folder name. Example: Q4 reports.
folder_handlestring- Parent folder handle; the library root if empty. Example: 9e8d7c6b_5a4f_4e3d_2c1b_0a9f8e7d6c5b.
gigasheet_formula_runAdd a column to a Gigasheet sheet computed from a formula over other columns.WriteAdd Formula Column
Add a column to a Gigasheet sheet computed from a formula over other columns. Returns a success acknowledgement. Use this for calculated columns. Use gigasheet_formula_functions_list for supported functions.
Inputs
column_namestringrequired- Name of the new column. Example: Total.
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
literal_formulastringrequired- Formula using column names, such as Price * Quantity. Example: Price * Quantity.
after_column_idstring- ID of the column to place the new column after. Example: D.
gigasheet_rows_appendAppend rows to a Gigasheet sheet, given as objects keyed by column name.WriteAppend Rows
Append rows to a Gigasheet sheet, given as objects keyed by column name. Returns a success acknowledgement. Use this to add data. Use gigasheet_sheet_append_from_sheet to copy rows from another sheet.
Inputs
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
recordsarrayrequired- Rows to add, each an object of column name to value. Example: [{"Name": "Jane Doe", "Country": "US"}]
gigasheet_sheet_append_from_sheetAppend all rows of one Gigasheet sheet to another, matching columns by name.WriteAppend From Another Sheet
Append all rows of one Gigasheet sheet to another, matching columns by name. Returns a success acknowledgement. Use this to merge sheets with the same columns.
Inputs
from_handlestringrequired- Handle of the source sheet. Example: 7d2e3f4a_1b2c_4d5e_8f90_a1b2c3d4e5f6.
handlestringrequired- Handle of the target sheet. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
add_unmatched_columnsboolean- True adds source columns that the target lacks as new columns. Example: true.
case_insensitiveboolean- True ignores letter case when matching column names. Example: true.
trim_column_namesboolean- True ignores leading and trailing spaces in column names. Example: true.
gigasheet_sheet_assistant_chatAsk Gigasheet's AI Sheet Assistant a question about a sheet you can edit; it may answer or apply changes such as filters.WriteAsk Sheet Assistant
Ask Gigasheet's AI Sheet Assistant a question about a sheet you can edit; it may answer or apply changes such as filters. Returns the assistant's reply. Use this for natural-language analysis. Use gigasheet_dataset_query for exact, read-only queries.
Inputs
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
querystringrequired- Question or instruction for the assistant. Example: Which 5 states have the most customers?.
gigasheet_upload_from_urlImport a file into Gigasheet from a public URL (CSV, JSON, Excel and other supported formats), or append its records to an existing sheet.WriteUpload From URL
Import a file into Gigasheet from a public URL (CSV, JSON, Excel and other supported formats), or append its records to an existing sheet. Returns the handle of the new sheet. Use this to load data. Use gigasheet_dataset_operation_status_get to wait for parsing.
Inputs
urlstringrequired- Public URL of the file. Example: https://example.com/data/customers.csv.
folder_handlestring- Folder to upload into. Example: 9e8d7c6b_5a4f_4e3d_2c1b_0a9f8e7d6c5b.
namestring- Name for the new sheet. Example: customers.csv.
skip_type_inferenceboolean- True treats every column as text. Example: false.
target_handlestring- Handle of a sheet to append the records to instead of creating a sheet. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_view_createCreate a named view of a Gigasheet sheet from a client state version (filters, sorting, grouping and visible columns).WriteCreate View
Create a named view of a Gigasheet sheet from a client state version (filters, sorting, grouping and visible columns). Returns the created view with its handle. Use this to save a way of looking at a sheet.
Inputs
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
namestringrequired- View name. Example: US customers.
client_state_idstring- Client state version to base the view on; the current state if empty. Example: cs_5f6e7d8c.
gigasheet_view_updateRename a Gigasheet view or point it at another client state version.WriteUpdate View
Rename a Gigasheet view or point it at another client state version. Returns the updated view. Use this to change a saved view.
- Idempotent
Inputs
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
viewstringrequired- Handle of the view, from gigasheet_views_list. Example: v_8a1b2c3d4e5f.
client_state_idstring- Client state version for the view. Example: cs_5f6e7d8c.
namestring- New view name. Example: US customers (active)
gigasheet_column_deleteDelete one column of a Gigasheet sheet by column ID.DestructiveDelete Column
Delete one column of a Gigasheet sheet by column ID. Returns a success acknowledgement. Use this to drop a column. Use gigasheet_columns_delete_by_name for several columns.
- Idempotent
Inputs
column_idstringrequired- Column ID (such as B), from gigasheet_dataset_columns_list. Example: B.
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_columns_delete_by_nameDelete several columns of a Gigasheet sheet by name.DestructiveDelete Columns by Name
Delete several columns of a Gigasheet sheet by name. Returns a success acknowledgement. Use this to drop unneeded columns. Use gigasheet_column_delete to delete one column by ID.
Inputs
column_namesarrayrequired- Names of the columns to delete. Example: ["Internal ID", "Notes"]
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
gigasheet_file_deleteDelete a Gigasheet sheet or an empty folder; with recursive, delete a folder and everything in it.DestructiveDelete File
Delete a Gigasheet sheet or an empty folder; with recursive, delete a folder and everything in it. Returns a success acknowledgement. Use this to remove files for good.
- Idempotent
Inputs
handlestringrequired- Handle of the sheet or folder. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
recursiveboolean- True deletes a folder and all its children. Example: false.
gigasheet_saved_filter_deleteDelete a saved Gigasheet filter.DestructiveDelete Saved Filter
Delete a saved Gigasheet filter. Returns a success acknowledgement. Use this to remove a filter you no longer need.
- Idempotent
Inputs
filter_handlestringrequired- Handle of the saved filter, from gigasheet_saved_filters_list. Example: f_1a2b3c4d5e6f.
gigasheet_view_deleteDelete a saved view of a Gigasheet sheet; the data is not changed.DestructiveDelete View
Delete a saved view of a Gigasheet sheet; the data is not changed. Returns a success acknowledgement. Use this to remove a view.
- Idempotent
Inputs
handlestringrequired- Handle of the sheet, from gigasheet_library_root_list or gigasheet_library_search. Example: 6c1f2e5a_9b3d_4f7e_a2c8_0d1e2f3a4b5c.
viewstringrequired- Handle of the view, from gigasheet_views_list. Example: v_8a1b2c3d4e5f.
No tools match.