Connect Grist to your AI agent
Grist is a relational spreadsheet platform that combines the flexibility of a spreadsheet with the robustness of a database, allowing users to create custom applications tailored to their data needs.
We set up the connection using your own Grist account, with keys you control, and keep it running. Your agent picks it up and starts doing the work.
Actions
What your agent can do in Grist
Each one is a real action the agent can take on its own, the same things a person clicking around Grist could do. Read-only by default; write actions are confirmed against your policy.
- Add Records Add one or more records to a Grist table. First use GRIST_LIST_WORKSPACES to get docId, GRIST_LIST_TABLES to get tableId, and GRIST_LIST_COLUMNS to get column IDs for the fields mapping.
- Create Document Creates a new Grist document in a specified workspace. Use this tool when you need to add a new spreadsheet document to a workspace. Requires a valid workspace ID (obtainable via GRIST_LIST_WORKSPACES) and a document na…
- Create SCIM User Tool to create a new SCIM user. Use when provisioning new user accounts via SCIM. Run after gathering all required user details.
- Create Table Tool to create tables in a document. Use after confirming the document ID. Creates one or more tables with specified columns in the given document.
- Create Document Webhook Tool to create a new webhook for a specified document. Use when you need to register webhook endpoints for document events in Grist. Run after confirming document ID.
- Remove Unused Attachments Remove unused attachments from a Grist document to free up storage space. IMPORTANT: This action removes ALL attachments that are not currently referenced by any cell in the document. It does NOT delete a specific attac…
- Delete Column Tool to delete a column from a Grist document table. Use after confirming document, table, and column IDs.
- Delete Grist Table Records Tool to delete records from a specified Grist table. Use when you need to remove specific rows by their IDs. Use after confirming the row IDs exist.
- Delete SCIM User Delete a user from the Grist organization by their numeric user ID. Use GRIST_GET_USERS first to find the user's ID. Falls back to org access API if SCIM is not enabled. Note: Cannot delete your own account.
- Delete Webhook Permanently removes a webhook from a Grist document. Use this tool when you need to stop receiving notifications for document changes. First use GRIST_LIST_WEBHOOKS to find the webhook_id you want to delete. This action…
- Download All Attachments Archive Download all attachments from a Grist document as a single archive file (.zip or .tar). Use this to bulk-download attachments. Ensure the document has attachments before calling (check with GRIST_LIST_ATTACHMENTS). Retu…
- Download Attachment Download a file attachment from a Grist document. Returns the file content as a downloadable file. Use GRIST_LIST_ATTACHMENTS first to get valid attachment IDs.
- Fetch Document Metadata Tool to fetch metadata for a specified Grist document. Use after obtaining the document ID.
- Fetch Table Metadata Tool to retrieve metadata for a specified table in a Grist document. Use when you need to inspect table schema details before data operations.
- Get Org Access Retrieves the list of users who have access to a Grist organization along with their access roles (owners, editors, viewers). Use this to find user IDs, emails, or check access permissions within an organization. Useful…
- Get Users Tool to retrieve a list of users via SCIM v2. Use when you need to page through and filter enterprise users in Grist.
- List Attachments Tool to list all attachments in a Grist document. Use after confirming the document ID to retrieve attachment metadata.
- List Columns Tool to list all columns in a specified Grist table. Use after selecting the document and table to inspect column metadata.
- List Organizations Tool to list all organizations accessible to the authenticated user. Use when you need to select a Grist organization for subsequent operations.
- List Records Tool to retrieve records from a specified table within a Grist document. Use when you need to fetch rows by applying optional filters, sorting, limits, or hidden columns. Example: list records where pet is 'cat' sorted…
- List Tables Tool to list all tables within a specified document. Use after obtaining the document ID to retrieve its tables.
- List Webhooks List all webhooks configured for a Grist document. Returns webhook configuration details (URL, event types, table binding) and delivery status information. Use this to inspect, audit, or manage webhooks for a document.…
- List Workspaces Tool to list all workspaces and documents accessible to the authenticated user on the current site. Use when you need to select a workspace or document for subsequent operations.
- Run SQL Query Tool to execute a read-only SQL SELECT query on a Grist document. Use after confirming the document ID and preparing a valid SQL SELECT statement.
- Update Column Metadata Updates metadata (label, type, description, formula, etc.) for one or more columns in a Grist table. Use List Columns first to get valid column IDs. Warning: changing 'label' may rename the column ID unless 'untieColIdF…
- Update Document Metadata Tool to update metadata for a specified Grist document. Use when you need to rename or pin/unpin a document after obtaining its ID.
- Update Records Update existing records in a Grist table by their row IDs. Use this tool to modify field values for one or more records in a specified document and table. First use GRIST_LIST_RECORDS to obtain the record IDs you want t…
- Update Table Metadata Update metadata properties for a table in a Grist document. Currently the main updatable property is 'onDemand' which controls lazy loading of table data. Use List Tables to find valid table IDs first.
- Update Webhook Update an existing webhook configuration for a Grist document. Use to modify webhook settings such as URL, event types, enabled status, or target table. Requires valid document ID (from GRIST_LIST_WORKSPACES) and webhoo…
- Upload Attachment Upload one or more file attachments to a Grist document. Returns attachment IDs that can be used to link files to records in Attachments-type columns. First use GRIST_LIST_WORKSPACES to get a valid document ID.
Setup
How we connect it
- 1
Connect your account
You create a key in Grist, a key you create and control, and paste it in once. It lives in a secrets store on your server, not with us.
- 2
Set the guardrails
Read-only by default. You choose which write actions the agent may take, and anything outside that policy gets confirmed with you first.
- 3
We keep it running
Health checks on every connection, updates handled for you, and we watch the first week of activity to make sure the work lands.
FAQ
Grist questions, answered.
With a key you create and control. You paste it in once, it is stored in a secrets store on your server, permissions are scoped to the minimum the agent needs, and you can revoke it at any time.
The actions Grist's API allows, the same things a person clicking around the app could do. Connections start read-only by default; write actions are confirmed against the policy you set before the agent takes them.
Connections are priced per tool on top of the base plan. Some are included, some are premium. See pricing for how connection charges work.
Standard tools are ready inside 7 business days of the setup call. We test the connection end to end, walk you through how the agent uses it, and watch the first week of activity.
Ready to put Grist to work?
Tell us what your team runs on. We set up the connection, secure it, and your agent takes it from there.
All product names, logos, and brands are property of their respective owners; used for identification only. ZeroToClaw is not affiliated with or endorsed by Grist.