Tool reference

These are the tools your assistant sees once Teramot is connected. You rarely call one by name — ask in plain language and the assistant picks the tool — but knowing them helps you understand what it can do and what it will ask you to approve.

Under each tool:

• Read-only tools only look at your data.
• Makes changes tools create or change something, without destroying anything.
• Can delete or overwrite tools can remove something or replace its content.
• Reaches outside Teramot tools connect to something outside Teramot: they read a website, or send your data to the people or services you name.

Minimum role is the role you need in the workspace or project the tool acts on (see Permissions). Several tool names contain the word gold: that is the tool’s fixed name, and it refers to results tables.

Workspaces and session

list_workspaces

List Workspaces · Read-only

Lists the workspaces you are a member of, with their names and ids. Minimum role: any.

create_workspace

Create a Workspace · Makes changes

Creates a new workspace, with you as its owner. Minimum role: any signed-in user, within your plan’s workspace allowance.

delete_workspace

Delete a Workspace · Can delete or overwrite

Permanently deletes a workspace and everything in it. The assistant first shows what would be deleted and asks you to confirm. Minimum role: Owner.

switch_context

Switch Active Workspace/Project · Makes changes

Sets the workspace, and optionally the project, that the following requests use by default. It changes nothing in your data. See Choosing or switching the workspace and project. Minimum role: any.

Projects

list_projects

List Projects · Read-only

Lists the projects in a workspace (or in all your workspaces). For each one: how many source tables it has and how many of them are processed, building, failed or never ingested (a table you did not select for loading counts as never ingested); how many results tables it has and their status; how many sources; and when it was last refreshed. Tables other projects share with it are counted on their own, so a project that only uses shared tables does not show as empty. Minimum role: Read only.

create_project

Create a Project · Makes changes

Creates a project in a workspace. Minimum role: Admin.

delete_project

Delete a Project · Can delete or overwrite

Permanently deletes a project and everything in it, after a confirmation step. Minimum role: Owner.

review_project

Review a Project · Read-only

A health check of one project in a single call: every source, its processed and results tables, their status and how fresh they are, plus the tables other projects share with it and which project shares each one. Minimum role: Read only.

project_knowledge

View Project Knowledge · Read-only

Reads the project’s knowledge document — the shared notes about what the data means — with the workspace’s ahead of it. See Knowledge. Minimum role: Read only.

update_project_knowledge

Edit Project Knowledge · Can delete or overwrite

Creates, edits or deletes the project’s knowledge document. Everyone on the project sees the change. Minimum role: Analyst.

Tables and queries

explore_tables

Explore Tables · Read-only

Lists a project’s tables, or shows one table in detail: its columns, how it was built, its status, where its data comes from, and any data-quality findings. Tables other projects share with this one are included and marked with the project that shares them; their columns and data are available here, while how they were built and their status are only in that project. See Data Shares. Minimum role: Read only.

preview_table

Preview a Table · Read-only

Shows the first 100 rows and the columns of a table. Minimum role: Read only.

query_data

Run a SQL Query · Read-only

Runs a read-only SQL query over the project’s tables and returns up to 100 rows per page (at most 500 per query). Name the columns you need: SELECT * is refused. A query that takes longer than one answer keeps running for a few minutes while the assistant waits on it; one that still has not finished is better built as a results table. Minimum role: Read only.

sql_tool

Run a Results-Table Query · Read-only

Test-runs the query a new results table would be built from and returns its first rows and column types, without creating anything. Minimum role: Read only.

refresh_tables

Refresh Table Data · Makes changes

Re-runs one results table, or every table in the project, to pick up new data from the sources. Nothing is destroyed: each run produces a new revision. Minimum role: Admin.

revise_silver_query

Revise a Processed Table’s SQL · Can delete or overwrite

Fixes the cleanup query of one processed table: the assistant validates the change and shows it to you. A fix the assistant is confident in, that removes no column and that Teramot verifies breaks none of the tables built on this one, is applied — and the table refreshed — straight away. Otherwise it is applied only once you confirm, and the assistant tells you which tables the fix would break, the columns and why. On a large table, validating or applying can take longer than an assistant waits for one tool call: the assistant then tells you it is still running and checks back later, without sending the fix twice. Minimum role: Admin.

Results tables

create_gold_table

Create a Results Table · Makes changes

Builds a saved results table from a SQL query. The build runs in the background and usually takes a few minutes. Minimum role: Analyst.

update_gold_table

Edit a Results Table · Can delete or overwrite

Changes what a results table computes: the assistant writes the table’s new SQL, runs it to check the result, and sends it with the complete list of tables it reads. The table is rebuilt from that SQL, keeping its name and the dashboards built on it. A SQL that reads a table the list leaves out, or a source that already reads from the table, directly or through other results tables, is refused. When the new SQL drops columns that a dashboard, an alert or a presentation still uses, nothing changes: the assistant tells you which ones would stop working and which columns they miss, and applies the edit only if you confirm, after which those dashboards and alerts need their queries moved to the new columns. Minimum role: Analyst.

duplicate_gold_table

Duplicate a Results Table · Makes changes

Copies a results table into a new draft you can change. Minimum role: Analyst.

delete_gold_table

Delete a Results Table · Can delete or overwrite

Permanently deletes a results table, after a confirmation step. Dashboards built on it are deleted too; the confirmation also names the presentations that read it, which stay but cannot be rendered until the table exists again. Minimum role: Analyst.

get_gold_table_download_link

Download a Results Table · Read-only

Returns a link to download a results table as CSV. A private link (the default) works for 10 minutes and only for your account; a public link works for 15 minutes for anyone who has it. Minimum role: Read only.

Dashboards

dashboard_authoring_guide

Dashboard Authoring Guide · Read-only

Gives the assistant the rules for writing a Teramot dashboard. Minimum role: any.

list_dashboards

List Dashboards · Read-only

Lists the project’s saved dashboards you are allowed to see, each with a link that opens it in Teramot. Minimum role: Read only.

get_dashboard

Get a Dashboard · Read-only

Returns one dashboard in full, with a link that opens it in Teramot. Given a version number, it returns what that earlier version showed instead. Minimum role: Read only.

list_dashboard_versions

List a Dashboard’s Versions · Read-only

Lists a dashboard’s versions, newest first: when each was saved, why (created, edited or restored) and which one the dashboard shows now. Minimum role: Read only.

preview_dashboard

Preview a Dashboard · Read-only

Renders a dashboard in the chat without saving it, so you can review it first. Minimum role: Read only.

save_dashboard

Create Dashboard · Makes changes

Saves a new dashboard to the project, built on one or more results tables, and returns a link that opens it in Teramot. Its query is run first: if it fails, nothing is saved and the assistant gets the error to fix. Minimum role: Analyst.

update_dashboard

Edit a Dashboard · Can delete or overwrite

Replaces a dashboard’s title, content, query or the minimum role that can view it. A new query that fails is refused and the dashboard stays as it was. Every change to what the dashboard shows is kept as a version you can restore. Minimum role: Analyst.

restore_dashboard_version

Restore a Dashboard Version · Makes changes

Brings back an earlier version of a dashboard, saved as its newest version, so the one it replaces can be restored in turn. A version whose query no longer runs, for example because its results table’s columns changed, is refused and nothing changes. Minimum role: Analyst.

delete_dashboard

Delete a Dashboard · Can delete or overwrite

Deletes a dashboard. Anyone who had its link loses access. Minimum role: Admin.

Presentations

Presentations are decks and reports, rendered again for a month or over the data as it is now. Tool names say studio: that is their fixed name.

studio_authoring_guide

Presentations Authoring Guide · Read-only

Gives the assistant the rules for writing a presentation: the page blocks, the charts, how a query names the month, what a month with no data prints, how its sentences are checked (every number, in digits or in words and with its unit, and every month they name) and how pages move. Minimum role: any.

studio_render_document

Render a Draft Presentation · Read-only

Renders a presentation without saving it, for a month or, when its queries name none, over the data as it is now. Returns a link to view it, the PDF, an image of every page and the pages whose content does not fit. Minimum role: Read only.

studio_list_documents

List Presentations · Read-only

Lists the project’s presentations you are allowed to see. Minimum role: Read only.

studio_get_document

Get a Presentation · Read-only

Returns one presentation with its current version: its pages, queries and sentences. Minimum role: Read only.

studio_save_document

Save a Presentation · Makes changes

Saves a new presentation to the project, within your plan’s allowance. Minimum role: Analyst.

studio_save_version

Save a New Version of a Presentation · Makes changes

Saves new content for a presentation as its next version; the earlier versions are kept. Minimum role: Analyst.

studio_update_document

Update a Presentation’s Settings · Makes changes

Changes a presentation’s title, status or the minimum role that can see it. Minimum role: Analyst.

studio_refresh_document

Render a Saved Presentation · Read-only

Renders a saved presentation, like Render or Generate in the app: for a month, or over the data as it is now when its queries name none, with the same images and checks. Minimum role: Analyst.

studio_delete_document

Delete a Presentation · Can delete or overwrite

Deletes a presentation and its versions. Minimum role: Admin.

studio_get_brand

Get the Client Studio Brand · Read-only

Reads the brand the workspace’s presentations print in: its colours, fonts, footer line and whether it has a logo. Empty fields keep Teramot’s look. Minimum role: Read only.

studio_set_brand

Set the Client Studio Brand · Makes changes

Sets the brand every presentation of the workspace prints in: the client’s logo, up to four colours, the client’s own font files and the fonts that use them, and a footer line. Every page keeps the Teramot logo, with the client’s logo beside it. Minimum role: Admin.

studio_brand_from_site

Propose the Client Studio Brand From a Website · Reaches outside Teramot

Reads the client’s website and proposes its brand: the colours, the fonts of its titles and text, and its logo, each with where it was found. Nothing is saved until you confirm the proposal. Open fonts such as Google Fonts are taken with their files; fonts the site hosts itself only once you confirm the client licenses them; fonts from Adobe Fonts or Monotype never, so the assistant asks for the client’s font files instead. Minimum role: Admin.

Alerts

An alert is a query Teramot runs on its own and emails (or posts to Slack) when the result is worth telling. It has one of three modes:

• Digest sends the result at a set time, for example every morning.
• Incident sends only rows that are new, or that keep appearing after a waiting period, and can tell you when a row stops appearing.
• Threshold watches one number against a line and can tell you when it goes back.

An alert is checked when a table it reads finishes refreshing, or at its scheduled time. Your plan can limit how many alerts a workspace has and how often each one is checked.

list_alerts

List Alerts · Read-only

Lists the project’s alerts: each one’s query, mode, recipients and whether it is paused. For one alert, it also returns its recent checks — whether it fired, what it found, and for each recipient whether the message went out or why not (for example, still in its waiting period). Minimum role: Read only.

set_alert

Save Alert · Reaches outside Teramot

Creates an alert, replaces one (keeping its history), or pauses and resumes it. Recipients do not need a Teramot account. The message can carry your own words — a description, an opening line, a footer — and use the card layout: a coloured header with the alert’s name, the tables, the alert’s id and priority. You set the priority (low, medium, high or critical), and unless you pick a colour it also colours the header. A digest can show several tables, each from its own query and each attached as its own CSV, and the CSV can carry more rows than the message shows. Changing an alert keeps its Slack webhook and review date unless you replace or remove them. An assistant that supports confirmations asks you to approve it first. Minimum role: Analyst.

test_alert

Test Alert · Reaches outside Teramot

Tries an alert and says whether it would fire, how many rows it found and a sample, without sending anything. Asked to run it for real, it checks the alert as a refresh would and sends the message if the alert decides to, which is why an assistant that supports confirmations asks you to approve it first. A trial waits once, for less time than query_data can wait on a query, so an alert over a heavy query is best built on a results table. Minimum role: Analyst.

remove_alert

Remove Alert · Can delete or overwrite

Removes an alert, so its recipients stop hearing from it. Its past checks are kept. The assistant asks you to confirm first. Minimum role: Admin.

Documentation

search_docs

Search Teramot Documentation · Read-only

Searches this documentation and returns the most relevant sections, each with a link to its page, so the assistant can answer questions about using Teramot — where a button is, what a connector needs, what an error means. It understands questions in English or Spanish; for Spanish, each button is also given with the Spanish name the app shows. Minimum role: any.