# AI Chat Source: https://help.teable.ai/en/basic/ai/ai-chat Interact with your data using natural language for analysis, visualization, and creation. Available on all Cloud plans; Self-Hosted requires Business or higher. AI Chat helps analyze the current table, explain record content, generate charts and reports, and create or update tables, views, apps, and automations. AI prioritizes the current page. To reference other tables, views, apps, automations, or folders, type `@` in the input box and select the related node. ## How to Open Open a table or view, then click the Cuppy in the top right corner to open AI Chat. Describe the question or task in the input box. If the task will modify data or create nodes, ask AI to list the plan first, then confirm before execution. ## What AI Can Reference AI prioritizes information from the current page: * **Current table and view**: The current table, current view, and the filtered or sorted results in that view. * **Selected rows, columns, and cells**: If rows, columns, a single cell, or a cell range are selected in Grid view, AI uses that selection as key context. * **Uploaded files**: Add PDFs, Excel files, Word documents, images, and other files to the conversation. * **More nodes with `@`**: Type `@` in the input box to add tables, views, apps, automations, or folders from the tree. Files can also be pasted or dropped directly into the input box. They appear as attachment chips first, then become available to AI after the message is sent. When you paste a long block of plain text, Teable converts it to a Markdown attachment so the message input stays easy to read. You can preview text and Markdown attachments from their attachment chips. ## Input Controls * **Voice input**: Click the microphone button in the input box and allow microphone access to start recording. While recording, choose **Finish voice input** or **Discard voice input**. After you choose finish, Teable transcribes the recording into the input box. * **Model**: Use the model menu to choose the model for the conversation. Use a lighter model for simple queries, cleanup, or rewriting, and a stronger model for complex planning, cross-table analysis, and app building. * **Intelligence**: Choose the **Intelligence** level separately in the model menu. It controls thinking depth; higher levels produce more thorough reasoning. * **My secrets**: Open **+** → **More** → **My secrets** to store API keys or other credentials in **Settings** → **Integrations**. The values are yours, AI Chat can read them as environment variables at runtime, and you can grant them to individual apps and automations. See [Credentials and Integrations](/en/basic/credential). * **Credential requests**: When AI needs a third-party account or a secret, it pins a credential request card to the conversation. Choose **Connect my account** to run an OAuth flow, or grant a credential you already have. Click **Skip** to withhold it; AI continues with the parts it can complete without it. * **Scraper**: Open the **+** menu and choose **Scraper**, then pick a platform and a data type. Entries come in two kinds: some scrape a link you paste, such as **personal profile** on LinkedIn or **product reviews** on Amazon; others search by keyword, hashtag, or name, such as **video search** on TikTok or **posts of a subreddit** on Reddit. Teable prefills the matching instruction in the chat input and leaves the part you need to fill in at the end. **Any web page** takes a pasted link directly. * **Skills**: Open the **+** menu and choose **Skills** to import, enable, disable, or try skills in the current chat. When you import one, choose who can use it: **Personal** keeps it to yourself, **Base** gives it to collaborators in this base, and **Space** gives it to everyone in this space. Type `/` in the input box to choose an enabled skill. To connect or migrate an external system, see [Connect & Migrate Everything](/en/basic/ai/connect-everything). * **Context usage**: The ring next to the input box shows how much of the model's context window the conversation currently uses. Click it for the percentage and token counts. When the context fills up, Teable compacts the conversation; start a new chat if you want a clean context instead. * **Manage files**: Open **+** → **More** → **Manage files** to view files in the current chat sandbox. You can preview supported files, download files, or delete files and folders you no longer need. A conversation must exist before its files can be managed. * **Message queue**: Sending another message while AI is working does not interrupt it. The message waits in a queue above the input box and goes out when the current run ends. Queued items keep the same table, view, attachment, and selection chips as the chat input; **Remove** drops one, **...** → **Edit message** puts it back in the input box, and a text-only item also offers **Steer** to hand its text to the running turn instead of waiting. ## Common Uses Plan a business database, create tables, views, apps, automations, or update existing records. Summarize data in the current table or view, or analyze across multiple related nodes. Turn queried data into a chart, report, or small interactive page you can reopen and share. Answer questions using PDFs, Excel files, Word documents, images, and other attachments. ### Create Tables and Automations AI Chat can help create, update, and organize data, not only answer questions. For a new business workflow, discuss the data structure first, then ask AI to create the tables, views, apps, and automations. Suitable prompts include: * Help me plan a customer follow-up system. What tables and fields do I need? * Based on the plan above, create these tables, views, and fields. * Add priority, assignee, due date, and status fields to the task table, then create common views. * Change the selected records to Completed. * Create a new table from this Excel file and check whether the field types are appropriate. * Create a CRM app from this customer table, with customer list, customer detail, and follow-up record pages. * When a new order is created, notify the owner and include the order number, customer name, and amount. For a complete business database, start by asking AI to plan the table structure. After reviewing the plan, continue with table, view, app, and automation creation. Describe the business goal, such as building a customer follow-up system, and ask AI to outline the required tables, fields, views, and automations. Review the proposed tables, fields, field types, and relationships. Add any missing rules or workflow details. Ask AI to create the confirmed tables and views, then continue with apps or automations. **Changes this turn**, below each answer, lists what the turn changed, resource by resource: fields, views, and record counts added, updated, or deleted, and apps and automations published or switched on and off. Click an entry to open that resource and check it. For app creation details, see [App Builder](/en/basic/ai/app-builder). For automation details, see [Automation](/en/basic/automation). ### Analyze Data Ask questions about data in the current table, for example: * Count completed tasks this month by assignee. * Find the customers with the highest sales in the past 30 days. * Analyze unusual records in this view. If the question involves multiple tables, use `@` to add the related tables or views to the conversation. In Grid view, you can also select rows, columns, a single cell, or a cell range, then use **Add to Chat** from the context menu. The selection appears as a chip in the input box, and clicking the chip highlights the related grid area again. Column chips use field names when available and shorten long selections after the first few names. ### Create Charts and Reports Ask AI to turn queried data into a chart, a written report, or a small interactive page: * Generate a weekly sales trend chart. * Turn this query result into a pie chart. * Create a summary report from these records. AI builds these as **artifacts**: they appear as a card in the conversation, open in their own viewer, and stay available after the conversation ends. See [Artifacts](#artifacts) for what you can do with one. An artifact holds the data AI put into it when it was created, so it does not refresh on its own. For a page that keeps reading live table data, or that collects input and stores state, create an app with [App Builder](/en/basic/ai/app-builder). ### Read Files After uploading files, AI can answer questions using both file content and table data: * Summarize this PDF and connect it with the current customer record. * Read this Excel file and identify the fields that should be imported. * Generate a product description from this image. Files uploaded to the conversation and files generated during the conversation are saved in the current chat sandbox. Use **Manage files** to inspect them later. When a reply presents several files at once, use **Download all** below the file cards to save them as one zip. ### Memory Memory stores information you explicitly ask Cuppy to remember. Memory is scoped by user and Base: each user in each Base has an independent memory context, and memory saved in another Base will not automatically appear in the current one. * Save memory in the current Base Say what Cuppy should remember in the conversation: ```text theme={null} Please remember xxx. ``` * Reuse memory from another Base Ask Cuppy to read another Base and save the relevant parts into the current Base: ```text theme={null} Cuppy, please read the memory for Base ID bsexxxxxxxxxxxx and save the relevant memory into this current Base. ``` ### Handle Long Tasks AI Chat can keep a single conversation environment available for about 24 hours, which is enough for most data analysis, file processing, and app-building tasks. Keep long-running work in the current conversation so you can follow its progress and provide input when needed. If the interface shows `Thinking` or continues to return progress updates, the task is still running. If it shows `Completed`, the current run has finished. For work with multiple stages, ask Cuppy to write results back to Teable, export them, or generate a downloadable file at key checkpoints. Saved work remains available even if the conversation environment is released later. A single conversation environment has an approximate maximum lifetime of 24 hours. After foreground execution ends, an idle environment is released after about 30 minutes. Temporary files and unsaved intermediate results are not preserved if the environment restarts. For long-running or repeatable work, use the feature that matches the workflow: Use for record-by-record work, such as large table processing, batch classification, content processing, or field filling. Use for repeatable work after records are created or updated, notifications, or scheduled data processing. ## Artifacts When AI builds a chart, report, dashboard-style page, or small interactive tool, it saves the result as an **artifact**: a self-contained page that renders outside the conversation. Artifacts appear as a card in the chat and stay available afterwards. Each one is either an interactive HTML page or a Markdown report. Click the card to open the artifact. From the viewer you can: * **Fullscreen** or **Open in new page** to give the artifact more room. * **Download** the current version as a file. * Open the version list to look at an earlier version and **Restore this version** to make it current again. * **Delete** the artifact. Its cards in the conversation turn into a deleted placeholder, so delete only when you no longer need the result. To change an artifact, ask AI in the same conversation. Each revision becomes a new version of the same artifact rather than a separate one, so the share link keeps working and you can still go back. If the page fails to run, the viewer shows the error and offers **Fix with AI**, which sends the error back to the chat so AI can correct it. ### Share an Artifact Artifacts are private to the person who created them, so use a share link to let anyone else open one. Click **Share** in the viewer and enable **Enable sharing**. Teable generates the link. Set **Who can view** to **Anyone with the link**, or to **Space members** so only signed-in members of the space can open it. Under the advanced settings, turn on **Password protection** and set a password. Viewers must enter it before the artifact loads. Use **Copy link** to copy it. If the link has spread too far, **Reset link** issues a new one and stops the old link from working. ### Find Artifacts Later Open **+** → **More** → **Manage artifacts** to browse everything you have created across your chats. Search by name, then open one to view or reshare it. ## Prompting Tips * **State the goal first**: In the first message, describe what to do, the relevant conditions, and the expected output. For example, analyze weekly sales trends over the past 3 months, grouped by region, and return a trend table with a short conclusion. * **Use field names**: For example, sort by `Created Time`, so AI can identify the target column. * **Provide several examples**: For fixed-format output, provide 3-5 input -> expected output examples. * **Use `@` to select nodes**: When AI needs to reference tables, views, apps, automations, or folders, type `@` and select them directly. * **Confirm before execution**: For tasks that modify data, create tables, create apps, or enable automations, ask AI to describe the changes before running them. * **Choose the model by task**: If the space supports model selection, use a lighter model for simple queries, cleanup, or rewriting, and a stronger model for complex planning, cross-table analysis, and app building. * **Adjust the Intelligence level**: **Intelligence** controls thinking depth; higher levels produce more thorough reasoning. * **Start a new chat when the topic changes**: A new chat is recommended when the topic changes, the conversation becomes too long, or context usage should be reduced. ## FAQ Type `@` in the input box and select the node you want AI Chat to reference. For Grid view selections, you can also select rows, columns, a single cell, or a cell range, then use **Add to Chat** from the context menu. Yes. AI is not limited to the base the chat belongs to; it can look up the other bases you have access to and work in them. Name the base in your request, for example "compare this table with the orders table in the Sales base". `@` only lists nodes in the current base, and anything you do not point elsewhere still happens in the chat's own base. Yes. They are saved as artifacts, with version history and an optional share link, and you can reopen them from **+** → **More** → **Manage artifacts**. An artifact keeps the data it was built with and does not refresh on its own. For a page that reads live table data, create an app with [App Builder](/en/basic/ai/app-builder). Not by default. Only you can open your own artifacts. Turn on **Enable sharing** in the viewer and send the link, choosing **Space members** if the artifact should stay inside the space. No. Memory is scoped by user and Base. If you want to reuse memory from another Base, ask Cuppy to read that Base's memory and save the relevant parts into the current Base. Do not use AI Chat as a background task runner. Keep working in the visible conversation, and ask Cuppy to write results back to Teable, export results, or generate a downloadable file. Each user can run up to 3 Agents at the same time, including AI Chat and App Builder. If you see `Agent is busy in another conversation. Please wait.`, another task is still running. Wait for Cuppy to finish the previous task before continuing. One AI Chat turn can include multiple processing steps. The conversation and billing page both show the total credits for that turn. Work that Cuppy already completed and saved can still be used. If the final step is interrupted by an unexpected error, credits for that interrupted step are refunded automatically. You can continue working in the same conversation. It joins the send queue above the input box rather than interrupting the run, and Teable sends the whole queue as one message when the run ends. The queue lives on the server, so it survives a refresh and looks the same in every tab or device where that conversation is open. While an item waits you can **Remove** it or use **Edit message** to bring it back into the input box. A text-only item can also be steered: **Steer** hands it to the running turn right away, and it then appears in the conversation labelled **Steered conversation**. A conversation holds up to 30 queued messages. Past that, the message is not queued and Teable replies `The send queue is full. Wait for Cuppy to catch up.` Stopping a run also holds the queue, so nothing you queued is sent by a stop you meant for the current answer. The queue header then reads `Queue paused because you interrupted`. Click **Resume** to release it, or just send your next message: starting a new run releases the queue as well. Open the **+** menu and choose **Skills** to import or manage skills, or type `/` in the input box to choose an enabled skill. Choose who can use the skill when you import it: personal for your own chats, base when collaborators in the same base need it, and space when everyone in the space does. Users who can manage the base can add base skills, and space owners and creators can add space skills. If AI Chat presents a `.skill` file, use **Install** on the file card to add it. Only one version is ever in effect, and the shared team version wins over a personal copy: a base skill beats a space skill, and a space skill beats a personal one. In an app or bot conversation, the skill added for that app or bot comes first. To move everyone to a new version, update the copy in the base or space. **Manage files** holds two folders: `uploads` for the files you added, and `outputs` for the files produced in the conversation. Both use their own storage, so they survive the sandbox being released or rebuilt and you can come back later to preview, download, or delete them. Anything Cuppy writes outside those two folders is temporary, such as intermediate results from a script. It does not appear in **Manage files** and is gone after the sandbox restarts. For results you need to keep, ask Cuppy to write them into `outputs` or back into Teable, or download them while the conversation is open, using **Download all** when a reply produced several files. When you copy a user message, tables, views, apps, automations, folders, selections, and attachments are kept as marker text. When you paste the text back into AI Chat, Teable restores the markers it can recognize as chips. Use **+** → **More** → **My secrets** in the chat input. AI Chat can use those values during the conversation without putting the plaintext in your prompt. The menu holds the common platforms. Just describe in plain language which site and what content you want, and the AI will find a matching data source. For list content such as search results, feeds, and comments, each link or keyword returns at most 10 records by default. Ask for a specific number if you need more, up to 50. Scraping a single page returns that one record and is not affected by this limit. # App Builder Source: https://help.teable.ai/en/basic/ai/app-builder Transform your data into custom web applications using AI. Available on all Cloud plans; Self-Hosted requires Business or higher. Teable App Builder allows you to turn your data bases into fully functional, customized web applications without writing code. By combining the power of your data structure with AI-driven design, you can launch internal tools, customer portals, and data dashboards in minutes. ## Overview The App Builder follows a "Prompt to App" workflow. You describe what you want, and AI builds the application structure, pages, and logic for you. You can then fine-tune every detail using the visual editor or code. Use App Builder to create custom interfaces and standalone apps. For interactive data analysis and ad-hoc questions inside the database, use [AI Chat](/en/basic/ai/ai-chat). ## Creating an App There are two main ways to create an app: 1. **From Base**: In any Base, click "Create App" to generate an application linked to your current data. 2. **From Chat**: Open AI Chat and say "Create a CRM app for this customer table". ## The App Editor Interface The App Builder provides a dual-interface for both non-technical users and developers. App Builder editor interface ### 1. Chat Interface (AI-Driven) The command center for your app. * **Natural Language Editing**: Describe changes like *"Make the header blue"* or *"Add a submission form for new records"*. * **Auto-Routing**: The AI understands which component or page you are referring to and modifies it directly. * **Integrations**: When the app task needs access to a third-party account, App Builder can show a card such as **Connect Slack** in the chat panel. Click **Connect** to authorize with OAuth. Click **Skip** to cancel this authorization; AI continues with the parts it can complete without that connection. * **Skills**: Open the **+** menu and choose **Skills** to manage skills for this app conversation. A skill added here is only available to the current app, and the skills shared with the app's base and space can be used here as well. Type `/` in the input box to choose an enabled skill. * **Manage files**: Open **+** → **More** → **Manage files** to view files in the app sandbox. Use it to preview supported files, download generated files, or delete files and folders you no longer need. * **Clear Conversation**: If the current conversation has drifted, click **Clear Chat** in the bottom-right corner of the panel to start a new session. This clears the chat history for the current conversation but does not delete the app itself. The first use shows a confirmation, and you can choose not to show it again next time. ### 2. Preview Panel * **Preview and Live**: The panel has two tabs. **Preview** runs the version you are building, including changes that are not published yet. **Live** loads the published app from its public address, so you can compare what your users see with what you are working on. Until the app is published, **Live** shows a publish prompt instead. App Builder opens a published app on **Live** and an unpublished one on **Preview**, and afterwards remembers the tab you last used for that app. * **Multi-Device Simulation**: Use the switcher at the top to toggle **Desktop**, **Tablet**, and **Mobile** views. * **Live Generation**: The preview panel can show the app taking shape while App Builder is generating. * **Instant Feedback**: After App Builder finishes a change, the preview refreshes with the latest saved version. On the **Preview** tab, use the floating toolbar at the bottom to make targeted changes: * Choose **Select an element to edit**, then click an element in the preview. App Builder adds the element to the chat input. Add your instruction and send the message so AI can update that specific part of the app. * Choose **Edit text directly**, then click static text in the preview and type your replacement. You can edit more than one text element before clicking **Save**. Click **Discard edits** to undo the pending text changes. Dynamic text, such as content loaded from data or calculated by the app, cannot be edited directly. Select the element and describe the change in chat instead. Element selection and direct text editing pause while AI is generating. Press `Esc` to exit either mode. ### 3. Developer Mode (Code Editor) For infinite customization, you have direct access to the code. * **Monaco Editor**: A VS Code-like experience right in the browser. * **React Components**: Edit the underlying React code, Tailwind CSS classes, and logic. * **File Tree**: Navigate through the project structure. App Builder code editor #### Download Code You can download the entire app as a ZIP archive at any time: 1. Switch to the **Code** tab in the editor. 2. Click the **`...`** menu in the tab bar. 3. Select **Download code** to save a ZIP archive that includes all source files. The archive holds a root `.env` file with the platform-injected runtime variables only, including the access token; credentials granted to the app are not part of it. Review the contents before sharing the ZIP. #### Import Code You can update the app's code by importing a ZIP: 1. Switch to the **Code** tab in the editor. 2. Click the **`...`** menu in the tab bar. 3. Select **Import code** and choose a ZIP file up to 20 MB. * Include source files only. `node_modules`, `.next`, and other build artifacts are ignored automatically. * The ZIP replaces the existing project. Files you leave out are removed from the new version. * If the ZIP contains one wrapper folder, Teable strips that folder. You can compress the outermost project folder directly. * The imported project must include `package.json` at the project root. * Custom variables in a root `.env` file are stored as your secrets and granted to the app under the same names. Other `.env*` variants, such as `.env.local`, are ignored. #### Credentials and Config Keep API keys, credentials, and configuration out of your source. An app uses **your credentials**: an OAuth connection or a secret you store. In the App Builder chat panel, open **+** → **More** → **Credentials & config** and grant a credential to the app. | Detail | Behavior | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | Availability | Credentials granted to the app are available in the app preview environment and the published app | | Variable name | The alias you enter when granting; it must start with an uppercase letter and can contain uppercase letters, digits, and underscores | | Reading a secret | Server-side app code reads environment variables such as `process.env.MY_API_KEY` | | Reading a connection | Server-side app code calls `getConnectionToken('ALIAS')` for an access token | | Saved values | Values are write-only after saving; enter a new value to replace one | After you add a grant, remove one, or replace a credential value, the app preview environment uses the new value. The published app uses it only after you republish. Copying an app does not copy its credentials: the panel keeps **Not bound yet** placeholders, and **Bind mine** supplies your own. See [Credentials and Integrations](/en/basic/credential) for managing credentials and checking where they are used. #### Manage App Files App Builder stores uploaded files, generated outputs, and runtime files in the app sandbox. In the chat panel, open **+** → **More** → **Manage files** to inspect them. Supported file types open in preview. You can also download files or delete files and folders you no longer need. #### Add AI Features to an App Add AI when your app needs to summarize records, classify requests, draft replies, or answer questions for app users. You can tell App Builder what you want, such as: "Add an AI reply assistant for support tickets" or "Summarize each form submission." App Builder can turn on **AI access** and add the code for the feature. After App Builder adds the AI feature, the app preview uses the new version. The published app uses it only after you republish. ## Sync Code with GitHub Available on Cloud Business plans and above. Link an app to a private GitHub repository when you want to review code in pull requests, keep a copy outside Teable, or work on the app in your local editor. Once linked, the app and the repository sync in both directions: every new app version is pushed to GitHub, and commits you push to GitHub become new app versions. ### Connect an Account and Create the Repository Generate the app at least once first. Until the app has code, the GitHub button shows **Generate the app first to connect GitHub** and does nothing. Click the GitHub icon in the app header to open **GitHub sync**. You need edit access to the app. Click **Connect GitHub** and complete the installation in the popup window. Choose your personal account or an organization you administer. Allow popups if your browser blocks the window. Select the connected account under **GitHub account**. Click **+** to connect another one. **Repository name** is prefilled from the app name. Names may contain letters, digits, `.`, `-`, and `_`, up to 100 characters. Click **Create repository & link**. For a personal account, GitHub asks you to authorize the creation in one more popup. Teable creates a new private repository and commits the current app code to the `main` branch, along with a README that points back to the app and explains how the two stay in sync. You cannot link an app to a repository that already exists. By default a connection belongs to whoever created it. To let collaborators build on the same organization account, select the connection and turn on **Allow other members to use this connection**. Other members with app editing access can then create repositories for their own apps under that organization. Personal connections cannot be shared, because GitHub requires the account owner's own authorization to create a repository. ### How Syncing Works | Direction | What happens | | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | App → GitHub | Each new app version is pushed to the `main` branch of the repository. | | GitHub → app | Commits pushed to `main` become a new app version. A message in the chat panel reports what was synced, and an open preview reloads on the new code. | Environment files are never pushed. See **Environment Variables and Local Development** below. The panel shows the current state next to the repository name: | Status | Meaning | What to do | | ------------ | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | | **Synced** | The repository matches the latest app version. | No action needed. | | **Syncing** | A push is in flight. | Wait; the panel updates on its own. | | **Conflict** | The `main` branch has commits Teable did not produce, and they cannot be combined automatically. | Merge the `teable-sync` branch on GitHub. See below. | | **Paused** | Teable stopped syncing because the GitHub App was uninstalled or suspended. | The panel says which. Lifting a suspension resumes syncing on its own. | | **Error** | The last sync attempt failed. | Read the reason in the panel and click **Retry**. | ### Resolve a Conflict Teable never force-pushes your branch. When the histories diverge, it parks the latest app version on a branch named `teable-sync` and marks the link **Conflict**. Merge `teable-sync` into `main` on GitHub; the merge comes back as a new app version and the link returns to **Synced**. While the conflict lasts, later app versions keep moving the `teable-sync` branch forward, so merging it always brings in the newest work. ### Environment Variables and Local Development The repository holds source only. Teable never pushes a file whose name starts with `.env`: not at the project root, not in a subfolder, and not in the commit history. Environment values come from the credentials granted to the app, live in **Credentials & config**, and never enter git. The repository's `.gitignore` already lists `.env*`, so a local clone will not commit one by accident. To run the app on your own machine: Clone the repository and run `pnpm install`. In the GitHub panel, click **Copy local env variables**, then paste the clipboard into a `.env` file at the project root. Run `pnpm dev`. The copied content matches what the app receives in Teable's own sandbox: the credentials granted to the app, plus the variables the platform injects for the app's API endpoint, access token, and AI access. The `TEABLE_APP_TOKEN` line in that file grants access to the app's data, which is why only members with edit access to the app can copy it. Never commit the file, and never paste it into an issue or a pull request. To add or replace a credential the app uses in production, use **Credentials & config** in Teable; editing the local file or committing a `.env` to GitHub has no effect. After a platform variable changes, such as a regenerated access token, copy the variables again to refresh your local `.env`. ### Unlink the Repository Click the delete icon next to the repository name and confirm. Syncing stops, and the repository and its code stay on GitHub. Linking the same app again later creates a new repository rather than reconnecting to the old one. ## Publishing & Management ### Publishing Your App When your app is ready, click the **Publish** button (arrow icon) in the top right corner. * **Public URL**: Teable generates a secure, publicly accessible URL for your app. * **Custom Domain**: Map your own domain to the app. * **Show branding**: Use **Show branding** in the **Publish** menu to control whether the published app shows the **Build with Teable** badge. If you change this setting after publishing, click **Redeploy** to apply it. * **Unpublish**: For a published app, use **Unpublish** in the publish menu to take the public link offline. * **App configuration changes**: When the publish menu shows **Runtime configuration changed. Redeploy to apply it to the live app** or **Branding setting changed. Redeploy to apply it to the live app**, click **Redeploy**. * **Open published app**: Once an app is published, the icon next to **Publish** opens the live app in a new tab. Hiding the **Build with Teable** badge requires the Business plan or above. Publish app menu ### Unpublish an App To take a published app offline, open the **Publish** menu and click **Unpublish**. After you confirm, the public app URL can no longer be accessed. Unpublish app button in the publish menu Unpublishing does not delete the app or its edit history. You can keep editing the app and publish it again later. ### Custom Domains Custom domains require the Business plan or above. Use **Custom domain** to bind a domain to the published app. A subdomain is recommended, such as `app.yourdomain.com`. After you enter the domain, Teable shows the DNS records to add. Add the records with your DNS provider, wait for propagation, then verify the domain in Teable. You can also use an available subdomain under `teable.app` and edit the `teable.app` prefix, such as `your-name.teable.app`. Custom domain settings ### Custom Site Info Use **Custom site info** in the **Publish** menu to set the browser tab icon, page title, and description of the published app. The dialog previews how they look together as you edit. | Setting | What it controls | | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Favicon** | The icon shown in the browser tab. Upload a PNG, JPEG, WebP, SVG, or ICO file up to 5 MB; 32×32 is the recommended size. Remove the uploaded file to return to the default Teable icon. | | **Title** | The page title, up to 120 characters. | | **Description** | The site description in the page metadata, up to 500 characters. | Leave a field empty to keep the value App Builder wrote for you. Saving applies the change to the app preview environment; the published app uses it only after you republish. ### App Login Click **Add login** in the app header to require visitors to sign in before they can use the app. Once login is configured, the button changes to **Login settings**. App login settings When you enable login: 1. Choose where to store app users. You can create a **Users** table or reuse an existing table with an email field. Each signed-in user is stored as one record, and the same user table can be reused by multiple apps. 2. Choose at least one sign-in method, such as **Email OTP**, **Google**, or **Teable**. Available methods depend on your instance's authentication settings. 3. Choose an access policy: **Anyone can sign up**, **Allowed email domains**, or **Invite only**. Login changes appear in the app preview environment after it reloads. Publish the app again to apply those changes to the published app. ### Version History & Rollback Teable automatically tracks every deployment. * Click the **History** (clock icon) button to view a list of all deployed versions. * **One-Click Rollback**: If a new update causes issues, you can instantly revert the live app to any previous stable version. App version history ### Auto-fix If your custom code changes cause a build error, the deployment will fail. * Teable provides an **Auto-fix** button alongside the error log. * Clicking this lets AI analyze the compilation error and automatically patch the code to resolve the issue. ### Deleting an App To delete an app, click the **Settings** (gear icon) button in the header and select **Delete**. ## Best Practices For prompt patterns, build tips, rollback advice, and common troubleshooting, see [App Builder Practical Guide](/en/basic/ai/app-builder-practical-guide). ## FAQ No. Clearing the conversation only removes the chat history for the current app conversation. It does not delete the app itself. Use it when the conversation has drifted and you want to start again. Switch to the **Code** tab in the editor, click the **`...`** menu in the tab bar, then choose **Download code** or **Import code**. Imported ZIP files can be up to 20 MB and replace the existing project, so include every source file you want to keep. The imported project must include a root `package.json`. Custom variables in a root `.env` file are stored as your secrets and granted to the app under the same names. Login settings appear in the app preview environment after it reloads. Publish the app again to apply those changes to the published app. Tell App Builder what AI feature you want, such as a reply assistant, submission summary, or request classifier. App Builder can enable **AI access** and add the code for the feature. The app preview uses the new version after App Builder finishes the change. The published app uses it only after you republish. AI calls made through this app appear as **App AI** in the credit usage details. **Built-in AI** includes AI features available directly in Teable, such as AI Field generation, AI Chat, IM Bot, and App Builder. These features currently use credits at a significantly discounted rate. **In-app AI** refers to AI features used inside apps created with App Builder. Usage is charged at the selected model provider's [official API price](https://vercel.com/ai-gateway/models), with no markup or discount. US\$1 of API usage equals 100 credits. Click the **History** (clock icon) button to view deployed versions, then restore the live app to a previous stable version. Each user can run up to 3 Agents at the same time, including AI Chat and App Builder. If App Builder says an Agent is busy in another conversation, another task is still running. Wait for the previous task to finish before continuing. One App Builder run can include multiple processing steps. The conversation and billing page both show the total credits for that run. Work that Cuppy already completed and saved can still be used. If the final step is interrupted by an unexpected error, credits for that interrupted step are refunded automatically. You can continue working in the same app conversation. If you are running Teable self-hosted, follow the setup on the [AI Settings](/en/basic/admin-panel/ai-setting) page. If App Builder uses your own key (BYOK), the chat model must come from an **OpenAI Compatible** or **Anthropic** provider. For deployment support, contact Teable at **[support@teable.ai](mailto:support@teable.ai)**. If you select **Vercel** under **Deployment Engine**, make sure both your Teable instance and object storage (MinIO / S3) are publicly accessible, then use **Test Public Access** on the [AI Settings](/en/basic/admin-panel/ai-setting) page. This check is not required when you select **Teable Infra**. # App Builder Best Practices Source: https://help.teable.ai/en/basic/ai/app-builder-practical-guide Practical tips and patterns for getting the most out of Teable App Builder. ## Building Tips ### 1. Define data first Teable App Builder works on top of your existing Teable tables — **your tables and fields are your schema**, and the AI reads them directly when generating UI and logic. So before you start building, define your data model clearly. The more precise your field types, links, and read/write paths are, the higher the quality of what the AI produces. ### 2. Plan before you build Once your data model is in place, still resist the urge to jump straight into building the UI. Run a planning pass with the AI first. Say something like: *"Let's not write code yet — let's make a plan."* Describe the problem you're solving, the target users, and the rough feature set. Let the AI draft a structured proposal. Review it, adjust it, and only start building once you agree the plan makes sense. A few extra minutes aligning on direction up front saves hours of rework later. ### 3. Start small Don't try to cram every feature into a single prompt. Describe the core functionality first, get a minimal working version running, then add one thing at a time: one interaction, one style tweak, one piece of logic. Verify each change before moving on. When something breaks, you only need to roll back one small change instead of starting over. ### 4. Be specific, not abstract Descriptions like *"make it prettier"* or *"make the interactions feel more natural"* carry almost no information for the AI. Effective prompts are concrete: **which page, which area, what behavior you want, what you don't want**. Attaching screenshots or reference UIs helps a lot. Treat your prompt like a brief for a smart person who knows nothing about your project. The more precise the instructions, the closer the output gets to what you imagined. ### 5. Diagnose before fixing When the app behaves unexpectedly, resist the urge to tell the AI to *"just fix it."* Vague fix instructions push the AI into blindly patching things, often introducing new bugs along the way. A better approach is two steps: Describe the symptoms and ask the AI to list likely causes and possible approaches — without touching the code yet. Decide which explanation is most plausible, and tell the AI to proceed along that path. If several fix attempts in a row fail, roll back to the last known-good version and start fresh. It's usually faster than patching on top of patches. ### 6. Lean on version rollbacks Every conversation with the AI produces changes. The recommended rhythm: finish one feature module, confirm it works, then move on. **Don't juggle multiple unfinished features at once.** Later change broke something? Roll back to the last stable version and try again with a clearer prompt. ## FAQ ### App Builder only supports Next.js App Builder's runtime environment (sandbox, preview, and build) is built on **Next.js** and currently **does not support** other frontend frameworks, including Astro, Vite, Create React App, Vue, Svelte, etc. If you ask the AI to use a non-Next.js framework, it may not consistently refuse and might even attempt to generate the corresponding code. However, since the underlying environment is incompatible, **the preview will fail to start** — you'll be stuck on "Preview is starting..." indefinitely, and conversations will continue to consume credits during this time. If you need to use a framework other than Next.js, we recommend developing in your own local environment and connecting to your data via the Teable API. ### Handling 429 errors The Teable API is currently limited to **10 QPS** (10 requests per second). Apps generated by App Builder can hit 429 errors during normal use if request handling isn't optimized. Our engineering team is actively working on optimizing API performance, and we may adjust this limit in the future. There are four broad strategies to address this: Reduce duplicate requests Shrink per-request payloads Lower request frequency Reduce preview errors Each section below lists common scenarios, the fix, and a reference prompt you can reuse. **Caching — reduce duplicate requests** **Scenario**: A dashboard page has multiple charts, stat cards, and lists, each querying a different table. Or the page is mainly for display, but every visit still hits the API directly. In both cases, page-load concurrency can spike, and traffic surges are more likely to trigger 429 errors. **Fix**: Prefer cache-friendly rendering patterns. Cache data in app memory after loading (a 1–3 minute TTL is a good starting point) and reuse it on later visits. Lazy-load below-the-fold components to stagger requests. If the page still re-fetches on every visit, explicitly ask the AI to strengthen the caching strategy. **Reference prompt**: "This is a display-heavy page. Prefer a cache-friendly rendering approach. Cache data locally after page load with a 1-minute TTL, don't re-request the API within the TTL window, and delay below-the-fold components by 500 ms." **Scenario**: Three components on the same page each need data from the same table and each fires its own request — when one would have been enough. **Fix**: Centralize data fetching so the same dataset is loaded once and shared across components. **Reference prompt**: "If multiple components need data from the same table, fetch it once and share it across all of them. Do not fire duplicate requests." **Scenario**: Users move back and forth between pages. Each return triggers a fresh fetch, even when nothing has changed. **Fix**: Within the cache TTL, reuse the previously loaded data instead of re-requesting. **Reference prompt**: "When a user returns to a page, if it's been less than 1 minute since the last load, use the cached data. Do not re-request the API." **Scenario**: A dropdown shows every record from a table as an option. With many records, that single request alone is heavy. **Fix**: Convert it into a search-style picker — only fetch matching records after the user types. Alternatively, cache the option list. **Reference prompt**: "Dropdowns should not load all options upfront. Switch to a keyword search that fetches matching records on input, with debounce applied." **Scenario**: Choosing one field triggers a load for the next level's options. Multi-level cascades rack up several requests per interaction. **Fix**: Preload the related data once and filter locally, or cache cascade data after the first load. **Reference prompt**: "Cache cascading selector option data locally after loading. When the user changes a parent option, filter from the cache instead of re-requesting." **Scenario**: Poor state management causes components to re-fetch data on every render. **Fix**: Trigger data fetching on specific events (initial mount, explicit user action), not on every render. Use caching as a safety net. **Reference prompt**: "Only fetch data on first page load or explicit user actions. Do not re-fetch on re-renders — use cached data instead." **Pagination & batching — shrink per-request payloads** **Scenario**: Loading all records at once produces a flood of API calls when the dataset grows. **Fix**: Paginate. Only fetch the current page's data. **Reference prompt**: "Show 20 rows per page. Only load the next page when the user navigates to it. Do not load everything at once." **Scenario**: After loading a list, you fetch linked-table details for each record one at a time. Loading 50 projects and then 50 owner lookups = 50 extra requests in an instant. **Fix**: Fetch all linked data in one batch, not row by row. **Reference prompt**: "When loading a list, batch-fetch all linked data in a single request. Do not loop through records to fetch their linked information individually." **Scenario**: Bulk-updating multiple records by sending one update request per record instead of a single batch request. **Fix**: Use the batch update API to submit all changes in one call. **Reference prompt**: "For bulk operations, merge multiple record changes into a single batch request. Do not send one update per record." **Scenario**: A `for` loop processes records one at a time, calling the API each iteration. **Fix**: Collect all the IDs first, then issue a single batch request. **Reference prompt**: "Do not call the API inside a loop. Collect all required IDs first, then issue a single batch request." **Debounce & throttle — lower request frequency** **Scenario**: Every keystroke in a search box fires a request. Typing a 4-character query produces 4 requests. **Fix**: Debounce the input — wait 300–500 ms after the user stops typing before firing the request. **Reference prompt**: "Debounce the search input. Only send a request 300 ms after the user stops typing. Do not send requests mid-typing." **Scenario**: Rapid-fire submit clicks, quick filter toggling, fast pagination — each action fires a request immediately. **Fix**: Apply debounce or throttle. Disable submit buttons until the request completes to prevent double-submits. **Reference prompt**: "Disable the submit button after click and re-enable it once the request resolves. Debounce filter changes so rapid changes within 300 ms fire only one request." **Scenario**: Every field change saves immediately. Filling out a form can trigger a dozen writes. **Fix**: Switch to explicit save on button click, or debounce auto-save so it fires once after a pause in editing. **Reference prompt**: "Do not save on every field change. Save on explicit button click, or auto-save once after the user has paused editing for 2 seconds." **Scenario**: Data refreshes every few seconds, producing sustained high-frequency traffic. **Fix**: Lengthen the poll interval to something reasonable (30 seconds or more), or switch to manual refresh. **Reference prompt**: "Set the auto-refresh interval to 60 seconds. Add a manual refresh button so users can pull the latest data on demand." **Scenario**: Several components on a page each set up their own poll timer. The combined load easily exceeds the limit. **Fix**: Centralize polling. Run one periodic fetch, then fan the result out to every component that needs it. **Reference prompt**: "Don't let each component set up its own poll timer. Use a single refresh mechanism that fetches everything on a schedule and distributes the data to the components." **Rendering compatibility — reduce preview errors** **Scenario**: The page uses charts, maps, or libraries that depend on `window`, DOM measurements, or other browser-only APIs, and the preview shows errors, a blank screen, or hydration mismatches. **Fix**: These components are often safer to load in the browser instead of rendering them directly on the server. If preview issues persist, explicitly ask the AI to switch them to a browser-only loading pattern. **Reference prompt**: "This component depends on the browser environment. Load it only on the client to avoid preview rendering errors or hydration mismatches." AI can make mistakes. Please double-check responses. # Connect & Migrate Everything Source: https://help.teable.ai/en/basic/ai/connect-everything Use Teable AI Chat to connect and migrate Airtable, Baserow, SmartSuite, NocoDB, APIs, databases, and project data from Jira, Asana, monday.com, or ClickUp. **Connect Everything** is a [Teable AI Chat](/en/basic/ai/ai-chat) skill for connecting external systems and migrating their data into Teable. Move token-accessible Airtable data and structure into Teable. Connect a Baserow instance and migrate accessible databases. Connect SmartSuite with an API key and Workspace ID. Connect a NocoDB instance and migrate accessible bases. Move projects from Jira, Asana, monday.com, ClickUp, Smartsheet, Trello, Notion, Linear, or Microsoft Planner. Connect another API, database, SaaS tool, or authorized data source. ## How it works 1. Open [Teable AI Chat](/en/basic/ai/ai-chat). 2. Type `/` and select **Connect Everything**. 3. Provide the source URL and required token or credentials. 4. Tell Teable AI what to migrate, then review the result. Depending on what the source exposes, Teable AI can migrate data, records, tables, field types, and relationships. Coverage depends on the source API and the permissions granted to the connection. # Migrate Airtable Source: https://help.teable.ai/en/basic/ai/connect-everything/migrate-airtable Migrate token-accessible Airtable data, table structure, field types, and relationships into Teable with Connect Everything. In [**Teable AI Chat**](/en/basic/ai/ai-chat), type `/` and select the **Connect Everything** skill, then provide your Airtable Token. Teable AI can use that authorized connection to migrate all token-accessible data, table structure, field types, and relationships into Teable, so you do not have to rebuild the workspace manually. ## Start the migration 1. Create an [Airtable Personal Access Token](https://airtable.com/create/tokens) with access to the bases you want to migrate. 2. Open the target Teable base and launch AI Chat. 3. Type `/`, select **Connect Everything**, and provide the token. 4. Ask Teable AI to migrate the Airtable base, then review the result. Migration coverage depends on the Airtable API and the token's scopes and resource access. Revoke the token after the migration is complete. ## Compare before you switch Review the differences in data modeling, automation, AI, deployment, and pricing in the [Teable vs Airtable comparison](https://teable.ai/compare/airtable-alternative). # Migrate Baserow Source: https://help.teable.ai/en/basic/ai/connect-everything/migrate-baserow Migrate accessible Baserow tables, fields, records, and relationships into Teable with Connect Everything. Use **Connect Everything** in [Teable AI Chat](/en/basic/ai/ai-chat) to connect a Baserow instance and migrate accessible data into Teable. ## Start the migration 1. Copy the Baserow instance URL and create a [Baserow database token](https://baserow.io/user-docs/personal-api-tokens) with read access to the source tables. 2. Open the target Teable base and launch AI Chat. 3. Type `/`, select **Connect Everything**, and provide the instance URL and database token. 4. Ask Teable AI to migrate the Baserow database, then review the result. Migration coverage depends on the Baserow API and the tables and permissions assigned to the database token. ## Compare before you switch Review the differences in data modeling, automation, AI, deployment, and pricing in the [Teable vs Baserow comparison](https://teable.ai/compare/baserow-alternative). # Migrate ClickUp Source: https://help.teable.ai/en/basic/ai/connect-everything/migrate-clickup Migrate API-accessible ClickUp Workspaces, Spaces, Folders, Lists, tasks, subtasks, fields, comments, and attachments into Teable with Connect Everything. In [**Teable AI Chat**](/en/basic/ai/ai-chat), type `/` and select **Connect Everything**, then provide your ClickUp personal API token. Teable AI can use that authorized connection to migrate API-accessible Workspaces, Spaces, Folders, Lists, tasks, subtasks, fields, comments, and attachments into Teable, so you do not have to rebuild the workspace manually. ## Start the migration 1. In ClickUp, open **Settings → Apps**, then copy your personal API token. See ClickUp's [authentication guide](https://developer.clickup.com/docs/authentication). 2. Open the target Teable base and launch AI Chat. 3. Type `/`, select **Connect Everything**, and provide the personal API token. 4. Ask Teable AI to migrate the accessible ClickUp Workspaces and build the project views, dashboards, and automations your team needs. Migration coverage depends on the ClickUp API, plan limits, rate limits, and token-authorized resources. Dashboards, automations, permissions, and unsupported assets may require separate handling. Rotate a migration-only credential after the migration is complete. ## Compare before you switch Review the differences in project structure, workflow automation, reporting, AI, and pricing in the [Teable vs ClickUp comparison](https://teable.ai/compare/clickup-alternative). # Migrate Jira Source: https://help.teable.ai/en/basic/ai/connect-everything/migrate-jira Migrate API-accessible Jira projects, work items, fields, users, sprints, comments, relationships, and attachments into Teable with Connect Everything. In [**Teable AI Chat**](/en/basic/ai/ai-chat), type `/` and select **Connect Everything**, then provide your Jira Cloud site URL, Atlassian account email, and API token. Teable AI can use that authorized connection to migrate API-accessible projects, work items, fields, users, statuses, sprints, comments, relationships, and attachments into Teable, so you do not have to rebuild the workspace manually. ## Start the migration 1. Create an [Atlassian API token](https://id.atlassian.com/manage-profile/security/api-tokens) for an account with access to the Jira projects you want to migrate. See Atlassian's [Basic auth for REST APIs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/). 2. Open the target Teable base and launch AI Chat. 3. Type `/`, select **Connect Everything**, and provide the Jira Cloud site URL, account email, and API token. 4. Ask Teable AI to migrate the accessible Jira projects and build the project views, dashboards, and automations your team needs. Migration coverage depends on the Jira API, account permissions, and token access. Jira automation rules, Marketplace app data, dashboards, and permission schemes may require separate handling. Revoke a migration-only token after the migration is complete. ## Compare before you switch Review the differences in project structure, workflow automation, reporting, AI, and pricing in the [Teable vs Jira comparison](https://teable.ai/compare/jira-alternative). # Migrate monday.com Source: https://help.teable.ai/en/basic/ai/connect-everything/migrate-monday Migrate API-accessible monday.com workspaces, boards, groups, items, subitems, columns, users, updates, and files into Teable with Connect Everything. In [**Teable AI Chat**](/en/basic/ai/ai-chat), type `/` and select **Connect Everything**, then provide your monday.com personal API token. Teable AI can use that authorized connection to migrate API-accessible workspaces, boards, groups, items, subitems, columns, users, updates, and files into Teable, so you do not have to rebuild the workspace manually. ## Start the migration 1. In monday.com, open your profile menu, choose **Developers**, and copy your personal API token. See monday.com's [API authentication guide](https://developer.monday.com/api-reference/docs/authentication). 2. Open the target Teable base and launch AI Chat. 3. Type `/`, select **Connect Everything**, and provide the personal API token. 4. Ask Teable AI to migrate the accessible monday.com workspaces and build the project views, dashboards, and automations your team needs. Migration coverage depends on the monday.com API and the user's token permissions. Dashboards, automation recipes, integrations, apps, and inaccessible private boards may require separate handling. Rotate a migration-only credential after the migration is complete. ## Compare before you switch Review the differences in project structure, workflow automation, reporting, AI, and pricing in the [Teable vs monday.com comparison](https://teable.ai/compare/monday-alternative). # Migrate NocoDB Source: https://help.teable.ai/en/basic/ai/connect-everything/migrate-nocodb Migrate accessible NocoDB bases, tables, fields, records, and relationships into Teable with Connect Everything. Use **Connect Everything** in [Teable AI Chat](/en/basic/ai/ai-chat) to connect a NocoDB instance and migrate accessible data into Teable. ## Start the migration 1. Copy the NocoDB instance URL and create a [NocoDB API token](https://nocodb.com/docs/product-docs/account-settings/api-tokens) with access to the source base. 2. Open the target Teable base and launch AI Chat. 3. Type `/`, select **Connect Everything**, and provide the instance URL and API token. 4. Ask Teable AI to migrate the NocoDB base, then review the result. Use a fine-grained API token when available. Migration coverage depends on the NocoDB API and the token's base access and permissions. ## Compare before you switch Review the differences in data modeling, automation, AI, deployment, and pricing in the [Teable vs NocoDB comparison](https://teable.ai/compare/nocodb-alternative). # Migrate Smartsheet Source: https://help.teable.ai/en/basic/ai/connect-everything/migrate-smartsheet Migrate API-accessible Smartsheet workspaces, folders, sheets, reports, columns, rows, discussions, and attachments into Teable with Connect Everything. In [**Teable AI Chat**](/en/basic/ai/ai-chat), type `/` and select **Connect Everything**, then provide your Smartsheet API access token and account environment. Teable AI can use that authorized connection to migrate API-accessible workspaces, folders, sheets, reports, columns, rows, discussions, and attachments into Teable, so you do not have to rebuild the workspace manually. ## Start the migration 1. In Smartsheet, open **Account → Personal Settings → API Access**, then generate an access token. See Smartsheet's [API getting-started guide](https://developers.smartsheet.com/api/smartsheet/guides/getting-started). 2. Open the target Teable base and launch AI Chat. 3. Type `/`, select **Connect Everything**, and provide the access token and account environment: standard, Regions Europe, or Gov. 4. Ask Teable AI to migrate the accessible Smartsheet workspaces and build the project views, dashboards, and automations your team needs. Migration coverage depends on the Smartsheet API, account permissions, and account environment. Tokens are not interchangeable between Smartsheet environments. Revoke a migration-only token after the migration is complete. ## Compare before you switch Review the differences in project structure, workflow automation, reporting, AI, and pricing in the [Teable vs Smartsheet comparison](https://teable.ai/compare/smartsheet-alternative). # Migrate SmartSuite Source: https://help.teable.ai/en/basic/ai/connect-everything/migrate-smartsuite Migrate accessible SmartSuite solutions, tables, fields, records, and relationships into Teable with Connect Everything. Use **Connect Everything** in [Teable AI Chat](/en/basic/ai/ai-chat) to connect SmartSuite and migrate accessible data into Teable. ## Start the migration 1. Get your [SmartSuite API key and Workspace ID](https://help.smartsuite.com/en/articles/6096587-retrieving-your-api-key-and-workspace-id). 2. Open the target Teable base and launch AI Chat. 3. Type `/`, select **Connect Everything**, and provide the API key and Workspace ID. 4. Ask Teable AI to migrate the SmartSuite solution, then review the result. The API key uses the permissions of the SmartSuite member who created it. Use an account with only the access required for the migration. ## Compare before you switch Review the differences in data modeling, automation, AI, deployment, and pricing in the [Teable vs SmartSuite comparison](https://teable.ai/compare/smartsuite-alternative). # Connect & Migrate More Sources Source: https://help.teable.ai/en/basic/ai/connect-everything/more-sources Use Connect Everything to connect APIs, databases, SaaS tools, and other authorized data sources to Teable. Connect Everything is not limited to Airtable, Baserow, SmartSuite, or NocoDB. It can work with other systems that expose data through an API or another authorized connection. ## What to provide * The source system name and URL * API documentation or endpoint information * A token or credential with the minimum required access * A short description of what you want to connect or migrate In [Teable AI Chat](/en/basic/ai/ai-chat), type `/`, select **Connect Everything**, provide the connection details, and tell Teable AI what to migrate. Available data and migration coverage depend on the source system, its API, and the permissions granted to the connection. # Custom AI Model Source: https://help.teable.ai/en/basic/ai/custom-model Add custom model providers for AI Fields, Automations, AI Chat, App Builder, and other supported AI features. Available for Pro plan and above ## Where to Configure It 1. Open the target space. 2. Click **Settings** in the top right corner. 3. Go to **AI settings**. AI settings page ## Setup Steps Under **AI Capabilities**, turn on what you need: * **AI Field** * **AI Chat** Enabling **AI Chat** controls whether the chat feature is available in the space. The **Concurrency** row beneath **AI Field** sets how many AI field generations this space runs at the same time; the rest wait in the queue. Lower it when this space's bulk AI fills are slowing down other people's work, and raise it when you want a large fill to finish faster. ### Add LLM Provider When you add a new LLM provider, choose **OpenAI**, **Anthropic**, or **OpenAI Compatible** as the provider type. Use **OpenAI Compatible** for services that expose an OpenAI-compatible API endpoint. If a task uses images, screenshots, or other visual input, choose a model with vision support. Models without vision support will fail on these multimodal tasks. Click **Add LLM provider** and fill in the following: * **Name**: Used to distinguish different providers. * **Provider type**: Select the provider type. * **Base URL**: Enter the provider's API endpoint. * **API Key**: Enter the API key from the provider. * **Models**: Enter the model names you want to connect. Separate multiple models with English commas. Add LLM provider dialog ### Test Model Capabilities There are currently three ways to test: * Click **Test** on the LLM provider row. * Click **Test** on an individual model row. * Click **Test Model Capabilities** in the top-right corner of the list to batch-test all configured models. If a model is meant for image generation, check **Image Generation Model** before running the test. Once checked, Teable tests it as an image model for text-to-image and image-to-image capabilities. If it is not checked, the model is tested as a regular text model. ## Configuration Tips ### Base URL and Models Some Coding Plan keys may only work in designated coding tools and may not be standard API keys. Check the provider's terms before using them with third-party services. To connect Teable, use a standard API key created in the provider dashboard. Common examples: | Provider type | Base URL format | Example models | | ----------------- | ----------------------------------------------- | -------------------------------------------------- | | OpenAI | `https://api.openai.com/v1` | `gpt-5.5,o3,gpt-5-mini` | | Anthropic | `https://api.anthropic.com/v1` | `claude-opus-4-8,claude-sonnet-5,claude-haiku-4-5` | | OpenAI Compatible | The provider's OpenAI-compatible `/v1` endpoint | `gpt-5.5,gpt-5.4,o3,gpt-5-mini` | Model names must match the provider documentation exactly and are case-sensitive. Separate multiple models with English commas. Notes: * Model names are case-sensitive. Use the exact names from the provider documentation. * Some providers require no spaces after commas, for example `gpt-5.5,o3`. * For **OpenAI Compatible** providers, use the model naming format required by that provider. Some services use `provider/model-name`. ## FAQ Check whether the **Base URL** is correct, whether it was mistakenly filled with the provider homepage URL, or whether it has an extra trailing `/`. If you are using an OpenAI-compatible endpoint, also confirm that `/v1` is not missing. Check whether the **API Key** is valid and whether the account still has credits or permission to call the model. Check whether the **Base URL** is correct and whether your current environment can reach that address. Make sure the **Models** value matches the provider documentation exactly, including case and separator format. This kind of key may not support standard API calls, or the provider's terms may not allow third-party service use. Check the provider's Coding Plan terms first. To connect Teable, use a standard **API Key** created in the provider dashboard. If the model is meant for image generation, check **Image Generation Model** first and then test again. Once checked, Teable tests text-to-image and image-to-image capabilities instead. # Overview Source: https://help.teable.ai/en/basic/ai/overview Explore Teable's AI capabilities for intelligent data processing, automation, and analysis. Available on all Cloud plans; Self-Hosted requires Business or higher. AI can make mistakes. Please double-check responses. Teable integrates powerful AI capabilities throughout the platform to help you work smarter with your data. From intelligent field processing to automated workflows, AI features streamline your data operations. ## AI Capabilities Context-aware intelligent assistant for data analysis, visualization, and creation. Transform your data into custom web applications using AI. Write custom AI-powered scripts to extend automation capabilities. Automatically generate, summarize, translate, and extract information from your data using AI-powered fields. Integrate AI processing into your automation workflows for intelligent data handling. ## Configuration Integrate custom AI models and third-party API providers. Configure AI Chat, AI fields, AI automation, and App Builder for a self-hosted instance. ## Getting Started 1. **Enable AI** (Self-hosted only) - Teable Cloud comes with built-in AI ready to use. Self-hosted users should complete [AI Settings](/en/basic/admin-panel/ai-setting) first. If you want to connect your own models, continue with [Custom AI Model](/en/basic/ai/custom-model). 2. **Use AI Chat** - Ask questions about your data or generate charts 3. **Build Apps** - Turn your Base into a web app with a simple prompt 4. **Create AI Fields** - Add AI-powered fields to automatically process your data 5. **Build Automations** - Use AI generate and Run script actions in your workflows # Connect AI Agents to Teable Source: https://help.teable.ai/en/basic/ai/teable-skill Query and update data, manage tables, and create automations or apps from your AI agent. ## Install Teable Skill Copy this prompt into your AI agent: ```text wrap theme={null} Please read https://github.com/teableio/agent-skills, follow the guide to help me install the Teable agent skill, and complete Teable CLI authentication. ``` Or install it directly: ```bash theme={null} npx skills add https://github.com/teableio/agent-skills ``` ## Try Teable Skill After the skill is installed, try these prompts. ```text Simple Starter Prompts wrap theme={null} Create a simple CRM table in {paste Base URL}. ``` ```text Local Files → Teable wrap theme={null} Upload all invoices in this local folder to {paste table URL} and extract key fields. ``` ```text Cross-Platform Data → Teable wrap theme={null} Import new GitHub issues into {paste table URL}. ``` ```text Clean Or Organize Teable Data wrap theme={null} Check {paste table URL} and mark overdue tasks. ``` # Overview Source: https://help.teable.ai/en/basic/automation Create automation workflows with AI or manual configuration. Teable Automation makes powerful workflows simple. No code, no drag-and-drop, no complicated setup. Just tell AI what you need in plain language, and Teable takes care of the repetitive work for you. ## Build with AI (from scratch) The easiest way to get started. Open any table, click the **AI chat** on the right sidebar, and describe what you want: * *"When a new order comes in, send a Slack notification with the customer name and amount."* * *"Every Monday morning, email me a summary of tasks that are overdue."* * *"When someone submits the feedback form, classify it and update the category field."* AI creates and tests the entire automation for you - trigger, actions, and field mappings. Review the results in the Automation panel and enable. ## Build with AI (from trigger) You can also start from a specific trigger and let AI build the actions: 1. **Add a trigger** — choose a trigger type (e.g. "When Record Created") and configure it. 2. **Add an action** — click **+**, go to **Build with AI**, and select **Run Script**. 3. In the configuration panel, click **Open Editor**. 4. Pick from the **suggestions** to get started quickly, or describe what you need in your own words. 5. AI generates the JavaScript code. Review it, click **Apply**. 6. Click **Test** to run the script with real data, then **Enable** the workflow. ## Build manually You can also build automations step by step using the built-in actions: 1. **Add a trigger** — choose a trigger type, select the table, configure fields. Click **Test**. 2. **Add an action** — choose an action type (Create Record, Send Email, HTTP Request, etc.), map field values using **+** to insert dynamic variables. Click **Generate Preview** or **Run as Configured**. 3. **Enable** — click the toggle in the top-left corner. ## Editing a live workflow Changes are saved as a draft. The live workflow keeps running on the previous version until you click **Apply Update**. ## Credentials and Config An automation calls external services with your credentials: an OAuth connection or a secret you store. Open the workflow on the editing tab, click **Credentials & config** next to the test controls, grant a credential to this automation, and give it a **Variable name**. Script actions read that name from an environment variable such as `process.env.EXTERNAL_API_KEY`; other actions can click **Insert secret** beside an input field to insert a reference. Values are never shown in plaintext, and test results mask them. Credentials themselves live in **Settings** → **Integrations**. See [Credentials and Integrations](/en/basic/credential). ## Run history Open a workflow → **Run history**. The history panel lists each run with its status, time spent, and step details. Click a run to inspect per-step input/output. Use the history filters to narrow the list by status, duration, or date range. For failed runs, use the run detail panel to diagnose or rerun: * **Diagnose** opens AI Chat with the failed run as context, so you can ask Cuppy to explain the failure. * **Full rerun** runs every step again and may create duplicate records, emails, or notifications. * **Resume from failed step** is available when Teable can safely continue from the failed step. When **Resume from failed step** is unavailable, Teable explains why only **Full rerun** can be used. This can happen when the workflow was modified after the failed run, the workflow is disabled, no step finished successfully before the failure, or control-step data is missing. Rerun attempts are marked as retries and link back to the original run. ## Limits | Item | Limit | | ----------------------------- | ----------------------------------------- | | Email sending rate | 5 / second / base | | Webhook receiving rate | 50 / second / base, 2 / second / workflow | | Webhook payload size | 4 MB | | Run quota & history retention | Varies by plan | ## FAQ In Teable Cloud, Teable sends automation run usage notifications to Space Owners when a space is close to or over its run quota, or when runs increase sharply in a short time. For quota reminders, Teable sends a notification when the current billing period reaches 80% or 90% of the available run quota. Pro and above plans may receive alerts after automation runs go over the quota. Teable may remind you about every 6 hours. Teable Cloud may also send critical notifications for unusual usage, such as a large daily increase or a sudden burst in a short time. The system uses recent daily and hourly run patterns, and the exact thresholds may change. The notification opens **Space Settings** → **Billing**. When available, it shows which workflow and Base contributed the most runs. Quota reminders are based on runs counted toward your plan limit; unusual usage checks may also consider recent runs with **success**, **failed**, or **pending** status. If the usage is expected, consider buying extra automation quota or changing your plan. If it is unexpected, review the top workflow and adjust or pause the related automation. # AI generate Source: https://help.teable.ai/en/basic/automation/actions/ai/ai-generate Use AI models to generate text or structured data in a workflow We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it picks the right trigger, chooses the appropriate actions, maps the fields, and configures the entire workflow automatically. Describe the goal once, and the workflow is ready — no manual setup needed. Sends a prompt to a large language model and returns text or structured JSON. Use it to classify, extract, summarize, or generate data based on your records. ## Configuration | Setting | Required | Description | | ----------- | -------- | ------------------------------------------------------------------------------------------------------------ | | Prompt | Yes | Your instruction to the AI. Click **+** to insert dynamic variables from previous steps | | Model | No | Choose a model. Defaults to the system model. Vision and Reasoning models are also available | | Temperature | No | Controls randomness: 0 = most deterministic, 1 = most creative. Default is usually around 0.7 | | Output Type | No | **Text** (default) — returns free-form text. **JSON** — returns structured JSON matching a schema you define | | Attachments | No | Upload images, PDFs, Word docs, or Excel files. Requires a vision-capable model | ## Model capabilities | Tag | Meaning | | ------------- | -------------------------------------------------------------------------------------------------- | | **Vision** | Can read and analyze images, PDFs, Word documents, and Excel files attached to the prompt | | **Reasoning** | Returns both the answer and step-by-step reasoning (chain of thought), useful for complex analysis | You can connect third-party AI models via **Space → Settings → Integrations**. This lets you use models from OpenAI, Anthropic, Google, and other providers. ## How to set it up 1. Add an **AI Generate** action to your workflow. 2. Write your **Prompt**. This is the instruction the AI will follow. Click **+** to insert dynamic values — for example, the text of a support ticket, the contents of a form submission, or a product description. 3. (Optional) Select a **Model** if you want to use a specific one instead of the default. 4. (Optional) Adjust **Temperature**. Lower values (0–0.3) give more consistent, predictable outputs. Higher values (0.7–1.0) give more varied, creative outputs. 5. (Optional) Switch **Output Type** to **JSON** if you need structured data. Define the JSON schema so the AI knows what format to return. 6. (Optional) Add **Attachments** if you want the AI to read documents or images (requires a vision model). 7. Save the action. The AI's response will be available to subsequent steps via the **+** variable picker. ## Prompt writing tips The quality of the AI output depends heavily on your prompt. Here are practical guidelines: * **Be specific.** Instead of "Classify this", write "Classify this support ticket into one of these categories: Billing, Technical, Account, Other." * **Give examples in the prompt.** Show the AI what you expect: ``` Classify the following support ticket. Return only the category name. Categories: Billing, Technical, Account, Other Examples: - "I can't log in to my account" → Account - "My invoice amount is wrong" → Billing - "The API returns a 500 error" → Technical Ticket: {{Ticket Description}} ``` * **Define the output format.** If you want a specific format, say so: "Return only the category name, nothing else" or "Return a JSON object with keys: category, confidence, reason." * **Keep it focused.** One task per prompt works better than asking the AI to do multiple things at once. ## JSON output When you set Output Type to **JSON**, the AI returns structured data instead of free text. This is useful when you need to extract multiple pieces of information and use them separately in later steps. Example prompt for JSON output: ``` Extract the following information from this invoice email. Return JSON with these keys: - vendor_name (string) - invoice_number (string) - amount (number) - due_date (string in YYYY-MM-DD format) Email body: {{Email Body}} ``` The AI returns something like: ```json theme={null} { "vendor_name": "Acme Corp", "invoice_number": "INV-2024-001", "amount": 1250.00, "due_date": "2024-03-15" } ``` Each key in the JSON is then available as a separate variable in subsequent steps, so you can map `vendor_name` to one field, `amount` to another, and so on. ## Vision models and attachments Vision models can analyze images and documents. Attach files to the prompt and the AI will "read" them: * **Images:** screenshots, photos, diagrams, charts. * **PDFs:** invoices, contracts, reports. * **Word / Excel files:** documents and spreadsheets. Use cases: extract text from scanned documents, read data from invoice images, analyze chart images, process uploaded forms. Make sure to select a model with the **Vision** tag. Non-vision models will ignore attachments. ## Credit system Each AI Generate call consumes credits based on: * The **model** used (more powerful models cost more credits per token). * The **number of tokens** processed (both input and output). The exact credit cost is shown in the test panel after a test run. Monitor your credit usage in your account settings, especially if you are using AI Generate inside a Loop over many records. ## Concrete prompt examples ### Classification ``` Classify this customer feedback into: Positive, Negative, or Neutral. Return only the classification. Feedback: {{Feedback Text}} ``` ### Data extraction ``` Extract all email addresses mentioned in the following text. Return them as a JSON array of strings. Text: {{Message Body}} ``` ### Summarization ``` Summarize the following meeting notes in 3 bullet points. Focus on action items and decisions made. Notes: {{Meeting Notes}} ``` ### Content generation ``` Write a professional follow-up email to {{Customer Name}} regarding their inquiry about {{Product Name}}. Keep it under 150 words. Mention that we will respond within 24 hours. ``` ### Translation ``` Translate the following text from {{Source Language}} to {{Target Language}}. Preserve the original formatting. Text: {{Content}} ``` ## When to use * **Classify support tickets by topic.** Automatically categorize incoming tickets so they can be routed to the right team. * **Extract structured data from invoices or emails.** Pull out amounts, dates, names, and reference numbers into separate fields. * **Summarize long text fields.** Condense meeting notes, descriptions, or comments into brief summaries. * **Generate personalized email content.** Create custom email body text based on record data. * **Analyze images and documents.** Use vision models to read uploaded invoices, receipts, or screenshots. ## Tips * Use the **test panel** to iterate on your prompt before activating the automation. Run tests with real data to verify the output format and quality. * For consistent results (especially classification), set Temperature to 0 or near 0. * JSON output mode is more reliable when you provide a clear schema in your prompt. Always list the expected keys and their types. * If you are processing many records in a [Loop](../logic/loop-run), keep your prompts concise to reduce token usage and credit costs. * Connect additional AI providers via **Space → Settings → AI settings** if the default models do not meet your needs. For details, see [Custom AI Models](/en/basic/ai/custom-model). Connect third-party AI models via **Space → Settings → AI settings**. ## Related * [Loop (batch)](../logic/loop-run) — process multiple records with AI in a single automation run * [Run script](/en/basic/automation/ai/scripting/runscript) — for custom logic that goes beyond prompt-based generation * [Send email](/en/basic/automation/actions/communication/send-email-overview) * [Update record](/en/basic/automation/actions/records/update-record) # Run script Source: https://help.teable.ai/en/basic/automation/actions/ai/ai-script Describe what you need in plain language and let AI write the automation logic for you We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. The most powerful way to build automation actions. Describe what you need, and AI writes the code. No programming experience required. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it creates the trigger, writes the script, maps the fields, and configures the entire workflow automatically. Describe the goal once, and the workflow is ready — no manual setup needed. **Example:** *"When a new support ticket comes in, classify it by topic and assign it to the right team."* ## How to use * **Add a trigger** — choose a trigger type (e.g. "When Record Created") and configure it * **Add an action** — click **+**, go to **Build with AI**, select **Run script** * **Edit manually** — in the configuration panel, click **Edit manually** * **Describe or pick** — choose a built-in suggestion, or type your own request in the AI panel on the right * **Apply** — AI generates the code and shows a visual flowchart on the left. Click **Apply** * **Test and enable** — click **Test** to run with real data, then **Enable** the workflow ## Built-in suggestions The AI panel offers ready-made prompts you can click to use directly: * Send message to Slack when the record is updated * Send to Teams bot upon record is created * Send me email when status changes * Update records when status changes * Send HTTP request to Zapier You can also describe your own task in plain language: * *"Calculate order total with 10% tax and update the record"* * *"When a new support ticket is created, classify it by topic and assign it to the right team"* * *"Every morning, check for overdue invoices and send reminder emails to customers"* ## Connecting third-party services If your script needs a service such as Slack, Airtable, or Google Sheets, click the integration buttons at the top of the AI panel to connect your accounts. The AI will use these connections when generating code. # Send email overview Source: https://help.teable.ai/en/basic/automation/actions/communication/send-email-overview Send customized emails from a workflow We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it picks the right trigger, chooses the appropriate actions, maps the fields, and configures the entire workflow automatically. Describe the goal once, and the workflow is ready — no manual setup needed. This action sends an email to one or more recipients. You can customize recipients, subject, body, and reply-to address, and use dynamic values from previous steps to personalize each message. By default, emails are sent from Teable's built-in mail service. If you need to send from your own domain, configure a [custom SMTP server](/en/basic/automation/actions/communication/smtp-sender). ## Configuration | Setting | Required | Description | | ------------------- | -------- | -------------------------------------------------------------------------------------- | | To | Yes\* | Recipient email address(es). Separate multiple addresses with commas | | Subject | Yes | The subject line. Supports dynamic variables via **+** | | Body | Yes | The email body. Supports Markdown, HTML, and dynamic variables | | Sender Name | No | The display name shown in the recipient's inbox (e.g., "Acme Support") | | CC | No | Carbon copy recipients | | BCC | No | Blind carbon copy recipients | | Reply-To | No | The address recipients reply to (if different from the sender) | | Custom email server | No | Sends this action through a specific SMTP account, leaving other automations untouched | \* At least one of **To** or **BCC** is required. **Rate limit:** 5 emails / second / base. ## How to set it up 1. Add a **Send Email** action to your workflow. 2. In the **To** field, enter a static email address or click **+** to insert a dynamic value (e.g., the Email field from the trigger record). 3. Write the **Subject**. Click **+** to include dynamic values like the record's name or a status. Example: `New order from {{Customer Name}} — #{{Order ID}}`. 4. Write the **Body**. You can use: * **Plain text** — just type your message. * **Markdown** — use `**bold**`, `*italic*`, `- lists`, `[links](url)`, etc. * **HTML** — for full control over formatting, write HTML tags directly. * **Dynamic variables** — click **+** anywhere in the body to insert values from previous steps. 5. (Optional) Set **Sender Name**, **CC**, **BCC**, or **Reply-To** as needed. 6. Save the action. ### Give this action its own SMTP To send this one action through a different SMTP account, click **Add config** under **Custom email server** and fill in the host, port, username, and sender details. The password is no longer typed in. Click **Select a secret** to pick one of the secrets granted to this automation, or **Add secret** to create one (default variable name `SMTP_PASSWORD`; a second SMTP account in the same workflow is numbered `SMTP_PASSWORD_2`). The action stores a reference, so the plain value never enters the workflow configuration and run history and exports show it masked. **Reset** clears the config, and the action goes back to the default email server. This dialog does not send a test email. Once it is configured, run the workflow once to confirm delivery. ## Using variables in subject and body Variables let you personalize each email. Click the **+** button in any text field to open the variable picker. You can reference: * **Trigger data:** fields from the record that triggered the automation (e.g., customer name, email, order amount). * **Previous action output:** data from earlier steps, like a newly created Record ID or AI-generated text. Example body with variables: ``` Hi {{Customer Name}}, Your order #{{Order ID}} has been confirmed. **Total:** ${{Order Amount}} **Estimated delivery:** {{Delivery Date}} Thank you for your purchase! ``` ## Body formatting options | Format | How to use | Best for | | ---------- | --------------------------------------------------- | ----------------------------------------- | | Plain text | Just type your message | Simple notifications | | Markdown | Use Markdown syntax (`**bold**`, `# heading`, etc.) | Structured messages with formatting | | HTML | Write HTML tags (`

`, `

`, ``, etc.) | Fully designed emails with custom layouts | You can mix Markdown and dynamic variables in the same body. For complex email designs, HTML gives you the most control. ## When to use * **Send order confirmations.** When a new order is created, send an email with the order details and a thank-you message. * **Notify team members of status changes.** When a task moves to "Blocked", email the assignee and their manager. * **Deliver scheduled reports.** Combine with a scheduled trigger and Get Records to email a weekly summary. * **Send personalized outreach.** Use record data to customize subject and body for each recipient. * **Confirm form submissions.** After a form is submitted, send the submitter a confirmation with their responses. ## Deliverability tips * **Use a custom SMTP** if you are sending high-volume or business-critical emails. Teable's built-in service works for basic notifications, but emails from your own domain are more likely to land in the recipient's inbox. * **Avoid spammy content** in your subject and body — excessive capitalization, exclamation marks, or link-heavy messages can trigger spam filters. * **Set a Reply-To address** so recipients can respond to a real inbox rather than a no-reply address. * **Test your emails** before activating the automation in production. Run the automation manually with test data to verify formatting and delivery. ## Related * [Set up SMTP and sender](/en/basic/automation/actions/communication/smtp-sender) — send emails from your own domain * [Loop (batch)](../logic/loop-run) — send emails in bulk by looping through a list of records * [AI generate](/en/basic/automation/actions/ai/ai-generate) — generate personalized email content with AI # Set up SMTP and sender Source: https://help.teable.ai/en/basic/automation/actions/communication/smtp-sender Configure a custom SMTP server and sender identity for automation emails By default, automation emails are sent from Teable's built-in mail service. While this works for basic notifications, you may want to send emails from your own domain for branding, deliverability, or compliance reasons. Custom SMTP configuration lets you do exactly that. When you configure a custom SMTP server, all emails sent by that action come from your own mail server and your own sender address — recipients see your domain, not Teable's. ## When to use custom SMTP * **Send emails from your company domain** (e.g., `noreply@yourcompany.com` or `support@yourcompany.com`) so recipients recognize the sender. * **Improve deliverability.** Emails from your own domain with proper SPF, DKIM, and DMARC records are less likely to land in spam. * **Meet compliance requirements.** Some industries require that automated emails originate from an organization-controlled domain. * **Use your existing email infrastructure.** Route emails through your company's mail server for logging, archival, or security scanning. * **Higher sending limits.** Teable's built-in service has rate limits. Your own SMTP server may support higher throughput. ## Configuration In the **Send Email** action, click the transport configuration option to set up a custom SMTP server: | Setting | Required | Description | | ------------ | -------- | --------------------------------------------------- | | SMTP Host | Yes | Your mail server address (e.g., `smtp.gmail.com`) | | Port | Yes | The SMTP port — usually 465 (SSL) or 587 (STARTTLS) | | Username | Yes | SMTP account username (often your email address) | | Password | Yes | SMTP account password or app-specific password | | From Address | Yes | The sender email address shown to recipients | ## How to set it up 1. Open your automation and go to the **Send Email** action. 2. Click the **transport configuration** option (gear icon or link near the sender settings). 3. Enter your SMTP server details: * **Host:** Your email provider's SMTP server address. * **Port:** Use 465 for SSL/TLS or 587 for STARTTLS. If unsure, try 465 first. * **Username:** Your email account or SMTP username. * **Password:** Your email password or, for providers like Gmail, an app-specific password. 4. Set the **From Address** — this is what recipients see as the sender. 5. Click **Test** to verify the connection. Teable will attempt to send a test email through your SMTP server. 6. If the test succeeds, save the configuration. All emails from this action will now use your SMTP server. ## Common SMTP settings by provider | Provider | Host | Port | Notes | | --------------------------- | ----------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------- | | **Gmail** | `smtp.gmail.com` | 465 | Requires an App Password (not your account password). See [Set up Gmail IMAP](../../trigger/email/gmail-imap) | | **Outlook / Microsoft 365** | `smtp.office365.com` | 587 | Use your Microsoft account credentials | | **Amazon SES** | `email-smtp.{region}.amazonaws.com` | 465 | Use SES SMTP credentials (not IAM credentials) | | **SendGrid** | `smtp.sendgrid.net` | 465 | Username is `apikey`, password is your API key | | **Mailgun** | `smtp.mailgun.org` | 465 | Use the SMTP credentials from your Mailgun domain settings | | **Zoho Mail** | `smtp.zoho.com` | 465 | Use your Zoho account credentials | | **Yahoo Mail** | `smtp.mail.yahoo.com` | 465 | Requires an App Password | | **Postmark** | `smtp.postmarkapp.com` | 587 | Use your Postmark server API token as both username and password | | **Custom / Self-hosted** | Your server address | Varies | Check with your IT team for host, port, and credentials | ## Common errors and fixes When a run fails to send, open the workflow's **Run history** and check the output of the **Send Email** step. For a custom SMTP server, the step reports the rejection your mail server returned: its reply code, the SMTP command that failed, the rejected recipients, and the host. Match that against the causes below. | Error | Likely Cause | Fix | | -------------------------------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | **Connection refused** | Wrong host or port | Double-check the SMTP host and port. Try switching between 465 and 587 | | **Authentication failed** | Wrong username or password | Verify credentials. For Gmail/Yahoo, use an App Password instead of your account password | | **Certificate error / TLS handshake failed** | Port/encryption mismatch | Port 465 expects SSL; port 587 expects STARTTLS. Make sure the port matches your server's encryption | | **Sender address rejected** | From Address does not match SMTP account | Some providers require the From Address to match the authenticated account. Check your provider's policy | | **Rate limit exceeded** | Too many emails sent too quickly | Reduce sending frequency or upgrade your email plan. Use batch sending with delays if needed | | **Timeout** | Firewall or network issue | Ensure your network allows outbound connections on the SMTP port. Self-hosted Teable users: check server firewall rules | ## Tips * **Test before going live.** Always send a test email after configuring SMTP to confirm everything works. * **Use app-specific passwords** for Gmail, Yahoo, and other providers that support two-factor authentication. Your regular account password will not work if 2FA is enabled. * **Set up SPF, DKIM, and DMARC** on your domain's DNS records to improve email deliverability and prevent your emails from being flagged as spam. * **Keep credentials secure.** SMTP passwords are stored encrypted in Teable, but avoid sharing automation configurations with sensitive credentials. When a single action is configured with its own SMTP account, its password is a secret granted to that automation; see [Send email](/en/basic/automation/actions/communication/send-email-overview). * **Monitor delivery.** If emails stop arriving, check your SMTP provider's dashboard for bounced messages, rate limit warnings, or account issues. For Gmail, use an App Password instead of your account password. See [Set up Gmail IMAP](../../trigger/email/gmail-imap) for how to create one. ## Related * [Send email action](/en/basic/automation/actions/communication/send-email-overview) — the action that uses SMTP configuration * [Set up Gmail IMAP](../../trigger/email/gmail-imap) — instructions for Gmail App Passwords # HTTP request Source: https://help.teable.ai/en/basic/automation/actions/logic/http-request Call any external API from a workflow We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it picks the right trigger, chooses the appropriate actions, maps the fields, and configures the entire workflow automatically. Describe the goal once, and the workflow is ready — no manual setup needed. Sends an HTTP request to any URL and returns the response. Use it to call REST APIs, send notifications to Slack or Discord, push data to CRMs, or interact with any service that has an HTTP API. ## Configuration | Setting | Required | Description | | ------------ | -------- | ----------------------------------------------------------------------- | | URL | Yes | The target endpoint. Supports dynamic variables via **+** | | Method | Yes | GET, POST, PUT, PATCH, DELETE, or HEAD | | Headers | No | Custom HTTP headers as key-value pairs | | Content-Type | No | The format of the request body (see below) | | Body | No | The request payload — text or key-value pairs depending on Content-Type | ## How to set it up 1. Add an **HTTP Request** action to your workflow. 2. Enter the **URL** of the API endpoint. You can use **+** to insert dynamic values (e.g., include a Record ID in the URL path). 3. Choose the **Method**: * **GET** — retrieve data. * **POST** — send data to create something. * **PUT / PATCH** — update existing data. * **DELETE** — remove data. 4. Add **Headers** if the API requires them (e.g., authorization tokens, custom headers). 5. Choose a **Content-Type** and write the **Body** if needed (for POST, PUT, PATCH). 6. Save the action. ## Content-Type options explained | Content-Type | When to use | Body format | | ----------------------------------- | ---------------------------------------------- | ------------------------------------------ | | `application/json` | Most REST APIs. Send structured data | JSON text (e.g., `{"key": "value"}`) | | `application/x-www-form-urlencoded` | Traditional form submissions, some legacy APIs | Key-value pairs, URL-encoded automatically | | `multipart/form-data` | File uploads or mixed data | Key-value pairs with file support | | `text/plain` | Simple text payloads | Plain text string | If you are unsure which Content-Type to use, choose `application/json`. Most modern APIs use JSON. If you are unsure which to use, `application/json` is the right choice for most modern APIs. ## Authentication examples Many APIs require authentication. Here are common patterns you can set up in the Headers section: ### Bearer Token Add a header: * **Key:** `Authorization` * **Value:** `Bearer your-api-token-here` This works for APIs like Slack, GitHub, Notion, and many others. ### API Key in header Add a header: * **Key:** `X-API-Key` (or whatever the API expects, e.g., `api-key`, `x-api-token`) * **Value:** `your-api-key` ### Basic Authentication Add a header: * **Key:** `Authorization` * **Value:** `Basic base64encoded(username:password)` You will need to Base64-encode your credentials outside of Teable or use a Script action to generate the header value. ## Concrete example: send a Slack notification Goal: Post a message to a Slack channel when a new record is created. 1. **Trigger:** When record created. 2. **Action:** HTTP Request with: * **URL:** `https://hooks.slack.com/services/T00/B00/xxxx` (your Slack webhook URL) * **Method:** POST * **Content-Type:** `application/json` * **Body:** ```json theme={null} { "text": "New task created: {{Task Name}} — Priority: {{Priority}}" } ``` Replace `{{Task Name}}` and `{{Priority}}` with dynamic variables from the trigger by clicking **+**. ## Using response data in next steps After the HTTP request runs, the response is available to subsequent actions: * **Status code** — the HTTP status (200, 201, 404, etc.). * **Response body** — the data returned by the API, parsed as JSON if applicable. You can reference specific fields from the response using the **+** variable picker in later steps. For example, if the API returns `{"id": "abc123", "status": "created"}`, you can reference `id` and `status` individually. When inserting dynamic values with **+**, you can also use field paths and formatting options when an external API requires a specific request format. This is useful for chaining API calls — for example, create something via POST, get back an ID, then use that ID in a subsequent Update Record or another HTTP request. ## When to use * **Post messages to Slack or Discord.** Send notifications to channels using incoming webhook URLs. * **Sync data with a CRM or ERP.** Push new or updated records to Salesforce, HubSpot, or any system with an API. * **Call any third-party API.** Interact with payment processors, shipping services, analytics tools, or custom internal APIs. * **Trigger external workflows.** Call Zapier webhooks, Make (Integromat) scenarios, or other automation platforms. * **Fetch data from external sources.** Use GET requests to pull exchange rates, weather data, or any public API data into your workflow. ## Tips * Always check the API's documentation for required headers, authentication, and expected body format. * Use `application/json` as the Content-Type for most modern APIs. If the API expects form data, switch to `x-www-form-urlencoded`. * If the API returns an error (4xx or 5xx status), the action still completes — but subsequent steps will see the error response. Check the status code in your workflow if you need conditional handling. * For APIs that return large responses, only reference the specific fields you need in subsequent steps. * Combine with [Loop (Batch)](/en/basic/automation/actions/logic/loop-run) to make multiple API calls, one per record. Be mindful of the external API's rate limits. * Use the [HTTP Array Body](/en/basic/automation/actions/logic/loop-run) feature when you need to send multiple items in a single request instead of one request per item. ## Related * [Loop (batch)](/en/basic/automation/actions/logic/loop-run) — make HTTP requests for each item in an array * [When webhook received](/en/basic/automation/trigger/external/webhook-received) — the inbound counterpart: receive HTTP requests from external systems * [Run script](/en/basic/automation/ai/scripting/runscript) — for more complex API interactions with custom code # Loop (batch) Source: https://help.teable.ai/en/basic/automation/actions/logic/loop-run Process multiple items in one action by iterating over an array We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. Loop lets you run an action **once per item** in an array. Instead of processing a single record or sending a single email, Loop repeats the action for every item in a list — creating records in bulk, sending personalized emails to a list of contacts, or making API calls for each item. Items are processed in order, and the results from all iterations are returned as an array that subsequent steps can use. ## Supported actions | Action | Loop Support | | ------------- | ------------ | | Create Record | Yes | | Update Record | Yes | | Send Email | Yes | | HTTP Request | Yes | | AI Generate | Yes | ## Where arrays come from To use Loop, you need an array as input. Common sources include: | Source | What you get | | ------------------------------------ | -------------------------------------------------------------- | | **Get Records** action | An array of records from a table query | | **Webhook received** trigger | The JSON body may contain arrays (e.g., a list of order items) | | **AI Generate** action (JSON output) | The AI can return an array of structured items | | **HTTP Request** action | An API response that contains an array | | **Script** action | A script can output any array via `output.set()` | ## How to set it up 1. Open a supported action (e.g., Create Record, Send Email). 2. Click **Loop Run** below the table selector (or in the action configuration area). 3. In the data source picker, select an **array variable** from a previous step. For example, the records array from a Get Records step. 4. The field mapping area now shows the properties of each individual item (not the full array). Click **+** to reference properties of the **current item** — for example, the current record's Name, Email, or Status. 5. Save the action. When the workflow runs, the action executes once per item in the array. ## How to reference the current item When Loop is active, the **+** variable picker shows properties of the current item in the iteration. For example: * If looping over Get Records output, you can reference `current item → fields → Name`, `current item → fields → Email`, etc. * If looping over a webhook array, you can reference `current item → product_name`, `current item → quantity`, etc. This is different from non-loop mode, where you reference the full array or a specific index. ## Concrete example: send reminder emails to overdue tasks 1. **Trigger:** At scheduled time — every day at 9:00 AM. 2. **Action 1:** Get Records — from Tasks table, filter: Due Date is before today AND Status is not "Done". 3. **Action 2:** Send Email with **Loop** enabled, data source = Action 1's records array. * **To:** current item's Assignee Email field. * **Subject:** `Reminder: "{{current item → Task Name}}" is overdue` * **Body:** `Hi {{current item → Assignee Name}}, your task "{{current item → Task Name}}" was due on {{current item → Due Date}}. Please update it.` Result: one personalized email per overdue task. ## HTTP Array Body For HTTP Request actions, Loop offers a special **Array Body** mode. Instead of sending one HTTP request per item (which can be slow and hit rate limits), Array Body sends the **entire array as a single JSON array** in one request. This is useful when the external API supports batch operations — for example, creating multiple records in one API call or sending a batch of events to an analytics service. To use Array Body: 1. Enable Loop on an HTTP Request action. 2. Choose **Array Body** mode instead of the default per-item mode. 3. The entire array is serialized as a JSON array and sent in the request body. ## Performance considerations * Loop processes items **sequentially**, not in parallel. A loop over 100 items will take roughly 100 times as long as a single execution. * For large arrays (hundreds or thousands of items), consider whether the external action can handle batch input. Use HTTP Array Body when the API supports it. * If you are looping over Get Records output and making HTTP requests for each record, be mindful of the external API's rate limits. * For very large datasets, consider breaking the work into smaller batches using pagination in Get Records (Skip/Take), with multiple automation runs. ## When to use * **Bulk-create records.** Get records from one table, loop to create corresponding records in another table. * **Send personalized emails to a list.** Get a list of contacts, loop to send each one a customized email. * **Update multiple records.** Get records that match a condition, loop to update each one (e.g., mark all overdue tasks as "Escalated"). * **Make API calls for each record.** Push each record's data to an external system, one at a time. * **AI-process a batch of records.** Loop over records and use AI Generate to classify, summarize, or extract data from each one. ## Tips * Always check the size of your array before enabling Loop. If Get Records returns 1,000 records, your loop will run 1,000 times. * If your loop creates or updates records in the same table that triggered the automation, be careful about re-triggering the automation. Use filters on the trigger to avoid loops. * The results of all loop iterations are available as an array in subsequent steps, but for very large loops, this array can be large. Reference only what you need. ## Related * [Get records](/en/basic/automation/actions/records/get-records) — the most common source of arrays for Loop * [Create record](/en/basic/automation/actions/records/create-record) — commonly used inside a Loop to bulk-create records * [HTTP request](/en/basic/automation/actions/logic/http-request) — commonly used inside a Loop for per-item API calls * [Send email](/en/basic/automation/actions/communication/send-email-overview) — commonly used inside a Loop for bulk email sends # Conditional logic Source: https://help.teable.ai/en/basic/automation/actions/manual/conditional-logic Add if/else branching to control which actions run We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. Conditions let you add decision points. The workflow splits into a **true** path and a **false** path. ## How to Use 1. Add a **Condition** node between steps. 2. Define one or more rules. 3. Click **Test** to validate. ## Operators by Field Type ### Text | Operator | Meaning | | --------------------------- | --------------- | | is / is not | Exact match | | contains / does not contain | Substring match | | is empty / is not empty | Null check | ### Number | Operator | Meaning | | ----------------------- | ----------------- | | = / ≠ | Equal / not equal | | > / ≥ / \< / ≤ | Comparison | | is empty / is not empty | Null check | ### Date | Operator | Meaning | | -------------------------------- | -------------- | | is / is not | Exact date | | is before / is after | Comparison | | is on or before / is on or after | Inclusive | | is within | Relative range | | is empty / is not empty | Null check | **Relative dates:** today, tomorrow, yesterday, one week ago/from now, one month ago/from now, X days ago/from now. **Ranges (for "is within"):** past/next week, past/next month, past/next year, past/next N days. ### Single Select / Multiple Select | Operator | Meaning | | ------------------------------------- | -------------- | | has any of / has all of / has none of | Set membership | | is exactly / is not exactly | Exact match | | is empty / is not empty | Null check | ### Boolean | Operator | | ----------------- | | is (true / false) | ## Combining Rules * **AND** — all rules must be true * **OR** — any rule can be true * **NOT** — negate a rule or group Groups can be nested: ``` (status is "Active" OR status is "Pending") AND amount > 1000 ``` # Create record Source: https://help.teable.ai/en/basic/automation/actions/records/create-record Create a new record in any table as part of a workflow We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it picks the right trigger, chooses the appropriate actions, maps the fields, and configures the entire workflow automatically. Describe the goal once, and the workflow is ready — no manual setup needed. Creates a new record in a specified table. You can map data from previous steps into the new record's fields. After creation, the new Record ID and all field values are available to subsequent steps. ## Configuration | Setting | Required | Description | | ------- | -------- | ---------------------------------------------------------------------------------------- | | Table | Yes | The target table where the new record will be created | | Fields | Yes | Map each field to a value — static text/numbers or dynamic variables from previous steps | ## How to set it up 1. Add a **Create Record** action to your workflow. 2. Choose the **Table** where you want the record created. By default this is a table in the same base, but you can use [Cross-Base Access](/en/basic/automation/actions/records/cross-base) to target a table in another base. 3. The field mapping area shows all fields in the target table. For each field you want to fill: * **Static value:** Type a value directly into the field (e.g., type "New" for a Status field). * **Dynamic value:** Click the **+** button next to the field to insert a variable from a previous step. For example, insert the trigger's "Name" field to copy the name from the triggering record. 4. You can mix static and dynamic values. For example, set Status to the static value "Pending" while setting Customer Name to a dynamic value from the trigger. 5. Save the action. You can combine multiple variables in a single text field. For example, insert `Trigger record's Customer Name - Trigger record's Order ID` into a "Summary" field. ## What happens with required fields If a required field has a default value and you leave it unmapped, Teable fills the default value when the record is created. If a required field has no default value, or a mapped value is empty at runtime, the action fails. To check which fields are required, look at the field configuration in your target table. Required fields are typically marked with an asterisk or a "Required" label. ## Output: using the created record in later steps After the Create Record action runs, the newly created record is available to all subsequent steps. This includes: * **Record ID** — the unique identifier assigned to the new record. * **All field values** — every field value of the created record, including any auto-calculated or default values. This is useful when you need to chain actions. For example: create a record, then immediately send an email that includes a link to that record, or update a related record with the new Record ID. ## When to use * **Log form submissions into a separate table.** When a form is submitted, create a record in a "Submissions Log" table with the submitted data plus a timestamp. * **Create follow-up tasks automatically.** When a project is created, create a set of default tasks in a related Tasks table. * **Duplicate records across tables.** Copy data from one table to another — for example, moving a lead from "Prospects" to "Active Clients" when a deal closes. * **Generate records from external data.** When a webhook delivers order data, create a new record in your Orders table with the order details. * **Create audit trail entries.** After any automation runs, create a record in an Audit Log table documenting what happened. ## Tips * If you are creating records in the same table that has a **When record created** trigger, be careful about infinite loops. Use a filter on the trigger to exclude automation-created records (e.g., check for a "Source" field set to "Automation"). * You can create records in bulk by combining this action with [Loop (Batch)](../logic/loop-run). For example, get 50 records from one table and create 50 corresponding records in another. * Fields you do not map will use the table's default values (if any) or remain empty. * Linked record fields expect Record IDs, not display values. If you need to link to a record, make sure you are passing the Record ID, not the record's name. * Use [Cross-Base Access](/en/basic/automation/actions/records/cross-base) when the target table is in a different base than the automation. ## Related * [Update record](/en/basic/automation/actions/records/update-record) — modify existing records instead of creating new ones * [Get records](/en/basic/automation/actions/records/get-records) — retrieve records to use as input for creating new ones * [Cross-base access](/en/basic/automation/actions/records/cross-base) — create records in tables outside the current base * [Loop (batch)](../logic/loop-run) — create multiple records in a single action step # Cross-base access Source: https://help.teable.ai/en/basic/automation/actions/records/cross-base Read and write data across different bases in a single workflow We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. By default, automation actions operate on tables within the workflow's own base. Cross-Base Access lets a workflow read from and write to another base. Use it for workflows that span departments, projects, or datasets. For example, a Sales base automation can create a fulfillment record in a separate Operations base, or a reporting workflow can pull data from multiple project bases into a single summary. ## Supported actions | Action | Cross-Base Support | | ------------- | ------------------ | | Create Record | Yes | | Update Record | Yes | | Get Records | Yes | These are the three record-oriented actions. Other actions (Send Email, HTTP Request, etc.) do not need cross-base access because they do not target a specific table. ## How to set it up 1. Open a supported action (Create Record, Update Record, or Get Records) in your workflow. 2. Next to the **Table** selector, click **Cross-Base Access**. 3. A panel opens showing all spaces and bases your account can access. Select the target **Space**, then the target **Base**. 4. Choose the **Table** within that base. If the action supports it, you can also select a specific **View**. 5. Map fields and configure the action as usual. The field list now reflects the target table's fields, not the current base's fields. 6. Save the action. ## Concrete example: Sales to Fulfillment Imagine you have two bases: * **Sales Base** — contains a "Deals" table where the sales team tracks closed deals. * **Operations Base** — contains a "Fulfillment" table where the ops team manages shipping. You want to automatically create a fulfillment record when a deal closes: 1. **Trigger:** In the Sales Base, use "When record matches conditions" with filter: `Stage` equals `Closed Won`. 2. **Action:** Create Record with Cross-Base Access pointing to the Operations Base > Fulfillment table. 3. **Field mapping:** Map the deal's Customer Name, Product, Quantity, and Shipping Address to the corresponding fields in the Fulfillment table. Now, every time a deal closes, a fulfillment record is automatically created in the Operations Base — no manual handoff needed. ## Permission model When you create, edit, or apply workflow updates, Teable checks each cross-base action against the current editor's permissions: | Action | Required permission on the target base | | ------------- | -------------------------------------------- | | Get Records | Read fields and records | | Create Record | Read fields and records, plus create records | | Update Record | Read fields and records, plus update records | Active workflow runs use Teable's automation runtime identity for the target base. Records created or updated by a cross-base action appear as **Automation Robot** in record metadata and audit surfaces. ### What happens when access changes If the current editor does not have the required permission on the target base, Teable blocks that editor from adding or changing cross-base actions that point to that base. If a draft already contains cross-base actions the editor cannot access, Teable also blocks applying that draft. The already active version keeps running; Teable checks permissions again the next time someone edits or applies the workflow. To fix a permission error while editing or applying a workflow: 1. Ask someone with access to both bases to edit and apply the workflow. 2. Or restore the required permissions on the target base, then apply the workflow again. ## Tips * Cross-base access can reach bases in different **Spaces**. The editor configuring or applying the workflow must have the required target-base permissions. * When mapping fields across bases, field types must be compatible. For example, you cannot map a text field to an attachment field. * If you restructure a target base (rename tables, delete fields), the cross-base actions referencing those tables and fields will break. Update your workflow after making structural changes. * For complex cross-base workflows, consider centralizing your automations in one "hub" base to keep things organized. ## Related * [Create record](/en/basic/automation/actions/records/create-record) — create records in the current or another base * [Update record](/en/basic/automation/actions/records/update-record) — update records in the current or another base * [Get records](/en/basic/automation/actions/records/get-records) — retrieve records from the current or another base # Get records Source: https://help.teable.ai/en/basic/automation/actions/records/get-records Retrieve records from a table with optional filters and pagination We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it picks the right trigger, chooses the appropriate actions, maps the fields, and configures the entire workflow automatically. Describe the goal once, and the workflow is ready — no manual setup needed. Retrieves records from a table and returns them as an array. Use the results in later steps to loop through records, pass data to a script, or feed into other actions. ## Configuration | Setting | Required | Description | | ------- | -------- | ----------------------------------------------------------------------------------------------------------- | | Table | Yes | The table to query | | View | No | Limit results to records visible in a specific view (inherits the view's filters, sorts, and hidden fields) | | Filter | No | Additional filter conditions applied on top of any view filter | | Skip | No | Number of records to skip from the beginning (for pagination) | | Take | No | Maximum number of records to return (for pagination) | ## How to set it up 1. Add a **Get Records** action to your workflow. 2. Choose the **Table** you want to query. Use [Cross-Base Access](/en/basic/automation/actions/records/cross-base) if the table is in a different base. 3. (Optional) Select a **View** to inherit that view's filter, sort, and field visibility settings. 4. (Optional) Add **Filter** conditions to narrow the results. For example, `Status` equals `Active` and `Due Date` is before today. 5. (Optional) Set **Skip** and **Take** for pagination. For example, Skip 0 and Take 100 to get the first 100 records. 6. Save the action. When the workflow runs, the results will be available as an array for subsequent steps. ## Output: working with the results The output is an **array of records**. Each record in the array contains: * **Record ID** — the unique identifier. * **All field values** — every field in the table (or view, if you selected one). ### Using results in the next step * **Reference a single record:** If you only expect one result (or want the first one), you can reference fields from the first record directly using the **+** variable picker. * **Loop through all records:** Add a [Loop (Batch)](../logic/loop-run) action after Get Records and select the results array as the data source. Inside the loop, reference each item's fields. * **Process in a script:** Pass the array to a [Run script](/en/basic/automation/actions/ai/ai-script) step for custom processing, filtering, or transformation. ## Pagination If you do not set **Skip** and **Take**, the action returns records up to the system default limit. For large tables, use pagination to control the result size: | Setting | Purpose | Example | | ------- | --------------------------------------- | ------------------------------ | | Skip | How many records to skip from the start | `0` (start from the beginning) | | Take | How many records to return | `100` (return 100 records) | To process an entire large table, you could use multiple Get Records steps with increasing Skip values, or handle pagination in a script. ## When to use * **Find overdue tasks to send reminders.** Filter for tasks where Due Date is before today and Status is not "Done". Loop through the results and send an email for each. * **Gather data for a daily digest.** Retrieve all records updated in the last 24 hours and compile them into a summary email. * **Look up related records before creating or updating.** Before creating a duplicate, check if a record with the same email already exists. * **Feed data into an AI action.** Get records with long text fields, then use AI Generate in a loop to summarize or classify each one. * **Sync records to an external system.** Get all records that have changed since the last sync, then push them to a CRM or data warehouse via HTTP requests. ## Tips * **Use filters.** The more specific your filter, the fewer records are returned and the faster the action runs. * **Limit results with Take.** If you only need the first 10 records, set Take to 10. There is no need to retrieve thousands of records when you only need a few. * **Select a View** that already filters and sorts the data you need. This keeps your automation configuration simpler. * **Avoid fetching the entire table** unless you genuinely need all records. Large result sets take longer to process and use more resources, especially when combined with Loop. * Get Records does not modify any data — it is read-only. * If the query returns zero records, subsequent steps referencing the results will receive an empty array. Make sure your workflow handles this gracefully (e.g., do not send an email saying "here are your results" when there are no results). * Filters in Get Records work the same as view filters: you can combine conditions with AND/OR logic. * When using Cross-Base Access, the query runs under the workflow creator's permissions. If the creator loses access to the target base, the step will fail. ## Related * [Cross-base access](/en/basic/automation/actions/records/cross-base) — query tables in other bases * [Loop (batch)](../logic/loop-run) — iterate over the results array * [Create record](/en/basic/automation/actions/records/create-record) — create records based on retrieved data * [Update record](/en/basic/automation/actions/records/update-record) — update records found by Get Records # Update record Source: https://help.teable.ai/en/basic/automation/actions/records/update-record Modify fields in an existing record as part of a workflow We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it picks the right trigger, chooses the appropriate actions, maps the fields, and configures the entire workflow automatically. Describe the goal once, and the workflow is ready — no manual setup needed. Updates one or more fields in an existing record. Only the fields you map will change — everything else stays the same. ## Configuration | Setting | Required | Description | | --------- | -------- | ----------------------------------------------------------------------------------------------- | | Table | Yes | The table containing the record to update | | Record ID | Yes | Which record to update. Supports dynamic variables and comma-separated IDs for multiple records | | Fields | Yes | Map each field to its new value — static or dynamic | ## How to set it up 1. Add an **Update Record** action to your workflow. 2. Choose the **Table** that contains the record you want to modify. 3. Set the **Record ID**. Click **+** to insert a dynamic variable: * From a **record trigger** (created, updated, button clicked): the trigger provides the Record ID directly. * From a **Get Records** action: reference the Record ID from the retrieved results. * You can also type a static Record ID or use a comma-separated list to update multiple records at once (e.g., `rec123,rec456,rec789`). 4. Map the fields you want to change. For each field: * **Static value:** Type the new value directly. * **Dynamic value:** Click **+** to insert a value from a previous step. 5. Leave fields you do not want to change unmapped — they will keep their current values. 6. Save the action. ## How to get the Record ID The Record ID is the key piece of information this action needs. Here is where to find it depending on your trigger: | Trigger / Previous Step | How to get Record ID | | ----------------------- | ------------------------------------------------------------------------------------- | | When record created | Available directly as a trigger output variable | | When record updated | Available directly as a trigger output variable | | When button clicked | Available directly — it is the row where the button was clicked | | When form submitted | Available directly — it is the record created by the submission | | Get Records action | Each record in the results has an ID. In a Loop, reference the current item's ID | | Webhook received | You must include the Record ID in the webhook payload, or look it up with Get Records | Need to update multiple records at once? You can pass comma-separated Record IDs, or use [Loop (Batch)](../logic/loop-run) with a Get Records result to update records in bulk. ## Partial updates This action performs a partial update. This means: * **Mapped fields** are overwritten with the new values you specify. * **Unmapped fields** are left exactly as they are. You do not need to re-send all field values — just the ones you want to change. This is safe and efficient. ## Warning: trigger loops If your workflow uses a "When record updated" trigger and a subsequent step updates the same watched fields in the same table, the workflow will fire again, creating an infinite loop. If your automation is triggered by **When record updated** and your Update Record action writes back to the **same table**, you can create an infinite loop: 1. Record changes → trigger fires → automation updates the record → trigger fires again → and so on. **How to prevent loops:** * **Watch specific fields** on the trigger that are *different* from the fields you update. For example, watch "Status" but update "Processed Date". * **Add a filter** to the trigger. For example, trigger only when `Processed` is not `true`, and set `Processed` to `true` in your action. * Consider using [When record matches conditions](/en/basic/automation/trigger/records/record-matches-conditions) instead, which only fires on state transitions. ## When to use * **Mark a task as complete after approval.** When a button is clicked, set Status to "Approved" and fill in the approval date. * **Update a status field based on external events.** When a webhook reports a payment, find the order record and update its status to "Paid". * **Write a timestamp when something changes.** When a record is updated, set a "Last Modified By Automation" date field to the current time. * **Sync data back from an external system.** After calling an external API, write the response data (e.g., a tracking number) back into the record. * **Batch-update records.** Combine with Get Records and Loop to update multiple records at once — for example, marking all overdue tasks as "Escalated". ## Tips * Updating a record may trigger other automations watching the same table. Be aware of cascading effects. * When updating multiple records with comma-separated IDs, all records receive the same field values. For different values per record, use a [Loop](../logic/loop-run) step instead. * If you need to clear a field, map it to an empty value. Simply leaving it unmapped will *not* clear it. * Use [Cross-Base Access](/en/basic/automation/actions/records/cross-base) to update records in a table that lives in a different base. ## Related * [Create record](/en/basic/automation/actions/records/create-record) — add new records instead of modifying existing ones * [Get records](/en/basic/automation/actions/records/get-records) — retrieve records to find their IDs before updating * [Cross-base access](/en/basic/automation/actions/records/cross-base) — update records in tables outside the current base * [Loop (batch)](../logic/loop-run) — update multiple records with different values # Run script Source: https://help.teable.ai/en/basic/automation/ai/scripting/runscript Run custom JavaScript in a secure sandbox for logic that goes beyond built-in actions We strongly recommend using Run script to build automations, because it can cover all action behaviors, including actions that would otherwise need to be built manually. Just describe your requirements to AI in chat. Please note: if you add actions manually, AI will not recognize or modify them later. The Run script action lets you write custom JavaScript to handle logic that built-in actions cannot cover. You can transform data, call external APIs, perform calculations, implement conditional branching, and more — all within a secure sandbox environment. Scripts receive data from previous steps via the `input` object and pass results to subsequent steps via the `output.set()` function. ## When to use Run script vs. built-in actions | Scenario | Use built-in actions | Use Run script | | --------------------------------------------- | --------------------- | -------------------------------------------------------------------- | | Create, update, or get records | Yes | Only if you need complex logic around it | | Send a simple email | Yes | No | | Call a single API endpoint | Yes (HTTP Request) | Only if you need to process the response in complex ways | | Transform data between steps | Sometimes | Yes — when you need conditional logic, loops, or string manipulation | | Parse complex JSON structures | No | Yes | | Calculate dates, format numbers | No | Yes | | Chain multiple API calls with logic | Awkward with built-in | Yes | | Implement business rules with many conditions | Not practical | Yes | In general, use built-in actions when they fit your needs. Use Run script when you need custom logic, data transformation, or complex API interaction. ## Environment | Property | Value | | -------- | ---------------------------------------------- | | Language | JavaScript (ES6+), top-level `await` supported | | Runtime | Secure sandbox with a 60-second timeout | | Modules | CommonJS (`require()`), npm packages supported | | Network | HTTP requests via `fetch()` | ## How to set it up 1. Add a **Run script** action to your workflow. 2. The script editor opens with a blank canvas. Write your JavaScript code here. 3. Your script can read data from previous steps using the `input` object (see below). 4. Use `output.set(key, value)` to pass results to subsequent steps. 5. (Optional) Add npm dependencies in the configuration panel if your script needs external libraries. 6. Click **Test** to run the script with real data from the most recent trigger execution. 7. Check the test output and console logs to verify your script works correctly. 8. Save the action. ## Reading input data The `input` object contains data from all previous steps in the workflow. Each step is identified by its action ID. ### Input structure ```javascript theme={null} // input is an object keyed by action IDs // Each key contains the output of that step const actionIds = Object.keys(input); // actionIds might be: ["triggerStep1", "actionStep2", "actionStep3"] ``` ### Getting trigger data (record fields) ```javascript theme={null} const actionIds = Object.keys(input); const triggerData = input[actionIds[0]]; // First entry is usually the trigger // For record-based triggers (created, updated, button clicked, form submitted): const recordId = triggerData.record.id; const fields = triggerData.record.fields; // Access specific fields by field ID const customerName = fields.fldXXXXXXX; // Replace with actual field ID const orderAmount = fields.fldYYYYYYY; ``` ### Getting data from a Get Records step ```javascript theme={null} const actionIds = Object.keys(input); const getRecordsData = input[actionIds[1]]; // Second step, for example const records = getRecordsData.records; records.forEach(record => { console.log(record.id, record.fields.fldName); }); ``` ### Getting data from other action outputs ```javascript theme={null} const actionIds = Object.keys(input); const previousOutput = input[actionIds[2]]; // Third step output // The structure depends on what that action outputs ``` Use `console.log(JSON.stringify(input, null, 2))` during testing to see the exact structure of your input data. This is the fastest way to understand what is available. ## Writing output Use `output.set(key, value)` to make data available to subsequent steps. You can set multiple keys. ```javascript theme={null} // Set simple values output.set("status", "success"); output.set("count", 42); // Set objects output.set("result", { name: "Alice", score: 95, passed: true }); // Set arrays output.set("items", [ { id: 1, name: "Item A" }, { id: 2, name: "Item B" } ]); ``` Each key you set becomes a separate variable that subsequent steps can reference via the **+** variable picker. For example, if you call `output.set("status", "success")`, the next step can reference `status` from this script's output. ## Debugging with console.log During development, use `console.log()` to inspect data and track execution flow. Log output appears in the test panel when you click **Test**. ```javascript theme={null} const actionIds = Object.keys(input); console.log("Action IDs:", actionIds); const data = input[actionIds[0]]; console.log("Trigger data:", JSON.stringify(data, null, 2)); // Log intermediate results const processed = data.record.fields.fldName.toUpperCase(); console.log("Processed name:", processed); output.set("name", processed); ``` Console logs are only visible during testing — they do not appear in production run history. Use them liberally while building your script. ## npm package management You can use npm packages in your scripts. Declare dependencies in the configuration panel: ```json theme={null} [ { "name": "lodash", "version": "4.17.21" }, { "name": "dayjs", "version": "1.11.10" } ] ``` Then use them in your script with `require()`: ```javascript theme={null} const _ = require("lodash"); const dayjs = require("dayjs"); const actionIds = Object.keys(input); const records = input[actionIds[0]].records; const grouped = _.groupBy(records, r => r.fields.fldCategory); const today = dayjs().format("YYYY-MM-DD"); output.set("grouped", grouped); output.set("date", today); ``` Prefer built-in JavaScript features over npm packages when possible. Modern JavaScript has many utilities built in — `Array.map()`, `Array.filter()`, `Object.entries()`, template literals, destructuring, etc. Only add npm packages when they provide significant value. ## Built-in variables | Variable | Description | | ------------------------------ | ----------------------------------------------------------------------------------------- | | `process.env.AUTOMATION_TOKEN` | A Bearer token for calling the Teable API. Scoped to the current automation's permissions | | `process.env.PUBLIC_ORIGIN` | The base URL of your Teable instance (e.g., `https://app.teable.io`) | ### Security: AUTOMATION\_TOKEN scope The `AUTOMATION_TOKEN` is automatically generated for each automation run. It has the same permissions as the automation creator and is scoped to the current execution. Key points: * It can access any table the automation creator has access to. * It is valid only for the duration of the script execution (60-second timeout). * Do not expose this token to external systems — it is meant for calling the Teable API from within your script. ### Calling the Teable API ```javascript theme={null} const base = process.env.PUBLIC_ORIGIN + "/api"; const token = process.env.AUTOMATION_TOKEN; // Example: get records from a table const res = await fetch(`${base}/table/tblXXXXXXX/record?take=10`, { headers: { Authorization: `Bearer ${token}`, "Content-Type": "application/json" } }); const data = await res.json(); console.log("Fetched records:", data); output.set("records", data); ``` ### Calling AI from a script `POST /api/automation/runtime/ai` sends a prompt to your base's AI model. The base comes from the automation's context, so no base ID is needed. The body takes `prompt`, plus optional `attachments`, `modelKey`, `temperature`, and `outputType`; the response is `{ "message": ... }`. Attachments are `{ url, mimetype, name }` items, up to 10 per call, each under 20MB and 30 seconds to download, covering images, PDFs, and Office documents. The default chat model may not read images and similar attachments, so pass `modelKey` when you send files. Each call consumes credits. ## Error handling Always wrap risky operations in try/catch blocks so your workflow can handle failures gracefully: ```javascript theme={null} try { const res = await fetch("https://api.example.com/data"); if (!res.ok) { throw new Error(`API returned ${res.status}: ${res.statusText}`); } const data = await res.json(); output.set("success", true); output.set("data", data); } catch (error) { console.log("Error:", error.message); output.set("success", false); output.set("error", error.message); } ``` Without error handling, a failed fetch or unexpected data format will crash the script, and subsequent steps will not receive any output. ## Complete example: process and route support tickets ```javascript theme={null} const actionIds = Object.keys(input); const record = input[actionIds[0]].record; const subject = record.fields.fldSubject || ""; const body = record.fields.fldBody || ""; const email = record.fields.fldEmail || ""; // Simple keyword-based routing const text = (subject + " " + body).toLowerCase(); let category = "General"; let priority = "Normal"; if (text.includes("billing") || text.includes("invoice") || text.includes("payment")) { category = "Billing"; } else if (text.includes("bug") || text.includes("error") || text.includes("crash")) { category = "Technical"; priority = "High"; } else if (text.includes("cancel") || text.includes("refund")) { category = "Account"; priority = "High"; } // Check for VIP customers const vipDomains = ["bigcorp.com", "enterprise.io"]; const domain = email.split("@")[1] || ""; if (vipDomains.includes(domain)) { priority = "Urgent"; } output.set("category", category); output.set("priority", priority); output.set("isVIP", vipDomains.includes(domain)); ``` ## Tips * **Start with console.log.** When building a new script, log the entire `input` object first to understand its structure. * **Keep scripts focused.** Do one thing well rather than cramming multiple tasks into one script. Chain multiple Run script actions if needed. * **Mind the 60-second timeout.** Long-running operations (large data processing, many sequential API calls) can hit the timeout. Break large tasks into smaller chunks. * **Test with real data.** The test panel uses actual data from the most recent trigger execution, giving you realistic results. * **Handle missing data.** Use default values (`||` operator) for fields that might be empty or undefined. ## Related * [AI generate](/en/basic/automation/actions/ai/ai-generate) — for prompt-based AI tasks that do not need custom code * [HTTP request](/en/basic/automation/actions/logic/http-request) — for simple API calls that do not need scripting # Auto-classify new form entries with AI Source: https://help.teable.ai/en/basic/automation/examples/ai-classify-forms Use AI Generate to automatically categorize form submissions We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"When someone submits the feedback form, classify the feedback as Bug Report, Feature Request, or General Feedback, and write the category back to the record"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. ## Manual setup 1. **Create a workflow** with trigger **When Form Submitted**. 2. Select your **Feedback** table and form. 3. Click **Test**. 4. **Add an action** → **AI Generate**. * Prompt: ``` Classify this feedback into exactly one category: Bug Report, Feature Request, or General Feedback. Reply with only the category name. Feedback: ``` * Output Type: **Text** 5. **Add an action** → **Update Record**. * Record ID: the trigger record's ID (via **+**) * Category field → the AI Generate output (via **+**) 6. Test each step, then **enable**. ## Tips * For more nuanced classification, increase the number of categories in the prompt. * Use **JSON** output type if you want the AI to return multiple fields (e.g. category + sentiment + summary) in one call. # Generate and send a daily email digest with AI Source: https://help.teable.ai/en/basic/automation/examples/ai-email-digest Use a scheduled trigger + AI Generate to summarize the day's activity and email it to your team We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"Every day at 6pm, find all tasks completed today, summarize them into a brief report, and email it to [team@yourcompany.com](mailto:team@yourcompany.com)"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. ## Manual setup 1. **Create a workflow** with trigger **At Scheduled Time** — daily at 18:00. 2. **Add an action** → **Get Records**. * Table: **Tasks** * Filter: `Status` **is** `Completed` AND `Completed At` **is** `today` 3. **Add an action** → **AI Generate**. * Prompt: ``` Summarize these completed tasks into a brief daily report. Group by category if applicable. Keep it under 200 words. Tasks: ``` * Output Type: **Text** 4. **Add an action** → **Send Email**. * To: `team@yourcompany.com` * Subject: `Daily Task Report` * Body: insert the AI Generate output (via **+**) 5. Test each step, then **enable**. ## Variations * **Weekly digest:** change the schedule to Fridays and the filter to "past 7 days". * **Customer activity digest:** query a CRM table for new interactions and summarize. # Build automations programmatically with the API Source: https://help.teable.ai/en/basic/automation/examples/api-automation Create and configure workflows using the Teable API and JavaScript We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"Create an automation that watches for order status changes and sends a webhook notification when an order ships"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. ## Prerequisites * A Personal Access Token (PAT). See [Access Token](/en/api-doc/token). * Your base ID, table ID, and field IDs. See [Get IDs](/en/api-doc/get-id). ## Helper Functions ```javascript theme={null} const baseUrl = "https://app.teable.ai/api"; const token = process.env.TEABLE_TOKEN; const baseId = "bserxxxxxx"; const headers = { Authorization: `Bearer ${token}`, "Content-Type": "application/json", }; async function api(method, path, body) { const res = await fetch(`${baseUrl}${path}`, { method, headers, body: body ? JSON.stringify(body) : undefined, }); if (!res.ok) throw new Error(`${method} ${path} → ${res.status}`); return res.json(); } ``` ## Create the Workflow ```javascript theme={null} // 1. Create a workflow const wf = await api("POST", `/base/${baseId}/workflow`, { name: "Notify on shipment", description: "Send webhook when order status becomes Shipped", }); // 2. Add a trigger const trigger = await api("POST", `/base/${baseId}/workflow/${wf.id}/trigger`, { type: "recordUpdated", config: { tableId: "tblOrders", watchFieldIds: ["fldStatus"] }, }); // 3. Test the trigger await api("POST", `/base/${baseId}/workflow/${wf.id}/test/${trigger.id}`); // 4. Add an HTTP Request action const action = await api("POST", `/base/${baseId}/workflow/${wf.id}/action`, { type: "httpRequest", parentNodeId: trigger.id, }); // 5. Enable await api("PUT", `/base/${baseId}/workflow/${wf.id}/active`, { method: "activate", }); ``` ## Best Practices * Use the least-privileged PAT — restrict it to the spaces/bases it needs. * Store tokens in environment variables, never hardcode them. * Use **Test Node** to verify before enabling. * See the full [Automation API Reference](/en/api-reference/automation/put-base-workflow-action). # Batch-process records with loop Source: https://help.teable.ai/en/basic/automation/examples/batch-loop Use Get Records + Loop to process multiple records in a single workflow run We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"Every day at 8am, find all tasks where the due date has passed and status is not Overdue, then update their status to Overdue"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. ## Manual setup 1. **Create a workflow** with trigger **At Scheduled Time** — daily at 08:00. 2. **Add an action** → **Get Records**. * Table: **Tasks** * Filter: `Due Date` **is before** `today` AND `Status` **is not** `Overdue` 3. Click **Test** to see matching records. 4. **Add an action** → **Update Record**. 5. Click **Loop Run** below the table selector. 6. Select the array output from the Get Records step. 7. Map: * Record ID → the current item's record ID (via **+**) * Status → `Overdue` 8. Click **Test**, then **enable**. ## How It Works The Get Records step returns an array. The Update Record step with Loop enabled iterates through each item and updates it individually, in order. # Run different actions based on record values Source: https://help.teable.ai/en/basic/automation/examples/conditional-actions Use conditional logic to branch your workflow and perform different actions depending on field values We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"When a new ticket is created, check the priority field. If it's Urgent, email the on-call team. Otherwise, email the general support queue"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. ## Manual setup 1. **Create a workflow** with trigger **When Record Created**. 2. Select your **Tickets** table. 3. Click **Test** to get a sample record. 4. **Add a Condition** node. 5. Set the rule: **Priority** `is` **Urgent**. 6. Click **Test**. 7. **On the true path** → add a **Send Email** action: * To: `oncall@yourcompany.com` * Subject: `Urgent ticket: ` + ticket title (via **+**) * Body: ticket description (via **+**) 8. **On the false path** → add a **Send Email** action: * To: `support@yourcompany.com` * Subject: `New ticket: ` + ticket title * Body: ticket description 9. Test both paths, then **enable**. ## Tips * You can nest conditions: add another condition inside the false path to separate "High" from "Low" priority. * Combine rules with AND/OR — e.g. `Priority is Urgent AND Assignee is empty`. # Keep records in sync across multiple bases Source: https://help.teable.ai/en/basic/automation/examples/cross-base-sync Automatically replicate new or updated records to another base using Cross-Base Access We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"When a new order is created in the Sales base, create a matching record in the Fulfillment base with the order ID, customer name, amount, and status set to Pending"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. ## Manual setup 1. **Create a workflow** in the **Sales** base with trigger **When Record Created**. 2. Select your **Orders** table. 3. Click **Test**. 4. **Add an action** → **Create Record**. 5. Click **Cross-Base Access** next to the table selector. 6. Navigate to the **Fulfillment** base and select the **Orders** table. 7. Map fields: * Order ID → trigger's Order ID (via **+**) * Customer → trigger's Customer * Amount → trigger's Amount * Status → `Pending Fulfillment` 8. Click **Test**, then **enable**. ## Two-Way Sync To sync updates in both directions: 1. Create a second workflow in the **Fulfillment** base. 2. Use **When Record Updated** → **Update Record** with Cross-Base Access pointing back to the Sales base. 3. Use a filter to avoid infinite loops — e.g. only trigger when specific fields change, and check that the value actually differs before updating. # Send deadline reminders before tasks are due Source: https://help.teable.ai/en/basic/automation/examples/deadline-reminders Automatically email assignees about tasks that are due soon We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"Every morning at 8am, find tasks due within the next 2 days that aren't completed, and email each assignee a reminder"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. ## Manual setup 1. **Create a workflow** with trigger **At Scheduled Time** — daily at 08:00. 2. **Add an action** → **Get Records**. * Table: **Tasks** * Filter: `Due Date` **is within** `next 2 days` AND `Status` **is not** `Completed` 3. Click **Test** to see matching records. 4. **Add an action** → **Send Email** with **Loop** enabled. 5. Select the array from the Get Records step as the loop source. 6. Map: * To → Assignee's email (via **+**, referencing the current loop item) * Subject: `Reminder: "" is due soon` * Body: `Your task "" is due on . Please update the status when done.` 7. Click **Test**, then **enable**. ## Tips * Adjust the filter window ("next 2 days", "next 7 days") based on how urgent tasks typically are. * Add a condition to only email tasks where the Assignee is not empty. # Avoid unwanted triggers with filters and watch fields Source: https://help.teable.ai/en/basic/automation/examples/prevent-unwanted-triggers Prevent your automations from running when they shouldn't We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"When the Status field changes to Approved, send a notification email to the assignee. Only trigger on Status changes, ignore other field edits"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. A workflow that triggers too often wastes runs, sends unwanted emails, and creates noise. Here's how to keep triggers precise. ## Use Watch Fields When using **When Record Updated**, always select specific fields instead of "All Fields". **Problem:** A workflow sends a notification when the Status field changes. With "All Fields" selected, it also triggers when someone edits the Description or adds a comment. **Fix:** Set Watch Fields to **Status** only. Now the workflow ignores all other changes. ## Use Filters Add a filter to any record trigger to narrow which records activate the workflow. **Problem:** A workflow processes all new records, but some are test entries. **Fix:** Add a filter: `Type` **is not** `Test`. Only real records trigger the workflow. ## Combine Both For maximum control, use watch fields **and** a filter together: * Watch Fields: `Status` * Filter: `Status` **is** `Approved` This means: only trigger when the Status field changes **and** the new value is "Approved". ## Use "When Record Matches Conditions" for State Changes If you want to trigger **only on the transition** (e.g. from "Pending" to "Approved"), use the **When Record Matches Conditions** trigger instead. It fires once at the moment the record begins to match — not on every subsequent edit. # Push notifications to Slack, Discord, or Teams Source: https://help.teable.ai/en/basic/automation/examples/push-notifications Send a message to a chat channel when something happens in your table We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"When a new high-priority ticket is created, send a Slack message to the #support channel with the ticket title and description"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. ## Prerequisites You need a webhook URL from your chat platform: * **Slack:** Create an [Incoming Webhook](https://api.slack.com/messaging/webhooks) * **Discord:** Server Settings → Integrations → Webhooks → New Webhook * **Teams:** Channel → Connectors → Incoming Webhook ## Manual setup 1. **Create a workflow** with trigger **When Record Created**. 2. Select your **Tickets** table. 3. Add a filter: `Priority` **is** `High`. 4. Click **Test**. 5. **Add an action** → **HTTP Request**. 6. Configure: * Method: **POST** * URL: your webhook URL * Content-Type: `application/json` * Body (for Slack): ```json theme={null} { "text": "New high-priority ticket: " } ``` * Use the **+** button to insert the ticket title dynamically. 7. Click **Test**, then **enable**. ## Adapting for Discord Discord uses `"content"` instead of `"text"`: ```json theme={null} { "content": "New high-priority ticket: " } ``` ## Adapting for Teams Teams uses an Adaptive Card format: ```json theme={null} { "type": "message", "attachments": [{ "contentType": "application/vnd.microsoft.card.adaptive", "content": { "type": "AdaptiveCard", "body": [{ "type": "TextBlock", "text": "New high-priority ticket: " }], "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", "version": "1.2" } }] } ``` # Auto-create records on a recurring schedule Source: https://help.teable.ai/en/basic/automation/examples/recurring-records Use a scheduled trigger to create records automatically at regular intervals We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"Every Monday at 9am, create a new Weekly Review task in my Tasks table with status set to To Do"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. ## Manual setup 1. **Create a workflow** and choose the trigger **At Scheduled Time**. 2. Configure the schedule: * Frequency: **Weeks**, every **1** week * Weekdays: **Monday** * Trigger time: **09:00** * Time zone: your local time zone 3. Click **Test** to verify the next trigger time. 4. **Add an action** → **Create Record**. 5. Select your **Tasks** table. 6. Map the fields: * Title → `Weekly Review` * Due Date → use the **+** button to insert the trigger's timestamp * Status → `To Do` 7. Click **Run as Configured** to test. 8. **Enable** the workflow. ## Variations * **Daily standup reminder:** set frequency to Days, every 1 day, at 09:00. * **Monthly invoice:** set frequency to Months, day 1, to create a billing record at the start of each month. * **One-time event:** set frequency to One-time for a single future date. # Auto-record the time when a status changes Source: https://help.teable.ai/en/basic/automation/examples/timestamp-status Automatically write a timestamp when a record's status changes to a specific value We recommend building automation examples directly in AI chat. Just describe the workflow you want, and AI will handle the full setup for you, including the trigger, actions, script, and configuration. ## Build with AI Open the AI Chat in your table's right sidebar and tell AI what you want. For example, you can say: *"When a task's status changes to Completed, write the current date and time into the Completed At field"* AI will create the complete workflow automatically. You can review the generated script, test it with real data, and enable the workflow when ready. ## Manual setup 1. **Create a workflow** with trigger **When Record Matches Conditions**. 2. Select your **Tasks** table. 3. Set the filter: `Status` **is** `Completed`. 4. Click **Test**. 5. **Add an action** → **Update Record**. 6. Map: * Record ID → the trigger record's ID (via **+**) * Completed At → use an expression or set to the trigger's timestamp 7. Click **Test**, then **enable**. ## Why "When Record Matches Conditions"? This trigger fires **once** — at the moment the record transitions to matching. If someone later edits the Description (while Status is still "Completed"), the workflow does **not** fire again. This prevents the timestamp from being overwritten. ## Variations * **"Started At"** — trigger when Status becomes "In Progress". * **"Escalated At"** — trigger when Priority becomes "Urgent". * **"Approved At"** — trigger when Approval becomes "Yes". # When email received overview Source: https://help.teable.ai/en/basic/automation/trigger/email/email-received-overview Trigger a workflow when a new email arrives in a monitored mailbox Please note: all trigger setup can be done in AI chat. Tell AI what you want the workflow to do, and it will handle the rest. This trigger runs when a new, unread email arrives in a monitored mailbox. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it chooses the right trigger, maps the relevant fields, and sets up all actions automatically. Describe the goal once, and the workflow is ready — no manual setup needed. **Example:** *"When I receive a support email, create a ticket and classify it."* ## Configuration | Setting | Required | Description | | --------------- | -------- | ---------------------------------------------------------------- | | Connection Type | Yes | IMAP only | | Poll Interval | Yes | How often to check for new emails: 10 to 60 minutes (default 10) | ## Connect the mailbox The trigger connects over IMAP, which works with any provider that supports the protocol, Gmail and Outlook included once IMAP is enabled on the account. | Setting | Required | Description | | -------- | -------- | ------------------------------------------------------------------------ | | Host | Yes | Your IMAP server address (e.g., `imap.gmail.com`, `imap.mail.yahoo.com`) | | Port | Yes | Usually 993 (SSL/TLS) or 143 (unencrypted, not recommended) | | Username | Yes | Your email address or account username | | Password | Yes | A secret granted to this automation, not a value typed into the trigger | | Mailbox | No | The folder to monitor (defaults to `INBOX`) | For the password, click **Select a secret** to pick one of the secrets granted to this automation, or **Add secret** to create one (default variable name `IMAP_PASSWORD`). Store the app password or authorization code there, not your mailbox login password; the trigger keeps a reference to the secret rather than the value. ## What email data is available to next steps When the trigger fires, the following data from the email is available as variables in your action steps: | Data | Description | | --------------- | ------------------------------------------------- | | **From** | The sender's email address | | **Subject** | The email subject line | | **Body (text)** | The plain-text version of the email body | | **Body (HTML)** | The HTML version of the email body (if available) | | **Date** | When the email was sent | | **Attachments** | File attachments included in the email | You can reference any of these by clicking **+** in your action fields. ## How to set it up (IMAP example) 1. Open your automation and add a new trigger. 2. Select **When email received**. 3. Choose **IMAP** as the connection type. 4. Enter your IMAP server details: host, port, and username, then select or add the secret that holds the password. 5. (Optional) Change the **Mailbox** if you want to monitor a folder other than INBOX. 6. Set the **Poll Interval** — how often to check for new emails. A shorter interval means faster responses but more frequent server checks. 7. Click **Test** to verify the connection. Teable will attempt to connect to your mailbox and report success or failure. 8. Save and activate the automation. 9. Add your action steps, using the email data (From, Subject, Body, etc.) as variables. ## When to use * **Create a record for each incoming support email.** Parse the subject and body to populate fields in a support tickets table automatically. * **Extract invoice data from emails with AI.** Use the AI Generate action to read the email body or attachment and pull out amounts, dates, and vendor names. * **Route customer inquiries to the right team.** Based on keywords in the subject or body, update a "Team" field or send notifications to specific people. * **Archive important emails as records.** Automatically log emails from specific senders or with specific subjects into a Teable table for easy searching and tracking. * **Process order confirmations.** When an order confirmation email arrives, extract the order number and details to update your orders table. ## Troubleshooting * **Connection failed (IMAP):** Double-check your host, port, username, and password. Make sure your email provider allows IMAP access — some providers disable it by default. * **Gmail: "Less secure app" error:** Gmail does not allow plain password login. Store an **App Password** as the secret instead. See [Set up Gmail IMAP](/en/basic/automation/trigger/email/gmail-imap) for instructions. * **Emails not being picked up:** Check the poll interval. Also confirm that the emails are arriving in the monitored folder. Emails in subfolders may be missed if the wrong mailbox is selected. * **Duplicate processing:** The trigger tracks which emails it has already processed. However, if you deactivate and reactivate the automation, it may reprocess recent emails. Mark emails as read in your inbox if needed. ## Tips * A shorter poll interval means faster response to emails but does not guarantee real-time delivery. For true real-time processing, consider using a webhook-based approach if your email provider supports it. * Use filters in your email client to route relevant emails to a specific label or folder, then have Teable monitor only that label. This reduces noise. * For high-volume mailboxes, consider increasing the poll interval and processing in batches to avoid overwhelming your workflow. * A trigger that still holds a typed password keeps running, and the password field reads **Password set. Select a secret to replace it.** The next change to that password has to be a secret. ## Related * [Set up Gmail IMAP](/en/basic/automation/trigger/email/gmail-imap) — detailed instructions for connecting Gmail * [AI generate action](/en/basic/automation/actions/ai/ai-generate) — useful for extracting structured data from email content * [Create record action](/en/basic/automation/actions/records/create-record) — commonly paired with email triggers to log emails as records * [Send email](/en/basic/automation/actions/communication/send-email-overview) * [Credentials and integrations](/en/basic/credential) — manage secrets and grant them to an automation # Set up Gmail IMAP Source: https://help.teable.ai/en/basic/automation/trigger/email/gmail-imap How to enable Gmail IMAP and create an App Password for Teable # How to Enable Gmail IMAP and Create App Password This guide shows how to prepare your Gmail account so Teable can automatically capture incoming emails. ## Enable IMAP in Gmail 1. Open Gmail in a web browser. 2. Click the **Settings → See all settings**. 3. Go to **Forwarding and POP/IMAP** tab. 4. Scroll to **IMAP Access**. 5. Select **Enable IMAP**. 6. Optional: Leave **Auto-Expunge on** and **Do not limit folder size** as default. 7. Click **Save Changes**. **Screenshot example:** ![Enable IMAP](https://dxshyegpql0u3hra.public.blob.vercel-storage.com/9a53be669002acaefbae6ab98d57405b.png) ## Enable 2-Step Verification 1. Go to **[https://myaccount.google.com/](https://myaccount.google.com/)** and log in. 2. Select **Security → 2-Step Verification**. 3. Follow steps to enable 2FA (SMS, authenticator, or security key). **Screenshot example:** ![2FA Setup](https://dxshyegpql0u3hra.public.blob.vercel-storage.com/00047fb62cbf7ca042a4edeb7c511f0a.png) ## Create App Password 1. After enabling 2-Step Verification, go to **App Passwords**: * Direct link: [https://myaccount.google.com/apppasswords](https://myaccount.google.com/apppasswords) 2. In **Select App**, choose `Mail`. 3. In **Select Device**, choose `Other` and name it `Teable IMAP`. 4. Click **Generate**. 5. Copy the **16-character password** (you will need this in Teable). **Screenshot example:** ![App Password](https://dxshyegpql0u3hra.public.blob.vercel-storage.com/f6a7753ef8d3d99901495d4ea79758f2.png) ## Notes * Use the generated **App Password**, not your Gmail main password, in Teable. * Only new, unread emails trigger the automation. * Keep the App Password safe — you will only see it once. # At scheduled time Source: https://help.teable.ai/en/basic/automation/trigger/external/scheduled-time Run a workflow on a recurring or one-time schedule Please note: all trigger setup can be done in AI chat. Tell AI what you want the workflow to do, and it will handle the rest. This trigger runs on a schedule you define — from every few minutes to once a month, or a single one-time run. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it chooses the right trigger, maps the relevant fields, and sets up all actions automatically. Describe the goal once, and the workflow is ready — no manual setup needed. **Example:** *"Every Monday at 9am, email me a list of overdue tasks."* ## Configuration | Setting | Required | Description | | ---------- | -------- | -------------------------------------------------------------------------- | | Start Time | Yes | When the schedule begins | | End Time | No | When the schedule stops (leave blank to run indefinitely) | | Time Zone | Yes | Defaults to your current time zone. All times are interpreted in this zone | | Frequency | Yes | How often the trigger fires — see options below | ## Frequency options | Frequency | Interval | Extra Settings | | --------- | ----------------- | ------------------------------------------------------- | | Minutes | Every 10–60 min | — | | Hours | Every 1–24 h | — | | Days | Every 1–31 days | Trigger time (hour + minute) | | Weeks | Every 1–52 weeks | Weekdays (Mon–Sun) + trigger time | | Months | Every 1–12 months | Days of month + trigger time | | One-time | — | Fires once at the specified time, then auto-deactivates | Use **-1** as the day of month to target the last day of the month, regardless of whether it has 28, 30, or 31 days. ## How to set it up 1. Open your automation and add a new trigger. 2. Select **At scheduled time**. 3. Set the **Time Zone**. This is especially important if your team spans multiple time zones — the schedule runs in whichever zone you select here. 4. Choose a **Frequency**. For example, to run every Monday at 9:00 AM: * Set Frequency to **Weeks**. * Set interval to **1** (every 1 week). * Check **Monday** in the weekday selector. * Set the trigger time to **09:00**. 5. Set a **Start Time** (when the schedule becomes active). 6. (Optional) Set an **End Time** if you want the schedule to expire. 7. Save and activate the automation. 8. Since there is no record data, your first action will typically be a **Get Records** step to load the data you need. ## Concrete example: weekly Monday morning report Goal: Every Monday at 9:00 AM, get all tasks due this week and send a summary email. 1. **Trigger:** At scheduled time — Weeks, every 1 week, Monday, 09:00, your time zone. 2. **Action 1:** Get Records — from the Tasks table, filter: Due Date is within this week. 3. **Action 2:** Send Email — to your team, with the retrieved tasks listed in the body. ## One-time schedules When you select **One-time** frequency, the automation fires once at the specified date and time and then automatically deactivates itself. This is useful for: * A reminder to follow up on a specific date. * A delayed action that needs to happen once (e.g., send a launch announcement at a future date). * A time-limited campaign that triggers only once. After a one-time trigger fires, you will see the automation marked as inactive. You can reactivate it with a new time if needed. ## When to use * **Generate a daily summary report.** Run every day at 8:00 AM, get all records updated yesterday, and email a digest. * **Create recurring tasks every Monday.** Run weekly and create records in your task table for the new week. * **Send monthly invoice reminders.** Run on the 1st of each month, find unpaid invoices, and send reminder emails. * **Clean up stale records.** Run daily, find records older than 90 days with a "Draft" status, and archive or delete them. * **Sync data on a schedule.** Run every hour to push updated records to an external API. Schedule triggers are not linked to any record, so there is no record data available to subsequent steps. If you need to process records, add a Get Records action as your first step and use filters to select the records you need. ## Tips * Since schedule triggers have no "current record," you cannot reference trigger data in actions the way you would with record-based triggers. Always start with a **Get Records** action if you need data. * Be mindful of time zones, especially for teams that work across regions. The time zone setting on the trigger determines when it fires — not the viewer's local time. * For high-frequency schedules (every few minutes), keep your workflow lightweight to avoid overlapping runs. * If your automation is time-sensitive (e.g., must run before a daily meeting), set it a few minutes early to allow for processing time. * The **-1** day-of-month trick is useful for month-end reports or processes. Using -1 means "last day of the month", so it correctly fires on January 31, February 28 (or 29), March 31, etc. ## Related * [Get records action](/en/basic/automation/actions/records/get-records) — typically the first step after a schedule trigger * [Send email action](/en/basic/automation/actions/communication/send-email-overview) — commonly paired with schedules for periodic notifications * [Loop (batch) action](/en/basic/automation/actions/logic/loop-run) — useful for processing the array of records returned by Get Records # When webhook received Source: https://help.teable.ai/en/basic/automation/trigger/external/webhook-received Trigger a workflow by receiving an HTTP request from any external system Please note: all trigger setup can be done in AI chat. Tell AI what you want the workflow to do, and it will handle the rest. This trigger generates a unique URL. When an external system sends an HTTP POST to it, the workflow runs. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it chooses the right trigger, maps the relevant fields, and sets up all actions automatically. Describe the goal once, and the workflow is ready — no manual setup needed. **Example:** *"When I receive a Stripe payment webhook, create an order record."* ## Configuration | Setting | Required | Description | | ------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- | | Authorization | No | **None** (public — anyone with the URL can trigger it) or **Bearer Token** (auto-generated token required in the request header) | | Response | No | **Default** (Teable returns its own acknowledgement) or **Custom** (you decide the status code, content type, and body) | ## How to set it up 1. Open your automation and add a new trigger. 2. Select **When webhook received**. 3. The trigger immediately generates a unique **webhook URL**. Copy this URL — you will need it for the external system. 4. (Optional but recommended) Click **Generate Token** to enable Bearer Token authorization. This produces a token that must be included in the `Authorization` header of incoming requests. 5. Save and activate the automation. 6. Configure your external system to send a POST request to the webhook URL. Include the token in the header if you enabled authorization. 7. Send a test request (see examples below). Check the automation's run history to verify it received the data correctly. 8. Add your action steps. Click **+** in any action field to reference values from the webhook's JSON body. ## What data is available to next steps The entire JSON body of the incoming POST request is available as variables. For example, if you send: ```json theme={null} { "order_id": "12345", "customer": "Alice", "amount": 99.95 } ``` Then in your actions, you can reference `order_id`, `customer`, and `amount` individually by clicking **+** and navigating to the trigger's output fields. Teable automatically parses the JSON and creates named variables for each top-level key. Nested objects are also accessible. ## Customize the response By default, Teable replies to every incoming request with its own acknowledgement. Some platforms will not accept that: they verify a subscription URL by sending a probe and requiring your endpoint to echo one field of it back. Slack works this way, so its events can only reach an automation once the webhook answers the handshake. In the trigger panel, switch **Response** from **Default** to **Custom**: | Field | Description | | ----------------- | ------------------------------------------------------------------------------------- | | **Status code** | Any code from 200 to 299. Defaults to 200. | | **Content type** | **JSON** or **raw text**. Defaults to JSON. | | **Response body** | The text to return. Use `{{body.}}` to insert values from the incoming request. | Switching to **Custom** pre-fills the body with the handshake reply most callers need: ```json theme={null} {"challenge":"{{body.challenge}}"} ``` The paths inside `{{ }}` are the same ones the trigger exposes as output variables, so you can copy a path straight from a payload you have already seen in a test run. Nested values work too, for example `{{body.event.type}}`. In a JSON body, a path the request does not contain is rendered as `null`, so the response stays valid JSON. Slack cannot send an `Authorization` header, so keep **Authorization** set to **None** when you connect it. The trigger panel shows a warning if both are on at once. Switch **Response** back to **Default** at any time to return to Teable's own acknowledgement. Automations that never touch this setting are unaffected. ## Testing your webhook The easiest way to test is with `curl` from the command line. Copy the real URL from the trigger panel rather than typing it out; it carries the base and workflow ids. **Without authorization:** ```bash theme={null} curl -X POST https://your-teable-instance.com/api/webhook/base/bseXXXXXXXXXXXX/workflow/wflXXXXXXXXXXXX \ -H "Content-Type: application/json" \ -d '{"test": true, "message": "Hello from curl"}' ``` **With Bearer Token authorization:** ```bash theme={null} curl -X POST https://your-teable-instance.com/api/webhook/base/bseXXXXXXXXXXXX/workflow/wflXXXXXXXXXXXX \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your-generated-token" \ -d '{"order_id": "12345", "status": "paid"}' ``` **Sending more complex data:** ```bash theme={null} curl -X POST https://your-teable-instance.com/api/webhook/base/bseXXXXXXXXXXXX/workflow/wflXXXXXXXXXXXX \ -H "Content-Type: application/json" \ -H "Authorization: Bearer your-generated-token" \ -d '{ "event": "invoice.paid", "data": { "invoice_id": "INV-001", "amount": 250.00, "currency": "USD", "customer_email": "alice@example.com" } }' ``` After sending a test request, check the automation's run history to confirm the data was received and parsed correctly. ## Rate limits | Scope | Limit | | ------------ | -------------------- | | Per base | 50 requests / second | | Per workflow | 2 requests / second | Requests exceeding the rate limit will receive an HTTP 429 response. If your external system sends bursts of requests, consider implementing retry logic with exponential backoff. ## Security best practices * **Always use Bearer Token authorization** for production webhooks. A public webhook URL can be triggered by anyone who discovers the URL. * **Keep your webhook URL private.** Treat it like a password. Do not commit it to public repositories or share it in open channels. * **Regenerate the token** if you suspect it has been compromised. You can generate a new token from the trigger panel at any time. * **Validate data in your workflow.** Do not assume the incoming data is well-formed. Use filters or script steps to verify required fields are present before processing. * **Monitor run history.** Regularly check your automation's run logs to spot unexpected or unauthorized requests. ## When to use * **Receive payment events from Stripe or PayPal.** Configure a Stripe webhook to send `invoice.paid` events to your Teable automation, creating or updating order records automatically. * **Accept form submissions from your website.** Point your website's contact or signup form to the webhook URL to create records directly in Teable. * **Ingest data from IoT devices.** Sensors or devices that can send HTTP requests can push data into Teable for monitoring and alerting. * **Connect CI/CD pipelines.** Trigger workflows when a build succeeds or fails — create records, send notifications, or update project status. * **Receive events from any SaaS tool.** Many tools (GitHub, Jira, Shopify, Twilio, etc.) support webhook notifications. Point them at your Teable webhook to automate cross-tool workflows. ## Tips * The webhook only accepts **POST** requests. GET, PUT, and other methods will not trigger the automation. * Always send a `Content-Type: application/json` header. If the body is not valid JSON, the trigger may not parse the data correctly. * If you need to send data from a system that does not support custom headers (for Bearer auth), consider using the public mode but adding a secret key in the JSON body that your workflow validates with a filter or script. * For debugging, you can use services like [webhook.site](https://webhook.site) to inspect what your external system is actually sending before pointing it at Teable. ## Related * [HTTP request action](/en/basic/automation/actions/logic/http-request) — the outbound counterpart: call external APIs from your workflow * [Run script](/en/basic/automation/ai/scripting/runscript) — for advanced webhook payload processing * [Loop (batch) action](/en/basic/automation/actions/logic/loop-run) — process arrays in webhook payloads # When button clicked Source: https://help.teable.ai/en/basic/automation/trigger/forms/button-click Trigger a workflow when a button field is clicked Please note: all trigger setup can be done in AI chat. Tell AI what you want the workflow to do, and it will handle the rest. This trigger runs when a user clicks a Button field in a table row. The workflow receives that row's data. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it chooses the right trigger, maps the relevant fields, and sets up all actions automatically. Describe the goal once, and the workflow is ready — no manual setup needed. **Example:** *"When I click the Approve button, update the status and notify the team."* ## Configuration | Setting | Required | Description | | ------------ | -------- | ------------------------------------------------------------------------------ | | Table | Yes | The table that contains the button field | | Watch Fields | Yes | The button field(s) to monitor for clicks | | Filter | No | Only trigger if the record matches these conditions when the button is clicked | ## How to create a Button field Before you can use this trigger, you need a Button field in your table: 1. Open the table where you want the button. 2. Click **+** to add a new field. 3. In the field type menu, go to **Advanced** and select **Button**. 4. Give the field a name (e.g., "Approve", "Send Invoice", "Export"). 5. Save the field. A clickable button will now appear in every row of that column. ## How to set it up 1. Open your automation and add a new trigger. 2. Select **When button clicked**. 3. Choose the **Table** that has the button field. 4. In **Watch Fields**, select the button field you want to monitor. You can select multiple button fields if needed. 5. (Optional) Add a **Filter** to restrict which rows can trigger the automation. For example, `Status` not equal to `Completed` will prevent the button from firing on already-completed records. 6. Save and activate the automation. 7. Add your action steps. Click **+** in any action field to insert data from the clicked row. ## What data is available to next steps When a button is clicked, the trigger provides: * **Record ID** — the unique identifier of the row where the button was clicked. * **All field values** — every field in the clicked row is available as a variable. This includes text, numbers, dates, linked records, attachments, and more. This means you can use the row's data to populate emails, update other records, or send data to external APIs — all based on the specific row the user clicked. ## When to use * **One-click approval workflows.** Add an "Approve" button to each row. When clicked, update the status to "Approved" and send a notification to the requestor. * **Generate a report or document on demand.** A "Generate Report" button triggers an AI action or HTTP request to create a PDF or summary for that specific record. * **Push a record to an external system.** A "Sync to CRM" button sends the row's data to Salesforce, HubSpot, or another platform via an HTTP request. * **Send a personalized email.** A "Send Reminder" button composes and sends an email using the row's contact information and relevant details. * **Trigger a manual review step.** A "Flag for Review" button marks the record and notifies a manager, giving humans explicit control over which items get escalated. ## Tips * The button field itself does not store data — it is purely a trigger mechanism. You will not see a value in the cell; just a clickable button. * If you have multiple button fields in a table, you can create separate automations for each one, or use a single automation that watches multiple buttons and uses conditional logic. * The filter is evaluated at the moment the button is clicked. If the record does not match the filter, the automation simply does not run — the user will not see an error. * Button triggers are great for workflows where you want human judgment before an action is taken, rather than fully automatic processing. ## Related * [When form submitted](/en/basic/automation/trigger/forms/form-submitted) — fires on form submissions rather than button clicks * [When record updated](/en/basic/automation/trigger/records/record-updated) — fires automatically on field changes, no user action required * [Update record action](/en/basic/automation/actions/records/update-record) — commonly paired with button clicks to change the row's status * [Send email](/en/basic/automation/actions/communication/send-email-overview) # When form submitted Source: https://help.teable.ai/en/basic/automation/trigger/forms/form-submitted Trigger a workflow when a form view is submitted Please note: all trigger setup can be done in AI chat. Tell AI what you want the workflow to do, and it will handle the rest. This trigger runs when someone submits a specific form view. All submitted fields are available to the next steps. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it chooses the right trigger, maps the relevant fields, and sets up all actions automatically. Describe the goal once, and the workflow is ready — no manual setup needed. **Example:** *"When someone submits the contact form, send a confirmation email."* ## Configuration | Setting | Required | Description | | ------- | -------- | ----------------------------------------------- | | Table | Yes | The table the form belongs to | | Form | Yes | The specific form view to watch for submissions | ## How to set it up 1. Make sure you already have a form view on your table. If not, create one by clicking **+** in the view bar and selecting **Form**. 2. Open your automation and add a new trigger. 3. Select **When form submitted**. 4. Choose the **Table** that contains the form. 5. Choose the **Form** view you want to monitor. 6. Save and activate the automation. 7. Add your action steps. Click **+** in any action field to reference the submitted data — all form fields are available. ## What data is available to next steps When a form is submitted, the following data is passed to your workflow: * **Record ID** — the unique identifier of the newly created record. * **All submitted field values** — every field that was included in the form (text, email, numbers, dates, selections, attachments, etc.) can be referenced by clicking **+** in subsequent actions. Fields that the form does not include (hidden fields) will not have values from the submission, but they may have default values set on the table. ## Form submission also creates a record It is important to understand that a form submission and a record creation are the same event at the data level. When someone submits a form, a new record is added to the table. This means: * If you also have a **When record created** automation on the same table, *both* automations will fire on a form submission. * To avoid duplicate processing, either use the Form Submitted trigger exclusively or add a filter to the Record Created trigger that excludes form-originated records. A form submission is essentially a record creation. If the same table also has a "When record created" trigger configured, both workflows will run. ## When to use * **Send a confirmation email after submission.** When a customer fills out a contact form, automatically send them a "thank you" email with details of their submission. * **Auto-classify new support tickets with AI.** Use the AI Generate action to categorize the ticket based on the description the user submitted. * **Notify your team about incoming applications.** When someone submits a job application form, post a notification to Slack or email the hiring team. * **Create linked records in other tables.** When an order form is submitted, automatically create records in an "Order Items" table or a "Shipments" table. * **Validate and flag submissions.** Check if required information is complete or if a value is out of range, and update a status field to "Needs Review" if something looks off. ## Tips * This trigger fires once per submission. If the same person submits the form twice, it fires twice. * If you need to trigger on all new records regardless of source (manual entry, API, form), use [When record created](/en/basic/automation/trigger/records/record-created) instead. * You can have multiple automations watching the same form. For example, one automation sends a confirmation email while another creates a linked task. * Form views respect field visibility settings. Only fields visible in the form are filled by the submission — hidden fields keep their defaults or remain empty. ## Related * [When record created](/en/basic/automation/trigger/records/record-created) — fires on any new record, not just form submissions * [When button clicked](/en/basic/automation/trigger/forms/button-click) — fires when a user clicks a button field in an existing row * [Send email action](/en/basic/automation/actions/communication/send-email-overview) — commonly paired with form submissions for confirmations # When record created Source: https://help.teable.ai/en/basic/automation/trigger/records/record-created Trigger a workflow when a new record is added to a table Please note: all trigger setup can be done in AI chat. Tell AI what you want the workflow to do, and it will handle the rest. This trigger runs when a new record is added to the table, regardless of how it was created. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it chooses the right trigger, maps the relevant fields, and sets up all actions automatically. Describe the goal once, and the workflow is ready — no manual setup needed. **Example:** *"When a new order is created, notify the team on Slack."* ## Configuration | Setting | Required | Description | | ------- | -------- | ---------------------------------------------------------------------------------------------- | | Table | Yes | The table to watch for new records | | Filter | No | Only trigger if the new record matches these conditions. Uses the same filter builder as views | ## How to set it up 1. Open your automation and add a new trigger. 2. Select **When record created**. 3. Choose the **Table** you want to monitor. 4. (Optional) Add a **Filter** if you only want to react to certain new records. For example, `Priority` equals `High` will ignore new records with other priority values. 5. Save and activate the automation. 6. Add your action steps. In each action, click the **+** button in any field to insert values from the trigger — you will see every field of the new record listed. ## What data is available to next steps When this trigger fires, all fields of the newly created record are available as variables in subsequent steps: * **Record ID** — the unique identifier of the new record * **All field values** — every field in the table (text, number, date, attachments, linked records, etc.) can be referenced by clicking **+** in any action's field mapping This means if your table has fields like Name, Email, Status, and Created Date, all four values are ready to use in your actions without any extra configuration. ## How the filter works The optional filter lets you narrow which new records actually trigger the automation: * If **no filter** is set, every new record fires the trigger. * If a **filter** is set, the trigger only fires when the new record matches all conditions. Records that do not match are silently ignored. This is useful when you only want to act on a subset of new records — for example, only high-priority tasks, only records assigned to a specific team, or only orders above a certain amount. The filter is evaluated based on the field values at the time the record is created. If a field is empty at creation and filled in later, the automation will not retroactively fire. ## When to use * **Send a welcome email to a new contact.** When a contact is added to your CRM table, automatically send a personalized welcome email using the contact's name and email address. * **Create a linked task when a new project is added.** When a project record is created, automatically create a default set of tasks in a Tasks table linked to the new project. * **Notify your team about new orders.** Post a message to Slack or send an email to the sales team whenever a new order comes in. * **Auto-classify incoming records with AI.** When a support ticket is created, use the AI Generate action to categorize it based on the description field. * **Log new records to an external system.** Use an HTTP Request action to push new record data to a CRM, ERP, or data warehouse. ## Tips * This trigger fires for records created by *any* method, including other automations. If you have an automation that creates records in the same table, be careful to avoid infinite loops. Use a filter to exclude records that were created by automation (for example, by checking a flag field). * The trigger fires once per record. If 10 records are bulk-imported, it fires 10 separate times. * If you need to react only to records created through a specific form, use the [When form submitted](/en/basic/automation/trigger/forms/form-submitted) trigger instead — it gives you tighter control. * Fields that are empty when the record is created will still be available as variables, but their values will be blank. Make sure your actions handle empty values gracefully. ## Related * [When form submitted](/en/basic/automation/trigger/forms/form-submitted) — fires only for form submissions, not all record creation methods * [When record updated](/en/basic/automation/trigger/records/record-updated) — fires when existing records change * [Create record action](/en/basic/automation/actions/records/create-record) — the action counterpart for creating records in workflows * [Send email](/en/basic/automation/actions/communication/send-email-overview) # When record matches conditions Source: https://help.teable.ai/en/basic/automation/trigger/records/record-matches-conditions Trigger a workflow when a record starts matching specific conditions Please note: all trigger setup can be done in AI chat. Tell AI what you want the workflow to do, and it will handle the rest. This trigger is used when a workflow should run after a record begins to match certain conditions. It can fire in two common cases: * A new record is created and already matches the filter. * An existing record is edited and changes from not matching to matching the filter. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it chooses the right trigger, maps the relevant fields, and sets up all actions automatically. Describe the goal once, and the workflow is ready — no manual setup needed. **Example:** *"When a task becomes overdue, send me an email."* ## Configuration | Setting | Required | Description | | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- | | Table | Yes | The table to watch for changes | | Filter | **Yes** | The conditions the record must match. Uses the same filter builder as views — supports field comparisons, AND/OR groups, and dynamic values | ## How to set it up 1. Open your automation and add a new trigger. 2. Select **When record matches conditions**. 3. Choose the **Table** you want to monitor. 4. Click **Add Filter** to define the conditions. For example: `Status` equals `Overdue`, or `Amount` is greater than `10000`. 5. You can combine multiple conditions with AND/OR logic, just like view filters. 6. Save and activate the automation. 7. Test it by creating a matching record, or by editing an existing record so that it goes from *not matching* to *matching* your filter. The automation should fire once. After the trigger fires, subsequent steps can use all field data from the matched record, including the latest values at the time of the transition. ## How is this different from "When Record Updated"? These two triggers are easy to confuse. Here is the key difference: * **When Record Updated** fires every time a watched field changes, regardless of what the new value is. If you watch the "Status" field, it fires whether Status changes to "In Progress", "Done", or anything else. * **When Record Matches Conditions** fires only when a record crosses the boundary from "not matching" to "matching" your filter. It does not fire on every edit — only on the transition. Use **When Record Updated** when you need to react to any change. Use **When Record Matches Conditions** when you only care about a specific state being reached. If you want to run an action every time a record is edited, use the [When record updated](/en/basic/automation/trigger/records/record-updated) trigger. If you only want to run an action once when a record first reaches a specific condition, use this trigger. ## When to use * **Alert when an order becomes overdue.** Set the filter to `Due Date` is before today and `Status` is not `Shipped`. The automation fires once when the order first matches. * **Escalate a support ticket when priority changes to urgent.** Filter: `Priority` equals `Urgent`. Only fires when a ticket first becomes urgent, not on subsequent edits. * **Notify a manager when a deal exceeds a revenue threshold.** Filter: `Deal Value` is greater than `50000`. Fires once when the deal crosses that line. * **Flag records that become incomplete.** Filter: `Required Field` is empty. Fires when a previously complete record loses its value. * **Trigger onboarding steps when a contact's status changes to "Active".** Filter: `Status` equals `Active`. Only runs once per activation. ## Tips * You **must** define at least one filter condition. Without it, the trigger has nothing to evaluate. * The trigger checks the transition at the moment a record is saved. It does not retroactively fire for records that already matched before the automation was created. * Records created after activation are also checked against the filter. If the initial values match, the workflow can trigger immediately. * Combine this trigger with a **Send Email** or **Update Record** action to build powerful state-change workflows without writing any code. ## Related * [When record updated](/en/basic/automation/trigger/records/record-updated) — fires on any field change, not just transitions * [When record created](/en/basic/automation/trigger/records/record-created) — fires when new records are added * [Send email](/en/basic/automation/actions/communication/send-email-overview) # When record updated Source: https://help.teable.ai/en/basic/automation/trigger/records/record-updated Trigger a workflow when an existing record is modified Please note: all trigger setup can be done in AI chat. Tell AI what you want the workflow to do, and it will handle the rest. This trigger runs when an existing record is modified. It does not fire on creation. ## Build with AI Open the AI Chat in your table's right sidebar and describe what you want. AI handles everything: it chooses the right trigger, maps the relevant fields, and sets up all actions automatically. Describe the goal once, and the workflow is ready — no manual setup needed. **Example:** *"When the status field changes, send an email to the assignee."* ## Configuration | Setting | Required | Description | | ------------ | -------- | ---------------------------------------------------------------------------------- | | Table | Yes | The table to watch for changes | | Watch Fields | Yes | Choose specific fields to monitor, or select "All Fields" to trigger on any change | | Filter | No | Only trigger if the updated record matches these conditions after the change | ## How to set it up 1. Open your automation and add a new trigger. 2. Select **When record updated**. 3. Choose the **Table** you want to monitor. 4. In **Watch Fields**, select one or more specific fields. For example, choose only "Status" if you want to react to status changes. 5. (Optional) Add a **Filter** to further narrow which updates fire the trigger. For example, `Status` equals `Done` will only fire when a record's status is changed to "Done". 6. Save and activate the automation. 7. Add your action steps. Click **+** in any action field to insert values from the updated record. ## Understanding Watch Fields The Watch Fields setting is the most important part of this trigger: * **Specific fields (recommended):** Select only the fields you care about. The trigger only fires when one of these fields changes. All other edits to the record are ignored. * **All Fields:** The trigger fires whenever *any* field in the record changes. This includes computed fields, last-modified timestamps, and minor edits you might not care about. **Why specific fields are better in most cases:** * Fewer unnecessary trigger executions, which means fewer wasted automation runs. * Prevents accidental loops (see below). * Makes your automation's purpose clearer to anyone reading it. Choose "All Fields" only when you genuinely need to react to every possible change — for example, a full audit log. It is strongly recommended to select specific watch fields. Selecting "All Fields" can cause the workflow to fire on unrelated edits, waste automation runs, and lead to unexpected behavior. ### Computed fields [Formula](/en/basic/field/formula), [Lookup](/en/basic/field/lookup), [Rollup](/en/basic/field/rollup), [Conditional Lookup](/en/basic/field/conditional-lookup), and [Conditional Rollup](/en/basic/field/conditional-rollup) values come from Teable's own calculation rather than from typing, and a recalculation only fires this trigger when you name the computed field in **Watch Fields**. All five behave the same way. This lets you react to a derived result instead of to the raw inputs behind it. Watch a `Total amount` Formula field and the workflow runs whenever the total actually changes, no matter which of the underlying fields moved. Watch a Rollup of linked tasks and the workflow runs when the rolled-up value changes, including when the change came from an edit in the linked table. ## Common pitfall: update loops If your workflow includes an Update Record action that writes to the same table and updates a watched field, the trigger will fire again, creating an infinite loop. If your automation is triggered by updates to a table and also has an **Update Record** action that writes back to the *same table*, you can create an infinite loop: 1. A field changes → trigger fires. 2. The automation updates another field in the same record → trigger fires again. 3. Repeat endlessly. **How to avoid this:** * Watch only specific fields, and make sure your Update Record action writes to *different* fields than the ones being watched. * Use a filter condition to stop the loop. For example, only trigger when `Status` does not equal `Processed`, and have your action set `Status` to `Processed`. * If your action must update the same field, consider using the [When record matches conditions](/en/basic/automation/trigger/records/record-matches-conditions) trigger instead, which fires only on transitions. ## When to use * **Sync price changes to an external system.** Watch the "Price" field. When it changes, send an HTTP request to update the price in your e-commerce platform. * **Send a notification when a task's status changes.** Watch the "Status" field. When a task moves to "Blocked" or "Done", notify the assignee or manager. * **Log field changes for auditing.** Watch "All Fields" and create a record in an audit log table with the old and new values. * **Update a linked record when a parent changes.** Watch key fields on a project record. When the project deadline changes, update all linked tasks. * **Trigger a recalculation in another system.** Watch numeric fields like "Quantity" or "Unit Price". When they change, call an API to recalculate totals. ## Tips * Start with specific watch fields. You can always add more later if you find you are missing events. * The filter is evaluated *after* the update. This means the filter checks the record's new values, not the old ones. * This trigger does not tell you what the previous value was — only what the record looks like now. If you need before-and-after comparison, consider maintaining a "Previous Value" field that your automation updates. * The trigger fires once per save, even if multiple watched fields change in the same edit. ## Related * [When record matches conditions](/en/basic/automation/trigger/records/record-matches-conditions) — fires only on state transitions, not every edit * [When record created](/en/basic/automation/trigger/records/record-created) — fires on new records, not updates * [Update record action](/en/basic/automation/actions/records/update-record) — the action counterpart for modifying records in workflows # Overview Source: https://help.teable.ai/en/basic/base Create, manage, import and export bases. Move data between Teable Cloud spaces or migrate between Cloud and Self-Hosted instances using .tea files. A base is a tool for storing and processing all information for a specific project. Each space can have multiple bases, and each base can work independently, providing a clear information structure for specific projects or table collections. For users unfamiliar with bases, you can think of them as workbooks in Excel, where each workbook can contain multiple sheets. ## Create and Manage Bases ### Adding a Base 1. Enter a space 2. Click "Create Base" in the upper right corner Create a base ### Renaming/Deleting a Base 1. Enter a space 2. Hover over a base 3. Click the "···" button to open the menu 4. Click "Rename" or "Delete" Rename or delete a base ### Organize Resources in a Base After entering a base, the left sidebar shows the resources in the current base, such as tables, apps, and automations. You can use folders to organize these resources and make large bases easier to browse. Common operations include: * **Create folders**: Create folders in the left sidebar to group related resources. * **Move resources**: Drag tables, apps, or automations into folders, or drag them to reorder. * **Organize hierarchy**: Folders can contain child nodes. Keep the hierarchy shallow enough for easy navigation. * **Add descriptions**: For tables, apps, and automations, click **Add description** under the resource name in the header. Use descriptions to record purpose, owner, handoff notes, or usage rules. Teable opens a description the first time you open its resource, and once more after it changes. * **Check node info**: Open a resource's `...` menu and choose **Node info** to view the folder, table, automation, or app ID, plus created and modified information. ### Duplicate a Base to Another Space Step 1: In the space, select the base you want to duplicate; Step 2: Click the menu icon and select the Copy Base option; Step 3: In the popup, choose the target space. You need Creator permissions in that space. For larger bases, Teable shows progress in the duplicate dialog while it copies the base structure, records, and attachments. Keep the dialog open until the copy finishes. Revision history and collaborators are not copied. If the base contains Link, Lookup, Rollup, Conditional Lookup, or Conditional Rollup fields that point to another Space, Teable shows the affected fields before duplication. If you continue, Teable converts those fields to **Single line text** in the duplicated base. Duplicate a base to another space ### Move a Base Between Spaces If you have the required Space permissions, you can move a base to another Space. If the move would leave relationship-based fields pointing across Spaces, Teable warns you and lists the affected fields. When you confirm, Teable converts those fields to **Single line text** as part of the move. ## Import and Export Bases Use AI Chat to migrate Airtable, Baserow, NocoDB, SmartSuite, and other systems into Teable. ### Import Base (Data Migration) The `.tea` file format imports a complete base with all its tables, fields, data, and configurations. This is useful for: * **Data Migration**: Move bases between different Teable instances (e.g., from Cloud to Self-Hosted) * **Backup Restoration**: Restore a previously exported base * **Template Sharing**: Share complete base structures with other teams **Steps:** 1. Enter the space 2. Click the 「···」 button at the top right corner of the space to open the menu 3. Click 「Import」 4. Choose **Import from file** and upload the `.tea` file. Import a base from a .tea file If you want to create a base from Airtable, choose **Import from Airtable** in the same import dialog. ### Export Base (Backup & Migration) Export your base to a `.tea` file for backup or migration purposes. The exported file contains all tables, fields, data, views, and configurations. **Steps:** 1. Enter the space 2. Hover your mouse over the base you want to export 3. Click the 「···」 button to open the menu 4. Click 「Export」 5. Keep **Include records** turned on to export record data. Turn it off to export only the structure and configuration. 6. Click **Start exporting** and wait for the export to finish. 7. Click **Download** in the export dialog to save the `.tea` file. Export a base to a .tea file * To migrate data between Teable instances, export your base from the source instance, then import the `.tea` file to the target instance. All data and configurations will be preserved. * Teable converts cross-base relation fields to **Single line text** fields in the exported file. * When you duplicate or move a base across Spaces, cross-Space relationship fields are converted to **Single line text**. ## Share a Base Bases can be shared through public links. The sharing scope can be the entire base or the currently selected item. 1. Enter the target base 2. Open the share menu for the base or selected item 3. Turn on **Share to web** 4. Copy the share link or QR code Open base sharing Sharing scopes include: | Scope | Description | | ----------------------- | ---------------------------------------------------------------------------------------------------- | | **Share entire base** | Shares all items in the current base. New tables and folders added later are automatically included. | | **Share selected item** | Shares the currently selected item. When a folder is shared, its child items are included. | In the share settings, you can configure link permissions, **Allow viewers to copy data**, password access, regenerate the link, delete the share link, or copy the embed config. Base sharing settings If the sharing scope includes an app, the app must be published before it can be accessed through the public link. ## Features Within a Base A base can contain multiple tables for recording and organizing work or business-related information. For example: A customer management base might have separate tables for "Customer Companies," "Customer Contacts," and "Customer Follow-up Records," while a meeting room management base might have separate tables for recording "Meeting Room Management," "Meeting Room Equipment," and "Meeting Room Reservations." Therefore, most features within a base are related to tables: * **Creating Tables**: Bases allow users to create new tables based on project-specific needs, where users can define table structure, fields, and data types. * **Editing Tables**: Users can edit existing tables within the base, including adding, deleting, and modifying records. * **Exporting and Importing Data**: Bases support exporting data to CSV, and importing data in both CSV and XLSX formats. Refer to the [Tables section](/en/basic/table) for more information about tables. # Credentials and Integrations Source: https://help.teable.ai/en/basic/credential Manage your connections and secrets, and grant them to the apps and automations that need them. Available on all Cloud plans; Self-Hosted requires Business or higher. When an app or an automation calls an external service, it uses **your credential**. Credentials belong to you, not to the app or automation, and come in two kinds: * **Connections**: third-party accounts you authorize to Teable over OAuth, such as Slack, Airtable, or Google Sheets. * **Secrets**: strings you store yourself, such as an API key or an access token. You manage credentials in **Settings** → **Integrations** and grant them to individual apps and automations. Once granted, everyone who runs that app or automation uses the granting person's credential. The value is never shown to anyone, and automation test results mask it. ## Manage Your Connections and Secrets Click your avatar in the lower left, then open **Settings** → **Integrations**. The page has three sections: **My connections**, **My secrets**, and **Third-party apps you authorized**. **Add secret** asks for: | Field | Description | | --------------- | -------------------------------------------------------------------------------- | | **Key** | Starts with an uppercase letter; uppercase letters, digits, and underscores only | | **Value** | Write-only after saving; enter a new value to replace it | | **Description** | Optional, to record what the secret is for | Add a connection with **Connect new account**. When an authorization expires, the connection offers **Reconnect**. Each credential shows how many resources currently use it. Click **View** for the list of apps and automations, each marked with when the grant was made, where you can **Remove grant** for any single one. ## Grant a Credential to an App or Automation Open the resource's credential panel: * **Apps**: in the App Builder chat panel, open **+** → **More** → **Credentials & config**. * **Automations**: open the workflow and click **Credentials & config** on the **Edit** tab. **Grant** offers three routes: **Grant existing credential** picks one of your secrets or connections; **Add secret** creates one and grants it right away; or pick a third-party service from the **Services** list, which runs an OAuth flow for a service you have not connected and grants directly for one marked **Connected**. Every grant needs a **Variable name**, the alias this credential has inside that app or automation. It follows the same naming rules as a secret key, and it is the name the code reads. The panel can also list **Not bound yet** placeholders. Copying an app, duplicating a workflow, and importing or duplicating a base carry over the aliases the code expects but none of the credentials. Click **Bind mine** to supply your own credential so the app or automation can run. When an alias currently holds someone else's credential, **Replace with mine** takes it over. **Only remove the grant (keep placeholder)** unbinds it and leaves the placeholder, so the code needs no change. Editing a resource's credential grants requires edit permission on that app or automation. You can only grant credentials you own. ## Read a Credential in Code | Where | How to read it | | ----------------------- | ------------------------------------------------------------------------ | | Automation scripts | An environment variable, such as `process.env.EXTERNAL_API_KEY` | | Automation input fields | Click **Insert secret** beside the field and pick a granted secret | | Secrets in an app | Server-side code reads `process.env.MY_API_KEY` | | Connections in an app | Server-side code calls `getConnectionToken('ALIAS')` for an access token | Paste something that looks like a key into an automation input field and Teable stores it as your secret, leaving a reference in place, so the plaintext never lands in the workflow configuration. Click **Undo** in the notice if you would rather keep the text as typed. ## Credential Requests in AI Chat When AI needs an external account, it pins a credential request card to the conversation naming the service it wants a connection for, or the alias it wants a secret for. You can: * **Connect my account**: run an OAuth flow; the new connection is granted to the resource automatically. * **Grant my …**: use a connection or secret you already have. * **Skip**: withhold the credential. AI continues with the parts that do not depend on it. ## Replace, Delete, and Leaving a Space Before you replace a secret value, delete a secret, or disconnect a connection, Teable lists the apps and automations still using it. Deleting and disconnecting break those resources immediately, so grant them a different credential first if they need to keep running. The old secret value cannot be recovered. After a new value is saved, an automation picks it up on its next run; an app picks it up when its preview environment restarts, and a published app when you republish it. When you leave a space where an app or automation still uses your credential, the **Integrations** page flags it with **You left this space**. Click **Remove grant** to stop providing it. # Overview Source: https://help.teable.ai/en/basic/field Fields are the columns in a table. By combining different field types, you can build a structure that fits your workflow. ## Field Types Teable currently provides these field types: | Category | Field types | | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Basic fields | [Single line text](/en/basic/field/single-line-text), [Long text](/en/basic/field/long-text), [Number](/en/basic/field/number), [Single select](/en/basic/field/single-select), [Multiple select](/en/basic/field/multiple-select), [User](/en/basic/field/user), [Date](/en/basic/field/date), [Rating](/en/basic/field/rating), [Checkbox](/en/basic/field/checkbox), [Attachment](/en/basic/field/attachment) | | Advanced fields | [Formula](/en/basic/field/formula), [Link to record](/en/basic/field/link), [Lookup](/en/basic/field/lookup), [Rollup](/en/basic/field/rollup), [Conditional lookup](/en/basic/field/conditional-lookup), [Conditional rollup](/en/basic/field/conditional-rollup), [Button](/en/basic/field/button), [Auto number](/en/basic/field/auto-number) | | System fields | [Created time](/en/basic/field/created-time), [Last modified time](/en/basic/field/last-modified-time), [Created by](/en/basic/field/created-by), [Last modified by](/en/basic/field/last-modified-by) | ## Adding Fields In the table view, follow these steps to add a new field: 1. Enter the table view 2. Scroll the table to the rightmost side 3. Click the + icon on the far right of the field bar Add a field 4. Edit the field in the popup dialog 5. Click Save ## Editing Fields Users can edit fields when adding them or edit existing fields when needed. To edit an existing field, follow these steps: 1. Right-click the field you want to edit Field menu actions 2. Click the Edit Field option in the expanded menu 3. Edit the field in the Edit Field dialog 4. Click Save Editing fields may trigger field conversion. Users can change the current field to a new field type, for example, converting a single-line text field to a single select field. However, in some cases, certain conversions may result in data loss. For example, converting a text field to an attachment field will lose all text information because plain text values cannot be converted to attachments. If you find that some cell values were lost during conversion, you can use the keyboard shortcut `Ctrl+Z`, or `⌘ + Z` on Mac, to undo the conversion, restoring the field to its previous state and recovering any data lost due to the conversion. For detailed information about each field type and its specific customization options, please refer to the documentation for each field type. ## Deleting Fields 1. Right-click the field you want to edit 2. Click the Delete Field option in the expanded menu 3. Click Confirm in the confirmation dialog ## Hiding Fields Users can hide fields through the field right-click menu or the hide tool. Hidden fields will not be displayed in the table view. Users can control field visibility at any time using the hide tool. For filtering, sorting, grouping, and other toolbar capabilities, see [View toolbar](/en/basic/view/toolbar). In the hide tool, click a visible field name to scroll the grid to that column and briefly highlight it. Use the switch next to each field when you want to show or hide the field. Hide fields tool # AI Fields Source: https://help.teable.ai/en/basic/field/ai/ai-field AI fields can summarize text, classify tags, generate scores, or turn content into images. Available on all Cloud plans. Self-hosted deployments require the Business plan or higher. ## Main Use Cases AI fields generate the current field value from other fields in the same row. Use them to turn raw content into summaries, translations, extracted details, categories, scores, dates, or images. Summarize, translate, extract information, improve writing, or customize the output. Best for turning longer text into usable copy. Smart classify or customize the output. Best for matching content to one existing category. Smart tag or customize the output. Best for matching content to one or more existing tags. Rate or customize the output. Best for generating scores or numeric results from source content. Extract information or customize the output. Best for extracting dates or times from content. Generate images or customize the output. Best for creating images from text or attachments. If you are not sure which action to use, start here: * **Summarize**: Creates a summary from the source field. * **Translate**: Translates the source field into the target language. * **Extract Information**: Extracts specific information from text. Date fields can also use it to extract dates or times. * **Improve Writing**: Rewrites content based on your additional requirements. * **Smart Classify**: Matches a single select field to an existing option. * **Smart Tag**: Matches a multiple select field to existing options. * **Rate**: Generates a score or numeric value from the source content. * **Generate Image**: Creates images in an attachment field. Some models support using an attachment field as a reference image. Use a custom prompt when the default actions do not cover your case. Custom prompts can reference fields from the same row. ## Workflow Create a field, choose the field type, then expand **AI Configuration**. Each field type shows the AI actions it supports. Choose the **AI Action Type** and **AI Model**. The action controls the task. The model controls which AI model generates the result. Choose the field AI should read as input. The AI field generates its value from source fields in the same row. Depending on the action, fill in **Additional Requirements**, **Target Language**, or a **Custom Prompt**. For image generation in attachment fields, use **Advanced Settings** to adjust image size, quality, count, aspect ratio, resolution, or reference images. Available settings depend on the selected model. Create an AI field When you edit an AI field, you can change the action type, model, source fields, additional requirements, custom prompt, and auto-update setting. After you save, the new configuration applies to future generations. If an existing result is not what you want, regenerate it. Edit an AI field ## Auto-update and Batch Generation When **Auto-update** is enabled, the AI field updates with the current configuration when source field content or the AI configuration changes. Use it when the result should stay in sync with source content, such as categories, summaries, scores, or tags generated from feedback. After you create a field or change its AI configuration, you can choose whether to process records in the current view right away: Generate content only for empty cells. Existing values are not overwritten. Regenerate results for records in the current view. Existing values are overwritten. Save the field configuration without writing values to cells. AI field save options After you choose a generation option, Teable shows the task status while it processes records. AI field generation status To run generation later, use the field menu instead of saving the configuration again. You can also right-click the field and choose **Generate** to run batch generation for the current view. Availability depends on the current view and your permissions. AI field generate menu ## FAQ After you create a field or change its AI configuration, you can choose **Fill empty cells only**, **Generate entire column**, or **Save configuration only**. You can also batch generate later from the field right-click menu by choosing **Generate**. Enable **Auto-update** if you want the AI field to update when source field content changes. If you want to control when generation runs, leave it off and use **Generate** when needed. AI actions depend on the field type. Text fields are suited for summarizing, translating, and extracting information. Single select fields are suited for Smart Classify. Multiple select fields are suited for Smart Tag. Attachment fields are suited for image generation. The model list comes from models provided by Teable and AI models configured in the current space. To use a third-party model, add a custom AI model in space settings first. Image size, quality, count, aspect ratio, resolution, and reference image options depend on the selected model. Some image models apply a total pixel limit. When you choose a high resolution such as **4K**, Teable uses the largest compliant size for the selected aspect ratio, so the exact width and height can vary. # Attachment Source: https://help.teable.ai/en/basic/field/attachment Store images, PDFs, documents, and other files in records, with support for preview, download, and batch download. The **Attachment** field stores one or more files in a record. Common use cases include contracts, images, invoices, design files, resumes, reports, and images generated by AI fields. ## Use Cases | Scenario | Good for | | -------------------------- | ----------------------------------------------------------------- | | File archive | Contracts, invoices, reports, resumes, and other business files | | Image and asset management | Product images, campaign assets, design files, screenshots | | Form file collection | Resumes, reimbursement receipts, and files submitted by customers | | AI image output | Image results generated by AI fields | ## Create and Configure In a table, click `+` to add a field, then choose **Attachment**. Enter a field name, such as "Files", "Images", or "Contract attachments". After saving, each record can upload one or more files in this field. ## Upload and View Attachment fields can store images, PDFs, documents, archives, and other file types. * **Upload files**: Click the attachment area in a cell or record detail, then choose local files to upload. * **Store multiple attachments**: One attachment cell can contain multiple files. * **Preview files**: Images and some file types can be previewed in the cell or record detail. * **Download or delete one attachment**: Open an attachment to download the file. If you can edit the field, the preview also offers **Delete**, and it moves on to the next file in the record. Attachment fields store files, not plain text. When converting a text field to an attachment field, Teable cannot convert the original text into files. Check whether the data needs a backup before converting the field. ## Batch Download Attachments From the attachment field menu, you can download attachments from the current field as a ZIP file. The download scope follows the current table search results: * If no search is active, Teable downloads downloadable attachments in this attachment field. * If the table is searching and hiding unmatched rows, Teable only downloads attachments from matching records. When downloading the ZIP, you can choose an attachment filename prefix: | Prefix option | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------ | | **Default index** | Uses a system-generated index as the prefix, which helps keep file order clear | | **Select a field as prefix** | Uses another field value as the filename prefix, useful for organizing files by ID, customer name, or project name | | **No prefix** | Keeps the original filename where possible | If duplicate filenames appear in the ZIP file, Teable adds suffixes so each filename stays unique. ## Use with AI Fields AI fields can read attachments and write generated images to attachment fields. * **Read attachments**: In AI field settings, add the attachment field as an input field. Whether the AI field can recognize image or file content depends on the selected model. * **Save images**: Set the AI field output to an attachment field. Generated images are saved to that field. For more information, see [AI Field](/en/basic/field/ai/ai-field). ## Upload Attachments Through API The attachment upload API supports local file upload and URL-based upload. New attachments are appended to the end of the target attachment field in the specified record. See [Upload Attachment API](/en/api-doc/record/upload-attachment). # Auto Number Source: https://help.teable.ai/en/basic/field/auto-number Generate increasing numbers when records are created. Useful for ticket numbers, order sequences, and internal IDs. An **Auto Number** field automatically generates an increasing number for each record. After the field is created, Teable fills existing records and future records with numbers, so users do not need to maintain them by hand. ## Use Cases | Scenario | Good for | | ---------------------------- | ----------------------------------------------------------------------- | | Ticket numbers | Generate short IDs for issues, feedback, or support requests | | Order and contract sequences | Create internal sequence numbers for orders, contracts, or applications | | Member or candidate IDs | Assign base IDs to members, candidates, or employees | | Conversation references | Refer to records with numbers such as `#45` in messages or comments | ## Create and Configure Click the `+` icon on the right side of the table header, then choose **Auto Number** from the field type list. Enter a field name, such as "Order ID", "Member ID", or "Ticket Number". After the field is created, Teable fills sequence numbers for existing records and future records. ## Field Behavior * **Auto-incrementing**: Each new record receives the next number in the sequence. * **Read-only**: Auto numbers are record metadata. Users cannot edit specific values by hand. * **Stable across views**: After a number is generated, it stays with the record. Sorting, filtering, and switching views do not change it. ## Notes * Auto numbers only move forward. If record `3` is deleted, Teable does not reuse that number. The next new record continues with a later number. Gaps can appear in the sequence so references to historical records stay stable. # Button Source: https://help.teable.ai/en/basic/field/button Add a clickable button to each record and use it to trigger an automation. The Button field adds a clickable button to each record. When someone clicks the button, Teable can trigger a configured automation, such as updating a record, creating a record, sending a message, or calling an external system. ## Use Cases | Scenario | Suitable actions | | --------------------- | --------------------------------------------------------------------------------------------------------- | | Status workflow | Start work, complete a task, submit for approval, archive a record | | Data workflow | Convert a lead to an opportunity, create a task from a request, write the current record to another table | | Notifications | Send email, team messages, or reminder notifications | | External integrations | Connect to external systems through an HTTP action in an automation | ## Create and Configure Create a field in the table and choose the **Button** type. Customize the button text and color, such as "Send email", "Submit for approval", or "Generate report". Enable **Limit number of clicks** or **Confirm before click** when needed. Click **Custom automation** and set the actions that should run after the button is clicked. ## Settings | Setting | Description | | ---------------------- | ---------------------------------------------------------------------------- | | Button text and color | Controls how the button appears in the cell | | Limit number of clicks | Sets the maximum click count for each record, with an optional reset setting | | Confirm before click | Shows a confirmation dialog before running the button action | | Custom automation | Configures the automation triggered by the button | ## Common Uses * **Status workflow**: Click "Complete task" to update the current record status to "Completed". * **Lead conversion**: Click "Convert to opportunity" to create a record in the opportunities table and update the lead status. * **Send reminders**: Click "Send reminder" to send an email or team message. * **External system integration**: Use an HTTP action in the automation to sync the current record to another system. ## Notes * Each successful button click that triggers an automation counts toward the workspace automation run quota. * Permission to click a button is separate from permission to edit a record. If users can see the button, they may be able to click it and trigger the workflow, including read-only users or visitors with a shared link. * A button does not perform actions by itself. It depends on the linked automation. If the automation is disabled or deleted, clicking the button has no effect. # Button Practical Guide Source: https://help.teable.ai/en/basic/field/button-practical-guide Use a Button field to trigger automations and turn fixed workflows, such as lead conversion or task reminders, into one click. Button fields are useful for fixed, repeated workflows that should run after a person confirms the action. Common examples include converting a lead to an opportunity, scheduling approved content, sending task reminders, or syncing the current record to an external system. This guide uses lead conversion as the main example and shows how to connect a button to an automation. ## Use Cases | Scenario | What the button can do | | -------------------- | ---------------------------------------------------------------------------------- | | Lead conversion | Create a record in the opportunities table and mark the original lead as converted | | Content scheduling | Create a publishing schedule and notify the teammate responsible for publishing | | Task reminders | Send an email or team message to the assignee | | External system sync | Send the current record to another system through an HTTP request | ## Example: Convert a Lead to an Opportunity In a CRM table, a sales rep clicks the "Convert to opportunity" button after deciding that a lead is ready. The automation completes two actions: * Create a new record in the opportunities table with key information such as company and contact. * Update the original lead status in the leads table to "Converted". ### Prepare the Tables This example uses two tables: | Table | Purpose | Example fields | | ------------------- | -------------------------------------------------------------------- | ------------------------------------------------------ | | Leads table | Stores leads to follow up. This is where the button field is created | Company name, contact, owner, status | | Opportunities table | Stores converted opportunities | Opportunity name, related customer, owner, source lead | ### Create the Button Field Add a button field in the leads table: Create a field and choose **Button** as the field type. Set the button text to "Convert to opportunity" and choose a color that is easy to recognize. To avoid accidental clicks, enable **Confirm before click** and fill in the dialog title, message, and confirm-button text. ### Configure Automation Actions After creating the button field, configure the automation that runs when the button is clicked. In the button field settings, click **Custom automation** and create a workflow. Add a **Create record** action and choose the opportunities table as the target table. Write key lead fields into the new opportunity. For example: * `Opportunity name` = `Company name` from the triggering record * `Related customer` = `Contact` from the triggering record * `Owner` = `Owner` from the triggering record Add an **Update record** action. Choose the leads table as the target table, use the triggering record ID as the record ID, and update `Status` to "Converted". After saving the automation, the sales rep can click "Convert to opportunity" to create the opportunity and update the original lead status. ### Add Notifications If a sales manager or opportunity owner needs to be notified after conversion, add a **Send email** action or a team message action to the automation. Common settings: * **Recipient**: A fixed email address, or a user field from the current record. * **Subject and body**: Insert field values from the triggering record, such as company name, owner, or lead source. Example email body: > New opportunity converted: \[Company name] was converted by \[Owner]. Please follow up. ### Connect External Systems If converted opportunities also need to be synced to a CRM, finance system, or internal tool, add an HTTP request action to the automation. HTTP requests work best when the target system has a stable API. Before configuring the action, confirm the endpoint, request method, authentication method, and field format. ### Limit Duplicate Clicks Lead conversion usually should not happen more than once for the same lead. Enable **Limit number of clicks** in the button field: | Setting | Recommendation | | ----------- | ------------------------------------------------------ | | Max clicks | Set to `1` | | Allow reset | Usually keep this off to avoid duplicate opportunities | After the click limit is reached, the button on that record becomes disabled. ## Notes * Whether a button click runs successfully depends on whether the linked automation is enabled and working. * Each successful automation trigger counts toward the workspace automation run quota. * If the button changes important data, enable click confirmation and limit the number of clicks. # Checkbox Source: https://help.teable.ai/en/basic/field/checkbox Store binary states such as yes/no or done/not done. A **Checkbox** field records a binary state, such as yes/no, on/off, or done/not done. Users can click a cell to switch between checked and unchecked. ## Use Cases | Scenario | Good for | | ------------------- | ----------------------------------------------------------------------------------- | | Task completion | Done, processed, archived | | Quick flags | VIP, blocked, needs restock | | Process checkpoints | Image uploaded, copy reviewed, approval passed | | Automation triggers | Send a notification, update a status, or start the next step after a box is checked | ## Create and Configure Click the `+` on the right side of the table header, then choose **Checkbox** from the field type list. Enter a field name, such as "Done", "VIP", or "Approved". Choose whether new records should be checked or unchecked by default. After saving, users can click cells to switch the state. ## Common Uses * **Task status**: Use a "Done" field in a task table, then create an "Incomplete tasks" view that only shows unchecked records. * **Quick flags**: Mark "VIP" in a customer table or "Needs restock" in an inventory table. * **Process checkpoints**: Add fields such as "Image uploaded" or "Copy reviewed" in a content calendar so collaborators can see which steps are complete. ## Use Checkbox Values in Formulas Checkbox fields can be used as boolean values in formulas. For example, return different text based on completion status: ```js theme={null} IF({Done}, "Done", "In progress") ``` ## Statistics and Automation * **Track completion**: Use the summary bar to count checked values. With counts, you can calculate completion rates. * **Trigger automation**: When "Approved" is checked, automation can send an email or update other fields. ## Notes * A Checkbox field only represents two states. If you need several states, such as "Not started", "In progress", and "Done", use a **Single Select** field. * Use Checkbox fields for clear switches. Do not use them for notes, reasons, or explanations. # Formatting Source: https://help.teable.ai/en/basic/field/common/formatter Control how field values appear, such as decimal places, percentages, currency symbols, date formats, and time formats. Formatting controls how field values appear. It does not change the field's raw data. It only changes what users see in the table, such as decimal places, percentages, currency symbols, date formats, and time formats. ## Number Formatting Number fields can use display formats that match your work: | Format | Description | | ---------- | ------------------------------------------------------ | | Decimal | Set how many decimal places to show | | Percentage | Show a number as a percentage, such as `0.25` as `25%` | | Currency | Add a currency symbol and set decimal places | ## Date and Time Formatting Date and time fields can set the date format, time format, and timezone. | Setting | Example | | ------------------- | ------------ | | US style | `12/31/2023` | | European style | `31/12/2023` | | Asian style | `2023/12/31` | | ISO standard | `2023-12-31` | | Year and month only | `2023-12` | | Month and day only | `12-31` | | Year only | `2023` | | Month only | `12` | | Day only | `31` | Time formats support 24-hour time, 12-hour time, or no time display. Timezones can use a fixed timezone or follow the viewer's location. ## Field Basic Data Types | Teable field type | Basic data type | Supports formatting | Dynamic type flag | | ------------------ | --------------- | ------------------- | ----------------- | | Single line text | Text | No | No | | Long text | Text | No | No | | User | Text | No | No | | Attachment | Text | No | No | | Checkbox | Boolean | No | No | | Multiple select | Text | No | No | | Single select | Text | No | No | | Date | Date | Yes | No | | Number | Number | Yes | No | | Duration | Number | Yes | No | | Rating | Number | No\* | No | | Formula\* | Dynamic | Yes\* | Yes | | Rollup\* | Dynamic | Yes\* | Yes | | Count | Number | Yes | No | | Link | Text | No | No | | Created time | Date | Yes | No | | Last modified time | Date | Yes | No | | Created by | Text | No | No | | Last modified by | Text | No | No | | Auto number | Number | Yes | No | | Button | Text | No | No | ## Notes * Rating fields show an interactive rating bar. They do not use number formatting, but they are still number fields and can be used in numeric calculations. * Formula and rollup formatting depends on the output type. If the result is a date or number, it can be formatted. If the result is text or boolean, formatting does not apply. * Referenced fields still follow the basic value type of the original field. # Single Value and Multiple Values Source: https://help.teable.ai/en/basic/field/common/is-multiple-value Explains whether a field cell stores one value or a group of values. Single value and multiple values describe whether a cell stores one value or a group of values. After you understand this concept, it is easier to see why links, lookups, rollups, and formulas may return multiple results. ## Basic Concepts | Type | Description | Example | | --------------- | ---------------------------------------------- | ----------------------------------------------------- | | Single value | One definite piece of information | "today's date", "John's phone number" | | Multiple values | A group of values, also understood as an array | "all dates this month", "all of John's phone numbers" | ## Default Single and Multiple Value States | Field type | Default state | | ----------------------------------------------------------------------------------- | ------------- | | Single line text, long text | Single | | Single select, checkbox, date, number, rating | Single | | Created time, last modified time, created by, last modified by, auto number, button | Single | | Multiple select, attachment | Multiple | | User | Optional | | Link | Optional | | Formula, rollup | Dynamic | Here, "default state" means the field's common state on its own. **Optional** means you can decide whether the field is single-value or multiple-value through field settings. **Dynamic** means the result depends on formula logic, rollup functions, and whether referenced fields are multiple-value fields. After a value passes through a link, lookup, rollup, or formula reference, its state may change. ## State Changes from Links and References * **Link fields**: If a link field is multiple-value, fields referenced through that link may also become multiple-value. For example, if one task can be assigned to several employees, looking up employee phone numbers through that link may return several phone numbers. * **Formulas and rollups**: Formulas and rollups are often single-value, but they may become multiple-value when they reference multiple-value fields. ### Example Suppose you manage a company in Teable with two tables: `Employee Information` and `Project Tasks`. **Employee Information table** | Name | Phone | Email | Tasks | | ---- | ------ | ------------------------------------------- | -------------- | | John | 123456 | [john@company.com](mailto:john@company.com) | Task 1, Task 2 | | Mary | 789012 | [mary@company.com](mailto:mary@company.com) | Task 3 | **Project Tasks table** | Task name | Assignee | Due date | Progress | | --------- | -------- | ---------- | -------- | | Task 1 | John | 2023-11-20 | 50% | | Task 2 | John | 2023-12-01 | 30% | | Task 3 | Mary | 2023-11-15 | 80% | In this example: * The "Tasks" field in the **Employee Information** table is multiple-value because one employee can be responsible for several tasks. * The "Assignee" field in the **Project Tasks** table is single-value because each task has one assignee. When you create a new task in the "Project Tasks" table and assign it to an employee, that employee's "Tasks" field in the "Employee Information" table updates to include all assigned tasks. ### Number Mini Charts Number fields sometimes display multiple lines or bars instead of one number. This usually means the field has become multiple-value, often through a link, lookup, rollup, or formula reference. # Interactive Display Source: https://help.teable.ai/en/basic/field/common/show-as Change field value display and click behavior, such as emails, phone numbers, and number charts. Interactive display changes how field values appear and behave when clicked. It does not change the field type. It only changes how users view and interact with the field content. ## Interactive Display for Text Fields | Display | Description | | ------- | ------------------------------------------------------------------------------------------ | | Email | Show text as an email address. Clicking it opens the default mail app | | Phone | Show text as a phone number. Clicking it starts a call action, depending on device support | ## Interactive Display for Number Fields Number fields can show numeric status as charts. ### Single-Value Number Fields | Display | Description | | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | Bar | Show the value with bar length. You can set the color, whether to show the value, and the target value that represents 100% | | Ring | Show the value as ring progress. You can set the color, whether to show the value, and the target value that represents 100% | ### Multiple-Value Number Fields | Display | Description | | ------- | ------------------------------------------------ | | Bar | Show multiple number values as side-by-side bars | | Line | Show multiple number values as a line chart | ## Notes * The target value is a display reference. It does not set a hard upper limit. * Interactive display can also apply to some formula, rollup, and lookup results. Available options depend on the result type. # Conditional Lookup Source: https://help.teable.ai/en/basic/field/conditional-lookup Look up data across tables with filter conditions and return matching record values. Conditional Lookup can fetch matching data from a target table without creating a link relationship first. It is useful when the lookup needs to change based on field values in the current record, such as finding the top-selling product in the same category or looking up data for a matching period. ## Use Cases | Scenario | Good for | | ----------------- | ------------------------------------------------------------------------------ | | Category analysis | Find the top-selling product in the same category | | Period comparison | Look up the previous period's sales amount for period-over-period calculations | | Customer matching | Find customer details by phone number, email, or customer ID | | Detail lookup | Return matching detail records based on conditions from the current record | ## Procedure Click the `+` icon on the right side of a field name, choose **Conditional Lookup**, and enter a field title, such as "Related orders". In the target table dropdown, choose the table to query. Choose the field to extract and confirm the returned data type. Add filter conditions, choose the field, condition type, and comparison value. The comparison value can be a static value or a field from the current table. Set the sort field, sort direction, and number of records to show when needed. Turn on **Remove duplicate values** and each value is shown once. At least one filter condition is required. For multiple conditions, choose "All conditions are met (AND)" or "Any condition is met (OR)". ## Scenario Practice ### Sales Data Period-over-Period Analysis **Tables** * Period sales summary table, with fields such as period, start date, end date, and sales amount * Sales detail table, with fields such as sales amount and sales date In the period sales summary table, calculate period-over-period growth for each period. First use Conditional Rollup to calculate current period sales, then use Conditional Lookup to fetch previous period sales, and finally use a Formula field to calculate the growth rate. **Steps** **Create a conditional rollup field for current period sales** 1. In the period sales summary table, create a Conditional Rollup field named "Current period sales" 2. Target table: Sales detail table 3. Rollup field: Sales amount 4. Filter conditions: * Field: Sales date -> Condition: Earlier than or equal to -> Value: End date field from the current table * Field: Sales date -> Condition: Later than or equal to -> Value: Start date field from the current table 5. Aggregate function: Sum **Create a conditional lookup field for previous period sales** 1. Create a Conditional Lookup field named "Previous period sales" 2. Target table: Period sales summary table (this table) 3. Field: Current period sales 4. Filter condition: * Field: End date -> Condition: Equals -> Value: Previous period end date field from the current table 5. Aggregate function: Sum **Create a formula field for period-over-period growth** 1. Create a Formula field named "Period-over-period growth rate" 2. Set the formula to `(Current period sales - Previous period sales) / Previous period sales * 100` 3. Format it as a percentage with 2 decimal places ### Sales Data Product Analysis **Tables** * Products table, with fields such as category ID, product name, and sales volume * Categories table, with fields such as category ID and category name In the categories table, find the top-selling product for each category to identify the main product in each category. **Steps** **Top-selling product** 1. In the categories table, create a Conditional Lookup field named "Top-selling product" 2. Target table: Products table 3. Lookup field: Product name 4. Filter condition: * Field: Category ID -> Condition: Equals -> Value: Category ID field from the current table 5. Sorting: Sales volume field -> Descending 6. Limit display: 1 record **Sales volume** 1. Create another Conditional Lookup field named "Sales volume" 2. Target table: Products table 3. Lookup field: Sales volume 4. Filter condition: * Field: Category ID -> Condition: Equals -> Value: Category ID field from the current table 5. Sorting: Sales volume field -> Descending 6. Limit display: 1 record ## FAQ Some complex field types, such as images and attachments, may not support filter conditions. A regular Lookup field requires a Link field first. Conditional Lookup can match data in the target table directly with filter conditions. # Conditional Rollup Source: https://help.teable.ai/en/basic/field/conditional-rollup Calculate cross-table statistics with filter conditions and return one aggregated value. Conditional Rollup filters matching records from a target table without creating a link relationship first, then calculates statistics on a selected field. It is useful for calculating counts, sums, averages, and other results based on field values in the current record. ## Use Cases | Scenario | Good for | | ------------------------ | ------------------------------------------------------------------------- | | Employee task statistics | Count in-progress tasks and completed tasks for an assignee | | Period sales statistics | Calculate sales amount, order count, or average order value by date range | | Duplicate data checks | Count duplicate names, phone numbers, or IDs | | Regional reports | Aggregate business data by region, store, or channel | ## Procedure Click the `+` icon on the right side of a field name, choose **Conditional Rollup**, and enter a field title, such as "Total sales amount". In the target table dropdown, choose the table to query. Choose the field to calculate and confirm the field type. Add filter conditions, choose the field, condition type, and comparison value. The comparison value can be a static value or a field from the current table. Choose a calculation method based on the data type, such as original value, unique values, unique count, sum, count, average, maximum, or minimum. ## Scenario Practice ### Team Task Volume Statistics **Tables** * Tasks table * Statistics table A team admin needs to count tasks in different statuses for each employee, such as in-progress and completed tasks, to understand workload distribution and completion progress. **In-progress tasks** 1. In the employee information table, create a Conditional Rollup field named "In-progress tasks" 2. Target table: Task assignments table 3. Rollup field: Task ID 4. Filter conditions: * Field: Assignee -> Condition: Equals -> Value: Employee field from the current table * Field: Task status -> Condition: Equals -> Value: "In progress" 5. Aggregate function: Count all **Completed tasks** 1. Create another Conditional Rollup field named "Completed tasks" 2. Target table: Task assignments table 3. Rollup field: Task ID 4. Filter conditions: * Field: Assignee -> Condition: Equals -> Value: Employee field from the current table * Field: Task status -> Condition: Equals -> Value: "Completed" 5. Aggregate function: Count all ### Find Duplicate Values **Tables** * Customers table, with fields such as customer name and phone number In the customers table, find duplicate customer names before merging customer profiles. **Steps** 1. In the customers table, create a Conditional Rollup field named "Customer name duplicate count" 2. Target table: Customers table (this table) 3. Rollup field: Customer name 4. Filter condition: * Field: Customer name -> Condition: Equals -> Value: Customer name field from the current table 5. Aggregate function: Count all 6. Create a Formula field named "Duplicate flag" 7. Set the formula to `IF(Customer name duplicate count > 1, "Duplicate", BLANK())` The customers table shows how many times each customer name appears and marks duplicate records with "Duplicate", so you can filter and handle them later. ## FAQ Conditional Rollup returns one calculated value, which works well for totals, counts, and averages. Conditional Lookup returns a list of matching raw values, which works well for viewing detail data. # Created By Source: https://help.teable.ai/en/basic/field/created-by Automatically record who created each record. The **Created By** field automatically records who first created each record. Teable generates the value, so it works well for source tracking, workload analysis, and personal views. ## Use Cases | Scenario | Good for | | ------------------- | ------------------------------------------------------------- | | Source tracking | See which member first created a record | | Workload statistics | Group by creator and count how many records each member added | | Personal views | Filter records created by the current user | | Accountability | Find the original source when data looks wrong | ## Create and Configure Click the `+` icon on the right side of the table header, then choose **Created By** from the field type list. Enter a field name, such as "Submitted by" or "Registered by". After the field is added, it automatically shows the avatar and name of the original creator. ## Common Uses * **Workload statistics**: Group by the Created By field to see how many records each member created. * **Issue tracing**: When data looks wrong, check the Created By field to find the original source. * **Personal workspace**: Set a filter such as `Created By` `is` `current user`. ## Notes * Created By records the person who created the record **first**. Later edits by other members do not change this field. * To track who last edited a record, use **Last Modified By**. * For records imported from Excel or CSV, Created By usually records the user who ran the import. # Created Time Source: https://help.teable.ai/en/basic/field/created-time Automatically record when each record was first created. The **Created Time** field automatically records when each record was first created. Teable writes the value, so it works well for sorting, filtering, and reporting by creation time. ## Use Cases | Scenario | Good for | | --------------------- | ------------------------------------------------------------------------ | | New record tracking | See when each record was created | | Latest record sorting | Sort by Created Time descending to handle the newest data first | | Period reporting | Filter data created this week, this month, or within a custom date range | | Read-only timestamp | Store a creation time that users cannot edit by hand | ## Create and Configure Click the `+` icon on the right side of the table header, then choose **Created Time** from the field type list. Enter a field name, such as "Submitted at" or "Registered date". After the field is added, Teable fills the creation time for existing records and future records. ## Display Format | Setting | Description | | ----------- | --------------------------------------------------------------- | | Date format | Controls how dates are displayed for your business format | | Time format | Shows or hides time, and supports 12-hour or 24-hour time | | Time zone | Follows the viewer's system time zone or uses a fixed time zone | ## Common Uses * **Show latest activity first**: Sort by Created Time descending so newly created records appear at the top. * **Report by period**: Set a filter such as `Created Time` `is` `this month` to see new records for the month. ## Notes * Created Time is read-only and cannot be edited by hand. * When records are imported from Excel or CSV, the created time is usually the import time. * If you need to record a business date manually, use a **Date** field. # Date Source: https://help.teable.ai/en/basic/field/date Store dates and times, with support for date format, time format, time zone, and auto-fill current time. A **Date** field stores a specific date or point in time, such as a project deadline, meeting time, or employee start date. It can show only the date, or include a time such as `2025-11-03 14:30`. ## Use Cases | Scenario | Good for | | --------------------------- | ------------------------------------------------- | | Project scheduling | Task start dates, deadlines, milestone dates | | Event planning | Meetings, events, appointments, release plans | | People and contract records | Start dates, signing dates, expiration dates | | Period reporting | Filter and report data by week, month, or quarter | ## Create and Configure In table view, add a field and choose **Date**. Enter a field name, such as "Due Date", "Meeting Time", or "Start Date". Set the date format, whether to include time, the time format, and the time zone as needed. If new records should use the current time automatically, enable auto-fill current time. ## Date Field Options | Option | Description | | ---------------------- | ---------------------------------------------------------------------------------------- | | Include time | Store a specific time in addition to the date | | Date format | Controls date display, such as `YYYY-MM-DD`, `DD/MM/YYYY`, `MM/DD/YYYY`, or `D MMM YYYY` | | Time format | Controls whether time is shown, and whether it uses 12-hour or 24-hour time | | Time zone | Sets the time zone used for dates and times, useful for teams across regions | | Auto-fill current time | Fills new records with the current time when they are created | For more formats, see [Formatter](/en/basic/field/common/formatter). ## Common Uses * **Task scheduling**: Record start dates and due dates, then sort or filter by due date. * **Event planning**: Record meeting and event times so important dates are easy to track. * **Period reporting**: Filter data for this week, this month, or a custom date range. * **Date calculations**: Reference Date fields in Formula fields to calculate intervals between dates. ## Notes If you need to record when a record was created and keep that value read-only, use **[Created Time](/en/basic/field/created-time)**. # Formula Source: https://help.teable.ai/en/basic/field/formula Reference other fields and calculate text, numbers, dates, and logical conditions with formulas. Formula fields calculate results from other fields in the same record. They can handle math operations, text joining, date calculations, and conditional logic. Use them to turn repeated calculation rules into fields. ## Use Cases | Scenario | Good for | | --------------------- | --------------------------------------------------------------------------------------------- | | Automatic calculation | Calculate total price, profit, or score from quantity, unit price, discount, and other fields | | Text processing | Join text, extract content, or parse information by delimiter | | Date processing | Calculate date differences, check time ranges, or generate future dates | | Conditional logic | Return different results based on conditions, such as status, hints, or categories | ## Formula Basics ### Data Types Before writing a formula, confirm the types of the fields used in the calculation. Different types support different operations and functions. | Type | Description | Common uses | | ------- | ------------------------ | ----------------------------------------- | | Number | Integers or decimals | Arithmetic, rollups, comparisons | | Text | String values | Joining, extracting, replacing, splitting | | Date | Date or date-time values | Calculating intervals, comparing dates | | Boolean | `TRUE` or `FALSE` | Conditions and logical operations | ### Reference Fields In a formula, reference another field by its field name. Wrap the field name in `{}` and keep it consistent with the actual field name: ```js theme={null} {Unit price} * {Quantity} ``` ### Operators | Operator | Use | | -------- | ----------------------------------------------- | | `+` | Calculates the sum of numbers, or joins strings | | `-` | Calculates the difference between numbers | | `*` | Calculates the product of numbers | | `/` | Calculates the quotient of numbers | | `%` | Calculates the remainder | ## Functions and Expressions ### Common Functions Functions perform specific operations. For example, `SUM` calculates a total, `LEFT` extracts characters from the start of text, `TEXTBEFORE` extracts text before a delimiter, and `TEXTSPLIT` splits text by a delimiter. See the [formula cheat sheet](/en/basic/field/formula/cheat-sheet) for more functions. ### Text Processing | Operation | Function examples | Description | | ------------ | ------------------------------------ | --------------------------------------------- | | Join text | `&`, `CONCATENATE` | Joins two or more text values | | Extract text | `LEFT`, `RIGHT`, `MID`, `TEXTBEFORE` | Extracts part of a string | | Split text | `TEXTSPLIT` | Splits text into multiple values by delimiter | ### Logical Conditions Use the `IF` function to return different values based on a condition: ```js theme={null} IF(condition, value_if_true, value_if_false) ``` When checking whether a field is empty, compare it with `BLANK()`. For example, `IF({Weight}=BLANK(), 1, 2)` returns `1` when a number field is empty, and `2` otherwise. ### Complex Expressions A complex formula can include multiple functions, field references, and operators. Use parentheses to control calculation order: ```js theme={null} ({Unit price} * {Quantity}) * (1 - {Discount}) ``` ## Result Display and Maintenance ### Formatting and Interactive Display Formula results can also use [formatting](/en/basic/field/common/formatter) and [interactive display](/en/basic/field/common/show-as) settings, such as percentage, progress bar, or icon styles. Available options depend on the formula result type. ### Debugging and Optimization * **Check data types**: Confirm that operations and functions use the correct data types. * **Verify field references**: Confirm that field names are written correctly. * **Test step by step**: Break complex formulas into smaller parts and test them separately. * **Avoid repeated calculations**: If the same calculation is used in several places, consider storing the result in a separate field. # Function Cheat Sheet Source: https://help.teable.ai/en/basic/field/formula/cheat-sheet Quickly find formula functions, parameters, output types, and basic examples. The function cheat sheet helps you find available functions, parameters, output types, and examples. When writing a formula, use the function category to find the function you need. ## Numeric Functions Numeric functions handle math operations, statistical calculations, and number formatting. | Function Name | Description | Input | Output | Example | | ------------- | ------------------------------------------------------------------------------------------------------- | ------------------------- | ------ | --------------------------------------------------- | | SUM | Adds numbers together. Equivalent to number1 + number2 + ... | `number1, [number2, ...]` | Number | `SUM(100, 200, 300) => 600` | | AVERAGE | Returns the average of numbers. | `number1, [number2, ...]` | Number | `AVERAGE(100, 200, 300) => 200` | | MAX | Returns the largest value among given numbers. | `number1, [number2, ...]` | Number | `MAX(100, 200, 300) => 300` | | MIN | Returns the smallest value among given numbers. | `number1, [number2, ...]` | Number | `MIN(100, 200, 300) => 100` | | ROUND | Rounds a value to the number of decimal places specified by "precision". | `value, [precision]` | Number | `ROUND(1.99, 0) => 2` `ROUND(16.8, -1) => 20` | | ROUNDUP | Always rounds up, away from zero. | `value, [precision]` | Number | `ROUNDUP(1.1, 0) => 2` `ROUNDUP(-1.1, 0) => -2` | | ROUNDDOWN | Always rounds down, toward zero. | `value, [precision]` | Number | `ROUNDDOWN(1.9, 0) => 1` `ROUNDDOWN(-1.9, 0) => -1` | | CEILING | Returns the nearest integer multiple greater than or equal to the value. | `value, [significance]` | Number | `CEILING(2.49) => 3` `CEILING(2.49, 1) => 2.5` | | FLOOR | Returns the nearest integer multiple less than or equal to the value. | `value, [significance]` | Number | `FLOOR(2.49) => 2` `FLOOR(2.49, 1) => 2.4` | | EVEN | Returns the smallest even number greater than or equal to the specified value. | `value` | Number | `EVEN(0.1) => 2` `EVEN(-0.1) => -2` | | ODD | Rounds positive values up to the nearest odd number and negative values down to the nearest odd number. | `value` | Number | `ODD(0.1) => 1` `ODD(-0.1) => -1` | | INT | Returns the integer part of a number. | `value` | Number | `INT(1.9) => 1` `INT(-1.9) => -2` | | ABS | Returns the absolute value. | `value` | Number | `ABS(-1) => 1` | | SQRT | Returns the square root of a non-negative number. | `value` | Number | `SQRT(4) => 2` | | POWER | Calculates the specified base to the specified power. | `base, exponent` | Number | `POWER(2, 2) => 4` | | EXP | Calculates Euler's number (e) to the specified power. | `value` | Number | `EXP(0) => 1` `EXP(1) => 2.718` | | LOG | Calculates the logarithm of a value in the provided base. If not specified, base defaults to 10. | `value, [base=10]` | Number | `LOG(100) => 2` `LOG(1024, 2) => 10` | | MOD | Returns the remainder after dividing the first parameter by the second. | `value, divisor` | Number | `MOD(9, 2) => 1` `MOD(9, 3) => 0` | | VALUE | Converts a text string to a number. | `text` | Number | `VALUE("$1,000,000") => 1000000` | ## Text Functions Text functions handle joining, searching, replacing, extracting, and splitting strings. | Function Name | Description | Input | Output | Example | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | ------------- | ---------------------------------------------------------------- | | CONCATENATE | Joins multiple value type parameters into a single text value. | `text1, [text2, ...]` | Text | `CONCATENATE("Hello ", "Teable") => Hello Teable` | | FIND | Finds the position of a substring in specified text. Returns 0 if substring not found. | `stringToFind, whereToSearch, [startFromPosition]` | Number | `FIND("Teable", "Hello Teable") => 7` | | SEARCH | Finds the position of a substring in specified text. Returns empty if substring not found. Similar to FIND but returns empty instead of 0. | `stringToFind, whereToSearch, [startFromPosition]` | Text or Empty | `SEARCH("Teable", "Hello Teable") => 7` | | MID | Extracts a specified number of characters from a text string starting at a specified position. | `text, whereToStart, count` | Text | `MID("Hello Teable", 6, 6) => "Teable"` | | LEFT | Extracts a specified number of characters from the start of a string. | `text, count` | Text | `LEFT("2023-09-06", 4) => "2023"` | | RIGHT | Extracts a specified number of characters from the end of a string. | `text, count` | Text | `RIGHT("2023-09-06", 5) => "09-06"` | | REPLACE | Replaces a specified number of characters starting at a specified position with replacement text. | `text, whereToStart, count, replacement` | Text | `REPLACE("Hello Table", 7, 5, "Teable") => "Hello Teable"` | | REGEXP\_REPLACE | Replaces all substrings matching a regular expression with replacement text. | `text, regular_expression, replacement` | Text | `REGEXP_REPLACE("Hello Table", "H.* ", "") => "Teable"` | | SUBSTITUTE | Replaces old text with new text. Can specify an index to replace a specific occurrence of old text. If no index specified, replaces all occurrences. | `text, oldText, newText, [index]` | Text | `SUBSTITUTE("Hello Table", "Table", "Teable") => "Hello Teable"` | | TEXTBEFORE | Returns the text before the specified delimiter. | `text, delimiter` | Text | `TEXTBEFORE("20, 04, 79", ",") => "20"` | | TEXTSPLIT | Splits text by the specified delimiter and returns multiple text values. | `text, delimiter` | Array | `TEXTSPLIT("20, 04, 79", ",") => ["20", " 04", " 79"]` | | LOWER | Converts string to lowercase. | `text` | Text | `LOWER("Hello Teable") => "hello teable"` | | UPPER | Converts string to uppercase. | `text` | Text | `UPPER("Hello Teable") => "HELLO TEABLE"` | | REPT | Repeats text a specified number of times. | `text, number` | Text | `REPT("Hello!", 3) => "Hello!Hello!Hello!"` | | TRIM | Removes whitespace characters from the beginning and end of a string. | `text` | Text | `TRIM(" Hello ") => "Hello"` | | LEN | Counts the number of characters in a string. | `text` | Number | `LEN("Hello") => 5` | | T | Returns the parameter if it's text, otherwise returns empty. | `value` | Text or Empty | `T("Hello") => "Hello"` `T(100) => null` | | ENCODE\_URL\_COMPONENT | Replaces certain characters with encoded equivalents for constructing URLs or URIs. Does not encode: - \_ . \~ | `value` | Text | `ENCODE_URL_COMPONENT("Hello Teable") => "Hello%20Teable"` | ## Logical Functions Logical functions handle conditions and logical operations, such as `IF`, `AND`, and `OR`. | Function Name | Description | Input | Output | Example | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | --------------------------------------- | --------------------------------------------------------------------------- | | IF | Returns value1 if the logical parameter is true, otherwise returns value2. Can be used for nested IF statements and checking if cells are empty. | `logical, value1, value2` | String \| Number \| Boolean \| Datetime | `IF(2 > 1, "A", "B") => "A"` `IF(2 > 1, TRUE, FALSE) => TRUE` | | SWITCH | Matches an input expression against a series of values and returns the corresponding result. Can return a default value if no match is found. Can often replace nested IF() formulas. | `expression, [pattern, result]..., [default]` | String \| Number \| Boolean \| Datetime | `SWITCH("B", "A", "Value A", "B", "Value B", "Default Value") => "Value B"` | | AND | Returns true if all parameters are true; otherwise returns false. | `logical1, [logical2, ...]` | Boolean | `AND(1 < 2, 5 > 3) => true` `AND(1 < 2, 5 < 3) => false` | | OR | Returns true if any parameter is true. | `logical1, [logical2, ...]` | Boolean | `OR(1 < 2, 5 < 3) => true` `OR(1 > 2, 5 < 3) => false` | | XOR | Returns true if an odd number of parameters are true. | `logical1, [logical2, ...]` | Boolean | `XOR(1 < 2, 5 < 3, 8 < 10) => false` `XOR(1 > 2, 5 < 3, 8 < 10) => true` | | NOT | Inverts the logical value of its parameter. | `boolean` | Boolean | `NOT(1 < 2) => false` `NOT(1 > 2) => true` | | BLANK | Returns a null value. Can also be used to test whether a field is empty. | `-` | null | `BLANK() => null` `IF({Weight}=BLANK(), 1, 2) => 1` | | ERROR | Returns an error value. | `message` | Error | `IF(2 > 3, "Yes", ERROR("Calculation")) => "#ERROR: Calculation"` | | IS\_ERROR | Returns true if the expression causes an error. | `expr` | Boolean | `IS_ERROR(ERROR()) => true` | ## Date Functions Date functions handle and convert date and time values, such as getting the current date, calculating date differences, and comparing dates. | Function Name | Description | Input | Output | Example | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -------- | ------------------------------------------------------------------------------------------------------- | | TODAY | Returns the current date. | `-` | Datetime | `TODAY() => "2023-09-08 00:00"` | | NOW | Returns the current date and time. | `-` | Datetime | `NOW() => "2023-09-08 16:50"` | | YEAR | Returns the four-digit year of a date. | `date` | Number | `YEAR("2023-09-08") => 2023` | | MONTH | Returns the month of a date as a number between 1 (January) and 12 (December). | `date` | Number | `MONTH("2023-09-08") => 9` | | WEEKNUM | Returns the week number of the year. | `date` | Number | `WEEKNUM("2023-09-08") => 36` | | WEEKDAY | Returns the day of the week as an integer between 0 and 6. You can optionally provide a second parameter ("Sunday" or "Monday") to start the week on that day. | `date, [startDayOfWeek]` | Number | `WEEKDAY("2023-09-08", "Monday") => 5` | | DAY | Returns the day of the month as a number between 1-31. | `date` | Number | `DAY("2023-09-08") => 8` | | HOUR | Returns the hour of a date as a number between 0 (12:00am) and 23 (11:00pm). | `date` | Number | `HOUR("2023-09-08 16:50") => 16` | | MINUTE | Returns the minute of a date as an integer between 0 and 59. | `date` | Number | `MINUTE("2023-09-08 16:50") => 50` | | SECOND | Returns the seconds of a date as an integer between 0 and 59. | `date` | Number | `SECOND("2023-09-08 16:50:30") => 30` | | FROMNOW | Calculates the number of days between the current date and another date. | `date, unit` | Number | `FROMNOW({Date}, "day") => 25` | | TONOW | Calculates the number of days between the current date and another date. | `date, unit` | Number | `TONOW({Date}, "day") => 25` | | DATETIME\_DIFF | Returns the datetime difference in specified units. Default unit is seconds. (See unit specifier list.) | `date1, date2, [unit]` | Number | `DATETIME_DIFF("2022-08-01", "2023-09-08", "day") => 403` | | WORKDAY | Returns the workday date offset from the start date, excluding specified holidays | `date, count, [holidayStr]` | Datetime | `WORKDAY("2023-09-08", 200) => "2024-06-14 00:00:00"` | | WORKDAY\_DIFF | Returns the number of workdays between date1 and date2. Workdays exclude weekends and an optional list of holidays formatted as a comma-separated string of ISO format dates. | `date1, date2, [holidayStr]` | Number | `WORKDAY_DIFF("2023-06-18", "2023-10-01") => 75` | | IS\_SAME | Compares two dates to a unit and determines if they are the same. Returns true if they are, false otherwise. | `date1, date2, [unit]` | Boolean | `IS_SAME("2023-09-08", "2023-09-10") => false` | | IS\_AFTER | Determines if date1 is later than date2. Returns true if it is, false otherwise. | `date1, date2, [unit]` | Boolean | `IS_AFTER("2023-09-10", "2023-09-08") => true` `IS_AFTER("2023-09-10", "2023-09-08", "month") => false` | ## Array and Other Functions Array and other functions handle rollup arrays, deduplication, joining, cleaning empty values, and record IDs. | Function Name | Description | Input | Output | Example | | -------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | ------ | ----------------------------------------------------------------------------- | | COUNTALL | Returns the count of all elements, including text and blanks. | `value1, [value2, ...]` | Number | `COUNTALL(100, 200, "", "Teable", TRUE()) => 5` | | COUNTA | Returns the count of non-empty values. This function counts both numbers and text values. | `value1, [value2, ...]` | Number | `COUNTA(100, 200, 300, "", "Teable", TRUE) => 4` | | COUNT | Returns the count of numeric items. | `value1, [value2, ...]` | Number | `COUNT(100, 200, 300, "", "Teable", TRUE) => 3` | | ARRAY\_JOIN | Joins an array of rollup items into a string using a separator. | `array, [separator]` | String | `ARRAY_JOIN(["Tom", "Jerry", "Mike"], "; ") => "Tom; Jerry; Mike"` | | ARRAY\_UNIQUE | Returns only the unique items in an array. | `array` | Array | `ARRAY_UNIQUE([1, 2, 3, 2, 1]) => [1, 2, 3]` | | ARRAY\_FLATTEN | Flattens an array by removing any array nesting. All items become elements of a single array. | `array` | Array | `ARRAY_FLATTEN([1, 2, " ", 3, true], ["ABC"]) => [1, 2, 3, " ", true, "ABC"]` | | ARRAY\_COMPACT | Removes empty strings and null values from an array. Preserves "false" and strings containing one or more whitespace characters. | `array` | Array | `ARRAY_COMPACT([1, 2, 3, "", null, "ABC"]) => [1, 2, 3, "ABC"]` | | RECORD\_ID | Returns the ID of the current record. | `-` | String | `RECORD_ID() => "recxxxxxx"` | # Formula Grammar Source: https://help.teable.ai/en/basic/field/formula/grammar Formula grammar consists of basic values, field references, operators, functions, and parentheses. After you understand these elements, you can write formulas for calculations, conditions, and text processing. ## Basic Elements | Element | Syntax | Description | | --------------- | ---------------------- | ----------------------------------------------------------------------- | | String | `'Hello'` or `"World"` | Text wrapped in single or double quotes | | Integer | `123`, `-456` | A number without a decimal point | | Decimal | `12.34`, `-45.67` | A number with a decimal point | | Boolean | `TRUE`, `FALSE` | A true or false value | | Field reference | `{age}` | A field name wrapped in `{}`. The name must match the actual field name | ## Operators Operators in formulas are used to connect or compare values: | Type | Operators | | | | ---------- | ------------------------------- | - | -- | | Math | `+`, `-`, `*`, `/`, `%` | | | | Comparison | `>`, `<`, `>=`, `<=`, `=`, `!=` | | | | Logic | `&&`, \` | | \` | ## Function Calls You can call functions within formulas. A function call consists of a function name, a pair of parentheses, and parameters inside the parentheses. Parameters are separated by commas. For example, `sum(1, 2, 3)` calls the `sum` function with three parameters: 1, 2, and 3. ## Other Structures | Structure | Description | | -------------------------- | ------------------------------------------------------------------- | | Parentheses | Change operation precedence, such as `(1 + 2) * 3` | | Comments | Add context. Block comments use `/* */`, and line comments use `//` | | Whitespace and line breaks | Usually ignored, but they can make formulas easier to read | # Last Modified By Source: https://help.teable.ai/en/basic/field/last-modified-by Automatically record the user who last edited a record. The **Last Modified By** field automatically records the user who last edited a record. It helps track collaboration changes. Used with Last Modified Time, it shows who made the latest update and when. ## Use Cases | Scenario | Good for | | --------------------------- | ----------------------------------------------------- | | Collaboration tracking | See which member last updated a record | | Accountability | Find the most recent editor when a record looks wrong | | Personal review | Filter records you recently updated | | Use with Last Modified Time | See both the last editor and last edit time | ## Create and Configure Click the `+` icon on the right side of the table header, then choose **Last Modified By** from the field type list. Enter a field name, such as "Last editor" or "Updated by". After the field is created, it updates to the current user when the record is edited. ## Common Uses * **Track collaboration responsibility**: If a task status changes to "Canceled", check Last Modified By to see who made the last change. * **Review recent work**: Set a filter such as `Last Modified By` `is` `current user` to see records you recently handled. * **Use with Last Modified Time**: View **Last Modified By** and **Last Modified Time** together to confirm when the latest update happened and who made it. ## Notes * Last Modified By updates automatically when record content changes. * This field is read-only. Users cannot choose or edit the value by hand. * If you only need to record the original creator, use **Created By**. # Last Modified Time Source: https://help.teable.ai/en/basic/field/last-modified-time Automatically record when a record was last edited. The **Last Modified Time** field automatically records when a record was last edited. It can track all fields or only selected fields, which makes it useful for recent updates, inactive data cleanup, and collaboration review. ## Use Cases | Scenario | Good for | | ----------------------- | -------------------------------------------------------------------------------- | | Recent updates | Sort by Last Modified Time to see records that changed recently | | Selected field tracking | Update the time only when key fields change, reducing noise from unrelated edits | | Inactive data cleanup | Filter records that have not been updated for a long time | | Collaboration review | Use with Last Modified By to see the latest edit time and editor | ## Create and Configure Click the `+` icon on the right side of the table header, then choose **Last Modified Time** from the field type list. Enter a field name, such as "Last updated at" or "Recently maintained". Choose whether to track all fields or only selected fields. Set the date format, time format, and time zone as needed. ## Tracking Options | Option | Description | | --------------------- | --------------------------------------------------------------- | | Track all fields | Updates Last Modified Time when any field in the record changes | | Track selected fields | Updates Last Modified Time only when selected fields change | ## Display Format | Setting | Description | | ----------- | -------------------------------------------------------------------------------------- | | Date format | Choose how dates are displayed, such as `2024-01-30` or `Jan 30, 2024` | | Time format | Controls whether a specific time is shown, and whether it uses 12-hour or 24-hour time | | Time zone | Uses a fixed time zone or follows the viewer's system time zone | ## Common Uses * **Find recently updated tasks**: Sort by Last Modified Time descending so changed records appear at the top. * **Track key content changes**: Choose **Track selected fields**, then select key fields such as "Title" and "Status". * **Clean up inactive data**: Set a filter such as `Last Modified Time` `is before` `90 days ago` to find records that have not been maintained. ## Notes * Last Modified Time is read-only and cannot be edited by hand. * If selected field tracking is enabled, changes to fields that are not selected do not update the time. * If you need to record when a record was first created, use **Created Time**. # Link Source: https://help.teable.ai/en/basic/field/link Create relationships between tables and select records from another table in the current record. The Link field connects two tables. With a Link field, you can select records from another table in the current table and open the linked records when needed. Link fields are also required before you can use **Lookup** and **Rollup** fields. ## Use Cases | Scenario | Good for | | ----------------------------- | ----------------------------------------------------------------------------------- | | Customers and orders | Link customers in the orders table, and view related orders from the customer table | | Projects and tasks | Link a task to its project, and view all tasks under a project | | Students and courses | Track course enrollment, project members, or other many-to-many relationships | | Line items and parent records | Link order line items to an order, then look up prices or roll up totals | ## Create and Configure In the current table, click add field and choose **Link**. In the configuration dialog, choose the table to link to, such as linking the orders table to the customers table. Choose a one-way or two-way link as needed. Use **Allow multiple selection** and **Allow duplicate values** to configure one-to-one, one-to-many, many-to-one, or many-to-many relationships. ## One-Way and Two-Way Links | Mode | Description | Best for | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | Two-way link | Enabled by default. When you create a link field, Teable creates a corresponding link field in the target table, and both sides stay in sync | Relationships that need to be viewed from both tables, such as orders and customers or projects and tasks | | One-way link | When the two-way option is off, only the current table shows the linked records. The target table does not get a reverse field | Cases where you only need to reference another table and do not want to change the target table structure | ## Relationship Types Use **Allow multiple selection** and **Allow duplicate values** together to define four common relationship types: | Relationship | Business example | Configuration | | :--------------------- | :---------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | | **One-to-one (1:1)** | **Employee - Profile**
One employee has one profile, and one profile belongs to one employee | ☐ Allow multiple selection
☐ Allow duplicate values
*(both options off)* | | **One-to-many (1:N)** | **Department - Employee**
One department has multiple employees, but each employee belongs to one department | ☑ Allow multiple selection
☐ Allow duplicate values
*(only allow multiple selection)* | | **Many-to-one (N:1)** | **Task - Project**
Multiple tasks belong to one project, but each task belongs to only one project | ☐ Allow multiple selection
☑ Allow duplicate values
*(only allow duplicate values)* | | **Many-to-many (N:N)** | **Student - Course**
One student can take multiple courses, and one course can have multiple students | ☑ Allow multiple selection
☑ Allow duplicate values
*(both options on)* | ## Common Uses * **CRM customer management**: In a `Companies` table, create a link field to a `Contacts` table so one company can link to multiple contacts. * **Project task assignment**: In a `Tasks` table, create a link field to a `Projects` table so each task belongs to one project, while the project table can show related tasks. * **Order line items**: In an `Orders` table, link to a `Products` table, then use lookup fields to show prices and rollup fields to calculate order totals. ## Notes * **One-to-many limits**: In a strict one-to-many relationship, when multiple selection is off on the Table B side, a Table B record linked by one Table A record cannot be selected by other Table A records. This works for data that should not be reused, such as ID numbers or employee profiles. Link fields can only connect tables in the same Space. Lookup, Rollup, Conditional Lookup, and Conditional Rollup fields also need same-Space source data. # Long Text Source: https://help.teable.ai/en/basic/field/long-text Store long text with line breaks, with support for plain text and Markdown display. **Long Text** is for longer content that needs line breaks, such as notes, instructions, logs, meeting notes, or detailed descriptions. Unlike Single Line Text, Long Text keeps paragraph structure and can be displayed as Markdown. ## Use Cases | Scenario | Good for | | --------------------- | ------------------------------------------------------------------- | | Detailed descriptions | Task details, product descriptions, bug reproduction steps | | Process notes | Customer follow-ups, daily summaries, meeting notes | | Supporting context | Notes or explanations that should not be split into separate fields | | Content drafts | Copy, announcements, and knowledge base snippets | ## Create and Configure In a table, click `+`, then choose **Long Text**. Enter a field name, such as "Description", "Notes", or "Details". Set **Default value**, **Display mode**, and **Field description** as needed. After saving, users can enter multi-line content in cells. ## Display Mode | Display mode | Good for | Description | | ------------ | ------------------------------------ | ---------------------------------------------------------------- | | Plain text | Notes, logs, instructions | Keeps line breaks and is suitable for direct editing and reading | | Markdown | Document snippets, checklists, links | Displays content with Markdown formatting | ## Common Uses * **Manual line breaks**: Press `Shift + Enter` while editing to insert a line break. * **Automatic wrapping**: Cells wrap content based on column width, which makes long text easier to read. * **Default text**: If every new record needs the same note, set a default value. ## Notes * Web addresses in the text become clickable links automatically, with nothing to configure. In an expanded record, a link button next to the input lists every address found in the cell. * Long Text does not support Email or Phone interactive display. Use a **Single Line Text** field when you need to click an address or number to write or call. # Lookup Source: https://help.teable.ai/en/basic/field/lookup Reference field values from a linked table through an existing link relationship and keep the data in sync. Lookup fields are built on **Link** fields. A Lookup field references a selected field from a linked table, so the current table can display data from another table without entering it again. ## Use Cases | Scenario | Good for | | ------------------ | -------------------------------------------------------------------- | | Order line items | After linking a product, show its price, SKU, or category | | Ticket handling | After linking a customer, show phone number, customer tier, or owner | | Book management | In a books table, show the author's birthday, nationality, or bio | | Project management | From linked tasks, show assignee, due date, or status | ## Create and Configure Before using a Lookup field, create a **Link** field between the two tables. In the table view, click `+` to add a field and choose **Lookup**. Choose an existing link field in the current table as the lookup path. Choose the field to read from the source table, such as an author's birth date, a customer's phone number, or a product price. When the link points to several records, turn on **Remove duplicate values** and each value is shown once. ## Automatic Sync After setup, Teable fills the lookup result based on the existing link relationship: * If the linked record changes, such as choosing a different author, the lookup value updates. * If source data changes, such as editing an author's birthday, the lookup value refreshes. ## Common Uses * **Book management**: In a `Books` table, use an `Author` link field to look up `Birth date` from an author details table. * **Order calculation**: In an `Order line items` table, look up the product price and then use a formula to calculate the total. * **Customer information sync**: In a tickets table, link a customer and look up the customer's phone number, email, or tier. ## Notes * **Read-only field**: Lookup fields are **read-only**. You cannot edit the looked-up value from the current table. To change the value, edit the original field in the source table. * **Single value and multiple values**: If the link relationship is one-to-one, the lookup result is a single value. If the relationship is one-to-many, the lookup result becomes a multi-value array and displays values separated by commas. * **Data dependencies**: Lookup fields depend on the link field and the source field. If the link field or target field in the source table is deleted, the lookup field stops working. # Multiple Select Source: https://help.teable.ai/en/basic/field/multiple-select Choose one or more values from a predefined list. Useful for tags, categories, and multi-dimensional filtering. A **Multiple Select** field lets users choose one or more values from predefined options. It works well for tags, topics, skills, departments, and other categories that can apply at the same time. ## Use Cases | Scenario | Good for | | ---------------------------- | -------------------------------------------------------------------------- | | Tags and topics | Multiple tags for articles, videos, customers, or tasks | | Skills and capabilities | Several skills or areas of experience for a member | | Cross-team work | Departments involved in a project, such as Sales, Engineering, and Finance | | Multi-dimensional categories | Records that belong to several topics, channels, or business lines | ## Create and Configure Click the `+` icon on the right side of the table header, then choose **Multiple Select** from the field type list. Enter a field name, such as "Topics", "Skills", or "Departments". Enter an option name in the setup panel and press **Enter** to add it quickly. Set default values as needed, and choose whether users can create new options while editing. ## Option Management | Setting | Description | | -------------------------- | ---------------------------------------------------------------------------------------------------------- | | Color | Teable assigns colors automatically. You can also click the dot on the left side of an option to change it | | Order | Drag the icon on the left side of an option to reorder the list | | Default value | New records can start with a common set of tags | | Allow creating new options | When turned off, users can only choose existing options while editing cells | ## Filter by Multiple Select Values | Filter type | Description | | --------------- | ------------------------------------------------------------------------- | | Contains any of | Shows records that include at least one selected option | | Contains all of | Shows records that include every selected option | | Exactly equals | The selected options must match exactly, with no extra or missing options | ## Common Uses * **Content tags**: Add topics such as "Technology", "Design", and "Marketing" to content records. * **People skills**: Record several skills for each member, then filter by skill combinations. * **Project departments**: Record which departments are involved in cross-team projects for grouping and reporting. ## Notes * Multiple Select allows **1 to N** values. Single Select allows **1** value per record. * Colors help identify categories, but do not rely on color alone for key meaning. * If the value must be mutually exclusive, use a **Single Select** field. # Number Source: https://help.teable.ai/en/basic/field/number Store numeric data such as prices, inventory, quantities, and ratios. Supports decimals, currency, percentage, and visual displays. A **Number** field stores values that can be calculated, such as prices, inventory, quantities, scores, and ratios. It supports number, currency, and percentage formats, and can show values as bars, rings, or lines. ## Use Cases | Scenario | Good for | | ------------------------ | -------------------------------------------------- | | Amounts and costs | Contract amounts, product prices, budgets, costs | | Quantities and inventory | Stock counts, order quantities, work hours, counts | | Ratios and progress | Achievement rate, conversion rate, completion rate | | Scores and metrics | Scores, weights, health scores, risk scores | ## Create and Configure Click the `+` on the right side of the table header, then choose **Number** from the field type list. Enter a field name, such as "Product Price", "Inventory", or "Achievement Rate". Choose **Number**, **Currency**, or **Percentage** based on the data. Set decimal places, and add a default value for new records if needed. ## Number Formats | Format | Good for | Example | | ---------- | ---------------------------------- | ------------ | | Number | Counts, quantities, scores | `100`, `2.5` | | Currency | Amounts, costs, budgets | `$100.00` | | Percentage | Ratios, progress, conversion rates | `50%` | Precision controls how many decimal places are shown. After precision is set, Teable rounds displayed values to that precision. ## Display Settings Number fields can show values visually in addition to plain text. | Display mode | Good for | Description | | ------------ | ------------------------------------ | ----------------------------------------------- | | Default | Single-value and multi-value numbers | Shows the number directly | | Bar | Single-value and multi-value numbers | Uses bar length to show value size | | Ring | Single-value numbers | Uses a ring progress display to show proportion | | Line | Multi-value numbers | Uses a line to show changes across values | For Bar and Ring display, you can set a target value, color, and whether to show the number. The target value is the value that fills the visual display. For example, if the full score is `100`, set the target value to `100`. ## Common Uses * **Contract amounts**: Create a "Contract Amount" field, choose **Currency**, select `$`, and set precision to 2 decimal places. * **Sales achievement rate**: Create an "Achievement Rate" field, choose **Percentage**, set display mode to **Bar**, and set the target value to `1`. * **Inventory management**: Create an "Inventory" field, choose **Number**, then use it for sorting, filtering, and summaries. ## Notes * Number fields only accept integers and decimals, such as `12` and `3.14`. * Percentages are stored as decimals. Entering `100%` stores `1`; entering `50%` stores `0.5`. * If Formula, Rollup, or Lookup results are numeric, they can use Number field formatting and display modes. # Rating Source: https://help.teable.ai/en/basic/field/rating Add visual numeric ratings to records. Useful for quality, priority, satisfaction, and evaluation results. A **Rating** field uses icons to show a score. It works well for customer satisfaction, product ratings, priority, idea scores, and performance reviews. ## Use Cases | Scenario | Good for | | ------------------ | ------------------------------------------------- | | Product evaluation | Product, feature, or content ratings | | Service feedback | Customer satisfaction and service quality ratings | | Performance review | Employee, project, or vendor scores | | Priority judgment | Urgency, value, or risk | ## Create and Configure Click the `+` icon on the right side of the table header, then choose **Rating** from the field type list. Enter a field name, such as "Customer Satisfaction", "Recommendation Score", or "Priority". The default maximum is **5**. You can change it to **10** or another limit to set the available rating range. Ratings use stars by default. You can choose another icon to match the meaning of the field. ## Settings | Setting | Description | | ------------- | ------------------------------------------------------------------------ | | Maximum value | Controls the rating limit, such as a 5-point or 10-point scale | | Icon style | Controls the rating symbol, such as star, heart, thumbs-up, or lightbulb | ## Common Uses * **Product review management**: Record product ratings, then filter for high-rated products. * **Service feedback**: Collect customer satisfaction in support records and review service quality. * **Employee performance review**: Score several capability areas in an HR review table. * **Rating plus comment**: Use with a **Long Text** field to capture both a score and written feedback. ## Notes * Rating values can be referenced by **Formula** fields to calculate averages or totals. * Before setting the maximum value, align the team on what each score means. * If you lower the maximum value later, such as changing 10 to 5, existing scores above the new limit may not display correctly. Check historical data before changing it. # Rollup Source: https://help.teable.ai/en/basic/field/rollup Aggregate values from linked records, such as sum, count, average, maximum, and minimum. Rollup fields calculate statistics from multiple linked records. A Rollup field usually starts from an existing **Link** field, selects a target field from linked records, and calculates the result with a chosen function. ## Use Cases | Scenario | Good for | | -------------- | ------------------------------------------------------------------ | | Order amount | Roll up prices from order line items to calculate the order total | | Task progress | Count linked tasks, completed tasks, or average ratings | | Customer value | Roll up total spend or order count from customer orders | | Tag cleanup | Combine tags, participants, or source channels from linked records | ## Create and Configure Before creating a Rollup field, create a **Link** field. Click `+` in the table header to add a field and choose **Rollup**. Choose the link field that provides the data source, then choose the target field to calculate. Choose a function based on the target field type, such as sum, count, average, maximum, or minimum. ## Formatting and Display Rollup results can usually use formatting and interactive display settings: * **Formatting**: Set decimal precision, currency symbols, or percentages. * **Interactive display**: Show number results as bars, rings, or other display styles. See [formatting](/en/basic/field/common/formatter) and [interactive display](/en/basic/field/common/show-as) for details. ## Common Uses * **Bookstore order totals**: In an `Orders` table, use the `Selected books` link field to roll up the `Price` field from the `Books` table. Choose **SUM** to calculate the order total. * **Project task statistics**: In a `Projects` table, count linked tasks or calculate task completion rate. * **Customer spending totals**: In a `Customers` table, roll up related order amounts to see each customer's total spend. ## Supported Rollup Formulas | Formula name | Explanation | | -------------- | ---------------------------------------------------------------- | | COUNTALL | Counts all values, including text values and blanks | | COUNTA | Counts non-empty values | | COUNT | Counts numeric items | | SUM | Calculates the sum of all numeric values | | MAX | Returns the largest numeric value | | MIN | Returns the smallest numeric value | | AND | Returns true if all values are true | | OR | Returns true if any value is true | | XOR | Returns true if an odd number of values are true | | ARRAY\_JOIN | Joins all values in an array into a string | | ARRAY\_UNIQUE | Removes duplicate values and returns an array with unique values | | ARRAY\_COMPACT | Removes empty values and returns a new array | | CONCATENATE | Joins multiple values into a string | ## Notes * **Dynamic updates**: Rollup fields calculate in real time. If source data or link relationships change, the rollup result refreshes. * **Data type limits**: Some functions only work with specific field types. For example, **SUM** only works with number fields. If you choose a text field, Teable does not offer sum as an option. * **Performance**: Many rollup fields can affect performance, especially when they involve many records. Plan link relationships carefully and review rollup settings from time to time. # Single Line Text Source: https://help.teable.ai/en/basic/field/single-line-text Store short text such as names, titles, IDs, URLs, email addresses, and phone numbers. **Single Line Text** stores short content that does not need line breaks, such as customer names, task titles, order IDs, SKUs, URLs, email addresses, or phone numbers. Values can be sorted and filtered, and formula functions can reference them for extraction, concatenation, and text formatting. For notes, summaries, or descriptions that need line breaks, use **[Long Text](/en/basic/field/long-text)**. For fixed values such as status, category, or priority, **[Single Select](/en/basic/field/single-select)** or **[Multiple Select](/en/basic/field/multiple-select)** is usually a better fit. ## Use Cases | Scenario | Good for | | ------------------------- | -------------------------------------------------------------------------- | | Record names or titles | Customer names, task titles, product names, project names | | IDs or codes | Order IDs, contract IDs, SKUs, external system IDs | | Contact or access details | Company websites, email addresses, phone numbers | | Short free text | Short notes, labels, or identifiers that cannot be listed as fixed options | ## Create and Configure Click the **+** icon on the right side of the table header, then choose **Single Line Text** from the field type list. Enter a field name, such as "Customer Name", "Order ID", or "Company Website". If new records usually start with the same text, enter a **Default value**, such as "Pending review" or "New". The default value is filled only when a new record is created and can still be edited later. ## Automatic Link Detection Web addresses in a cell become clickable links automatically, with nothing to configure. Teable recognizes addresses that start with `https://` or `www.`, as well as common domains such as `teable.ai`. When one value holds several addresses, each becomes its own link. In an expanded record, a link button next to the input lists every address found in the cell. File names and version numbers such as `readme.md` or `v1.2.3` are not mistaken for addresses. ## Display Mode Single Line Text supports three display modes: | Display mode | Good for | Click behavior | | ------------ | ---------------------------------------- | ---------------------------------------------------------------------------------------- | | Default | Names, titles, IDs, and other plain text | Addresses become links and open when clicked | | Email | Email addresses | Opens the default email app | | Phone | Phone numbers | Opens the communication app on the device. On mobile, users can call the number directly | Display mode changes how the value appears and behaves when clicked. It does not change the field type. Interactive display can also be used for Formula, Rollup, and Lookup fields. For details, see [Interactive Display](/en/basic/field/common/show-as). ## Common Uses * **Customer contact management**: Create a "Company Website" field and type the address in it so the website opens when clicked. Create a "Phone" field and set it to **Phone** so mobile users can call in one tap. * **Order or contract management**: Create an "Order ID" or "Contract ID" field for search, filtering, and matching with external systems. * **Initial ticket status**: Create a "Current Stage" field and set the default value to "New". If the stage comes from a fixed workflow, use a **Single Select** field instead. * **Text extraction and concatenation**: Reference Single Line Text in formulas to extract ID segments, concatenate display names, or normalize text format. ## Notes * Single Line Text is for short content. The Enter key usually confirms input. Use **Long Text** for notes, article summaries, and other long content. * Email and Phone are display modes. The field remains Single Line Text and can still be sorted, filtered, and processed with text functions. * Single Line Text does not limit values to predefined options. Use **Single Select** or **Multiple Select** for statuses, categories, and priorities that need consistent values. # Single Select Source: https://help.teable.ai/en/basic/field/single-select Choose one option from a predefined list. Useful for statuses, categories, and priorities. A **Single Select** field lets users choose one value from predefined options. It works well for mutually exclusive states, such as task stage, customer tier, priority, or approval result. ## Use Cases | Scenario | Good for | | ------------------- | ------------------------------------------------------------------- | | Status flow | Not started, in progress, done, and other mutually exclusive stages | | Category management | Customer tier, lead source, content type | | Priority management | High, medium, low, and other fixed priorities | | Approval result | Approved, rejected, needs more information | ## Create and Configure Click the `+` icon on the right side of the table header, then choose **Single Select** from the field type list. Enter a field name, such as "Task Status", "Priority", or "Customer Tier". Enter an option name in the input box and press **Enter** to create it quickly. If new records usually use the same option, set it as the default value. ## Option Management | Setting | Description | | -------------------------- | ----------------------------------------------------------------------------------- | | Color | Click the dot on the left side of an option name to choose a color from the palette | | Order | Drag the icon on the left side of an option to change its order in the dropdown | | Edit | Edit an option name directly. Existing records are updated with the new name | | Delete | Click the trash icon on the right side of an option to delete it | | Allow creating new options | When turned off, users can only choose existing options while editing cells | ## Common Uses * **Project progress management**: Create a "Task Status" field with options such as "Not started", "In progress", and "Done", then create a **Kanban View** based on that field. * **Customer tier management**: Create a "Customer Tier" field with options such as "High", "Medium", and "Low", then group customers by tier. ## Single Select vs. Multiple Select | Field type | Number of values | Good for | | --------------- | -------------------------------------- | --------------------------------- | | Single Select | Each record can choose only 1 value | Status, stage, tier, priority | | Multiple Select | Each record can choose multiple values | Tags, skills, topics, departments | ## Notes * Single Select allows only **1** value per record, so it is suitable for mutually exclusive states. * If a record needs multiple tags, use a **Multiple Select** field. * Before converting a Multiple Select field to Single Select, check the data. If a record has multiple options, Teable usually keeps only the first option, which may cause data loss. # User Source: https://help.teable.ai/en/basic/field/user Select space members in records. Useful for assignees, participants, approvers, and collaborators. A **User** field selects space members in a record. It works well for task assignees, project participants, approvers, and collaborators. It can also be used with filters, grouping, and Kanban views to build personal workspaces. ## Use Cases | Scenario | Good for | | -------------------------- | ------------------------------------------------------------------ | | Task owner | Assign one owner to each task | | Multi-person collaboration | Select multiple members on one record to show shared participation | | Approval and handoff | Record approvers, reviewers, or delivery owners | | Personal workspace | Filter records assigned to the current user | ## Create and Configure Click `+` in the table header to add a field, then choose **User**. Enter a field name, such as "Owner", "Assignee", or "Approver". When enabled, one record can select multiple members. When disabled, one record can select only one member. Enable **Notify users when selected** if needed. Selected members receive a notification. ## Settings | Setting | Description | Good for | | --------------------------- | --------------------------------------- | ----------------------------------------------- | | Allow multiple users | One record can select several members | Collaborative tasks, multi-person participation | | Do not allow multiple users | One record can select only one member | Clear ownership, single approver | | Notify users when selected | Selected members receive a notification | Task assignment, approval reminders | ## Common Uses * **Task assignment and Kanban management**: Create an "Owner" field, usually with multiple users turned off, then create a Kanban view grouped by owner. * **My workspace**: In a table or Kanban view, set a filter such as `Owner` `is` `current user` so each member sees their own tasks. ## Notes * If **Allow multiple users** is enabled, one record may appear under multiple member groups in grouped or Kanban views. For example, if a task is assigned to A and B, it appears in both A's column and B's column. * **Notify users when selected** covers new assignments only: someone selecting a member while editing records, or a form submission that fills the field. Operations that carry existing assignments along, such as importing data, duplicating a table or record, restoring records from the trash, and undo or redo, send no notifications. * When one person assigns members across several records in the same table within a few seconds, each member receives one combined notification instead of one per record. # Overview Source: https://help.teable.ai/en/basic/record Records are the basic data units stored in a table. In a table view, each row usually represents one record. Records store complete data entries. Each record is made up of multiple fields. For example, a customer record can include name, phone number, owner, and follow-up status. An order record can include order number, customer, amount, and delivery date. ## Basic Concepts | Concept | Description | | ------------- | ----------------------------------------------------------------------------------------- | | Record | A row of data in a table | | Field | An attribute in a record, corresponding to a table column | | Cell | The value of one record under one field | | Primary field | The main display name of a record, often used in mobile lists and linked record selectors | ## Create Records You can create records in the following ways: Create records from the row context menu | Entry | Action | | ------------------- | ------------------------------------------------------------------------------- | | Bottom of the table | Click the `+` button at the bottom of the table view to add a record at the end | | Top toolbar | Click `+ Add record` on the left side of the toolbar | | Context menu | Right-click an existing record and insert a record above or below it | ## Edit Records * **Edit a cell**: Click any cell and enter or change its content. * **Clear content**: Select one or more cells, then press `Delete` or `Backspace`. * **Bulk select**: Drag with the mouse to select multiple cells or records, then edit, delete, or copy them. * **Copy and paste**: Copy and paste one or more cells. If the pasted data has more rows than the current table, Teable automatically adds new rows. ## Delete Records Bulk delete records menu Select one or more records, then right-click and choose **Delete record**. For bulk deletion, you can select the checkboxes at the beginning of rows before deleting them. Deleted records go to the table trash, where you can review and restore them. If you want records out of the table but still available, archive them instead of deleting. See [Archive and Trash](/en/basic/record/archive-trash). If another table links to the record through a **Required** [Link](/en/basic/field/link) field, Teable refuses the deletion and names the table and field that would be left empty. Point that link at another record, clear the **Required** setting on the field, or delete the linking records together with this one. ## Record Details Open record detail entry Click the expand icon at the beginning of a record row, or select a record and press Space, to open the record detail card. The detail card is useful for records with many fields. You can browse fields vertically on one page, reduce horizontal scrolling, edit fields, view comments, and check record history. ## Collaboration and Tracking | Feature | Description | | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | Comments | Each record has its own comment area for discussing specific data, @mentioning teammates, or adding context. See [Comments](/en/basic/record/comment). | | Record history | Teable records record changes so you can trace updates. See [Record History](/en/basic/record/record-history). | | Archive and trash | Move finished records out of the table, or restore ones that were deleted. See [Archive and Trash](/en/basic/record/archive-trash). | | Linked records | Use a **Link** field to connect records across tables. See [Link Field](/en/basic/field/link). | ## Notes * The primary field is used as the main display name of a record. Put recognizable information such as a name, task title, or order number in the primary field, instead of note-style content. * Each record has a unique record ID. After opening the record detail card, the string in the browser URL that starts with `rec` is the record ID. * If you cannot edit some records, an administrator may have limited the editable scope through the **Authority Matrix**. See [Authority Matrix](/en/basic/authority-matrix). # Archive and Trash Source: https://help.teable.ai/en/basic/record/archive-trash Archive records to move them out of a table without losing them, and restore deleted records from the table trash. Records that leave the grid end up in one of two places. The **Archive** holds records you moved out of daily work but still need. The **Trash** holds records you deleted, so you can put them back. Both open from the same place: click the **...** button next to the table, then choose **History** > **Archive** or **History** > **Trash**. ## Archive Records Available for Business plan and above Archiving takes records out of the table view and out of your space's record count, while keeping their field values, attachments, and creator information. Use it for finished projects, closed deals, or past seasons that you want out of the way but not deleted. To archive records, select one or more rows in the grid, right-click, and choose **Archive record** or **Archive all selected records**. The confirmation dialog shows how many records will be archived. If you archive the wrong rows, `Ctrl/Cmd + Z` undoes the action and puts them back. ### Review the Archive The archive opens as a read-only grid with two extra columns, **Archived time** and **Archived by**, in front of the table's own fields. Click the expand icon on a row to open **Record detail** and read the full record. Use the toolbar to find the records you need: | Control | What it does | | ----------------- | ----------------------------------------------------------------------------------------------- | | Sort selector | Order by **Sort by archived time**, **Sort by created time**, or **Sort by last modified time** | | **All creators** | Show only records created by selected collaborators | | **Archived time** | Limit the list to a date range | | **Clear filter** | Return to the full archive | | **Export CSV** | Download the archived records currently listed | ### Restore or Permanently Delete Select rows in the archive, then use **Restore** or **Permanently delete** in the toolbar. Both buttons show the number of selected records. Restoring puts the records back into the table with their original values, and they count toward your space record limit again. If the space is already at its record limit, restore fails until you free up rows or raise the limit. **Permanently delete** removes the archived records for good. This cannot be undone. Owners and creators can archive, restore, and permanently delete. Editors can archive records and open the archive, but cannot restore or delete from it. Commenters and viewers have no access. ## Table Trash The trash lists records, fields, and views that were deleted from the table, along with who deleted them and when. Filter the list by type, by the user who deleted the item, or by deletion time, and use **Clear filter** to go back to the full list. To see what a deletion actually contained, click the entry in the **Deleted resource** column of a record row. **Deleted records** lists those rows in a grid, where you can filter by creator or created time and expand a row for its **Record detail**. Check the batch here before you restore it. Click **Restore** on a trash entry to put the deleted resource back. As with the archive, restoring records re-occupies row quota, so a space that is already at its record limit must free up rows first. ### How Long Deleted Records Stay Visible How far back the trash lists deletions depends on your plan: | Plan | Trash history visible | | -------- | --------------------- | | Free | 14 days | | Pro | 1 year | | Business | 3 years | ## Related * [Record History](/en/basic/record/record-history): trace who changed a value and when * [Records Overview](/en/basic/record): create, edit, and delete records * [Billing and Plans](/en/basic/space/billing): compare plan limits and change your subscription # Comments Source: https://help.teable.ai/en/basic/record/comment Start discussions in records, @mention teammates, and add context to specific data. Comments belong to specific records. Team members can discuss issues, add materials, explain why a change was made, and keep context with the data instead of spreading it across chat tools. ## Use Comments ### Open Comments Comments entry in the record detail card Open any record detail card, then click the **Comments** icon in the top-right corner to open the side comment panel. Add comment entry in the record context menu You can also right-click a record in the table view and select **Add comment**. ### Send Comments Enter content in the comment box and send it. Comments support images and pasted links, which are useful for adding screenshots, references, or external context. Comment editor ### Mention Teammates Type `@`, then choose a teammate from the dropdown. The mentioned member receives a notification and can jump directly to the related record. ### Reply and React | Action | Description | | ------ | ----------------------------------------------------------------------------- | | Reply | Click **Reply** below a comment to continue the discussion under that comment | | React | Click the emoji icon next to a comment to respond quickly | | Edit | Hover over a comment you sent, then click the action button to edit it | | Delete | Hover over a comment you sent, then click the action button to delete it | Edited comments display an "edited" label. ## Notifications and Subscriptions By default, notifications are sent only when: * Someone `@` mentions you. * Someone replies to your comment. If you want to follow a record closely, click the bell icon in the top-right corner of the comment panel and switch to notifications for all comments. New comment notifications usually appear in the notification center at the bottom-left corner of the interface. Clicking a notification opens the related record and locates the relevant comment. ## Common Scenarios * **Task clarification**: @mention a teammate under a requirement or task record to confirm details, with the discussion preserved in the record. * **Approval feedback**: Leave revision feedback under reimbursement, contract, or content review records so the requester can act on it directly. * **Change notes**: Add a reason after changing important fields so the context is available later. # Record History Source: https://help.teable.ai/en/basic/record/record-history View table-level or single-record change history and track who changed data and when. Record history is used to view data changes. You can view changes across multiple records from the table level, or open one record to view its complete change history. ## Table Record History Table record history shows changes across records in the current table. It is useful for checking which records were modified from a global table perspective, and it can also help find accidentally deleted records. Table history menu entry Click the **...** button in the top-right corner of the table, then choose **History** > **Table record history**. Table record history dialog In the table history dialog, click **View Record** next to a history entry to jump to the corresponding record. Use the filters at the top of the dialog to narrow history by field, user, and time range. After filtering, use **Clear filters** to return to the full list. When the **Authority Matrix** is not enabled, users with table editing permission can view table record history. When it is enabled, only administrators can view it. ## Individual Record History Individual record history only shows changes for the current record. It is useful for checking when a field in one record was changed and what changed before and after the update. Record history entry in the record detail card Open the record detail card, then click the record history icon in the top-right corner. Record history entry in the record context menu You can also right-click a record in the table view and select **Show record history**. In individual record history, you can use the same filters to focus on a field, modifier, or time range for that record. Users only need editing permission for a specific record to view that record's history. ## Notes * Record history stores changes at the cell level. * Bulk paste and bulk update operations can generate many history entries. * Records added by an import or by duplicating a table do not create history entries. Later changes to those records are recorded as usual. * Button field actions appear as **Clicked button** entries. * If you cannot see the history entry point, first confirm whether you have editing permission for the corresponding record or table. # Overview Source: https://help.teable.ai/en/basic/space Create, rename, delete, and manage spaces in Teable. ## Creating a New Space After logging into Teable, create a space from the space switcher: Each user can own up to two free spaces. If you already own two free spaces, you cannot create another free space. 1. Click the current space name in the upper-left corner 2. Click **Create a space** 3. Enter the space name and confirm Create a space from the space switcher ## Renaming a Space Users can change the space name from Space settings: 1. Click **Settings** in the space sidebar 2. Open **General** under **Space** 3. Edit **Space name** Rename a space in Space settings ## Adding a Space Avatar 1. Click **Settings** in the space sidebar 2. Open **General** under **Space** 3. Hover over the avatar and select an image The image must be a JPEG, PNG, or WebP file no larger than 3 MB. ## Deleting a Space When necessary, you can also delete a space: 1. Click **Settings** in the space sidebar 2. Open **General** under **Space** 3. Click **Delete space** ## Space Trash Deleted spaces will go to the trash, where you can choose to empty the trash to permanently delete data or restore spaces Open Space trash from the space switcher ## Shared with Me When someone shares a base with you as a collaborator, the base appears under **Shared with me** in the space sidebar. Bases shared with you are different from bases in your own spaces: * Access is controlled by the sharer. * Available actions depend on the base permission you were granted. * If the sharer removes your access, the base no longer appears. For public base sharing, see [Base](/en/basic/base). ## Space Settings * Click the "···" button in the upper right corner of the space to open the space menu * Click Space Settings Space settings now open in the same settings dialog as personal settings. Use the **Space** section in the sidebar for space-level configuration. **General** In the General page, you can change the space avatar, edit **Space name**, and view the Space ID. **Collaborators** In the Collaborators page, you can manage collaborators, send invitations, remove members, and configure permissions. **AI settings** In the AI settings page, space owners can configure custom model providers for AI features in the current space. For configuration details, see [Custom AI models](/en/basic/ai/custom-model). **Chat in IM** On the **Chat in IM** page, space administrators can create bots and configure their model, accessible Bases, Skills, files, and IM integration. **Plan** In the Plan page, you can view the plan capabilities available to the current space. **Billing (Cloud Version Only)** In the Billing page, you can view your current subscription plan and usage statistics. **Authentication** In the Authentication page, you can configure SSO providers for the space and manage **Login by URL** and **Login by Button**. See [Single Sign-On (SSO)](/en/basic/sso/overview). # Base Invitation Source: https://help.teable.ai/en/basic/space/base-invite Manage permissions at the base level. Invite members to a specific base without granting access to the entire space for more granular and secure data collaboration. ## What is a Base Collaborator? A base collaborator is a member invited to a specific base only. Unlike space collaborators, they can only access the bases they've been invited to and cannot see other bases in the space. ## Adding Base Collaborators Enter any base and click the `Invite` button in the top-right corner. Two methods are supported: * **Invite by email**: Enter the recipient's email address, set the base permission level (e.g. "Creator"), and click **Send Invitation**. * **Invite by link**: Switch to the "Invite via Link" tab to generate a dedicated invitation link. Copy and share the link. Recipients can join by clicking it. After sending an email invitation, you can copy the direct Base link shown in the panel and send it separately. The invitee also receives an in-app notification that opens the Base. Base invitation methods In the invitation panel, you can view all users who currently have access to the base: * **Base collaborators**: Members invited directly to this base only. * **Space collaborators**: Shown with a "Space" badge next to their name, indicating they are space-level members who automatically inherit access to this base. Base collaborators list The base offers four permission roles to support different levels of collaboration. For a detailed permission comparison, see [Permission Details](/en/basic/space/space-permission). For finer-grained control at the table, field, or record level, use the [Authority Matrix](/en/basic/authority-matrix) feature. | Role | Description | | --------- | ---------------------------------------------------------------------------------------------------- | | Creator | Can perform creation actions, modify table structure, edit automations, and enable authority matrix. | | Editor | Can modify data. | | Commenter | Can comment on records but cannot modify data. | | Viewer | Can view but cannot comment. | ## Use Cases Base invitation is designed for external collaborators. For example, a freelance designer hired to organize an asset library can be invited to that base alone with **Editor** permission, without seeing any other bases in the space. ## Notes * **Permission inheritance**: A space Manager automatically has full access to all bases in that space and cannot be downgraded at the base level. * **Link security**: Anyone who obtains an invitation link can attempt to join the base. If a link is leaked, you can revoke it by clicking the X next to it in the invitation panel. When the [Authority Matrix](/en/basic/authority-matrix) and [Permission Details](/en/basic/space/space-permission) coexist, only **Manager** users are exempt from Authority Matrix restrictions. All other users are subject to it. # Billing & Subscription Source: https://help.teable.ai/en/basic/space/billing Learn how to manage your subscription, view billing details, monitor usage, and download invoices. Billing is only available in the Cloud version of Teable. Self-hosted users should refer to the [License Activation](/en/deploy/activate) documentation. ## Accessing Billing Settings Only **Space Owners** have access to billing settings. To access: 1. Click **Settings** in the space sidebar 2. Select **Billing** under **Space** Billing settings overview ## Billing Page Overview The Billing page displays the following information: ### Current Plan Shows your current subscription status including: * **Subscription level** (Free, Pro, or Business) * **Price per seat** (monthly or yearly) * **Number of seats** you have purchased * **Renewal date**, or the cancellation date when the subscription is set to cancel * A plan change already scheduled for the end of the current period Click **Change plan** to open the Plan page, where you can change the plan level, the number of seats, and the credit tier. ### Usage Statistics Monitor your space's resource consumption with these metrics: | Metric | Description | | ----------------------------------- | ---------------------------------------------------------------------- | | **Total collaborators** | Number of billable collaborators in the current space and its bases | | **Maximum monthly automation runs** | Monthly automation run quota. Each automation run consumes 1 run quota | | **Total records** | Total row count across all tables in the space | | **Attachments storage** | Total storage used by uploaded attachments | | **Total emails** | Emails sent via automation using Teable Email Service | Data in both space trash and base trash are counted in the total record statistics. To reduce the total record count, clean up data in "Space → Trash" or "Base → Trash". Click **Details** on the **Total records** card to view record usage by Base. The dialog shows active records, trash records, and total records for each Base. You can open a Base trash page from the dialog, or permanently delete a Base that is already in trash. ### When a Limit Is Reached When the space reaches a plan limit, Teable stops the action before it runs and opens the upgrade dialog, which names the limit you hit, shows how much of it you have used, and links to per-Base usage. This applies to pasting, filling, duplicating rows, creating records in bulk, importing, and uploading attachments. To continue, upgrade the plan or free up room by deleting records or attachments. ### Credits Credits are Teable's usage units for AI-powered features. Consumption is based on the AI tokens used by the underlying language models, and you can review the details on the Billing page. Credits reset every billing period and do not roll over. On paid plans, credits are bought per seat. Each plan card carries a **credits/seat/month** tier, and the space's monthly credits are the purchased seats multiplied by that tier, shared by everyone in the space. | Plan | Monthly credits | | ------------ | ----------------------------------- | | **Free** | 200 credits for the space | | **Pro** | 2,000 to 6,000 credits per seat | | **Business** | 3,000 to 1,000,000 credits per seat | To get more credits, buy more seats or choose a higher credit tier on the plan card. The bigger the tier, the less each credit costs. **What happens when credits run out:** Once your monthly credits are exhausted, AI features will be limited until the next billing cycle or until you raise the credit tier. Credits only apply to Teable Cloud; self-hosted editions don't consume Teable Cloud credits and are instead limited by your own infrastructure and any external AI providers you use. The credits card shows your total credits, included extra credits, reset date, and current usage. Click **Detail** to open **Credit usage summary**, where you can filter by date range and type, view usage charts, and check usage records by name, type, model, credits, member, and date. ### Billing Details Displays your billing information: * **Name**: The billing account name * **Email**: The billing email address Click **Manage info** to open the payment portal where you can: * Update your payment method * Change billing address * View payment history The "Manage info" button opens Stripe Customer Portal in a new tab. ### Invoices View and download your billing invoices: 1. Scroll to the **Invoices** section at the bottom of the page 2. Find the invoice you need in the table 3. Click the download icon to get a PDF copy The invoice table shows: * **Reference**: Invoice number * **Tax**: Total amount including tax * **Status**: Payment status (e.g., paid) * **Date**: Invoice date * **Download**: PDF download button ## Changing Your Subscription Plan To upgrade, downgrade, or modify your plan: 1. Go to **Settings** → **Plan** 2. Choose the billing period (Monthly or Yearly) at the top of the page 3. On the plan card you want, pick the **credits/seat/month** tier and set the number of seats. The card shows the resulting monthly credits and the total price 4. Click **Subscribe**, or **Modify subscription** on your current plan 5. Complete the checkout or confirmation Yearly billing is cheaper than monthly. The Plan page shows the current saving on the Yearly tab. Changing an existing subscription goes through a confirmation page in the billing portal and then returns you to the Billing page. An upgrade applies immediately and is prorated, while a downgrade is scheduled for the end of the current billing period. A scheduled change or a pending cancellation appears in a banner above the plan cards, with **Undo** to keep the subscription as it is. ### Available Plans | Plan | Best For | | ------------ | --------------------------- | | **Free** | Individuals | | **Pro** | Small teams & professionals | | **Business** | Scaling businesses | ### Seats Seats are purchased up front, and buying ahead of your team is fine. A seat is taken by collaborators with the **Owner**, **Creator**, or **Editor** role in the space and its bases. **Commenter** and **Viewer** are free. On cloud plans the purchased seats are a hard limit. Teable blocks any action that would push the space past it and offers to add seats. This covers email invitations, creating an invite link with a billable role or switching a link to one, joining through such a link, adding collaborators directly, and promoting someone to a billable role. Someone who already holds a seat can join another base or change role without taking a new one. To continue, add seats on the Plan page, or give the person the free Commenter or Viewer role. Only the space owner can buy seats. ### Add-on Usage Subscriptions In the **Plan** tab, **Add-on usage subscriptions** lets you purchase extra usage without changing the main plan. Available add-ons include: * **Automation** * **Records** * **Attachments storage** ## Canceling Your Subscription Teable follows a "use what you paid for" cancellation policy. When you cancel a subscription, you're not requesting an immediate service termination or refund. Instead, you're choosing not to renew at the end of your current billing period. To cancel your subscription: 1. Go to **Space Settings** → **Billing** 2. Click **Change plan** to go to the Plan page 3. Find your current plan and click the cancel option 4. Confirm the cancellation After cancellation: * Your subscription will remain active until the end of the current billing period * You'll see a "Will cancel on \[date]" notice * Your data will be preserved, but premium features will become unavailable after the period ends * You can resubscribe at any time to restore access to premium features * No refunds are provided for unused time ## FAQ Only the Space Owner has access to billing settings. Other collaborators (Creators, Editors, Commenters, Viewers) cannot view or modify billing information. Seats are counted based on collaborators with **Editor** role or higher (Owner, Creator, Editor). Collaborators with **Commenter** or **Viewer** (Read-only) roles are free of charge. * **Cloud version**: Teable Cloud plans are billed per seat on a space basis, and seats are bought up front for the whole space. Charges are prorated: if you buy seats partway through a billing period, you only pay for the remaining time in that period. Collaborators cannot exceed the purchased seats. * **Self-hosted version**: Pricing is based on a monthly or annual pre-paid seat license with no storage, row, or other usage limits. Seats are counted across the entire instance. If the number of users exceeds your license limit, you will need to upgrade your plan to add more seats. See [License Activation](/en/deploy/activate) for details. For Business plans with Authority Matrix enabled, users assigned through Authority Matrix are counted as billable users. Have more questions about products or pricing? [Contact sales](https://contact.teable.ai/). On cloud plans, purchased seats are a hard limit. An invitation, invite link, or role change that would need a seat you have not bought is rejected, and Teable offers to add seats. Buy seats on the Plan page, or give the person the free Commenter or Viewer role. Within the seats you already own, inviting someone costs nothing extra and needs no confirmation. Adding a member through the authority matrix still asks for confirmation, because that path bills automatically. Yes, until it takes effect. The banner above the plan cards names the pending change and the date it applies. Click **Undo**, and the subscription keeps renewing as it is. Bulk actions are checked against the number of records they would add, rather than writing until the quota runs out. An operation that would cross the limit is rejected outright, so it never leaves half-written data in your table. **Total records** and **Attachments storage** are floating usage metrics. Teable calculates them automatically, but after large imports, deletes, trash cleanup, attachment uploads, or attachment deletes, the page may take some time to update. If **Total records** still seems behind, open **Details** on that card and use **Calibrate** to recount records across all tables in the space. If **Attachments storage** looks inaccurate, use **Calibrate** on that card to recount storage for the current space. After calibration, the page may take a little time to update. You'll be charged immediately upon subscribing and then on the renewal date each billing cycle (monthly or annually). Click the **Manage info** button in the Billing details section. This opens the Stripe Customer Portal where you can update your card or add alternative payment methods. Teable follows a "use what you paid for" cancellation policy. When you cancel, you're choosing not to renew at the end of your current billing period, not requesting an immediate service termination. Teable does not provide refunds for canceled subscriptions (both Cloud and Self-Hosted) because your service continues until the end of your prepaid period. You receive the full value of your payment by maintaining access to paid features until your subscription naturally expires. For self-hosted licenses specifically, once a license key is issued, it cannot be modified, downgraded, or refunded. This is because self-hosted licenses are issued as pre-paid, fixed-term authorizations with encrypted validation that cannot be revoked after delivery. If you need a different seat count, you would need to purchase a new license when your current one expires. For annual billing payments, the upfront annual payment, as well as each additional annual user payment and monthly/quarterly true-up payments, are non-refundable. We offer this discounted rate as a way to encourage long-term investment in Teable, which helps us hire more people, improve the product and customer experience, and support the open source project. If you're not ready to commit, no worries; stick with monthly billing. If a payment fails, we'll notify you via email. You'll have a grace period to update your payment method before your subscription is suspended. AI-powered features in Teable use credits. See the credit usage details on the Billing page for the specific usage. Free spaces get 200 credits a month. On Pro and Business, you choose a credits/seat/month tier when you subscribe, and the space's monthly credits are that tier multiplied by the purchased seats. **Can I undo a prompt to get my credits back?** Credits can't be returned once a prompt is processed. For App Builder, you can roll back your app to a previous version to undo unwanted changes, but the credits used for that prompt won't be restored. **Credits were used on a failed action. Can I get them back?** Credits are consumed once your prompt is processed, even if the result is not what you expected. If the AI Agent is unexpectedly interrupted, Teable restores the credits used by the final failed step. If you believe the failure was caused by a Teable-side issue, contact support and we can review it. **I lost credits to repeated errors that didn't fix the problem.** We understand the frustration. For App Builder, follow the [App Builder Practical Guide](/en/basic/ai/app-builder-practical-guide) before sending repeated fix prompts. **The AI made changes I didn't ask for and used my credits.** If the AI agent made unwanted changes in App Builder, you can roll back to a previous version. Credits for processed prompts are not automatically refunded unless the AI Agent was unexpectedly interrupted, but if the behavior seems like a product bug, we can review it. If you believe credits were unfairly consumed because of a Teable-side issue, submit a [Credit Issue Report](https://app.teable.ai/share/shrmBIyArdkWm999klP/view) with the related usage details. One AI Chat or App Builder run can include multiple processing steps. The conversation and billing page both show the total credits for that run. Work that Cuppy already completed and saved can still be used. If the final step is interrupted by an unexpected error, credits for that interrupted step are refunded automatically. You can continue working in the same conversation. In Teable Cloud, Teable sends AI credit usage notifications to Space Owners when a space is close to or over its credit quota, or when credit usage increases sharply in a short time. For quota reminders, Teable sends a notification when the current billing period reaches 80% or 90% of the available credits. Teable Cloud may also send critical notifications for unusual usage, such as a large daily increase or a sudden burst in a short time. The system uses recent daily and hourly usage patterns, and the exact thresholds may change. The notification opens **Space Settings** → **Billing**. When available, it shows the main sources of credit usage. If the usage is expected, consider raising the credit tier or changing your plan. If it is unexpected, review the top contributor and adjust or pause the related workflow, app, or AI feature. Credits follow the seats you have purchased, not the number of people using them. Filling a seat you already own changes nothing. To get more credits, buy seats or raise the credit tier on the Plan page. ## Need Help? If you have billing questions or issues: * Email us at **[support@teable.ai](mailto:support@teable.ai)** * Include your space name and billing email for faster assistance # Space Invitation Source: https://help.teable.ai/en/basic/space/space-invite Invite others to become space collaborators via email or link ## What is a Space Collaborator? When you share a space with another user, they become a space collaborator with access to all bases within that space. ## Adding Space Collaborators Creating an invitation link requires Manager or Creator space permissions. 1. Click the space where you want to add collaborators in the left sidebar. 2. Click the "Invite" button near the top of the space. 3. This opens the space invitation window, where you'll see options to invite via email or link. You'll also find previously configured "Invitation Links" and existing "Space Collaborators" in their respective sections. 4. **Email invitation**: Enter an email address or multiple addresses (separated by commas). Then, set the permission level you want users to have for all bases in the space. Finally, click send email to invite users to collaborate. After sending an email invitation, you can copy the direct Space link shown in the panel and send it separately. The invitee also receives an in-app notification that opens the Space. Invite space collaborators by email 5. **Link invitation**: Click the "Invite via Link" option. Then, set the permission level that the invitation link will grant for all bases in the space. Finally, click create link. You can now click the clipboard icon next to the created link to share it however you see fit. Invite space collaborators by link Space collaborators have access to all bases in the space. If someone only needs to work on specific bases, consider making them [Base Collaborators](/en/basic/space/base-invite). ## Deleting Invitation Links To delete an invitation link, click the X on the right side of the link. This will invalidate the link, and anyone trying to use the old link will not be able to access the space. Delete a space invitation link ## Removing Space Collaborators You can remove space collaborators from the space sharing window. Click the X next to the user you want to remove. A few things to note: Remove a space collaborator * **Permission restriction**: Only users with Manager or Creator permissions can remove other collaborators. * **Self-removal**: You can remove your own access if there is at least one other Manager in the space. * **Scope**: Removing someone from the space does not remove the permissions they hold on individual bases. When adding new users to a space, you can assign the following roles (see [Permission Details](/en/basic/space/space-permission)): | Role | Description | | --------- | ----------------------------------------------------------------------------------------------------------------------------------- | | Manager | Responsible for administration, has full permissions including user management, tables, automations, and enabling authority matrix. | | Creator | Can perform creation actions, modify table structure, edit automations, and enable authority matrix. | | Editor | Can modify data. | | Commenter | Can comment on records but cannot modify data. | | Viewer | Can view but cannot comment. | ## Reviewing Base Access Each person or department appears once in the space collaborator list, even when they also hold permissions on individual bases. A **Base permissions** badge next to the role shows how many bases they were invited to. Someone who was never added to the space itself is listed as **Has access to selected bases only**. Expand a row to see those bases and the role held on each. From there, **Remove base access** withdraws one base permission, and **Remove collaborator** on a base-only row withdraws every base permission that person holds in this space. # Collaboration Permission Details Source: https://help.teable.ai/en/basic/space/space-permission This section outlines the operational scope for four different permission levels in spaces and bases. Teable provides more granular permission control at table/field/record levels. Please refer to the [Authority Matrix](/en/basic/authority-matrix) section. ### Base Operations | Description | Creator/Manager | Editor | Commenter | Viewer | | ---------------------------------------------------- | :-------------: | :----: | :-------: | :----: | | View data within the base | ✅ | ✅ | ✅ | ✅ | | Invite users with equal or lower permissions | ✅ | ✅ | ✅ | ✅ | | Create or delete view share links | ✅ | ✅ | | | | Create and edit automations | ✅ | | | | | Enable authority matrix | ✅ | | | | | Create or delete base collaboration invitation links | ✅ | | | | | Rename base | ✅ | | | | ### Record Operations | Description | Creator/Manager | Editor | Commenter | Viewer | | ------------------------------ | :-------------: | :----: | :-------: | :----: | | Comment on records | ✅ | ✅ | ✅ | | | Add, delete, or modify records | ✅ | ✅ | | | ### View Operations | Description | Creator/Manager | Editor | Commenter | Viewer | | ------------------------------------------ | :-------------: | :----: | :---------------------: | :----: | | Download view as CSV | ✅ | ✅ | ✅ | ✅ | | Print view | ✅ | ✅ | ✅ | ✅ | | Copy data from view | ✅ | ✅ | ✅ | ✅ | | Add, delete, or modify views | ✅ | ✅ | ✅ \*Personal views only | | | Lock and unlock views | ✅ | | | | | Delete other collaborators' personal views | ✅ | | | | ### Field Operations | Description | Creator/Manager | Editor | Commenter | Viewer | | ----------------------------------------------- | :-------------: | :----: | :-------: | :----: | | Add, delete, duplicate, rename, and edit fields | ✅ | | | | ### Table Operations | Description | Creator/Manager | Editor | Commenter | Viewer | | ----------------------------------------- | :-------------: | :----: | :-------: | :----: | | Add, delete, duplicate, and rename tables | ✅ | | | | | Import CSV as new table | ✅ | | | | ### Space Operations | Description | Manager | Creator | Editor | Commenter | Viewer | | -------------------------------------------- | :-----: | :-----: | :----: | :-------: | :----: | | Access all bases in the space | ✅ | ✅ | ✅ | ✅ | ✅ | | Invite users with equal or lower permissions | ✅ | ✅ | ✅ | ✅ | ✅ | | Rename space | ✅ | ✅ | | | | | Add and remove bases in space | ✅ | ✅ | | | | | Rearrange bases within space | ✅ | ✅ | | | | | Move bases between spaces | ✅ | ✅ | | | | | Adjust billing settings, upgrade space | ✅ | | | | | | Grant manager permissions | ✅ | | | | | Once the Authority Matrix is enabled, only users with "Manager" permissions are exempt from its restrictions. For permission levels below "Manager" (such as "Creator" and below), all members except Authority Matrix administrators are subject to the Matrix's unified control. # Overview Source: https://help.teable.ai/en/basic/table Create, import, share, and manage tables in a base. Each base can contain multiple tables for storing and managing related data. Teable tables are equivalent to database tables — understanding [how they differ from spreadsheets](/en/compare/teable-vs-excel) will help you get the most out of Teable. ## Create and Manage Tables ### Adding Tables In a base, click the `+` button in the directory and choose to: Add table menu 1. Create a new blank table 2. Import from a CSV file 3. Import from an Excel file 4. Import from Airtable, if Airtable integration is configured See the [Import section](/en/basic/table/import) for details. ### Renaming & Deleting * **Rename**: Double-click the table name in the directory, edit it, then click anywhere outside to save. * **Delete**: Hover over the table in the directory, click `...`, then select **Delete**. Rename or delete a table When other tables link to the table you are deleting, the confirmation dialog lists the fields the delete affects, with the Base and table each one belongs to. Deleting the table converts those link fields into single line text fields that keep the linked record titles, and lookup or rollup fields built on them stop working. ### Trash Click the trash icon in the upper left of the base to manage deleted tables. Table trash * **Restore**: Bring the table back to the base with all data intact * **Empty trash**: Permanently delete all trashed tables Restoring a table does not undo the link conversion. Link fields in other tables stay text, so recreate them if you need the connection back. ## Design Tables Click **Design** in the table menu to view the table's basic properties: Table design **Table Information** Schema, physical table name, description, and last modified time **Field Properties** | Property | Description | | :---------------------- | :---------------------------------------------------------------------------------- | | **id** | Field ID | | **name** | Field name | | **dbFieldName** | Field name in the physical database | | **type** | Field type | | **description** | Field description | | **graph** | View current field dependencies | | **cellValueType** | Current field value type | | **isLookup** | Whether it's a field looked up from a linked table | | **isMultipleCellValue** | Whether it's an [array value field](/en/basic/field/common/is-multiple-value) | | **isComputed** | Whether it's a computed field (record values of computed fields cannot be modified) | | **isPending** | Whether it's in calculation | | **hasError** | Whether there are calculation errors | | **notNull** | Whether non-null validation is enabled | | **unique** | Whether unique value validation is enabled | ## Share and Access Tables ### Share a Table In a table, click **Share** in the upper-right corner, switch to **Share table**, and turn on **Share to web** to generate a share link. Table share entry Share table to web After table sharing is enabled, the **Share** button appears in a gray shared state in every view in that table. This state comes from table sharing; it does not mean each view has been shared separately. Link permissions: Table share permissions * **Can view**: Anyone with the link can view table data * **Can edit**: Logged-in users can edit records in the shared table * **Can save as copy**: Anyone with the link can save a copy to their space You can also configure **Allow viewers to copy data**, **Restrict by password**, regenerate or delete the link, and copy the embed config. To share only the current view, switch to **Share view**. For details, see [View toolbar](/en/basic/view/toolbar). ### Ways to Access Tables Tables default to a [Grid view](/en/basic/view/grid) and are also accessible via the [API](/en/api-doc/overview). You can create additional views — such as Kanban — to suit different workflow needs. ## Search and Downloads ### Global Search Table global search * Turn on **Search field** to choose which fields to search. This mode supports date fields in addition to text fields. * Turn off **Search field** to run a fuzzy search across all supported fields. Global search does not include date, checkbox, or button fields. Your instance may also limit how many fields global search can cover. * Turn on **Hide not match row** to show only matching records. Turn it off to keep all rows visible and highlight matches. * For large tables, editors can turn on **Index** to improve search speed. Building or updating the index can temporarily affect read and write performance. ### Attachment Downloads Bulk attachment downloads respect the current search results and include only attachments from matching records. Bulk attachment download entry In the bulk download dialog, use **Attachment name prefix** to name ZIP files by default index, a chosen field, or **No prefix** to keep original filenames; duplicates get an auto-appended suffix. Bulk attachment download options ## FAQ Teable is stricter than Excel — each column has a fixed data type, and a Number column only stores numbers. This constraint ensures data integrity and is the foundation for advanced filtering and automation. See [Teable vs Excel](/en/compare/teable-vs-excel) for details. Check whether the table is referenced by **linked fields** in other tables. Deleting the source table may cause data display issues in linked tables. # Export Source: https://help.teable.ai/en/basic/table/export Export an entire table or the data currently shown in a view as a CSV file. Teable supports exporting an entire table or only the data currently shown in a view. Exported files use CSV format. Export the entire table when you need the full raw data. Export a specific view when you only need the data currently shown in that view. To export an entire table, open the target table menu in the left directory. To export a view, switch to the target view and open the view menu. Select **Download CSV**. Teable generates the file according to the selected export scope. ## Export Flow To export an entire table, hover over the target table name in the left directory, click the `...` button on the right, then select **Download CSV**. Export an entire table To export a specific view, switch to the target view, confirm the filters, sorting, and hidden-field settings, then click the `...` menu next to the view name and select **Download CSV**. Export a specific view ## Notes * **Entire table export**: Includes the raw table data, including hidden fields and records. * **View export**: Exports only the data currently shown in the view. Use it for filtered, sorted, or hidden-field results. # Import Source: https://help.teable.ai/en/basic/table/import Import CSV, Excel, Airtable, or Google Sheets data into Teable. Use import to initialize a new table, append new data to an existing table, or bring tables from Airtable or Google Sheets into a Teable base. Airtable and Google Sheets are also available when you import a whole base. Use Connect Everything in AI Chat to migrate Airtable, Baserow, NocoDB, SmartSuite, and other systems into Teable. Excel files are limited to **5MB**. If you need to import a larger dataset, save it as **CSV** first and then import it. To create a new table, click `+` at the top of the left directory and choose **CSV file** or **Excel file** under **Add from other sources**. To append data to an existing table, choose **Import data** from the target table menu. Select the CSV or Excel file you want to import. Excel files must be **5MB** or smaller. When you create a new table, Teable offers **Import with AI** or **Import manually**. Review the preview after upload. When creating a new table, you can adjust field types. When appending to an existing table, confirm how file columns map to target fields. Click **Import** and keep the dialog open until the import finishes. It shows how many rows have been imported, and for a multi-sheet Excel file, which sheet is running. Before the completion notification arrives, do not delete the table being generated, delete fields, or change field types. These changes may affect the import result. ## Import Flow Click `+` at the top of the left directory, or `+` on the folder that should hold the new table, and select **CSV file** or **Excel file** according to your file type. Import a new table from the menu Once the file is uploaded, Teable offers **Optimize and import with AI**. **Import with AI** hands the file to AI Chat, which analyzes the data, adjusts the table structure, relationships, and field types, and runs the import. The import dialog closes and the chat panel opens, so you can watch the progress and reply to steer the result. An AI import uses AI credits, and it is offered when you create a new table, not when you import into an existing one. **Import manually** goes to the field preview instead, and **Back** in the preview returns to the choice. In that preview, Teable predicts field types from the first 5,000 rows of data. You can adjust them before importing. Import preview and field settings To append data to an existing table, open the table menu, select **Import data**, and choose the file type. Import data from the table menu After upload, map file columns to fields in the target table, then click **Import**. Teable processes the data in the background and notifies you when the import succeeds or fails. ## Import from Airtable If Airtable integration is configured for your instance, you can use Airtable import in two ways: * To create a new Teable base, open the target space menu, click **Import**, then choose **Import from Airtable**. * To import tables into the Teable base you are viewing, use the base resource menu: 1. Open the target Teable base. 2. Click `+` at the top of the left directory. 3. Under **Add from other sources**, choose **Airtable**. Airtable import entry in the base menu 4. Connect your Airtable account if needed, then choose the Airtable base to import. 5. Choose whether to import records, download and import attachments, and import view filters, sorts, and grouping. 6. Click **Start import**. When **Import view filters, sorts and grouping** is enabled, Teable asks for a read-only Airtable shared-base link because the Airtable API does not expose view settings. In Airtable, open the base's **Share** menu, use **Share to web** with full base access, paste that shared-base link into Teable, then turn the shared link off after the import completes. During import, Teable shows progress by table. If some fields, views, or values need to be adjusted, the import log lists the changes before showing **Import completed**. ## Import from Google Sheets Start from either entry point: * To create a new Teable base, open the target space menu, click **Import**, then choose **Import from Google Sheets**. * To add tables to the base you are viewing, click `+` at the top of the left directory and choose **Google Sheets** under **Add from other sources**. The first time you import, click **Connect Google account** and finish authorizing in the popup. Teable remembers the connection for later imports. Click **Select a spreadsheet from Google Drive** and choose one file in Google's file picker. Teable then reads its structure. Use **Change** to switch to a different spreadsheet. Each tab is shown as a card with its row and column count. Select the tabs you want. Clear **Import records** if you only want the field structure without the data. Click **Start import** and keep the dialog open. It reports progress table by table and, when it finishes, how many records each table received. After a new-base import, use **Open base** to go straight to the result. Teable can only read the spreadsheets you select in Google's file picker, not your whole Drive. To import another file later, open the picker again and select it. When values or columns need adjusting, the dialog lists each case: an empty tab is skipped, columns beyond the 300-column limit for one tab are not imported, and a value that does not fit the type Teable inferred for its column is dropped. If the import fails partway, the tables that already finished are kept, and the dialog says how many. ## FAQ The table reached its row limit. That sheet keeps the rows that fit and skips the rest, and the other sheets in the file still import. The result list in the dialog marks which sheet was cut. Import the remaining rows into another table, or raise the row limit for your plan or instance. A column in the header row is probably missing its name, so Teable used a record as the header instead. Name every column in the header row, remove stray notes from the cells beside the table, then import again. When a sheet fails, the result list in the dialog shows the reason for that sheet. Before the import starts, Teable also blocks the file when the format does not match the option you chose, when an Excel file is larger than 5MB, or when a field name in the preview is empty or duplicated. Fix the file or the field names, then import again. ## Notes * **Header row detection**: A CSV file uses the first row as the header. In an Excel file, Teable skips titles and blank rows above the table to find the header row, as long as the header sits on its own row and every column has a name. Check the column names in the preview before importing. * **Date format**: Teable can recognize common date formats such as `YYYY-MM-DD`. For unusual formats, standardize them before import, or import them as text and convert the field type later. * **Google Sheets field types**: Teable reads each column's cell formats to choose a field type, so values formatted as dates or numbers in Google Sheets arrive as Date and Number fields. Leading blank rows and banners above the table are skipped when Teable looks for the header row. Check the field types after importing. * **Airtable select options**: If Airtable select options have names that become identical after trimming spaces, Teable keeps the first option and maps matching record values to it. This prevents duplicate option names during import. # Calendar Source: https://help.teable.ai/en/basic/view/calendar View and manage records by date, such as meetings, events, schedules, and project timelines. Calendar view displays records on a calendar. If a table has a single-value date field, you can use Calendar view to track tasks, meetings, events, publishing plans, or project milestones. ## Use Cases | Scenario | Good for | | ------------------------- | ------------------------------------------------------------------ | | Meetings and appointments | Meeting times, customer visits, interviews | | Project scheduling | Start dates, due dates, milestones | | Content planning | Publish dates, campaign dates, marketing schedules | | Multi-day items | Projects, events, leave requests, or work with start and end dates | ## Create a Calendar View Click `+` next to the view tabs. Select **Calendar view** from the view types. Teable selects suitable date fields when available. Open **Calendar config** to change the **Start date field**, **End date field**, or **Title field**. ## Date Field Settings | Setting | Description | | ---------------- | -------------------------------------------------------- | | Start date field | Controls which day the record appears on | | End date field | Shows records that span multiple days or have a duration | | Title field | Controls the text shown on calendar records | If the table does not have a date field, Teable may prompt you to add start and end date fields. ## Color Settings Calendar records can use colors to separate different types of work. | Color display | Description | | ------------------ | -------------------------------------------------------------- | | Customize color | Uses one fixed color for this Calendar view | | Align with records | Uses colors from a Single Select field, such as status or type | ## Navigate the Calendar * Use the left and right arrows to switch months. * Click **Today** to return to the current date. * Click a record on the calendar to open its details. ## Create and Adjust Events * Hover over a date cell and click `+` to create a new record on that date. * To create a multi-day item, set an end date in the record details, or drag the event edge when separate start and end date fields are configured. * Drag an existing record to another date to update its date fields. * Right-click a record to duplicate or delete it. ## Notes * Calendar view depends on single-value date fields. If a configured date field is deleted or changed, review **Calendar config**. * Calendar view changes how records are displayed. It does not change existing fields unless you choose to add date fields from the Calendar prompt. * Create, edit, delete, drag, and resize actions depend on your view, record, and field permissions. # Form Source: https://help.teable.ai/en/basic/view/form Use a Form view to collect submissions and save each response as a new record in the current table. Form views are generated from the current table. Each submission creates a new record in the table where the form view was created. Use forms to collect feedback, registrations, reimbursement requests, customer details, and other structured data. Use App Builder for conditional logic, multi-step flows, branded pages, or more complex interactions. Use a Form view when you only need field names, subtitles, required fields, and basic sharing. You can also describe your collection needs in [AI Chat](/en/basic/ai/ai-chat) and let AI generate a form view from the current table. ## Use Cases | Scenario | Good for | | -------------------------- | ----------------------------------------------------------- | | Information collection | Customer details, registration forms, surveys, feedback | | Internal requests | Reimbursements, purchasing, leave requests, access requests | | File submission | Resumes, receipts, contracts, screenshots | | Lightweight workflow entry | Save external submissions directly as table records | ## Create a Form View Go to the table that should store form submissions. Open the view sidebar, click `+`, and choose **Form view**. Enter a form view name. After creating the view, Teable opens the form builder for field setup. ## Configure Form Fields Form fields are generated from the table fields. In the form builder, you can adjust what submitters see. | Action | Description | | ----------------- | ----------------------------------------------------------------------------------- | | Reorder fields | Drag fields to change their order on the form | | Hide fields | Click the hide button on a field, or drag the field to the hidden area on the left | | Add fields | Drag a field from the left sidebar, or click `+ Add field to this table` | | Rename field | Click a field and rename it. The name shown on the form updates with the field name | | Field description | Add a field description to explain what the submitter should enter | | Require a field | Turn on required so the form cannot be submitted without that field | ## Form Appearance Form appearance supports a cover image, logo, and submit button text. The cover area uses a fixed height, so avoid placing important text or key information in an image that may be cropped. ## Share the Form After configuring the form, click **Share form** in the top-right corner of the table, copy the form link, and send it to submitters. You can also click preview to open the public form page in your browser. ## Submission Settings | Setting | Description | | --------------------- | ------------------------------------------------------------------------------------------------- | | Password protection | Submitters must enter the correct password before submitting | | Track form submitters | Requires submitters to log in to Teable and records submitter information in the Created By field | When submitter tracking is enabled, visitors who are not logged in must log in or create a Teable account before submitting. # Gallery Source: https://help.teable.ai/en/basic/view/gallery Display records as image cards for product catalogs, asset libraries, and portfolios. Gallery view displays records as image cards. Use it when images are the main content of the table, such as product photos, design drafts, campaign assets, photo libraries, or portfolios. ## Use Cases | Scenario | Good for | | ---------------- | ------------------------------------------------ | | Product catalogs | Product images, models, prices, status | | Asset management | Design drafts, campaign assets, ads, screenshots | | Portfolios | Project covers, case images, design work | | Image review | Filter image records by status, owner, or tags | ## Create a Gallery View Click `+` next to the view tabs. Select **Gallery view** from the view types. After the view opens, use **Customize cards**, filters, and sorting to adjust how records appear. ## Set the Cover Image Gallery view can use an attachment field as the card cover. If the table already has an attachment field, Teable selects one by default. | Setting | Description | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | Cover field | Choose an attachment field to use as the card cover, or choose **No image** | | Multiple files | If the selected attachment field has multiple files, the first file is shown first on the card; users can switch between files from the card carousel | | Fit | When enabled, the whole image fits inside the cover area; when disabled, the image fills the cover area and may be cropped | ## Configure Card Information Click **Customize cards** in the toolbar to choose which fields appear on cards, reorder fields, and turn **Hide field name** on or off. Keep only fields that help identify the record, such as name, status, owner, price, or tags. Too many fields make Gallery view harder to scan. ## View and Edit Images * Click a cover image to open the preview. * In preview mode, switch between files, zoom or rotate images, or download the file. * Click the card body to open the record. ## Manage Records * Click **Add record** in the toolbar to add a record. If an attachment field is available, you can upload files from the record editor. * Right-click a card to delete the record or use other record actions. * Use filters and sorting to manage image records by status, category, or owner. ## Notes * Gallery view works best when attachment images are central to the table. If records are mostly text or numbers, Grid view is usually faster. * Field display settings in Gallery view only affect the current view. They do not delete field content. * Create, edit, delete, and file actions depend on your view, record, and field permissions. # Grid Source: https://help.teable.ai/en/basic/view/grid Display records in rows and columns for structured viewing, editing, and data cleanup. Grid view is the most common view in Teable. Each record appears as a row, and each field appears as a column. Use it for daily data entry, bulk editing, sorting, filtering, and quick checks. ## Use Cases | Scenario | Recommended setup | | ------------------------ | ----------------------------------------------------------- | | Maintain data day to day | Enter, edit, copy, and paste records directly in the grid | | Clean up many records | Combine filters, groups, sorts, and hidden fields | | Check numeric data | Use selection statistics for average, filled count, and sum | | Work with wide tables | Freeze key columns so identifying fields stay visible | ## Create a Grid View Every new table includes a grid view by default. To create another grid view for a specific workflow: Go to the target table and open the view list on the left. Click `+` at the top of the view sidebar and choose **Grid view**. Enter a view name, set the collaboration mode if needed, and create the view. ## Display Settings ### Manage Field Display Hide fields tool | Action | Description | | -------------- | ---------------------------------------------------------------------------- | | Hide fields | Click **Hidden fields** in the toolbar and turn fields on or off | | Reorder fields | Drag field headers left or right | | Find fields | Search field names in the hidden fields panel when the table has many fields | Hidden fields only change the current view. They do not delete fields or record data. ### Adjust Row Height and Field Name Height Click **Row height** in the toolbar to adjust the display density of the table view. Grid view row height menu * **Row height**: Choose Short, Medium, Tall, or Extra tall to adjust record row height. * **Field name**: Choose 1 line, 2 lines, or 3 lines to control the display height of column names in the table header. ### Freeze Columns When a table has many fields, freeze key columns so they stay visible while you scroll horizontally. Grid view freeze divider * Drag the freeze divider to freeze the columns on its left. Freeze up to this field menu in Grid view * Right-click a field header and choose **Freeze up to this field** to freeze that field and all fields to its left. * Teable keeps a scrollable area to the right of frozen columns. If the current window is too narrow, **Freeze up to this field** is disabled or Teable shows **Cannot freeze to this area because the current window is too narrow**. Widen the window or freeze fewer columns. ## Edit and Review Data ### Edit and Work in Bulk * **Edit a cell**: Click any cell and enter or change content. * **View long content**: Double-click a cell, or select it and press Space, to open the full content. * **Fill by dragging**: Drag the fill handle at the bottom-right corner of a selected cell to copy values downward. ### Selection Statistics Grid view selection statistics When you select a range of cells, Teable shows **Average**, **Filled**, and **Sum** for numeric values. Use this for quick checks on amounts, counts, and scores. ### Track Computed Field Activity When a computed field is waiting, calculating, or has failed, click the calculation activity indicator on the right side of the Grid toolbar to view the current table's status. | Status | What you can see | | --------------- | ----------------------------------------- | | **Calculating** | Affected records and calculation progress | | **Waiting** | Fields queued for calculation | | **Failed** | The latest calculation error | If a calculated value grows past the size a cell can hold, the field reports `Computed cell value is too large` with the attempted and maximum size. The limit is 256 KB per computed cell. The rest of the table keeps calculating and the cell keeps its previous value, so the field recalculates on the next write once the value fits. A single piece of text or a number rarely reaches 256 KB. The limit is usually hit when a record links to many other records and a Lookup or Rollup pulls all of their long text into one cell. For example, a customer with 500 follow-up records, each holding a few hundred words of notes, exceeds the limit once every note is looked up. The fix is to keep the details out of the cell: use a Rollup to count or sum the linked records, or look up a shorter field such as a status or a number. Open the linked table when you need to read the full content. ## Notes * Hidden fields, sorting, filtering, grouping, and similar settings apply only to the current view. * To prevent accidental configuration changes, lock the view. Only users with permission can unlock or change it. # Kanban Source: https://help.teable.ai/en/basic/view/kanban Display records as cards grouped by a field, useful for tracking status, stages, and workflows. Kanban view displays records as cards and groups them into columns by field value. Use it for task status, sales stages, content workflows, recruiting pipelines, and other stage-based work. ## Use Cases | Scenario | Good for | | ---------------- | ---------------------------------------------------------- | | Project tasks | Track tasks by Not started, In progress, Done | | Sales pipeline | Manage customers by Lead, Opportunity, Negotiation, Closed | | Content workflow | Track content by Idea, Writing, Review, Published | | Hiring pipeline | Manage candidates by Screening, Interview, Offer, Hired | ## Create a Kanban View Click `+` next to the view tabs. Select **Kanban view** from the view types. Choose the field used to create stacks, such as status, stage, owner, or date. ## Stack Settings Kanban view can stack records by most fields. Attachment and Button fields are not available as stacking fields. | Action | Description | | --------------------- | --------------------------------------------------------------------------------- | | Change stacking field | Click **Stacked by \[field]** in the toolbar and choose another stacking field | | Hide empty stacks | Turn on **Hide empty stack** in stacking field settings | | Collapse stacks | Choose **Collapse stack** from the stack menu to show the stack as a vertical bar | | Sort stacks | When stacked by a Single Select field, drag stacks to reorder them | ## Manage Stacks When the stacking field is a Single Select field, you can manage options directly from the board: * Click **Add stack** to create a new option. * Choose **Rename stack** from the stack menu to rename an option. * Choose **Delete stack** from the stack menu to delete an option. These actions change the options in the corresponding Single Select field. Confirm the impact before changing stacks used by other views or workflows. ## Configure Cards Click **Customize cards** in the toolbar to control what appears on each card. | Setting | Description | | --------------- | --------------------------------------------- | | Visible fields | Choose which fields appear on cards | | Field order | Adjust the order of fields on cards | | Cover | Choose an attachment field as the card cover | | Hide field name | Show only field values to reduce card density | Show only fields needed to understand the record status, such as title, owner, due date, priority, and key tags. ## Move and Edit Cards * Drag a card to change its order or move it to another stack. * Click `+` at the bottom of a stack to open the create-record dialog. Set the stacking field value if you want the new record to appear in that stack. * Right-click a card to insert a card above or below, expand the card, or delete it. * Click a card, or choose **Expand card**, to open the record details. ## Notes * When you drag a card to another stack, Teable updates the value of the stacking field. * Create, edit, delete, and drag actions depend on your view, record, and field permissions; cards also cannot be dragged between stacks when the stacking field is computed or read-only. * For team workflows, consider locking important views so grouping and card settings are not changed by accident. # View Toolbar Source: https://help.teable.ai/en/basic/view/toolbar Use filters, groups, sorting, sharing, and view collaboration settings in the current view. The view toolbar controls how the current view displays and shares records. Filters, groups, sorts, visible fields, row height, and related settings affect the current view only. They do not delete records or change other views. Filter, group, and sort settings are independent in each view. Changes in one view do not affect other views. ## Toolbar Overview | Tool | Use it for | Common scenarios | | ------------------ | ------------------------------------------------------------------ | -------------------------------------------------------------------------- | | Filter | Show only records that match conditions | Open tasks, your own records, records in a date range | | Group | Group records by field values | Workload by owner, progress by status, records by date | | Sort | Reorder records by field values | Recently updated records, task priority, sales ranking | | Share | Publish the current view as a link | Share a filtered, sorted, grouped, hidden-field, or layout-specific result | | View Collaboration | Choose whether view settings sync to everyone or only apply to you | Temporary view changes, or a team view everyone uses | ## Filter Filters show records that match specific conditions in the current view. They hide records that do not match. They do not delete records. Click `Filter` in the view toolbar. Choose a field, an operator, and a comparison value. For multiple conditions, choose **Meeting all conditions** or **Meeting any conditions**. | Relationship | Description | | ---------------------- | --------------------------------------------------------------- | | Meeting all conditions | A record appears only when every condition in that level is met | | Meeting any conditions | A record appears when any condition in that level is met | View filter conditions ### Condition Groups Use **condition groups** for more complex filter logic. For example, "A and B, or C and D" can be expressed as two groups. * Click `Add condition group` to create a group. * Groups can use **Meeting all conditions** or **Meeting any conditions**. * A group can contain nested groups. * Condition groups support up to **3 levels**. View filter condition groups ### Common Filter Operators | Field type | Common operators | Input | | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | | Single Line Text, Long Text | Equals, Does not equal, Contains, Does not contain, Is empty, Is not empty | Text input | | User | Equals, Does not equal, Contains any, Does not contain any, Is empty, Is not empty | User list, current user | | Attachment | Is empty, Is not empty | No input | | Multiple Select | Contains any, Contains all, Exactly matches, Does not contain any, Is empty, Is not empty | Option list | | Single Select | Equals, Does not equal, Contains any, Does not contain any | Option list | | Date, Created Time, Last Modified Time | Equals, Does not equal, Within, Before, After, On or before, On or after, Is empty, Is not empty | Preset range or exact date | | Number, Rating, Auto Number | `=`, `≠`, `>`, `≥`, `<`, `≤`, Is empty, Is not empty | Number | | Link | Equals, Does not equal, Contains, Does not contain, Contains any, Contains all, Exactly matches, Does not contain any, Is empty, Is not empty | Linked record selector | | Created By, Last Modified By | Equals, Does not equal | User list, current user | Formula and Rollup operators depend on the result type. ### Invalid Condition Warnings If a field type changes, a field is deleted, or an older filter setup is no longer compatible, Teable ignores the invalid condition so the view can still open. * The `Filter` button in the toolbar shows a warning icon. * After you open the filter panel, the invalid condition shows a warning icon. * Hover over the icon to see the reason and fix the condition. ## Group Grouping records by field values helps you review distribution, summaries, and hierarchy. Click `Group` in the view toolbar. Choose the field you want to group by. Click `Add another group` when you need multiple grouping levels. | Field type | Recommended use | | ------------------------------ | -------------------------------------------------------- | | Single Select, Multiple Select | Group by fixed options such as status, priority, or type | | User | Group by owner, collaborator, or submitter | | Date | Group records by time period | | Checkbox, Link, Number, Rating | Group by clear values or results | * Grouping supports up to **3 levels**. * You can collapse or expand groups. Records inside each group still follow the current sort order. * Each group shows a summary bar at the top so you can review its summary results. * Empty values are placed into separate uncategorized, unassigned, or empty groups depending on the field type. ## Sort Sorting reorders records by field values. It changes the display order in the current view and does not edit record content. Click `Sort` in the view toolbar. Choose the field you want to sort by. Choose ascending or descending. Add more sort conditions when you need multi-level sorting. Multi-level sorting follows the order of the conditions. Teable sorts by the first condition first; if records have the same value, it then applies the next condition. | Field type | Sort behavior | | -------------------------------------- | ---------------------------------------------------------------------------- | | Text, Attachment | Sort alphabetically or in reverse order. Attachments are sorted by filename | | Number, Duration, Rating | Sort by value in ascending or descending order | | Date, Created Time, Last Modified Time | Sort from earliest to latest, or latest to earliest | | Checkbox | Sort from unchecked to checked, or in the reverse order | | Single Select, Multiple Select | Sort by the option order in the field configuration, or in the reverse order | Formula and Rollup fields are sorted according to their result type. Use the `Auto-sort records` toggle in the sort menu. | Status | Behavior | | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | On | Records stay sorted by the current rules. When a field value changes, the record moves to its new position. You cannot manually drag records while auto-sort is on | | Off | Records are sorted again only after you reapply sorting. You can manually drag records, and data updates do not move them automatically | ## Share View **Share view** publishes the current view as a link. Visitors see the data and layout in that view. This is not the same as inviting them as base collaborators. To share an entire base, a specific table, or a folder, use base sharing in [Base](/en/basic/base). | Share option | Best for | | ------------ | -------------------------------------------------------------------------------------------------------------- | | Share table | Giving external people broader access to the current table | | Share view | Publishing only the current view, such as a filtered, sorted, grouped, hidden-field, or layout-specific result | A view share link follows the current view configuration. If you later change filters, sorting, grouping, hidden fields, or layout, the shared page changes as well. Go to the view you want to share. Click **Share** in the view toolbar. Switch to **Share view**. Turn on **Share view to web**. Copy the generated link, or share the QR code. If you do not have permission to share the view, the sharing switch is unavailable. After **Share view to web** is turned off, existing share links can no longer be opened. Public links can be forwarded. Before enabling sharing, confirm that the current view does not include fields or records that should not be public. Different view types show different advanced options. | Option | Applies to | Description | | -------------------------------------------- | --------------- | --------------------------------------------------------------------------------------------- | | Allow viewers to copy data out of this view | Grid view | Controls whether visitors can copy data from the shared grid view | | Show all fields in expanded records | Grid view | Controls whether visitors can see hidden fields when opening record details | | Allow signed-in viewers to edit visible data | All views | Lets signed-in visitors edit records and fields within the shared view's scope | | Restrict by password | All view shares | Adds a password to the share link. Visitors must enter the correct password before opening it | | Require login to submit | Form view | Requires visitors to log in before submitting the form | When **Allow signed-in viewers to edit visible data** is enabled, anonymous visitors remain read-only and see a sign-in prompt. Signed-in visitors can create, update, or delete records only within the shared view's visible data. Records outside the current view filter and fields hidden from the view cannot be edited through the share link. Share views can be embedded in other webpages. Click **Embed config** to preview the embed, copy iframe code, hide the toolbar, and choose a theme. ```html theme={null} ``` | Embed option | Description | | ------------ | -------------------------------------------------------------------------------------------------------------------------------- | | Hide toolbar | Adds `hideToolBar=true` to the link and hides filter, sort, search, and other toolbar controls. This does not apply to Form view | | Theme | Supports system, light, and dark themes | ## View Collaboration View collaboration controls whether view settings are shared with everyone or kept as your own personal adjustments. It affects filters, sorts, groups, visible fields, row height, and other view settings. It does not affect record data. | Mode | Use case | Setting behavior | | ------------------ | ------------------------------------------------------------------------- | ------------------------------------------------------------------------ | | Collaboration mode | The team needs to use the same view setup | View settings are synced to everyone using this view | | Personal mode | You want a temporary view setup, or you want to view data in your own way | Filters, sorts, groups, visible fields, and row height apply only to you | Click `Personal` in the toolbar to switch between collaboration mode and personal mode. If the view is not locked and you have permission to update the view, turning off personal mode gives you two choices. | Option | Result | | --------------- | ---------------------------------------------------------------- | | `Exit and sync` | Sync your personal-mode view settings to everyone | | `Confirm exit` | Discard your personal-mode view settings and leave personal mode | If the view is locked, or you do not have permission to edit the view, you can still use personal mode for your own temporary adjustments, but you cannot sync those changes to others. ## FAQ If the shared view includes link fields, use **Restrict scope** in the share panel to limit which linked records and fields visitors can see or select from those link fields. ## Notes * Changing filters, groups, sorts, visible fields, or row height affects everyone using the current view, unless you are in personal mode. * Share view publishes the current view result, not full base permissions. For ongoing collaboration, use member permissions or base sharing. * In either mode, edits to cell values are still synced to everyone. # Error Codes Source: https://help.teable.ai/en/api-doc/error-code Teable Web API follows HTTP status code semantics. * 2xx Represents success * 4xx Client errors * 5xx Server errors Error responses will return a JSON-encoded body containing error and information fields. Here's an example of an error response body: ```json theme={null} { "message": "not allowed to operate space|read on spcxxxxxx", "status": 403, "code": "restricted_resource" } ``` ## Success Status Codes ### 200 OK The request has been successfully completed. ### 201 Created The request has been successfully completed and a new resource has been created. ## Error Codes ### 400 Bad Request The request body cannot be parsed as `JSON`, or the input body parameters do not meet specification requirements. ### 401 Unauthorized Unauthorized access to the API. ### 403 Forbidden Attempting to access a protected resource with API credentials that lack the necessary permissions. ### 404 Not Found Route or resource not found. This error is returned when accessing a non-existent resource path or when the request method doesn't match. ### 500 Internal Server Error The server encountered an unexpected condition. ### 503 Service Unavailable The service is temporarily unavailable, possibly due to processing timeout or database connection failure. # Getting IDs Source: https://help.teable.ai/en/api-doc/get-id ## SpaceId Click on the target space and copy the string starting with 'spc' from the URL, example: `spcXXXXXXXXXX` Space ID in the URL ## BaseId Click on the target base and copy the string starting with 'bse' from the URL, example: `bseXXXXXXXXXX` Base ID in the URL ## TableId Click on the target table and copy the string starting with 'tbl' from the URL, example: `tblXXXXXXXXXX` Table ID in the URL ## ViewId Click on the target view and copy the string starting with 'viw' from the URL, example: `viwXXXXXXXXXX` View ID in the URL ## FieldId **Method 1:** Click the "More" icon (three dots) in the top left corner, then select "Design" to enter the design interface and view all field IDs Open the design page from the More menu Field IDs in the design page **Method 2:** Double-click the column header or select "Edit field" to open the field properties. In the "DB field name" section, you can find the Field ID. Open field settings from the column menu DB field name with the field ID ## RecordId Expand the record edit form and copy the string starting with 'rec' after 'recordId=' in the URL, example: `recXXXXXXXXXX` Record ID in the expanded record URL # OAuth App Source: https://help.teable.ai/en/api-doc/oauth Build integrations that allow users to authorize access to their Teable data using OAuth 2.0. OAuth Apps allow third-party applications to access Teable on behalf of users. This guide explains how to create and configure an OAuth App, implement the OAuth 2.0 authorization flow, and use access tokens to interact with the Teable API. Teable supports three OAuth 2.0 authorization modes: * **Authorization Code + Client Secret**: For web applications with a backend server * **Authorization Code + PKCE**: For native apps, CLI tools, SPAs, and other public clients that cannot securely store a client secret * **Device Authorization Grant**: For clients that cannot receive a browser redirect at all, such as a CLI running over SSH, in a container, or in a cloud IDE ## Creating an OAuth App 1. Go to [Settings > OAuth Apps](https://app.teable.ai/setting/oauth-app) in your Teable account. 2. Click **New OAuth Apps** to create a new application. 3. Fill in the required information: * **OAuth App name**: A descriptive name for your application * **Homepage URL**: The full URL to your application's website * **Callback URL**: The URL where users will be redirected after authorization * **Scopes**: The permissions your application needs * **Enable device flow**: Off by default. Turn it on only if your application signs users in with a device code 4. After creating the app, generate a **Client Secret**. Make sure to copy and store it securely - you won't be able to see it again. You'll receive a **Client ID** and need to generate a **Client Secret**. Keep these credentials secure and never expose them in client-side code. If using the PKCE flow, a client secret is not required. ## Available Scopes Scopes define what actions your OAuth App can perform. Available scopes are organized by resource type: | Resource | Scopes | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **App** | `app\|create`, `app\|read`, `app\|update`, `app\|delete` | | **Base** | `base\|read`, `base\|read_all`, `base\|update`, `base\|table_import`, `base\|table_export`, `base\|query_data` | | **Table** | `table\|create`, `table\|delete`, `table\|export`, `table\|import`, `table\|read`, `table\|update`, `table\|trash_read`, `table\|trash_update`, `table\|trash_reset` | | **View** | `view\|create`, `view\|delete`, `view\|read`, `view\|update` | | **Field** | `field\|create`, `field\|delete`, `field\|read`, `field\|update` | | **Record** | `record\|comment`, `record\|create`, `record\|delete`, `record\|read`, `record\|update` | | **Automation** | `automation\|create`, `automation\|delete`, `automation\|read`, `automation\|update` | | **User** | `user\|email_read`, `user\|integrations` | Request only the scopes your application actually needs. Users will see the requested permissions during authorization. ## OAuth 2.0 Authorization Code Flow Teable implements the standard OAuth 2.0 Authorization Code flow: ```mermaid theme={null} sequenceDiagram participant User participant App as Your App participant Teable App->>Teable: 1. Redirect to /api/oauth/authorize Teable->>User: 2. Show authorization page User->>Teable: 3. Approve or deny Teable->>App: 4. Redirect with authorization code App->>Teable: 5. Exchange code for tokens Teable->>App: 6. Return access_token & refresh_token ``` ### Step 1: Redirect Users to Authorization Direct users to the authorization endpoint with your application parameters: ``` GET https://app.teable.ai/api/oauth/authorize ``` **Query Parameters:** | Parameter | Required | Description | | --------------- | -------- | ----------------------------------------------------------------------------------------------------------- | | `response_type` | Yes | Must be `code` | | `client_id` | Yes | Your OAuth App's Client ID | | `redirect_uri` | No | Must match one of your registered callback URLs. If omitted, the first registered callback URL will be used | | `scope` | No | Space-separated list of scopes. If omitted, uses scopes configured in your OAuth App | | `state` | No | Random string to prevent CSRF attacks. Will be returned in the callback | **Example:** ``` https://app.teable.ai/api/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=https://yourapp.com/callback&scope=table|read%20record|read&state=random_state_string ``` ### Step 2: User Authorization Users will see an authorization page showing: * Your application name and logo * The requested permissions (scopes) * Options to approve or deny access If the user has previously authorized your app (within 7 days by default), they will be redirected immediately without seeing the authorization page again. ### Step 3: Handle the Callback After the user approves (or denies), Teable redirects to your callback URL: **On success:** ``` https://yourapp.com/callback?code=AUTHORIZATION_CODE&state=random_state_string ``` **On denial:** ``` https://yourapp.com/callback?error=access_denied&state=random_state_string ``` ### Step 4: Exchange Code for Tokens Exchange the authorization code for access and refresh tokens: ``` POST https://app.teable.ai/api/oauth/access_token Content-Type: application/x-www-form-urlencoded ``` **Request Body:** | Parameter | Required | Description | | --------------- | -------- | ---------------------------------------------------------- | | `grant_type` | Yes | Must be `authorization_code` | | `code` | Yes | The authorization code received | | `client_id` | Yes | Your OAuth App's Client ID | | `client_secret` | Yes | Your OAuth App's Client Secret | | `redirect_uri` | Yes | Must exactly match the redirect\_uri used in authorization | **Example Request:** ```bash theme={null} curl -X POST https://app.teable.ai/api/oauth/access_token \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=authorization_code" \ -d "code=AUTHORIZATION_CODE" \ -d "client_id=YOUR_CLIENT_ID" \ -d "client_secret=YOUR_CLIENT_SECRET" \ -d "redirect_uri=https://yourapp.com/callback" ``` **Response:** ```json theme={null} { "token_type": "Bearer", "access_token": "teable_xxxxxxxxxxxx", "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "expires_in": 600, "refresh_expires_in": 2592000, "scopes": ["table|read", "record|read"] } ``` | Field | Description | | -------------------- | -------------------------------------------------------------- | | `token_type` | Always `Bearer` | | `access_token` | Token to use for API requests | | `refresh_token` | Token to obtain new access tokens | | `expires_in` | Access token lifetime in seconds (default: 600 = 10 minutes) | | `refresh_expires_in` | Refresh token lifetime in seconds (default: 2592000 = 30 days) | | `scopes` | Array of granted scopes | ## PKCE Authorization Flow PKCE (Proof Key for Code Exchange) is designed for applications that cannot securely store a client secret, such as native desktop apps, mobile apps, CLI tools, or single-page applications. ### Step 1: Generate PKCE Parameters Before initiating authorization, the client needs to generate a pair of PKCE parameters: ```javascript theme={null} // Generate code_verifier (43-128 character random string) const codeVerifier = generateRandomString(43); // Generate code_challenge = BASE64URL(SHA256(code_verifier)) const encoder = new TextEncoder(); const data = encoder.encode(codeVerifier); const digest = await crypto.subtle.digest('SHA-256', data); const codeChallenge = btoa(String.fromCharCode(...new Uint8Array(digest))) .replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, ''); ``` ### Step 2: Redirect Users to Authorization ``` GET https://app.teable.ai/api/oauth/authorize ``` **Query Parameters:** | Parameter | Required | Description | | ----------------------- | -------- | ------------------------------------------------------ | | `response_type` | Yes | Must be `code` | | `client_id` | Yes | Your OAuth App's Client ID | | `redirect_uri` | No | Callback URL. PKCE mode supports loopback addresses | | `scope` | No | Space-separated list of scopes | | `state` | No | Random string to prevent CSRF attacks | | `code_challenge` | Yes | SHA-256 hash of the code\_verifier (Base64URL encoded) | | `code_challenge_method` | Yes | Must be `S256` | **Example:** ``` https://app.teable.ai/api/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://127.0.0.1:8080/callback&code_challenge=YOUR_CODE_CHALLENGE&code_challenge_method=S256&state=random_state_string ``` In PKCE mode, `redirect_uri` supports loopback addresses (`http://127.0.0.1`, `http://[::1]`, `http://localhost`) with flexible port matching - you don't need to register each port exactly. ### Step 3: Handle the Callback Same as the standard authorization code flow - after user approval, the authorization code is returned via redirect. ### Step 4: Exchange Code + code\_verifier for Tokens ``` POST https://app.teable.ai/api/oauth/access_token Content-Type: application/x-www-form-urlencoded ``` **Request Body:** | Parameter | Required | Description | | --------------- | -------- | ---------------------------------------------------------- | | `grant_type` | Yes | Must be `authorization_code` | | `code` | Yes | The authorization code received | | `client_id` | Yes | Your OAuth App's Client ID | | `code_verifier` | Yes | The original random string generated in Step 1 | | `redirect_uri` | Yes | Must exactly match the redirect\_uri used in authorization | PKCE mode does not require `client_secret`. The `code_verifier` is used instead to verify the client's identity. **Example Request:** ```bash theme={null} curl -X POST https://app.teable.ai/api/oauth/access_token \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=authorization_code" \ -d "code=AUTHORIZATION_CODE" \ -d "client_id=YOUR_CLIENT_ID" \ -d "code_verifier=YOUR_CODE_VERIFIER" \ -d "redirect_uri=http://127.0.0.1:8080/callback" ``` The response format is the same as the standard authorization code flow. ## Device Authorization Flow The Device Authorization Grant ([RFC 8628](https://datatracker.ietf.org/doc/html/rfc8628)) is for clients that cannot receive a browser redirect: a CLI running over SSH, inside a container, or in a cloud IDE. Your client shows a URL and a short code, the user approves in any browser, and nothing is typed back into the terminal. Teable follows RFC 8628, so most OAuth client libraries can drive this flow without custom code. What follows is what is specific to Teable. Device flow is off by default. Turn on **Enable device flow** in your OAuth App settings before using it. Anyone who knows your Client ID can start this flow in your app's name, so enable it only if your app needs it. Turning it off again also stops requests that are already waiting for approval. ### Request a Device Code `POST /api/oauth/device/code` with your `client_id` and an optional `scope`. The endpoint is anonymous and rate limited to 30 requests per 15 minutes per IP address. ```json theme={null} { "device_code": "xxxxxxxxxxxx", "user_code": "BCDF-GHJK", "verification_uri": "https://app.teable.ai/oauth/device", "expires_in": 900, "interval": 5 } ``` Both codes expire after 15 minutes (`BACKEND_OAUTH_DEVICE_CODE_EXPIRE_IN`), and `interval` is the minimum seconds to wait between polls. Print the `verification_uri` and the `user_code`. On that page the user signs in, enters the code, and reviews your app's name, homepage, and requested scopes before approving or denying. The page warns them not to approve a code they did not start themselves. Each code can be used once. Teable does not return `verification_uri_complete`, and your client should not build one. An approved code signs the approver into their own Teable account, so a link that already carries the code is exactly what device-code phishing relies on. ### Poll for Tokens `POST /api/oauth/access_token` with `grant_type=urn:ietf:params:oauth:grant-type:device_code`, the `device_code`, and your `client_id`. Public clients send no `client_secret`; confidential clients add it as in the other flows. Until someone approves the code, the endpoint answers with an error instead of tokens: | Error | What your client should do | | ----------------------- | ----------------------------------------------------- | | `authorization_pending` | Nobody has approved yet. Keep polling at `interval` | | `slow_down` | You polled too fast. Wait longer before the next poll | | `access_denied` | The user denied the request. Stop polling | | `expired_token` | The code expired or was already used. Start over | Once the user approves, the response is the same token payload as the other flows. ## Using Access Tokens Include the access token in the `Authorization` header for API requests: ```bash theme={null} curl https://app.teable.ai/api/table/TABLE_ID/record \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" ``` Typically, the first step after obtaining a token is to retrieve all Bases accessible to the current user: ```bash theme={null} curl https://app.teable.ai/api/base/access/all \ -H "Authorization: Bearer YOUR_ACCESS_TOKEN" ``` This endpoint returns all Bases the current user has permission to access. You can use the `baseId` from the response for subsequent API calls. ## Refreshing Access Tokens When an access token expires, use the refresh token to obtain a new one: ``` POST https://app.teable.ai/api/oauth/access_token Content-Type: application/x-www-form-urlencoded ``` **Request Body:** | Parameter | Required | Description | | --------------- | ----------- | ----------------------------------------------------------------------- | | `grant_type` | Yes | Must be `refresh_token` | | `refresh_token` | Yes | Your current refresh token | | `client_id` | Yes | Your OAuth App's Client ID | | `client_secret` | Conditional | Required for standard authorization code mode, not needed for PKCE mode | **Example Request:** ```bash theme={null} curl -X POST https://app.teable.ai/api/oauth/access_token \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "grant_type=refresh_token" \ -d "refresh_token=YOUR_REFRESH_TOKEN" \ -d "client_id=YOUR_CLIENT_ID" \ -d "client_secret=YOUR_CLIENT_SECRET" ``` After refreshing, the previous refresh token becomes invalid (Refresh Token Rotation). Always store the new refresh token from the response. ## Revoking Access ### For OAuth App Owners Revoke the app's access for **all users** (only the app creator can do this): ``` POST https://app.teable.ai/api/oauth/client/{clientId}/revoke-access ``` This deletes all users' authorization records and tokens, completely preventing the app from accessing any user's data. ### For Users Revoke **your own** authorization for a specific app: ``` POST https://app.teable.ai/api/oauth/client/{clientId}/revoke-token ``` This only invalidates the current user's access tokens and refresh tokens, without affecting other users. Users can also revoke access through their [Authorized Apps](https://app.teable.ai/setting/authorized-apps) settings page. ### For Applications Applications can revoke their own access using an Access Token: ``` GET https://app.teable.ai/api/oauth/client/{clientId}/revoke-token Authorization: Bearer YOUR_ACCESS_TOKEN ``` This endpoint only accepts Access Token authentication, not session authentication. ## Token Expiration | Token Type | Default Expiration | Configurable Via | | -------------------- | ------------------ | --------------------------------------- | | Authorization Code | 5 minutes | `BACKEND_OAUTH_CODE_EXPIRE_IN` | | Device Code | 15 minutes | `BACKEND_OAUTH_DEVICE_CODE_EXPIRE_IN` | | Access Token | 10 minutes | `BACKEND_OAUTH_ACCESS_TOKEN_EXPIRE_IN` | | Refresh Token | 30 days | `BACKEND_OAUTH_REFRESH_TOKEN_EXPIRE_IN` | | Authorization Memory | 7 days | `BACKEND_OAUTH_AUTHORIZED_EXPIRE_IN` | ## Error Handling Common error responses: | Error | Description | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | `invalid_client` | Invalid Client ID or Client Secret | | `invalid_grant` | Authorization code expired or already used | | `invalid_scope` | Requested scope not allowed for this OAuth App | | `access_denied` | User denied the authorization request | | `redirect_uri_mismatch` | Redirect URI doesn't match registered URLs | | `unauthorized_client` | The OAuth App has not enabled the device flow | | `too_many_requests` | Rate limit exceeded. Token requests default to 30 per 15 minutes, and device code requests to 30 per 15 minutes per IP address | ## Best Practices 1. **Choose the right mode**: Use client secret mode for web apps with a backend, PKCE mode for native apps/CLI/SPA, and device flow when the client cannot receive a browser redirect 2. **Store secrets securely**: Never expose your Client Secret in client-side code 3. **Use state parameter**: Always include a random `state` parameter to prevent CSRF attacks 4. **Request minimal scopes**: Only request permissions your application actually needs 5. **Handle token refresh**: Implement automatic token refresh before expiration 6. **Secure token storage**: Store access and refresh tokens securely on your server ## Complete Examples ### Node.js (Authorization Code + Client Secret) ```javascript theme={null} const express = require('express'); const crypto = require('crypto'); const app = express(); const CLIENT_ID = 'your_client_id'; const CLIENT_SECRET = 'your_client_secret'; const REDIRECT_URI = 'http://localhost:3000/callback'; const TEABLE_URL = 'https://app.teable.ai'; // Step 1: Redirect user to authorization app.get('/login', (req, res) => { const state = crypto.randomBytes(16).toString('hex'); req.session.oauthState = state; // Store state in session const authUrl = `${TEABLE_URL}/api/oauth/authorize?` + `response_type=code&` + `client_id=${CLIENT_ID}&` + `redirect_uri=${encodeURIComponent(REDIRECT_URI)}&` + `scope=${encodeURIComponent('record|read table|read')}&` + `state=${state}`; res.redirect(authUrl); }); // Step 2: Handle callback and exchange code for tokens app.get('/callback', async (req, res) => { const { code, state } = req.query; // Verify state to prevent CSRF if (state !== req.session.oauthState) { return res.status(403).send('Invalid state'); } const response = await fetch(`${TEABLE_URL}/api/oauth/access_token`, { method: 'POST', headers: { 'Content-Type': 'application/x-www-form-urlencoded' }, body: new URLSearchParams({ grant_type: 'authorization_code', client_id: CLIENT_ID, client_secret: CLIENT_SECRET, code, redirect_uri: REDIRECT_URI, }), }); const tokens = await response.json(); // tokens.access_token — use for API calls // tokens.refresh_token — use to refresh tokens res.json({ success: true, scopes: tokens.scopes }); }); app.listen(3000); ``` ### Python (PKCE Mode for CLI Tools) ```python theme={null} import hashlib import base64 import secrets import http.server import urllib.parse import requests CLIENT_ID = 'your_client_id' TEABLE_URL = 'https://app.teable.ai' PORT = 8080 REDIRECT_URI = f'http://127.0.0.1:{PORT}/callback' # Step 1: Generate PKCE parameters code_verifier = secrets.token_urlsafe(32) # 43 characters code_challenge = base64.urlsafe_b64encode( hashlib.sha256(code_verifier.encode()).digest() ).rstrip(b'=').decode() # Step 2: Build authorization URL (open in browser) auth_url = ( f"{TEABLE_URL}/api/oauth/authorize?" f"response_type=code&" f"client_id={CLIENT_ID}&" f"redirect_uri={urllib.parse.quote(REDIRECT_URI)}&" f"code_challenge={code_challenge}&" f"code_challenge_method=S256" ) print(f"Open in your browser:\n{auth_url}") # Step 3: Start local server to receive callback authorization_code = None class CallbackHandler(http.server.BaseHTTPRequestHandler): def do_GET(self): global authorization_code query = urllib.parse.urlparse(self.path).query params = urllib.parse.parse_qs(query) authorization_code = params.get('code', [None])[0] self.send_response(200) self.end_headers() self.wfile.write(b'Authorization successful! You can close this page.') def log_message(self, format, *args): pass # Silence logs server = http.server.HTTPServer(('127.0.0.1', PORT), CallbackHandler) server.handle_request() # Handle single request # Step 4: Exchange code + code_verifier for tokens response = requests.post(f"{TEABLE_URL}/api/oauth/access_token", data={ 'grant_type': 'authorization_code', 'client_id': CLIENT_ID, 'code': authorization_code, 'redirect_uri': REDIRECT_URI, 'code_verifier': code_verifier, }) tokens = response.json() print(f"Access Token: {tokens['access_token']}") print(f"Expires in: {tokens['expires_in']}s") ``` # API Overview Source: https://help.teable.ai/en/api-doc/overview Everything you need to start calling the Teable API: base URL, authentication, IDs, and common request patterns. This section helps you start using the Teable API quickly and safely. ## Base URL * **Teable Cloud**: `https://app.teable.ai` * **Self-hosted**: use your own domain (for example `https://teable.example.com`) All API paths in this documentation are relative to the base URL and start with `/api`. ## Authentication Teable APIs use **Bearer tokens**: ```bash theme={null} curl -H 'Authorization: Bearer __token__' \ 'https://app.teable.ai/api/table/__tableId__/record' ``` You can use either: * **Personal Access Token**: best for scripts, internal tools, and server-side integrations. See [Access Token](/en/api-doc/token). * **OAuth Access Token**: best for multi-tenant integrations where end users grant access. See [OAuth App](/en/api-doc/oauth). ## IDs (spaceId / baseId / tableId / viewId / fieldId / recordId) Most endpoints require IDs like `tbl...`, `rec...`. See [Getting IDs](/en/api-doc/get-id). ## Scopes & permissions Both Personal Access Tokens and OAuth tokens are permission-scoped. If you get a 403, it usually means the token is missing the required scope. * See [Error Codes](/en/api-doc/error-code) * OAuth scopes reference: [OAuth App](/en/api-doc/oauth#available-scopes) ## Pagination (take / skip) Many list endpoints support: * `take`: number of items to return (some endpoints cap this, e.g. records max 100 per request, so page with `skip`) * `skip`: number of items to skip ## Field keys & cell format Some APIs let you control how record fields are represented: * `fieldKeyType`: `name` (default) / `id` / `dbFieldName` * `cellFormat`: `json` (default) / `text` For record field value structures, see [Record Field Interface](/en/api-doc/record/interface). ## Where to go next * **Just want to fetch data**: [Get Records](/en/api-doc/record/get) * **Create/update/delete records**: [Create Records](/en/api-doc/record/create), [Update Record](/en/api-doc/record/update), [Delete Records](/en/api-doc/record/delete) * **Upload attachments**: [Upload Attachment](/en/api-doc/record/upload-attachment) * **Full endpoint list**: use the left navigation under **API Reference** # Create Records Source: https://help.teable.ai/en/api-doc/record/create ### Path POST /api/table/\{tableId}/record ### Request #### Path Parameters * tableId (string): The unique identifier of the table. #### Request Body * **records (required)** * Description: Array of records to create * Type: Array * Example: ```json theme={null} [ { "fields": { "Name": "John Doe", "Age": 30, "Email": "john@example.com" } }, { "fields": { "Name": "Jane Smith", "Age": 28, "Email": "jane@example.com" } } ] ``` * Note: Each record is an item containing a `fields` object. The `fields` object contains field names and their corresponding values. Each field type has a different value structure, see [Record Field Value Types](/en/api-doc/record/interface) for details. * Default values: Fields omitted from `fields` use the table's default value when one is configured. If a required field has no default value, or if you explicitly pass `null` to a required field, the request fails. * **fieldKeyType (optional)** * Description: Specifies the type of field key * Type: String * Possible values: * "name": Use field name as key * "id": Use field ID as key * "dbFieldName": Use field dbFieldName as key * Example: `"name"` or `"id"` or `"dbFieldName"` * Note: If not specified, field name is used as key by default. * Usage: * When set to "name": ```json theme={null} { "fields": { "Name": "John Doe", "Age": 30 } } ``` * When set to "id": ```json theme={null} { "fields": { "fldABCDEFGHIJKLMN": "John Doe", "fldOPQRSTUVWXYZ12": 30 } } ``` * **typecast (optional)** * Description: Whether to automatically convert field value types. By default, strict validation is enforced, requiring input values to match the current field's data type. If enabled, the system will attempt automatic conversion. * Type: Boolean * Possible values: true or false * Example: `true` * Note: If set to true, the system will attempt to convert input values to the correct field value type. * Usage examples: * Link field: Can directly use primary key text for linking ```json theme={null} { "User table": "John Smith" } ``` * Date field: Can use non-standard format date strings ```json theme={null} { "Date": "2023-05-15" } ``` * User field: Can directly use username ```json theme={null} { "Assigned To": "John Doe" } ``` * **order (optional)** * Description: Specifies the position of new records in a specific view * Type: Object * Properties: * viewId * Description: View ID [(how to get)](/en/api-doc/get-id#viewid) * Type: String * Example: `"viwABCDEFGHIJKLMN"` * anchorId * Description: Anchor record ID [(how to get)](/en/api-doc/get-id#recordid) * Type: String * Example: `"rec123456789ABCDE"` * position * Description: Position relative to the anchor record * Type: String * Possible values: * "before": Before the anchor record * "after": After the anchor record * Example: `"after"` * Complete example: ```json theme={null} { "viewId": "viwABCDEFGHIJKLMN", "anchorId": "rec123456789ABCDE", "position": "after" } ``` * Note: Using order allows precise control of new record positions in a specific view. ### Response #### Success Response * Status code: 201 Created * Response body: Returns the created record data. **Example Response Body** ```json theme={null} { "records": [ { "id": "record789", "fields": { "single line text": "text value 1" } }, { "id": "record567", "fields": { "single line text": "text value 2" } } ] } ``` ### Error Responses * Status code: 400 Bad Request: Request body format error or missing required fields. * Status code: 404 Not Found: Specified tableId does not exist. ### Example Code ```bash CURL theme={null} curl -X POST 'https://app.teable.ai/api/table/__tableId__/record' \ -H 'Authorization: Bearer __token__' \ -H 'Content-Type: application/json' \ -d '{ "records": [ { "fields": { "Name": "John Doe", "Age": 30 } } ] }' ``` ```js JS SDK theme={null} import { configApi, createRecords } from '@teable/openapi'; configApi({ endpoint: 'https://app.teable.ai', token, }); const response = await createRecords('__tableId__', { records: [ { fields: { Name: 'John Doe', Age: 30 } } ] }); console.log(response.data); ``` ```ts TypeScript theme={null} const response = await fetch('https://app.teable.ai/api/table/__tableId__/record', { method: 'POST', headers: { 'Authorization': 'Bearer __token__', 'Content-Type': 'application/json' }, body: JSON.stringify({ records: [ { fields: { Name: 'John Doe', Age: 30 } } ] }) }); console.log(await response.json()); ``` ```python Python theme={null} import requests response = requests.post( 'https://app.teable.ai/api/table/__tableId__/record', headers={ 'Authorization': 'Bearer __token__', 'Content-Type': 'application/json' }, json={ 'records': [ { 'fields': { 'Name': 'John Doe', 'Age': 30 } } ] } ) print(response.json()) ``` # Delete Records Source: https://help.teable.ai/en/api-doc/record/delete ### Path DELETE /api/table/\{tableId}/record ### Request **Path Parameters** * tableId (string): The unique identifier of the table [(how to get)](/en/api-doc/get-id#tableid). **Query Parameters** * **recordIds (required)** [(how to get)](/en/api-doc/get-id#recordid) * Description: Array of record IDs to delete * Type: Array * Example: `["rec123456", "rec789012"]` * Note: Each element is a string representing the ID of a record to be deleted. #### Response **Success Response** * Status code: 200 OK * Response body: No content #### Error Responses * Status code: 400 Bad Request: Request parameter format error or missing required parameters. * Status code: 404 Not Found: Specified tableId does not exist or some record IDs do not exist. #### Example Code ```bash CURL theme={null} curl -X DELETE 'https://app.teable.ai/api/table/__tableId__/record?recordIds[]=rec123456&recordIds[]=rec789012' \ -H 'Authorization: Bearer __token__' ``` ```js JS SDK theme={null} import { configApi, deleteRecords } from '@teable/openapi'; configApi({ endpoint: 'https://app.teable.ai', token: '__token__', }); await deleteRecords('__tableId__', ['rec123456', 'rec789012']); ``` ```ts TypeScript theme={null} const response = await fetch('https://app.teable.ai/api/table/__tableId__/record?recordIds[]=rec123456&recordIds[]=rec789012', { method: 'DELETE', headers: { 'Authorization': 'Bearer __token__' } }); console.log(response.status); // 200 if successful ``` ```python Python theme={null} import requests response = requests.delete( 'https://app.teable.ai/api/table/__tableId__/record', headers={ 'Authorization': 'Bearer __token__' }, params={ 'recordIds': ['rec123456', 'rec789012'] } ) print(response.status_code) # 200 if successful ``` # Get Records Source: https://help.teable.ai/en/api-doc/record/get We provide developers with a built-in [Query Parameter Builder](https://app.teable.ai/developer/tool/query-builder) that can help construct custom requests based on your existing tables. ### Path GET /api/table/\{tableId}/record ​ ### Request #### Path Parameters tableId (string): The unique identifier of the table [(how to get)](/en/api-doc/get-id#tableid). #### Basic Query Parameters All parameters are optional Specifies the view ID to fetch records from. If not specified, records will be returned in order of creation time, including all records and fields. Specifies the number of records to retrieve, maximum value is 100. To read more records, page through the data with `skip` and `take` (see [Pagination](/en/api-doc/overview)). The 100-record cap applies to Teable Cloud personal API keys created on or after September 10, 2026. Keys created before that date, OAuth and plugin tokens, and self-hosted instances still accept up to 1000, but pages of 100 remain the recommended size. Specifies the number of records to skip, used for pagination. Defines the key type for fields in records, possible values: * `name`: Use field names as keys (default) * `id`: Use field IDs as keys * `dbFieldName`: Use field dbFieldName as keys Defines the return format for cell values, possible values: * `json`: Returns structured JSON data (default) * `text`: Returns plain text format If you only need specific fields, specify them through this parameter. Otherwise, all visible fields will be retrieved. Parameter values depend on fieldKeyType setting (using field names or IDs or dbFieldName). Array of sort objects specifying how records should be ordered. Complex query condition object for filtering results. Supports complex query conditions based on fields, operators, and values. Search for records matching specified fields and values. Array of group objects specifying how records should be grouped. Array of group IDs to collapse. Filter selected records by record IDs. When viewId is specified, setting this to true will ignore the view's filters, sorting, and other settings. Filter records from the linked table that can be selected by the specified link cell. For example, for one-to-many or one-to-one relationship fields, already selected record IDs will not appear. Filter records from the linked table that are already selected by this link cell. Note: viewId, filter, and orderBy will not take effect in this case, as selected records have their own order. # Record Field Interface Source: https://help.teable.ai/en/api-doc/record/interface Lookup field is not a specific field type. We can look up any type of field from a linked base. The type of a lookup field is determined by the original field in the linked base and has the isLookup property. Lookup fields cannot be edited. All field return values may have `isMultipleCellValue: true` in certain cases: 1. This occurs when the field is a lookup field. When the linked value allows multiple selections, the lookup field value will necessarily be an array. 2. Fields can be configured - for example, user fields and link fields can be configured as single or multiple selection. In your code, you can use `field.isMultipleCellValue` to determine if a field accepts multiple values. Do not use field type to determine write permissions. Instead, use the isComputed property of the field. ### 1. Number Field * type: number * Write type: `number` * Return type: * `isMultipleCellValue: false`: `number` * `isMultipleCellValue: true`: `number[]` Example: ```js theme={null} // Write value 42 // Return value (isMultipleCellValue: false) 42 // Return value (isMultipleCellValue: true) [42, 17, 99] ``` ### 2. Single Line Text Field * type: singleLineText * Write type: `string` * Return type: * `isMultipleCellValue: false`: `string` * `isMultipleCellValue: true`: `string[]` Example: ```js theme={null} // Write value "Hello, Teable!" // Return value (isMultipleCellValue: false) "Hello, Teable!" // Return value (isMultipleCellValue: true) ["Hello, Teable!", "Welcome", "Good day"] ``` ### 3. Long Text Field * type: longText * Write type: `string` * Return type: * `isMultipleCellValue: false`: `string` * `isMultipleCellValue: true`: `string[]` Example: ```js theme={null} // Write value "This is a long text field that can contain multiple paragraphs..." // Return value (isMultipleCellValue: false) "This is a long text field that can contain multiple paragraphs..." // Return value (isMultipleCellValue: true) ["This is a long text...", "Another long text...", "Yet another long text..."] ``` ### 4. Single Select Field * type: singleSelect * Write type: `string` (option value) * Return type: * `isMultipleCellValue: false`: `string` * `isMultipleCellValue: true`: `string[]` Example: ```js theme={null} // Write value "Option A" // Return value (isMultipleCellValue: false) "Option A" // Return value (isMultipleCellValue: true) ["Option A", "Option B", "Option C"] ``` ### 5. Multiple Select Field * type: multipleSelect * Write type: `string[]` (array of option values) * Return type: `string[]` Example: ```js theme={null} // Write value ["Red", "Blue", "Green"] // Return value ["Red", "Blue", "Green"] ``` ### 6. Link Field * type: link * Write type: * `isMultipleCellValue: false`: `{ id: string }` * `isMultipleCellValue: true`: `{ id: string }[]` * Return type: * `isMultipleCellValue: false`: `{ id: string, title?: string }` * `isMultipleCellValue: true`: `{ id: string, title?: string }[]` Example: ```js theme={null} // Write value (isMultipleCellValue: false) { id: "rec123456" } // Write value (isMultipleCellValue: true) [{ id: "rec123456" }, { id: "rec789012" }] // Return value (isMultipleCellValue: false) { id: "rec123456", title: "Related Record 1" } // Return value (isMultipleCellValue: true) [ { id: "rec123456", title: "Related Record 1" }, { id: "rec789012", title: "Related Record 2" } ] ``` ### 7. Formula Field * type: formula * Write type: Cannot be written directly * Return type: Depends on formula result, can be `string | number | boolean` or their array forms Example: ```js theme={null} // Return value (isMultipleCellValue: false) 42 // or "Result" or true // Return value (isMultipleCellValue: true) [42, 17, 99] // or ["Result1", "Result2"] or [true, false, true] ``` ### 8. Attachment Field To upload an attachment to an attachment field, use the dedicated API. For details, see the [Upload Attachment](/en/api-doc/record/upload-attachment) section. * type: attachment * Write type: ```ts theme={null} { id: string; name: string; path: string; token: string; // Unique identifier size: number; // File size in bytes mimetype: string; // File type presignedUrl?: string; // File preview/download URL width?: number; // Image width height?: number; // Image height }[] ``` * Return type: ```ts theme={null} { id: string; name: string; path: string; token: string; // Unique identifier size: number; // File size in bytes mimetype: string; // File type presignedUrl?: string; // File preview/download URL width?: number; // Image width height?: number; // Image height }[] ``` Example: ```js theme={null} // Write value [ { name: "document.pdf", type: "application/pdf", token: "abc123", size: 1024000 } ] // Return value [ { id: "att123", name: "document.pdf", path: "/uploads/document.pdf", token: "abc123", size: 1024000, mimetype: "application/pdf", presignedUrl: "https://app.teable.ai/preview/document.pdf", }, { id: "att456", name: "image.jpg", path: "/uploads/image.jpg", token: "def456", size: 2048000, mimetype: "image/jpeg", presignedUrl: "https://app.teable.ai/preview/image.jpg", width: 1920, height: 1080 } ] ``` ### 9. Date Field * type: date * Write type: `string` (ISO 8601 format) * Return type: * `isMultipleCellValue: false`: `string` (ISO 8601 format) * `isMultipleCellValue: true`: `string[]` (ISO 8601 format) You can use `new Date().toISOString()` to get the ISO 8601 time format Example: ```js theme={null} // Write value "2024-09-02T02:51:03.875Z" // Return value (isMultipleCellValue: false) "2024-09-02T02:51:03.875Z" // Return value (isMultipleCellValue: true) ["2024-09-02T02:51:03.875Z", "2024-09-02T02:51:03.875Z"] ``` ### 10. Created Time Field * type: createdTime * Write type: Cannot be written directly * Return type: * `isMultipleCellValue: false`: `string` (ISO 8601 format) * `isMultipleCellValue: true`: `string[]` (ISO 8601 format) Example: ```js theme={null} // Return value (isMultipleCellValue: false) "2024-09-02T02:51:03.875Z" // Return value (isMultipleCellValue: true) ["2024-09-02T02:51:03.875Z", "2024-09-02T02:51:03.875Z"] ``` ### 11. Last Modified Time Field * type: lastModifiedTime * Write type: Cannot be written directly * Return type: * `isMultipleCellValue: false`: `string` (ISO 8601 format) * `isMultipleCellValue: true`: `string[]` (ISO 8601 format) Example: ```js theme={null} // Return value (isMultipleCellValue: false) "2023-04-15T10:30:00Z" // Return value (isMultipleCellValue: true) ["2023-04-15T10:30:00Z", "2023-04-16T14:45:00Z"] ``` ### 12. Checkbox Field * type: checkbox * Write type: `boolean` * Return type: * `isMultipleCellValue: false`: `boolean` * `isMultipleCellValue: true`: `boolean[]` Example: ```js theme={null} // Write value true // Return value (isMultipleCellValue: false) true // Return value (isMultipleCellValue: true) [true, false, true] ``` ### 13. Rollup Field * type: rollup * Write type: Cannot be written directly * Return type: Depends on rollup configuration, can be `number | string` or their array forms Example: ```js theme={null} // Return value (isMultipleCellValue: false) 42 // or "Summary Result" // Return value (isMultipleCellValue: true) [42, 17, 99] // or ["Summary 1", "Summary 2"] ``` ### 14. Rating Field * type: rating * Write type: `number` * Return type: * `isMultipleCellValue: false`: `number` * `isMultipleCellValue: true`: `number[]` Example: ```js theme={null} // Write value 4 // Return value (isMultipleCellValue: false) 4 // Return value (isMultipleCellValue: true) [4, 3, 5] ``` ### 15. Auto Number Field * type: autoNumber * Write type: Cannot be written directly * Return type: * `isMultipleCellValue: false`: `number` * `isMultipleCellValue: true`: `number[]` Example: ```js theme={null} // Return value (isMultipleCellValue: false) 42 // Return value (isMultipleCellValue: true) [42, 43, 44] ``` ### 16. User Field * type: user * Write type: * `isMultipleCellValue: false`: `{ id: string, title: string }` * `isMultipleCellValue: true`: `{ id: string, title: string }[]` * Return type: * `isMultipleCellValue: false`: `{ id: string, title: string, email?: string, avatar?: string }` * `isMultipleCellValue: true`: `{ id: string, title: string, email?: string, avatar?: string }[]` Example: ```js theme={null} // Write value (isMultipleCellValue: false) { id: "user123", title: "John Doe" } // Write value (isMultipleCellValue: true) [ { id: "user123", title: "John Doe" }, { id: "user456", title: "Jane Smith" } ] // Return value (isMultipleCellValue: false) { id: "user123", title: "John Doe", email: "john@example.com", avatar: "https://example.com/avatar.jpg" } // Return value (isMultipleCellValue: true) [ { id: "user123", title: "John Doe", email: "john@example.com", avatar: "https://example.com/avatar1.jpg" }, { id: "user456", title: "Jane Smith", email: "jane@example.com", avatar: "https://example.com/avatar2.jpg" } ] ``` ### 17. Created By Field * Write type: Cannot be written directly * Return type: * `isMultipleCellValue: false`: `{ id: string, title: string, email?: string, avatar?: string }` * `isMultipleCellValue: true`: `{ id: string, title: string, email?: string, avatar?: string }[]` Example: ```js theme={null} // Return value (isMultipleCellValue: false) { id: "user123", title: "John Doe", email: "john@example.com", avatar: "https://example.com/avatar.jpg" } // Return value (isMultipleCellValue: true) [ { id: "user123", title: "John Doe", email: "john@example.com", avatar: "https://example.com/avatar1.jpg" }, { id: "user456", title: "Jane Smith", email: "jane@example.com", avatar: "https://example.com/avatar2.jpg" } ] ``` ### 18. Last Modified By Field * Write type: Cannot be written directly * Return type: * `isMultipleCellValue: false`: `{ id: string, title: string, email?: string, avatar?: string }` * `isMultipleCellValue: true`: `{ id: string, title: string, email?: string, avatar?: string }[]` Example: ```js theme={null} // Return value (isMultipleCellValue: false) { id: "user123", title: "John Doe", email: "john@example.com", avatar: "https://example.com/avatar.jpg" } // Return value (isMultipleCellValue: true) [ { id: "user123", title: "John Doe", email: "john@example.com", avatar: "https://example.com/avatar1.jpg" }, { id: "user456", title: "Jane Smith", email: "jane@example.com", avatar: "https://example.com/avatar2.jpg" } ] ``` # Update Record Source: https://help.teable.ai/en/api-doc/record/update ### Path PATCH /api/table/\{tableId}/record/\{recordId} ### Request #### Path Parameters * tableId (string): The unique identifier of the table [(how to get)](/en/api-doc/get-id#tableid). * recordId (string): The unique identifier of the record to update [(how to get)](/en/api-doc/get-id#recordid). #### Request Body * **record (required)** * Description: The record data to update * Type: Object * Example: ```json theme={null} { "fields": { "Name": "John Doe", "Age": 31, "Email": "john.doe@example.com" } } ``` * Note: The `fields` object contains field names and their corresponding new values. Each field type has a different value structure, see [Record Field Value Types](/en/api-doc/record/interface) for details. To clear a field's value, explicitly pass `null`. If a field name is not included, no update will be performed for that field. * **fieldKeyType (optional)** * Description: Specifies the type of field key * Type: String * Possible values: * "name": Use field name as key * "id": Use field ID as key * "dbFieldName": Use field dbFieldName as key * Example: `"name"` or `"id"` or `"dbFieldName"` * Note: If not specified, field name is used as key by default. * Usage: * When set to "name": ```json theme={null} { "fields": { "Name": "John Doe", "Age": 30 } } ``` * When set to "id": ```json theme={null} { "fields": { "fldABCDEFGHIJKLMN": "John Doe", "fldOPQRSTUVWXYZ12": 30 } } ``` * **typecast (optional)** * Description: Whether to automatically convert field value types. By default, strict validation is enforced, requiring input values to match the current field's data type. If enabled, the system will attempt automatic conversion. * Type: Boolean * Possible values: true or false * Example: `true` * Note: If set to true, the system will attempt to convert input values to the correct field value type. * Usage examples: * Link field: Can directly use primary key text for linking ```json theme={null} { "User table": "John Smith" } ``` * Date field: Can use non-standard format date strings ```json theme={null} { "Date": "2023-05-15" } ``` * User field: Can directly use username ```json theme={null} { "Assigned To": "John Doe" } ``` For uploading new files to attachment fields, please refer to the [Upload Attachment](/en/api-doc/record/upload-attachment) section. * **order (optional)** * Description: After updating the record, move it to a specified position in a specified view. * Type: Object * Properties: * viewId: View ID * anchorId: Anchor record ID * position: Position relative to the anchor record. Possible values: `"before"` or `"after"` * Example: ```json theme={null} { "viewId": "viwABCDEFGHIJKLMN", "anchorId": "rec123456789ABCDE", "position": "after" } ``` ### Response #### Success Response * Status code: 200 OK * Response body: Returns the updated record data. **Example Response Body** ```json theme={null} { "id": "rec123456789ABCDE", "fields": { "Name": "John Doe", "Age": 31, "Email": "john.doe@example.com" } } ``` #### Error Responses * Status code: 400 Bad Request: Request body format error or missing required fields. * Status code: 404 Not Found: Specified tableId or recordId does not exist. #### Example Code ```bash CURL theme={null} curl -X PATCH 'https://app.teable.ai/api/table/__tableId__/record/__recordId__' \ -H 'Authorization: Bearer __token__' \ -H 'Content-Type: application/json' \ -d '{ "record": { "fields": { "Name": "John Doe", "Age": 31 } } }' ``` ```js JS SDK theme={null} import { configApi, updateRecord } from '@teable/openapi'; configApi({ endpoint: 'https://app.teable.ai', token, }); const response = await updateRecord('__tableId__', '__recordId__', { record: { fields: { Name: 'John Doe', Age: 31 } } }); console.log(response.data); ``` ```ts TypeScript theme={null} const response = await fetch('https://app.teable.ai/api/table/__tableId__/record/__recordId__', { method: 'PATCH', headers: { 'Authorization': 'Bearer __token__', 'Content-Type': 'application/json' }, body: JSON.stringify({ record: { fields: { Name: 'John Doe', Age: 31 } } }) }); console.log(await response.json()); ``` ```python Python theme={null} import requests response = requests.patch( 'https://app.teable.ai/api/table/__tableId__/record/__recordId__', headers={ 'Authorization': 'Bearer __token__', 'Content-Type': 'application/json' }, json={ 'record': { 'fields': { 'Name': 'John Doe', 'Age': 31 } } } ) print(response.json()) ``` # Upload Attachment Source: https://help.teable.ai/en/api-doc/record/upload-attachment Upload local files or files via URL to the end of an attachment field in a specified record ### Path POST /api/table/\{tableId}/record/\{recordId}/\{fieldId}/uploadAttachment ### Request #### Path Parameters * tableId (string): The unique identifier of the table [(how to get)](/en/api-doc/get-id#tableid). * recordId (string): The unique identifier of the record to update [(how to get)](/en/api-doc/get-id#recordid). * fieldId (string): The ID of the attachment field to upload to [(how to get)](/en/api-doc/get-id#fieldid) Attachment fields can contain multiple attachments. This API allows uploading one attachment at a time to the end of the cell. To delete or reorder attachments, use the [Update Record API](/en/api-doc/record/update). fieldId must be an attachment type field. Through the API, uploaded attachments are limited to 100MB in the cloud version, with no limit in the self-hosted version. #### Request Body Type: formData Parameters: * **file (optional)** * Description: The record data to update * Type: Buffer or ReadStream * **fileUrl (optional)** * Description: The URL to upload from * Type: String * Example: `https://example.com/image.jpg` * Note: Only one of file or fileUrl can be specified at a time. If both are specified, file takes precedence. ### Response #### Success Response * Status code: 201 Created * Response body: Returns the updated record data. **Example Response Body** ```json theme={null} { "id": "rec123456789ABCDE", "fields": { "fld123456789ABCDE": [ { "id": "act75TiSyhcS7hfrizW", "name": "example.jpg", "path": "table/example", "size": 392903, "token": "tokenxxxxx", "width": 976, "height": 1000, "mimetype": "image/jpeg", "presignedUrl": "https://app.teable.ai/preview/previewURL" } ], } } ``` #### Error Responses * Status code: 400 Bad Request: Request body format error or missing required fields. * Status code: 404 Not Found: Specified tableId or recordId does not exist. ### Example Code ```bash CURL theme={null} # Upload via file curl -X POST 'https://app.teable.ai/api/table/__tableId__/record/__recordId__/__fieldId__/uploadAttachment' \ -H 'Authorization: Bearer __token__' \ -H 'Content-Type: multipart/form-data' \ -F 'file=@/path/to/your/file.jpg' # Upload via URL curl -X POST 'https://app.teable.ai/api/table/__tableId__/record/__recordId__/__fieldId__/uploadAttachment' \ -H 'Authorization: Bearer __token__' \ -H 'Content-Type: multipart/form-data' \ -F 'fileUrl=https://example.com/image.jpg' ``` ```js JS SDK theme={null} import { configApi, uploadAttachment } from '@teable/openapi'; configApi({ endpoint: 'https://app.teable.ai', token: '__token__', }); // Node.js environment: Upload local file const fileStream = fs.createReadStream('/path/to/your/file.jpg'); const response = await uploadAttachment('__tableId__', '__recordId__', '__fieldId__', fileStream); console.log(response.data); // Upload URL (works in both Node.js and browser environments) const response = await uploadAttachment('__tableId__', '__recordId__', '__fieldId__', 'https://example.com/image.jpg'); console.log(response.data); // Browser environment: Upload file // Assuming there's a file input element: document.getElementById('fileInput').addEventListener('change', async (event) => { const file = event.target.files[0]; if (file) { const response = await uploadAttachment('__tableId__', '__recordId__', '__fieldId__', file); console.log(response.data); } }); ``` ```ts TypeScript theme={null} import FormData from 'form-data'; import fs from 'fs'; // Node.js environment: Upload local file const formData = new FormData(); formData.append('file', fs.createReadStream('/path/to/your/file.jpg')); const response = await fetch('https://app.teable.ai/api/table/__tableId__/record/__recordId__/__fieldId__/uploadAttachment', { method: 'POST', headers: { 'Authorization': 'Bearer __token__', ...formData.getHeaders() }, body: formData }); console.log(await response.json()); // Upload URL (works in both Node.js and browser environments) const formDataUrl = new FormData(); formDataUrl.append('fileUrl', 'https://example.com/image.jpg'); const responseUrl = await fetch('https://app.teable.ai/api/table/__tableId__/record/__recordId__/__fieldId__/uploadAttachment', { method: 'POST', headers: { 'Authorization': 'Bearer __token__', ...formDataUrl.getHeaders() }, body: formDataUrl }); console.log(await responseUrl.json()); // Browser environment: Upload file // Assuming there's a file input element: document.getElementById('fileInput').addEventListener('change', async (event: Event) => { const fileInput = event.target as HTMLInputElement; const file = fileInput.files?.[0]; if (file) { const formData = new FormData(); formData.append('file', file); const response = await fetch('https://app.teable.ai/api/table/__tableId__/record/__recordId__/__fieldId__/uploadAttachment', { method: 'POST', headers: { 'Authorization': 'Bearer __token__' }, body: formData }); console.log(await response.json()); } }); ``` ```python Python theme={null} import requests import mimetypes import os # Upload local file file_path = '/path/to/your/file.jpg' with open(file_path, 'rb') as file: file_name = os.path.basename(file_path) mime_type, _ = mimetypes.guess_type(file_path) files = {'file': (file_name, file, mime_type)} response = requests.post( 'https://app.teable.ai/api/table/__tableId__/record/__recordId__/__fieldId__/uploadAttachment', headers={ 'Authorization': 'Bearer __token__' }, files=files ) print(response.json()) # Upload URL response_url = requests.post( 'https://app.teable.ai/api/table/__tableId__/record/__recordId__/__fieldId__/uploadAttachment', headers={ 'Authorization': 'Bearer __token__' }, data={'fileUrl': 'https://example.com/image.jpg'} ) print(response_url.json()) ``` # Access Token Source: https://help.teable.ai/en/api-doc/token Personal access tokens are used for authentication and authorization. Personal Access Tokens are best for scripts, internal tools, and server-side integrations. If you're building a multi-tenant integration for external users, use OAuth instead: see [OAuth App](/en/api-doc/oauth). ## Create a token 1. Go to the [Token Management Page](https://app.teable.ai/setting/personal-access-token) and click the "Create Token" button to create a new personal access token. 2. Choose an expiration period for your token. Note that this period cannot be modified once set. 3. Add appropriate permission scopes to your token. 4. Specify which bases and spaces the token can access. Once your token is created, it will only be displayed once. We recommend copying and storing it in a secure location. ## Use the token Send the token in the `Authorization` header: ```bash theme={null} curl -H 'Authorization: Bearer __token__' \ 'https://app.teable.ai/api/table/__tableId__/record' ``` Need help finding IDs like `tbl...`? See [Getting IDs](/en/api-doc/get-id). # Post base Source: https://help.teable.ai/en/api-reference/base/post-base /swagger.json post /base Create a base # Auto-fill a cell by AI Source: https://help.teable.ai/en/api-reference/record/auto-fill-a-cell-by-ai /swagger.json post /table/{tableId}/record/{recordId}/{fieldId}/auto-fill Automatically fill a cell in a specific record and field # Button click Source: https://help.teable.ai/en/api-reference/record/button-click /swagger.json post /table/{tableId}/record/{recordId}/{fieldId}/button-click Button click # Button reset Source: https://help.teable.ai/en/api-reference/record/button-reset /swagger.json post /table/{tableId}/record/{recordId}/{fieldId}/button-reset Button reset # Create records Source: https://help.teable.ai/en/api-reference/record/create-records /swagger.json post /table/{tableId}/record Create one or multiple records with support for field value typecast and custom record ordering. # Delete record Source: https://help.teable.ai/en/api-reference/record/delete-record /swagger.json delete /table/{tableId}/record/{recordId} Permanently delete a single record by its ID. # Delete records Source: https://help.teable.ai/en/api-reference/record/delete-records /swagger.json delete /table/{tableId}/record Permanently delete multiple records by their IDs in a single request. # Duplicate record Source: https://help.teable.ai/en/api-reference/record/duplicate-record /swagger.json post /table/{tableId}/record/{recordId}/duplicate Create a copy of an existing record with optional custom positioning in the view. # Get record Source: https://help.teable.ai/en/api-reference/record/get-record /swagger.json get /table/{tableId}/record/{recordId} Retrieve a single record by its ID with options to specify field projections and output format. # Get record history Source: https://help.teable.ai/en/api-reference/record/get-record-history /swagger.json get /table/{tableId}/record/{recordId}/history Retrieve the change history of a specific record, including field modifications and user information. # Get record status Source: https://help.teable.ai/en/api-reference/record/get-record-status /swagger.json get /table/{tableId}/record/{recordId}/status Retrieve the visibility and deletion status of a specific record. # Get table recordcollaborators Source: https://help.teable.ai/en/api-reference/record/get-table-recordcollaborators /swagger.json get /table/{tableId}/record/collaborators Get collaborators of a record. # Get table records history Source: https://help.teable.ai/en/api-reference/record/get-table-records-history /swagger.json get /table/{tableId}/record/history Retrieve the change history of all records in a table, including field modifications and user information. # Insert attachments at anchor Source: https://help.teable.ai/en/api-reference/record/insert-attachments-at-anchor /swagger.json post /table/{tableId}/record/{recordId}/{fieldId}/insertAttachment Insert attachments after the anchor in the cell (append to end if anchor not found or not provided) # List records Source: https://help.teable.ai/en/api-reference/record/list-records /swagger.json get /table/{tableId}/record Retrieve a list of records with support for filtering, sorting, grouping, and pagination. The response includes record data and optional group information. # Post table undo redoredo Source: https://help.teable.ai/en/api-reference/record/post-table-undo-redoredo /swagger.json post /table/{tableId}/undo-redo/redo Redo the last operation # Post table undo redoundo Source: https://help.teable.ai/en/api-reference/record/post-table-undo-redoundo /swagger.json post /table/{tableId}/undo-redo/undo Undo the last operation # Submit form Source: https://help.teable.ai/en/api-reference/record/submit-form /swagger.json post /table/{tableId}/record/form-submit Submit a record through a form view. This will trigger "When form submitted" automations. # Update multiple records Source: https://help.teable.ai/en/api-reference/record/update-multiple-records /swagger.json patch /table/{tableId}/record Update multiple records in a single request with support for field value typecast and record reordering. # Update record Source: https://help.teable.ai/en/api-reference/record/update-record /swagger.json patch /table/{tableId}/record/{recordId} Update a single record by its ID with support for field value typecast and record reordering. # Upload attachment Source: https://help.teable.ai/en/api-reference/record/upload-attachment /swagger.json post /table/{tableId}/record/{recordId}/{fieldId}/uploadAttachment Upload an attachment from a file or URL and append it to the cell # Delete space Source: https://help.teable.ai/en/api-reference/space/delete-space /swagger.json delete /space/{spaceId} Delete a space by spaceId # Delete space authentication Source: https://help.teable.ai/en/api-reference/space/delete-space-authentication /swagger.json delete /space/{spaceId}/authentication/{id} Delete a space authentication # Delete space collaborators Source: https://help.teable.ai/en/api-reference/space/delete-space-collaborators /swagger.json delete /space/{spaceId}/collaborators Delete a collaborator # Delete space domain verification Source: https://help.teable.ai/en/api-reference/space/delete-space-domain-verification /swagger.json delete /space/{spaceId}/domain-verification Delete a space domain verification # Delete space integration Source: https://help.teable.ai/en/api-reference/space/delete-space-integration /swagger.json delete /space/{spaceId}/integration/{integrationId} Delete a integration by integrationId # Delete space invitationlink Source: https://help.teable.ai/en/api-reference/space/delete-space-invitationlink /swagger.json delete /space/{spaceId}/invitation/link/{invitationId} Delete a invitation link to your # Delete space permanent Source: https://help.teable.ai/en/api-reference/space/delete-space-permanent /swagger.json delete /space/{spaceId}/permanent Permanently delete a space by spaceId # Get space Source: https://help.teable.ai/en/api-reference/space/get-space /swagger.json get /space/{spaceId} Get a space by spaceId # Get space authentication Source: https://help.teable.ai/en/api-reference/space/get-space-authentication /swagger.json get /space/{spaceId}/authentication/{id} Get a space authentication # Get space authentication 1 Source: https://help.teable.ai/en/api-reference/space/get-space-authentication-1 /swagger.json get /space/{spaceId}/authentication Get a space authentication list # Get space collaborators Source: https://help.teable.ai/en/api-reference/space/get-space-collaborators /swagger.json get /space/{spaceId}/collaborators List a space collaborator # Get space domain verification Source: https://help.teable.ai/en/api-reference/space/get-space-domain-verification /swagger.json get /space/{spaceId}/domain-verification Get a space domain verification list # Get space integration Source: https://help.teable.ai/en/api-reference/space/get-space-integration /swagger.json get /space/{spaceId}/integration Get integration list by query # Get space invitationlink Source: https://help.teable.ai/en/api-reference/space/get-space-invitationlink /swagger.json get /space/{spaceId}/invitation/link List a invitation link to your # Get space list Source: https://help.teable.ai/en/api-reference/space/get-space-list /swagger.json get /space Get space list by query # Get space search Source: https://help.teable.ai/en/api-reference/space/get-space-search /swagger.json get /space/{spaceId}/search Search bases and nodes within a space # Get spaceauthenticationproviders Source: https://help.teable.ai/en/api-reference/space/get-spaceauthenticationproviders /swagger.json get /space/authentication/providers Get space authentication providers # Patch space Source: https://help.teable.ai/en/api-reference/space/patch-space /swagger.json patch /space/{spaceId} Update a space info # Patch space collaborators Source: https://help.teable.ai/en/api-reference/space/patch-space-collaborators /swagger.json patch /space/{spaceId}/collaborators Update a space collaborator # Patch space integration Source: https://help.teable.ai/en/api-reference/space/patch-space-integration /swagger.json patch /space/{spaceId}/integration/{integrationId} Update a integration to a space # Patch space invitationlink Source: https://help.teable.ai/en/api-reference/space/patch-space-invitationlink /swagger.json patch /space/{spaceId}/invitation/link/{invitationId} Update a invitation link to your # Post space Source: https://help.teable.ai/en/api-reference/space/post-space /swagger.json post /space Create a space # Post space authentication Source: https://help.teable.ai/en/api-reference/space/post-space-authentication /swagger.json post /space/{spaceId}/authentication Create a space authentication # Post space collaborator Source: https://help.teable.ai/en/api-reference/space/post-space-collaborator /swagger.json post /space/{spaceId}/collaborator Add a collaborator to a space # Post space domain verification Source: https://help.teable.ai/en/api-reference/space/post-space-domain-verification /swagger.json post /space/{spaceId}/domain-verification Create a space domain verification # Post space domain verificationsend verification email Source: https://help.teable.ai/en/api-reference/space/post-space-domain-verificationsend-verification-email /swagger.json post /space/{spaceId}/domain-verification/send-verification-email Send space email verification # Post space integration Source: https://help.teable.ai/en/api-reference/space/post-space-integration /swagger.json post /space/{spaceId}/integration Create a integration to a space # Post space invitationemail Source: https://help.teable.ai/en/api-reference/space/post-space-invitationemail /swagger.json post /space/{spaceId}/invitation/email Send invitations by e-mail # Post space invitationlink Source: https://help.teable.ai/en/api-reference/space/post-space-invitationlink /swagger.json post /space/{spaceId}/invitation/link Create a invitation link to your # Post trashrestore Source: https://help.teable.ai/en/api-reference/space/post-trashrestore /swagger.json post /trash/restore/{trashId} restore a space, base, table, etc. # Put space authentication Source: https://help.teable.ai/en/api-reference/space/put-space-authentication /swagger.json put /space/{spaceId}/authentication/{id} Update a space authentication # Delete trash Source: https://help.teable.ai/en/api-reference/trash/delete-trash /swagger.json delete /trash/{trashId} Permanently delete a trash item by trashId # Get trash Source: https://help.teable.ai/en/api-reference/trash/get-trash /swagger.json get /trash Get trash list for spaces or bases # Get trashitems Source: https://help.teable.ai/en/api-reference/trash/get-trashitems /swagger.json get /trash/items Get trash items for base or table # AI Generation Queue Source: https://help.teable.ai/en/basic/admin-panel/ai-generation-queue Review AI field generation status in the current self-hosted instance. Available for self-hosted Business plan and above Path: Admin Panel → AI generation queue Use **AI generation queue** to check whether AI field generation is moving normally in the current self-hosted instance. ## Read the Health Status **Watchdog** is the automatic recovery check that identifies stalled generations and handles work that can be recovered. The status beside the page title summarizes the current queue: | Status | Meaning | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- | | **Healthy** | AI generation is running normally. | | **Degraded** | Teable found stalled work, an aging backlog, a high recent failure rate, a mismatch in processing capacity, orphaned work, or a disabled Watchdog. | The summary cards show: | Card | What it shows | | ---------------------- | ---------------------------------------------------------------- | | **Waiting to enqueue** | Generations that have not entered the queue and the longest wait | | **In queue** | Generations that are queued or processing | | **Last hour** | Recent successes, failures, and failure rate | | **Watchdog** | When the recovery scan last ran and what it handled | ## Review Spaces and Tasks The **Spaces** table ranks spaces with unfinished AI generation work. Click **View tasks** to review progress or cancel a task. Only tasks with unfinished generations appear here. Use **Audit log** to review completed work. ## Handle Stalled Generations When Teable finds generations without recent progress, the **Stalled generations** section shows how long they have been stalled and whether their queue job is still active. A slow but active job is left running. Recovery for a job that is gone or no longer active is handled by the Watchdog. ## Cancel a Task In a space's task list, click **Cancel task** to stop the task and all unfinished generations. # AI Settings Source: https://help.teable.ai/en/basic/admin-panel/ai-setting Configure AI Chat, AI fields, AI automation, and App Builder for a self-hosted instance. Available for self-hosted Business plan and above Path: Admin Panel → AI Settings The **AI Settings** page is used to configure **AI Chat**, **AI fields**, **AI automation**, and **App Builder**. The **Pending configuration** panel on the right shows which required items are still missing. ## Before you start Before you open the AI Settings page, make sure the following items are ready. | Requirement | Required? | Notes | | ----------------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | **Agent Runtime setup** | Required for AI Chat and App Builder | Used by AI Chat and App Builder | | **Custom provider** | Required when AI Chat or App Builder uses your own key (BYOK) | Use an **OpenAI Compatible** or **Anthropic** provider | | **OpenAI API Key** | Optional | Only needed if you want to enable **Voice input** in AI Chat | | **Public access** | Required when the **Vercel** deployment engine is selected | Your **Teable instance** and **object storage (MinIO / S3)** must be publicly accessible to Vercel | ## Setup steps Start with the AI Chat runtime, app deployment, and model setup: Choose a [deployment option](/en/deploy/choose) and complete the deployment, then click **Run test** and **Test Connection**. Set up your model connection and complete the initial test. Choose the recommended models for AI fields and AI automation. Choose the default model for AI Chat. ### Configure the runtime Click **Run test** to verify the AI Chat runtime. ### Configure LLM API In **LLM API**, add a model provider and test its models. If you use your own key (BYOK), choose **OpenAI Compatible** or **Anthropic** as the provider type. Open **Model Settings** for a model when you need to review or override these values: | Setting | Effect | | -------------- | ------------------------------------------------------------------------- | | **Context** | Optional. Sets the maximum input tokens used for context compaction. | | **Max output** | Optional. Sets the maximum tokens the model can generate in one response. | ### Configure Recommended Models Choose the recommended models users can select in **AI fields** and **AI automation**. ### Set chat model Choose the default model for sidebar **AI Chat**. The chat model must come from the recommended model list. ### Enable AI features In **AI Capabilities**, enable **AI Field** and **AI Chat** as needed. Configure the runtime before using **AI Chat**. ### Configure App Builder In **Deployment Engine**, choose how apps are deployed: | Deployment engine | Setup requirements | | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Vercel** | Enter a Vercel access token, click **Test Connection**, and use **Test Public Access** to confirm that Vercel can reach your Teable instance and object storage. | | **Teable Infra** | Uses the configured Teable Infra container runtime. No additional credentials or public access test is required here. | You can add these optional App Builder settings when needed: | Optional item | When you need it | | ----------------- | ------------------------------------------------------------ | | **Custom domain** | When you want to publish apps under your own domain | | **App Auth** | When generated apps need **Email OTP** or **Google** sign-in | In **App Auth**, you can configure sign-in providers for generated apps: * **Email OTP** uses an independent SMTP mailbox for app login verification emails. * **Google OAuth** requires a Client ID and Client Secret. Add the redirect URI shown on this page to the authorized redirect URI list in Google Cloud Console. **Teable** sign-in is available by default. **Email OTP** appears in App Builder only after the SMTP settings are complete, and **Google** appears only after both OAuth credentials are configured. **Auto-inject AI API Key into apps** is on by default, so apps can call the platform's AI models. Turn it off and apps can no longer reach them. ### Optional. Configure Voice input To use voice input in AI Chat, enable the feature and enter an **OpenAI API Key**. Configure the **Transcription Endpoint** only when using a custom transcription service. You can also limit the recording length and requests per minute. ### Verify the setup After the setup is done, first confirm that all required items in the **Pending configuration** panel are green. Then test **AI Chat**, **AI fields**, **AI automation**, and **App Builder** one by one. ## FAQ Check the account or provider used by your configured model service. Top up or change the model configuration if needed. # Announcements Source: https://help.teable.ai/en/basic/admin-panel/announcements Publish in-app announcements to everyone, to selected spaces, or to selected users, and withdraw them when they no longer apply. Available for self-hosted Business plan and above Path: Admin Panel → Announcements **Announcements** lets administrators put a message in front of signed-in users without sending email: planned maintenance, an incident and its resolution, a policy change, or a new feature you want people to find. Each announcement runs inside a scheduled window and can be aimed at the whole instance or at a specific group. ## Publish an Announcement Click **Publish announcement** and fill in the form. The preview on the side shows the announcement as users will see it. | Setting | What it controls | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Form** | Where the announcement appears: **Banner** across the top of the app, **Toast** as a transient notification, **Modal** as a dialog that interrupts, or **Sidebar card** in the space and base sidebars. | | **Level** | The tone users see: **Info**, **Maintenance**, **Critical**, or **Resolved**. | | Title and **Body** | The announcement text. | | **Starts at** / **Ends at** | The window during which the announcement is delivered. The end time must be after the start time. | | **Link text** / **Link URL** | An optional destination. A sidebar card is itself a link, so it always offers the URL field; the other forms show it once the body uses the `{link}` placeholder. | | **Audience** | **Everyone**, **Specific spaces**, or **Specific users**. | Choose the strongest form the message deserves. A banner and a sidebar card sit alongside the user's work; a modal blocks it. Users can dismiss an announcement themselves, and when several are active at once, banners collapse behind a **N more announcements** toggle. ### Target Specific Spaces or Users For **Specific spaces** or **Specific users**, paste identifiers into the audience box (space IDs or names, or user IDs, names, or emails, separated by commas), then click **Match**. Matched entries become chips, and anything Teable could not resolve stays in the box under **Not matched:** so you can correct and retry. Space membership is evaluated when the announcement is delivered, so collaborators added later still receive a space-targeted announcement. ### Insert Live Values Use **Insert placeholder** in the body to add values that Teable fills in at display time, so one message stays accurate for every reader: | Placeholder | Renders as | | --------------------------- | ----------------------------------------------------------------- | | `{startTime}` / `{endTime}` | The window's start or end, in the reader's language and time zone | | `{time:…}` | A specific instant you choose | | `{duration}` | How long the window lasts | | `{countdown}` | A live countdown to the start | | `{link}` | The link, shown with your **Link text** | `{link}` is unavailable for the sidebar card, because the whole card is already the link. ### Translate the Content Write the announcement in one language, then use **AI translate** to fill the other shipped interface languages. Choose **Fill blanks only** to keep translations you already wrote, or **Overwrite all** to re-translate everything. Review each language tab afterwards: the translation is a draft, not a final proofread. Readers see the language that matches their interface, falling back to English. ## Manage Published Announcements The list shows every announcement with its **Status**, **Title**, **Form**, **Level**, **Audience**, **Window**, and **Created by**. Open a row to inspect its full content. | Status | Meaning | | ------------- | ----------------------------------- | | **Scheduled** | The start time has not arrived yet. | | **Active** | Currently being delivered. | | **Expired** | The end time has passed. | | **Withdrawn** | Stopped early by an administrator. | Click **Withdraw** on an active announcement to stop delivering it immediately. An announcement that has already expired cannot be withdrawn, and its record stays as it was. # Audit log Source: https://help.teable.ai/en/basic/admin-panel/audit-log Review instance-wide activity, filter operation history, and inspect audit log details in the Admin Panel. Available for self-hosted Business plan and above Path: Admin Panel → Audit log **Audit log** lets administrators review activity across the instance and trace who performed an operation, when it happened, and what area it affected. ## What You Can Review The audit log covers common administration and collaboration activity, including spaces, bases, tables, views, fields, records, sharing, invitations, access tokens, and the Authority Matrix. Each log entry shows the operation time, operator, action type, related base or space, and request source. Open a log entry to view its details. ## Act on an Operator Open a log entry and use **Operator actions** beside the operator to handle that account without leaving the page. Each action asks for confirmation first. | Action | What it does | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | **Deactivate user** | Blocks the account from reaching this instance. Not offered for your own account, for instance administrators, or for deleted users. | | **Reactivate user** | Restores access for a deactivated account. The user can work again right away, without signing in again or replacing any credential. | ## Filter Logs Use the filters at the top of the page to narrow the log list: * **Select Operator**: Show actions performed by a specific user. * **Select Space**: Show activity within a specific space. * **Select Base**: Show activity for a specific base. * **Select Action**: Filter by operation type, such as records, fields, views, tables, bases, sharing, Authority Matrix, Authority Matrix roles, spaces, invitations, users, and access tokens. If a user, base, or space has been deleted, the entry remains in the log and the resource is marked as deleted. ## Browse Large Log Lists The grouped audit log shows 50 entries per page. Use **Previous** and **Next** at the bottom of the list to move through results, both in the grouped list and after you open a grouped entry to view the events inside that operation. ## Notes * Only instance administrators can access the Admin Panel. # Automation management Source: https://help.teable.ai/en/basic/admin-panel/automation-management View automation run status, success rate, and run history in the Admin Panel. Available for self-hosted Business plan and above Path: Admin Panel → Automation management **Automation management** is used to view automation run status across the instance. ## Summary Metrics The top of the page shows the overall status for the selected time range: | Metric | Description | | --------------------------- | ----------------------------------------------------------------------------- | | **Active workflows** | Number of automations that are currently active | | **Total runs** | Total runs in the selected time range | | **Success rate** | Percentage of successful runs among all runs | | **Failed runs** | Number of failed runs in the selected time range | | **Health overview** | Automation health grouped by healthy, warning, and critical states | | **Run status distribution** | Run distribution by successful, failed, running, pending, and canceled states | ## Filters The main page supports filters: * **Date range**: Last 30 minutes, 1 hour, 6 hours, 1 day, 3 days, 7 days, or 30 days. * **Trigger**: Filter automations by trigger type. ## Automation List The list shows a run summary for each automation: * Last run * Total runs * Average duration * Current health status * Whether attention is required If an automation is inactive, the list shows **Inactive**. ## Run History Open an automation to view **Run history**: | Field | Description | | -------------- | -------------------------------------------------------------------- | | **Status** | Whether the run is successful, failed, running, pending, or canceled | | **Start time** | When the run started | | **Duration** | How long the run took | | **Error** | Error information shown for failed runs | Run history can be filtered by successful, failed, running, pending, or canceled status. ## Actions From the automation list, you can: * **Deactivate**: Stop the automation from being triggered. * **Mark for deletion**: Mark the automation for deletion. # Computed Outbox Source: https://help.teable.ai/en/basic/admin-panel/computed-outbox Monitor BullMQ delivery and computed task backlog in the Admin Panel. Available for self-hosted Business plan and above Path: Admin Panel → Computed Outbox Use **Computed Outbox** when formula, lookup, or other computed field values stop updating or take much longer than expected. The page shows the overall task health, the jobs moving through the queue, tasks that may need recovery, and any space whose computed tasks are currently paused. ## Read the Health Status The status beside the page title shows whether computed tasks need attention: | Status | Meaning | | ------------ | ----------------------------------------------------------------- | | **Healthy** | Computed tasks are running normally. | | **Degraded** | Teable found failures, timed-out tasks, or a growing backlog. | | **Critical** | BullMQ is unavailable or no worker is available to process tasks. | When the status needs attention, the page lists the reason. ## Find a Task in the Queue **Live BullMQ queue** lists the jobs Teable still retains, so you can follow one computed task or look for slow ones. Each row is one task by default, and it moves through states in place as Teable retries it. Switch to **Deliveries** when you need the full attempt history of a task or want to hunt for slow runs. To narrow the list: * Click the state tiles above the table to filter by state: **Waiting**, **Active**, **Delayed**, **Failed**, **Completed (retained)**, and so on. You can select several at once, and hovering a tile explains what that state means. * Filter by **Space**, **Base**, **Cause**, or **Outcome**, search for a task, Base, Space, or error, or set a minimum processing time to surface slow tasks. * Click a row to open **Computed lineage**: queue timestamps, delivery lag, processing time, the full failure reason with the redacted SQL for a failed delivery, and the propagation detail described below. **Completed** does not mean the task did work. The outcome badge says what the delivery actually did: **Processed** ran the task, **No-op** found nothing left to do, **Deferred** rescheduled it for later, and **Parked** means its scope is paused. The **Outcome** filter narrows the list by that result and shows how many deliveries each one covers, so pairing **Completed (retained)** with **Processed** leaves only the deliveries that really ran the task. A failed row is the history of one delivery attempt, not a stuck task. The durable task keeps retrying on its own, so read the **Ledger state** column to decide whether to act: **Settled** means a later retry already succeeded, and **Dead letter** links to anomaly maintenance. Settled failures are hidden by default; a banner shows how many there are and lets you reveal them. **Clear failed history** removes the retained failed-job records from the queue only. It repairs nothing, and dead letters remain in **Anomaly maintenance**. A state tile can also count entries whose job data no longer exists in Redis, usually left behind after eviction or data loss. The list cannot show them, so the page explains the gap under the table. Teable sweeps such leftovers out of the failed state on its own; **Clear failed history** removes them right away. ## Trace How a Value Propagated When a computed value looks wrong or arrived late, open **Computed lineage** to see the whole chain behind it. Click any queue row, or click **Lineage** beside a task ID in anomaly detail. | Section | What it answers | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Summary | End-to-end latency, when the source changed, when the value converged, and which table and fields triggered the run. A **Computing** badge means the chain is still running. | | **Timeline** | Three lanes side by side: **End-to-end** runs from the source change to the computed writes settling, **This task** covers claim to commit, and **Wakeup job** is the wakeup that ran it. The task lane is split into queue wait, claim / setup, and compute. The wakeup job also drains other due work on the same database, so it normally outlasts end-to-end. | | **Task chain** | Every task in the cascade, nested under the task that enqueued it, so you can see where a branch came from. Partial batches split off the same stage are a serial queue and stay flat at one level instead of nesting deeper. Each row shows its state, plan steps, **Write target** (the table and fields that task updates), **Estimated complexity**, cascade depth, enqueue time, and duration. | | **Field propagation** | Which fields the run read and wrote, and how the change traveled between them. Dashed blue is the origin that led to this write, gray is an input that was not written this run, green is written this run, and the arrows are field dependencies or link hops rather than step order. Only origins that actually reach this run's writes are drawn. Use **Expand** to open the graph full screen when a wide chain is hard to follow inline. | The lineage ledger only records tasks created after this feature shipped and keeps 7 days of history. An older task shows its queue facts without a propagation graph. A seed task the worker has not planned yet shows only its trigger fields. When a change produced no downstream computed writes, the graph says so: nothing depended on those fields through a formula, lookup, rollup, or link title. ## Handle Anomalous Tasks The **Failed** count and **Anomaly maintenance** show different types of problems, so their numbers may differ. **Anomaly maintenance** collects anomalies into problem groups, one per Base, source table, and error, so a single root cause is easy to spot. Review the failure reason and fix the underlying problem before you recover anything. Expand a group to read its error details and the tasks it covers; those rows are for inspection, and recovery always runs on the group as a whole. The actions a group offers depend on its type: | Anomaly type | Action | What happens | | --------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | | **Dead letter** | **Recover entire group** | Restores every dead letter currently in that group to the durable queue and redelivers them. Every other group stays untouched. | | **Dead letter** | **Discard group** (in the **More actions** menu) | Permanently deletes the dead letters in that group. They cannot be recovered or replayed afterwards, so use it only when a replay is pointless. | | **Timed out** | **Re-arm latest timeout** | Wakes the queue for the newest task in the group so a worker can take it over. | After a group recovery, Teable reports how many tasks it restored, how many were newly queued or already queued, and how many were delivered or deferred. Workers then consume the group under the current concurrency and task-splitting limits. A group marked **Base deleted** belongs to a Base that no longer exists. Recovering it would fail again immediately, so **Discard group** is the only action offered. Moving a table to the trash no longer creates anomalies here. A computed task that still references a trashed table skips the steps that read it, finishes the steps that target live tables, and completes. Recovery is also unavailable when the data itself caused the failure, such as a value that exceeds a size limit or breaks a field constraint. Replaying the same task would fail the same way, so discard the group and fix the source data or the field definition instead; later writes recompute those fields automatically. ## Pause Computed Tasks for a Space When one space's computed tasks are making an incident worse, pause that space in **Computed task pauses** rather than stopping the whole instance. Click **Pause a space**. Search by space ID or name, then select it from the results. Set **Pause duration** to 15, 30, 60, or 120 minutes. Note the incident or maintenance window in **Reason**. Click **Confirm pause**. A pause only stops workers from claiming new computed tasks for that space. Tasks already running are not interrupted, and matching tasks wait until the pause ends rather than being dropped. A pause always expires on its own, and two hours is the longest you can set. If the incident outlasts it, click **Extend** on the pause row, choose how much longer to keep it paused, and confirm. The new auto-resume time is counted from the moment you confirm, again up to two hours, so the space is never released in between. The list shows every active pause with who created it, why, and when it auto-resumes, along with how many pending tasks the active pauses are holding, so you can judge the backlog a resume will release. To lift one early, click **Resume** on its row and confirm. ## Adjust Concurrency The queue section has two concurrency controls. Each one writes a cluster-wide override that every process picks up within about 15 seconds, with no restart, and each can be reset so processes return to their own environment setting. An **Overridden** badge marks a control that is no longer on its default. | Control | What it limits | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Per-process concurrency** | How many computed tasks each worker process handles at once. | | **Per-base claim caps** | How many computed tasks run at the same time for one Base (**Per base**) and for one source table within it (**Per seed table**). Both default to 2 and accept values from 1 to 16. | Raise the claim caps when one busy Base is the bottleneck, and per-process concurrency when many Bases are queued at the same time. Higher concurrency puts more load on your database. Spaces that store their data in a [database tenant](/en/basic/admin-panel/database-tenant) keep the environment defaults for the claim caps, because their connection pools are sized for those values. # Database Tenant Source: https://help.teable.ai/en/basic/admin-panel/database-tenant Host Teable Space data in a customer-managed PostgreSQL database. Available for self-hosted Business plan and above Path: Admin Panel → BYODB A database tenant is useful when a specific customer or business Space needs separately managed data storage. The Space's business data is stored in a designated PostgreSQL database instead of sharing the instance's default data database with other Spaces, reducing the impact of one tenant's database load or failure on other Spaces. Your organization can also manage the database's deployment location, database access controls, backups, and monitoring. ## What You Can Do From **Admin Panel** → **BYODB**, an instance administrator can: * Create a new Space that uses a customer-managed PostgreSQL database. * Move an existing Space to the target database. * Check the connection, migration status, and recent errors. For an existing Space, Teable tests the migration without switching databases by default. After validation, the administrator decides whether to switch. Switching briefly pauses writes, so plan it for a suitable maintenance window. ## FAQ No. It refers to the Teable Space whose data is stored in that database. No. It changes where Teable stores and manages its own Space data. You provide a PostgreSQL database hosted elsewhere, and Teable creates and manages its own data there. Existing tables and records in that database are not connected to Teable or automatically imported as Bases. # Overview Source: https://help.teable.ai/en/basic/admin-panel/overview Teable's self-hosted Admin Panel is used to manage instance users, spaces, and system configuration. Available for self-hosted Business plan and above The Admin Panel provides centralized management for your Teable instance. Administrators can manage users, spaces, templates, instance settings, and AI settings here. ## Accessing the Admin Panel After signing in as an instance administrator, select **Admin Panel** in the upper-left corner. Only instance administrators can access the admin panel. The first registered user automatically becomes an instance administrator. ## Admin Panel Modules The Admin Panel groups its pages by purpose: ### Instance configuration * **[Instance settings](/en/basic/admin-panel/settings)**: Configure system-wide settings, permissions, email, and system limits * **[AI settings](/en/basic/admin-panel/ai-setting)**: Configure AI features and models * **[Skills](/en/basic/admin-panel/skills)**: Publish skills that every AI agent in the instance can use * **[Template admin](/en/basic/admin-panel/template-admin)**: Configure template center and custom templates * **[Self-hosted license](/en/deploy/activate)**: Register, update, and view the current instance license ### Organization & spaces * **[Users](/en/basic/admin-panel/users)**: Manage user accounts, permissions, and access * **[Spaces](/en/basic/admin-panel/spaces)**: Manage spaces and auto-join settings * **[Database Tenant](/en/basic/admin-panel/database-tenant)**: Create and manage database tenants that use customer-managed PostgreSQL databases ### Operations & audit * **[Automation management](/en/basic/admin-panel/automation-management)**: View automation run status and run history * **[Table Query Ops](/en/basic/admin-panel/table-query-ops)**: Configure search coverage per table, create indexes, and follow the results * **[Computed Outbox](/en/basic/admin-panel/computed-outbox)**: Monitor computed task delivery, queue health, and database backlog * **[AI generation queue](/en/basic/admin-panel/ai-generation-queue)**: Review AI field generation status in the current self-hosted instance * **[Sandbox Agent](/en/basic/admin-panel/sandbox-agent)**: Configure and manage Sandbox Agent * **[Audit log](/en/basic/admin-panel/audit-log)**: Review recent instance activity and operation details ## Administrator Permissions Instance administrators have full control over the instance: * Manage all users and spaces * Configure system-wide settings * Register and update licenses * Not subject to user-level restrictions Administrator permissions are very powerful. Use them carefully to avoid unintended changes. ## Frequently Asked Questions **How do I add other administrators?** In the Users page, click the action menu for any user and select "Make Admin". The system requires at least one administrator at all times. # Sandbox Agent Source: https://help.teable.ai/en/basic/admin-panel/sandbox-agent Configure and manage Sandbox Agent. Available for self-hosted Business plan and above Path: Admin Panel → Sandbox Agent The **Sandbox Agent** page contains **Settings** and **Sandboxes** tabs for configuring how AI Chat runs in sandboxes. For self-hosted setup, deploy the full-featured runtime plane first. See [Architecture](/en/deploy/architecture). ## Runtime Limits Configure runtime limits in the **Settings** tab: | Setting | Description | | ------------------------- | ----------------------------------------------------------------------------------------------- | | **Stream Idle Timeout** | Set when an idle stream is terminated | | **Idle Timeout** | Set when an inactive sandbox is recycled | | **Concurrent Chat Limit** | Set how many Agents each user can run at the same time. AI Chat and App Builder are both Agents | | **vCPUs** | Set the number of virtual CPUs for each sandbox instance | | **Memory** | Set the memory limit for each sandbox instance | | **Temporary Disk** | Set the ephemeral storage limit for each sandbox instance | | **Thinking Effort** | Set the default thinking effort for agents | ## Sandboxes Tab Use the **Sandboxes** tab to view and manage current sandbox sessions. Ending active sessions interrupts running Agent work or app previews. Follow the in-product confirmation prompts before continuing. # Instance Settings Source: https://help.teable.ai/en/basic/admin-panel/settings Manage instance-level switches, email settings, and system pending items. Available for self-hosted Business plan and above Path: Admin Panel → Instance Settings The **Instance Settings** page is used to manage the core settings of the whole instance, including **General Settings**, **Email**, and the system checks shown in the **Pending configuration** panel. ## Overview This page mainly covers instance-level basics. The main settings are grouped as follows: | Setting type | Description | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **General Settings** | Includes **Allow creating new accounts**, **Banned email domains**, **Allow sending space invitations**, **Allow everyone to create new spaces**, and **Enable email verification** | | **Email** | Includes **Notification Email** and **Automation Email** for password reset, email verification, notification emails, and invitation emails | | **System limits** | Shows the effective table data, field, view, and text limits for the instance | To enable system emails, complete the setup in **Email**. Use **Banned email domains** to prevent email addresses from listed domains from signing up. Teable rejects those domains before sending signup verification codes, and no invitation emails involving those domains are sent. If email is not fully configured, the **Email** item in the **Pending configuration** panel will not turn green. ## System limits **System limits** shows the current instance-level limits for table data and related configuration. If you need to adjust a limit, use the environment variable shown on that page. After changing an environment variable, restart the service for the new value to take effect. ## Pending configuration The **Pending configuration** panel on the right is a system checklist. It shows which important settings are still missing for the instance. Common checks on this page include: | Item | Impact | | --------------------------------------- | ------------------------------------------------------------------------------------- | | **PUBLIC\_ORIGIN environment variable** | Affects features that rely on an external access URL, such as attachments and imports | | **Enable HTTPS** | Affects capabilities that rely on HTTPS, such as copy and paste | | **Email** | Affects password reset, email verification, notifications, and similar features | If these items are not completed, the instance may still open normally, but some features can remain unavailable. ## Relationship to AI Settings **Instance Settings** shows part of the system-level checks, but it is not where you configure **AI models**, the **AI Chat runtime**, or **App Builder**. Go here for those settings: * [AI Settings](/en/basic/admin-panel/ai-setting) You can think of the split like this: * **Instance Settings**: Covers the core capabilities of the instance itself * **AI Settings**: Covers AI Chat, AI fields, AI automation, and App Builder ## Check order If you are preparing a new self-hosted deployment or going live for the first time, check these items in order: Make sure **PUBLIC\_ORIGIN** is configured correctly. Make sure the instance already has **HTTPS** enabled. Make sure **SMTP** is configured and can send emails successfully. After the basic items are confirmed, continue with [AI Settings](/en/basic/admin-panel/ai-setting). This makes it easier to turn the **Pending configuration** items green in order and helps with troubleshooting. ## FAQ This usually means the instance is reachable, but one or more important runtime requirements are still missing. Follow the prompts in the right-side panel and complete them one by one instead of relying only on whether the page opens. Check whether the saved SMTP settings are complete, whether they match the intended sending purpose, and whether verification or notification emails can be sent reliably. Many features that rely on an external access URL depend on it. If the configured value does not match the actual access URL, features such as imports, attachments, or redirects may not work correctly. # Skills Source: https://help.teable.ai/en/basic/admin-panel/skills Publish skills that every AI agent in the instance can use. Available for self-hosted Business plan and above Path: Admin Panel → Skills Use **Skills** to publish skills for the whole instance. A skill added here is available in every AI Chat, App Builder, and bot conversation, so use it for working methods your organization should share by default, such as a house writing style, a reporting convention, or a shared integration procedure. Skills added by users elsewhere stay in their own scope. See [AI Chat](/en/basic/ai/ai-chat) for personal, base, and space skills. ## Add a Skill Click **Import Skill** and choose where the skill comes from: | Source | What to provide | | -------------------- | ------------------------------------------------------------------------------------------------------------------- | | **GitHub URL** | The link to the skill folder in a repository, for example `https://github.com/owner/repo/tree/main/skills/my-skill` | | **ZIP / Skill File** | A `.zip` or `.skill` file that contains `SKILL.md` | If a skill with the same name already exists in this scope, importing replaces it. ## Manage Published Skills The list groups skills by scope and shows where each one came from. Built-in skills are listed at the bottom for reference and are not editable. * Use the switch on a row to enable or disable a skill without deleting it. A disabled skill stays in the list but is not offered to agents. * For a skill imported from GitHub, click the refresh button to pull the latest version from its source. * Click a row to read its `SKILL.md`, edit its name and description, download it, replace its files, or delete it. Only instance administrators can add, change, or remove skills on this page. Every signed-in user can use the published skills in their conversations. ## When a Name Is Used Twice A skill published here is the instance default. If a base, space, personal, app, or bot skill uses the same name, the narrower one is in effect for that conversation, and the instance skill is ignored there. # Spaces Source: https://help.teable.ai/en/basic/admin-panel/spaces Manage all spaces in your instance through the admin panel, including viewing space information, deleting spaces, and configuring auto-join settings. Available for self-hosted Business plan and above ### Space Information * **Space Name**: The display name of the space * **Bases**: The total number of bases contained in the space * **Collaborators**: The total number of users who have access to the space * **Created Time**: When the space was created * **Auto-join**: Whether the space allows new users to join automatically ### Space Operations #### Auto-join * **Allow Auto-join**: When enabled, all newly registered users will automatically join this space with [Read permission](/en/basic/space/space-invite). Useful for public or company-wide spaces. * **Disallow Auto-join**: Disable automatic joining for new users. #### Delete Space Spaces deleted from the admin panel **cannot be recovered**. Unlike regular space deletion, spaces deleted here do not enter the trash bin system. When you delete a space from the admin panel: * The space is immediately marked as deleted * All bases and data within the space become inaccessible * Collaborators lose access to the space * This operation cannot be undone **Before deleting a space:** 1. Notify all collaborators about the deletion 2. Export or backup important data 3. Confirm that the space is no longer needed 4. Consider using the deactivate option if temporary removal is needed # Table Query Ops Source: https://help.teable.ai/en/basic/admin-panel/table-query-ops Review search coverage and indexes table by table, configure search, create indexes, and follow the results. Available for self-hosted Business plan and above Path: Admin Panel → Table Query Ops Use **Table search and indexes** when views, filters, relations, or searches on a large table become slow. Teable watches the query workload in the background and summarizes each table: how it is searched today, which fields are covered, which physical indexes exist, and how many slow queries it saw recently. Instance administrators configure search coverage, create indexes, and follow the results here. The page only queues tasks; it never changes the database directly. Every change runs asynchronously in the background, so confirm the outcome under **Tasks / history**. Table Query Ops is off by default. Set `V2_TABLE_QUERY_OPS_ENABLED` to `true` on the backend and restart, and the page starts collecting observations. ## Find the table to work on The page opens on the table list. The state buttons across the top carry their own counts and narrow the list: | State | Meaning | | --------------------- | ----------------------------------------------------------------------------------------------------------------------- | | **All tables** | Every observed table. | | **Needs attention** | Tables with slow queries, timeouts, pending recommendations, or failed tasks. Start here. | | **Indexed search** | Tables whose index metadata is published and usable and whose runtime switch is on, so search really runs on the index. | | **Configured search** | Tables with a saved search configuration or existing index metadata, including those not yet published. | | **Unconfigured** | Tables with no search coverage yet. | | **Unavailable** | Tables that cannot use indexed search right now. The row states why. | The search box accepts table, Base, and Space names or IDs. Sorting is either **Most slow queries** or **Table name**. **Observation window** covers the last 1 hour or 24 hours, and every observation figure in the list follows that window. Observations are kept for 2 days; anything older no longer appears in the list. Each row gives the table's estimated rows and size, the requests and slow queries within the window, the current search method and field coverage, the number of filter/sort indexes, and the counts of pending recommendations and active tasks. Click a table name to open its detail. **About index states**, next to the state buttons, explains how these counts are measured. ## Read the index state The table list and the table detail both show an index state next to the search method: | State | Meaning | What to do next | | ------------------------------------ | ----------------------------------------------------------- | -------------------------------------------------------------- | | **Not configured** | No saved search configuration and no index metadata. | Choose **Configure search** if the table needs indexed search. | | **Configured · pending publication** | The configuration is saved; the index is not published yet. | Check **Tasks / history** for a task still running. | | **Published · ready** | The index metadata is published and usable. | Nothing to do. | | **Unusable metadata** | The index metadata is broken and cannot serve search. | Run **Update selection / rebuild** again. | Two lines can appear below the state. **Configured: pg\_bigm / pg\_trgm** means the saved provider differs from the search method in use, and **Indexed-search runtime switch: off** means the index is ready but the runtime is off, so search still runs `ILIKE`. A published index does not mean every search hits it: a probe that is too short, or a field outside the coverage, still falls back to `ILIKE`. This page reports the state of the index, not proof that recent requests hit it. ## Configure search coverage The **Search coverage** tab shows the table's current search method, how many fields are covered, and the **Serving coverage** of each field. **Show uncovered fields** narrows the list to the fields not yet included; fields marked **Not eligible** cannot contribute to a substring search index. Serving coverage requires published, usable index metadata and the runtime switch on; a saved configuration alone does not count. Coverage is explicit, so fields you add later are not included automatically; configure the table again to bring them in. Choose **Configure search** on a table that has never been configured, or **Update selection / rebuild** on one that has, which opens with the provider and field selection saved last time. The dialog asks for: | Item | What to enter | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Search provider** | `pg_bigm` or `pg_trgm`. If the extension is missing, the dialog says what is missing and who can provision it. | | **Representative search text** | Text your users would really search for. It checks substring semantics and collects plan evidence, and is never saved. If it is too short, the dialog names the minimum length. | | **Fields** | Select the fields users actually search. Do not select everything on a wide table; building a search document for every field is expensive. | **Analyze and dry-run** runs the change without committing it and reports the covered field count, estimated rows, whether plan evidence exists, and the impact of creating or rebuilding. Tables estimated at 50,000 rows or more, or of unknown size, also require the maintenance-window acknowledgement. Then choose **Confirm and queue task**. Creating or rebuilding search coverage generates a search column and a GIN index. It can rewrite the whole table and hold locks, and indexed search is briefly interrupted while it runs. Schedule it inside a maintenance window. What the dialog returns is a task receipt, not a result. Close it and follow the task under **Tasks / history**. Submitting the same change again returns the existing task. ## Manage filter and sort indexes The **Filter / sort indexes** tab lists the physical indexes that serve filter predicates and ordering on this table, each with its validity, whether Teable manages it, its size, and its definition. These are managed separately from substring search indexes. **Pending actions** below holds the system's index recommendations and says whether plan evidence backs each one. **Review index creation** shows the proposed index, the database it runs against, and the evidence; after you confirm, Teable runs `CREATE INDEX CONCURRENTLY` asynchronously. Large tables and tables of unknown size need the maintenance-window acknowledgement here too. This page does not delete indexes. Unmanaged and system indexes may protect constraints or serve other workloads, so they are left alone. ## Diagnose specific queries When someone reports a slow table and no recommendation covers it, open the **Query diagnosis** tab and choose **Analyze queries**. The analysis only reads saved query shapes and available plan evidence; it creates nothing. The conclusion is one of **Plan-backed index opportunities found**, **No index opportunity confirmed by the available plans**, or **Insufficient evidence**. Insufficient evidence does not mean a sequential scan happened: a slow observation alone does not establish that the access path is at fault. Below it, each affected query is listed with whether it came from real traffic or a saved view configuration, and the estimated plan cost before and after the proposed index (plan cost, not milliseconds). ## Follow the results The **Tasks / history** tab holds three parts: * **Tasks**: background tasks for this table, with status, attempt count, task kind, and failure reason. When a task eventually succeeded after failing, the error is labelled as a prior attempt. * **Search configuration history**: the provider, status, and field list of each past coverage configuration. * **Recommendation history**: recommendations that were accepted, dismissed, or superseded. History loads only the most recent entries; when there are more, a line above the list gives the total. While a table has a queued or running task, the buttons for configuring search and creating indexes stay disabled. Wait for the task to finish. # Template Admin Source: https://help.teable.ai/en/basic/admin-panel/template-admin Manage workflow templates for your organization, enabling users to quickly start with pre-configured bases. Available for self-hosted Business plan and above ### Template Management In the Template Admin interface, you can create and configure templates that will be available in your organization's template center. #### Template Information * **Cover**: The cover image for the template card * **Name & Description**: The title and short description displayed in the template center * **Markdown Description**: Detailed description supporting rich text formatting * **Category**: Group templates by business scenarios (e.g., HR, Sales, Engineering) * **System**: Indicates if the template is an official system template * **Source**: The original base used to create this template #### Template Operations * **New Template**: Create a new template configuration * **Publish Snapshot**: Capture the current state of the source base. You must publish a snapshot before you can list the template. * **Status (Publish)**: Toggle to list/unlist the template in the template center. Requires a name, description, and snapshot. * **Pin**: Pin important templates to the top of the list * **Delete**: Remove the template configuration ### Using Official Templates Self-hosted users can import templates from the official Teable Cloud: 1. **Download**: Get the `.tea` file from the [Official Template Center](https://teable.ai/templates) 2. **Import**: Import the `.tea` file as a new base in your space 3. **Create Template**: Go to Template Admin > New Template 4. **Select Source**: Choose the imported base as the source 5. **Publish**: Configure details, publish snapshot, and enable status # Users Source: https://help.teable.ai/en/basic/admin-panel/users Manage all users in your instance through the admin panel, including viewing user information, deactivating and deleting users. Available for self-hosted Business plan and above ### User Information * **Username**: The user's display name * **Last login**: The most recent time the user logged into the system * **Signed up**: The time when the user first registered their account * **Status**: The current status of the user account (Active, Deactivated, or Deleted) ### User Operations #### Permissions * **Make Admin**: Grants full instance administration rights * **Remove Admin**: Revokes administrator rights #### Account Status * **Deactivate**: User cannot log in but data is retained * **Activate**: Restore access for a deactivated user #### Password Reset Open a user's action menu and select **Reset password**. After you confirm, Teable generates a one-time link that you can copy and send to the user. If notification email is configured, Teable also sends the link by email. The user's current password remains valid until they set a new one through the link. Teable shows the expiration time when it generates the link, and each link can be used only once. **Reset password** is not available when password login is disabled for the instance. #### Deletion * **Delete**: Soft-delete user (marked as deleted) * **Restore**: Recover a soft-deleted user * **Permanent Delete**: Completely remove user data (irreversible) # Overview Source: https://help.teable.ai/en/basic/authority-matrix Set access scopes for different teams in the same base, so members only see, edit, or export the data they need. Available for Business plan and above When sales, finance, operations, and leadership share the same base, permissions decide who can enter the base, which data they can see or edit, and whether they can import or export data. The Authority Matrix helps teams keep data in one place while separating access by responsibility. You can assign custom roles to members or departments, then let each role access only the tables, apps, and workflows it needs. For tables, you can also limit visible views, visible records, editable fields, and import or export permissions. For example, sales can maintain their own customers, finance can view billing fields, and leadership can view the full dataset. ## When to Use It | Scenario | Good for | | --------------------------------- | -------------------------------------------------------------------------------- | | Department-level access | Sales can maintain customer records, while finance only sees billing fields. | | Assignee-based records | Sales reps can view and update only records assigned to them. | | Restricted data entry | Members can create new records without editing or deleting existing records. | | Sensitive fields in a shared base | Members can view order records without seeing payment or cost fields. | | Controlled apps and workflows | Roles can open selected apps or workflows, while unauthorized nodes stay hidden. | ## How Permissions Work The Authority Matrix assigns access by role. Users can receive permissions from roles assigned directly to them or from department roles. When multiple roles apply, Teable combines the permissions allowed by those roles. Space users with the **Manager** permission and Authority Matrix administrators can manage the Authority Matrix and are not restricted by it. The role list includes an `Administrators` section and a `Custom roles` section: Authority Matrix role list Use `Add role` to create a custom role. In the role detail page, assign collaborators, write a short description, and configure access for each node in the base: Authority Matrix role detail page ## Configure Role Access Each table, app, and workflow has its own access setting. | Node type | Available setting | | --------- | --------------------------------------------------------------------------------------------------------------- | | Table | Choose `Can edit` or `No access`. After a table is set to `Can edit`, configure its detailed permissions. | | App | Choose `Can access` or `No access`. This controls whether the role can open the app. | | Workflow | Choose `Can access` or `No access`. This controls whether the role can open the workflow. | | Folder | Folders are shown for navigation. If none of the child nodes are accessible, the folder is hidden for the role. | To configure view, record, field, and other detailed table permissions, set the table to `Can edit` first. A table with `No access` is hidden from members in that role. ## Table Permissions When a table is set to `Can edit`, configure these permission areas: | Permission area | What it controls | | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | View permissions | Whether the role can create, update, or delete views, and whether it can view `All views` or only `Specific views`. | | Record permissions | Whether the role can create, update, delete, comment on, or copy records. Visible records can be `All records` or records that match filter conditions. | | Field permissions | Whether the role can view, update, or create values in specific fields. The primary field must remain visible. | | Import and export permissions | Whether the role can import data into the table or export table data. | Authority Matrix table permissions Record filters work well for access scopes that change by owner, department, or similar fields. For example, a condition such as `Sales owner` `is` `current user` lets each salesperson see only their own records. Field permissions can further hide or lock sensitive field values in records the role can access. ## Default Role Authority Matrix default role setting Use `Default role` for members who have not been assigned any custom role. You can select an enabled custom role, or choose `Permission denied` so these members cannot access content controlled by the Authority Matrix. ## Notes * After the Authority Matrix is enabled, users whose Space permission is below `Manager` are restricted by it unless they are added as Authority Matrix administrators. * The user who enables the Authority Matrix is automatically added to `Administrators`. * New custom roles are enabled when they are created from `Add role`, but each table, app, and workflow still needs its own access setting. * A table set to `No access` for a role is hidden from that role, even if its detailed permission options were edited earlier. * Assigning a role from `Add user` or `Add from organization` can add selected members or departments as base collaborators. The Authority Matrix then narrows what they can access inside the base. To learn about basic Space and base permission levels, see [Collaboration Permissions](/en/basic/space/space-permission). # Authority Matrix Guidelines Source: https://help.teable.ai/en/basic/authority-matrix/authority-matrix-practical-guide Configure Authority Matrix roles for a sales team that needs shared data, ownership-based record access, and restricted data entry. This guide uses a sales base with three tables: `Customers`, `Sales Orders`, and `Products`. The goal is to let each role work with the data it needs without exposing the whole base. | Role | Access goal | | ---------------- | --------------------------------------------------------------------------------------------------------------- | | Sales Director | View customer and sales data, comment on products, and avoid changing product prices. | | Sales Rep | View and update only their own customers and orders, create new customers, and avoid deleting completed orders. | | Data Entry Clerk | Add new products without seeing existing products, customers, or orders. | Turn on the Authority Matrix before relying on role permissions. Enable the Authority Matrix ## Create the Roles Open the Authority Matrix page in the base and turn on the main switch. The user who enables it is added as an administrator. Click `Add role` and create `Sales Director`, `Sales Rep`, and `Data Entry Clerk`. Create three roles: Sales Director, Sales Rep, Data Entry Clerk ## Configure Sales Director The Sales Director needs broad visibility, but product prices should stay protected from accidental edits. | Node | Setting | | ------------ | ---------------------------------------------------------------------------------------------------------- | | Customers | Set the table to `Can edit`. Keep record and field permissions open so the role can view customer data. | | Sales Orders | Set the table to `Can edit`. Keep record and field permissions open so the role can review sales activity. | | Products | Set the table to `Can edit`, then allow only `Read record` and `Comment on record` in record permissions. | Configure Sales Director permissions Assign members from the role list with `Add user` or `Add from organization`, then make sure the role switch is enabled. Add members to the Sales Director role After setup, a Sales Director can review customer and order data, comment on products, and avoid changing product records. Sales Director view after permissions are configured ## Configure Sales Rep The Sales Rep role uses record filters so each rep works only with records where they are the owner. ### Customers Set `Customers` to `Can edit`. | Permission area | Setting | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------- | | Record permissions | Choose records that match specific conditions. Add a filter such as `Sales Rep` `is` `Me (current user)`. | | Record operations | Allow `Read record`, `Update record`, and `Create record`. Leave `Delete record` off if reps should not delete customer records. | Configure an owner-based record filter for Sales Rep Configure Sales Rep customer permissions ### Sales Orders Set `Sales Orders` to `Can edit`. | Permission area | Setting | | ------------------ | --------------------------------------------------------------------------------------------------------------------------------- | | Record permissions | Use the same owner-based filter, such as `Sales Rep` `is` `Me (current user)`. | | Record operations | Allow `Read record` and `Create record`. Leave `Update record` and `Delete record` off if completed orders should stay unchanged. | | Field permissions | Hide sensitive fields such as `Payment Method` by turning off `Read record` for that field. | Configure Sales Rep order permissions Assign sales reps to the role and keep the role enabled. Add members to the Sales Rep role Each sales rep now sees only the customer and order records that match the owner filter. Preview of the Sales Rep view ## Configure Data Entry Clerk The Data Entry Clerk only needs to add products. | Node | Setting | | -------------------------- | ---------------------------------------------------------------------------------------------- | | Products | Set the table to `Can edit`. In record permissions, allow only `Create record`. | | Product fields | If linked order data should stay hidden, turn off `Read record` for the `Orders` linked field. | | Customers and Sales Orders | Keep these tables as `No access`. | Configure Data Entry Clerk permissions Assign clerks to the role and keep the role enabled. Add members to the Data Entry Clerk role After setup, the Data Entry Clerk can add new product records but cannot browse existing product, customer, or order data. Preview of the Data Entry Clerk view ## Sales Review View Use this setup for sales reviews: reps can see the full customer list, but can only edit customers they own. During a review, reps may need to see every customer record to compare follow-up patterns and customer status. Day-to-day editing should still stay limited to the customers they own, so they do not change another rep's records by mistake. Keep the existing `Sales Rep` role, then add a read-only role for company-wide customer visibility. A rep can use the read-only role to view all customers and use the `Sales Rep` role to update only the customers they own. ### Create a Read-Only Role Click `Add role` and create a read-only role, such as `Global Customer Viewer`. ### Configure Customer Access Set `Customers` to `Can edit`. In record permissions, allow only `Read record`. Do not enable `Update record`, `Delete record`, or `Create record`. Leave the record filter empty so this role can view all customer records. Configure read-only customer permissions for Global Customer Viewer ### Assign Sales Reps Return to the role list and add the sales reps who need review access to `Global Customer Viewer`. Add members to the Global Customer Viewer role When a user has both `Sales Rep` and `Global Customer Viewer`, Teable combines the permissions. The user can view all customer records, but can update only records allowed by the owner-based `Sales Rep` role. Sales Rep view with Global Customer Viewer permissions # Auth0 SSO Source: https://help.teable.ai/en/basic/sso/auth0 Configure Auth0 as your SSO authentication provider for Teable Available for Business plan and above ## Step 1: Create Authentication Provider in Teable 1. Navigate to your Teable SSO settings 2. Create a new authentication provider and name it **Auth0** and select **OpenID Connect** ## Step 2: Access Auth0 Dashboard 1. Log in to your [Auth0 Dashboard](https://manage.auth0.com) 2. Select your Auth0 tenant 3. Navigate to **Applications** → **Applications** in the left menu ## Step 3: Create a New Application 1. Click **Create Application** 2. Enter application details: * **Name**: Teable SSO * **Application Type**: Select **Regular Web Applications** 3. Click **Create** ## Step 4: Configure Application Settings After creating the application, go to the **Settings** tab: ### Basic Information 1. Copy your **Domain** (e.g., `your-tenant.auth0.com` or `your-tenant.us.auth0.com`) 2. Copy the **Client ID** 3. Copy the **Client Secret** 4. Paste these values into the Teable SSO configuration ### Application URIs Scroll down to the **Application URIs** section: 1. **Allowed Callback URLs**: Paste the **Callback URL** from Teable 2. **Allowed Logout URLs**: (Optional) `https://app.teable.ai` 3. **Allowed Web Origins**: (Optional) `https://app.teable.ai` 4. Click **Save Changes** at the bottom of the page Make sure to save your changes before leaving the page. ## Step 5: Configure OAuth Endpoints In Teable, fill in the following OAuth endpoints using your Auth0 domain: * **Authorization URL**: `https://{yourDomain}/authorize` * **Token URL**: `https://{yourDomain}/oauth/token` * **User Info URL**: `https://{yourDomain}/userinfo` * **Issuer**: `https://{yourDomain}/` Replace `{yourDomain}` with your actual Auth0 domain from Step 4. ## Step 6: Configure Connections (Optional) Auth0 allows you to enable multiple identity providers. To configure which login methods are available: 1. In your application settings, go to the **Connections** tab 2. Enable the authentication methods you want to support: * **Database**: Username/Password authentication * **Social**: Google, Microsoft, GitHub, etc. * **Enterprise**: SAML, Active Directory, etc. 3. Configure each connection as needed ## Step 7: Customize Login Experience (Optional) ### Universal Login Page 1. Go to **Branding** → **Universal Login** in the Auth0 dashboard 2. Customize the login page appearance 3. Add your company logo and brand colors ### Email Templates 1. Go to **Branding** → **Email Templates** 2. Customize email templates for verification, password reset, etc. ## Step 8: Configure User Permissions ### Define Scopes 1. Go to **Applications** → **APIs** in the Auth0 dashboard 2. Select **Auth0 Management API** or create a custom API 3. Define the scopes/permissions needed for your application ### Assign Roles (Optional) 1. Go to **User Management** → **Roles** 2. Create roles for different user types 3. Assign permissions to each role 4. Assign users to appropriate roles ## Step 9: Test SSO Login You have two options to enable SSO login: **Option 1: Direct Authentication URL** * Use the authorization URL as your SSO login URL **Option 2: Domain Verification** 1. In Teable, configure domain verification 2. Verify your custom domain 3. Visit [https://app.teable.ai](https://app.teable.ai) 4. Click the SSO login button 5. Enter your email address under the verified domain to log in ## Additional Configuration (Optional) ### Enable Multi-Factor Authentication 1. Go to **Security** → **Multi-Factor Auth** in the Auth0 dashboard 2. Enable your preferred MFA methods (SMS, authenticator app, etc.) 3. Define MFA policies and rules ### Configure Rules for Custom Logic 1. Go to **Auth Pipeline** → **Rules** 2. Create custom rules to: * Add custom claims to tokens * Enforce conditional access * Integrate with external services * Enrich user profiles ### Set Up Organizations (Auth0 Organizations Feature) If using Auth0 Organizations: 1. Go to **Organizations** in the Auth0 dashboard 2. Create organizations for different tenants/companies 3. Configure organization-specific branding and connections 4. Enable organization support in your Teable application # Authentik SSO Source: https://help.teable.ai/en/basic/sso/authentik Configure Authentik as your SSO authentication provider for Teable Available for Business plan and above ## Step 1: Create Authentication Provider in Teable 1. Navigate to your Teable SSO settings 2. Create a new authentication provider and name it **Authentik** and select **OpenID Connect** ## Step 2: Access Authentik Admin Interface 1. Log in to your Authentik instance admin interface 2. The default URL is typically `https://your-authentik-domain/if/admin/` 3. Use your administrator credentials to log in ## Step 3: Create a New Provider 1. Navigate to **Applications** → **Providers** in the left menu 2. Click **Create** button 3. Select **OAuth2/OpenID Provider** 4. Configure the provider settings: ### Basic Settings * **Name**: Teable SSO Provider * **Authorization flow**: Select your preferred flow (typically **default-authentication-flow**) * **Client type**: **Confidential** * **Client ID**: (Auto-generated, you can customize if needed) * **Client Secret**: (Auto-generated, copy this value) ### Redirect URIs * **Redirect URIs/Origins (RegEx)**: Paste the **Callback URL** from Teable * For exact match: `https://app.teable.ai/api/auth/authentication/__providerId__/callback` * For regex pattern: `https://app\.teable\.ai/api/auth/authentication/.*/callback` Replace `__providerId__` in the URL with the providerId shown after creating the authentication provider in Teable, or copy the callback URL directly from the Teable page. ### Advanced Settings * **Scopes**: Make sure the following scopes are available: * `openid` * `email` * `profile` * **Subject mode**: **Based on the User's hashed ID** * **Include claims in id\_token**: Check this option Click **Finish** to create the provider. ## Step 4: Save Client Credentials After creating the provider: 1. Copy the **Client ID** from the provider details 2. Copy the **Client Secret** (this is shown only once during creation) 3. Paste both values into the Teable SSO configuration Store the Client Secret securely. You can regenerate it later if needed. ## Step 5: Create an Application 1. Navigate to **Applications** → **Applications** in the left menu 2. Click **Create** button 3. Configure the application: * **Name**: Teable * **Slug**: `teable` (or your preferred slug) * **Provider**: Select the **Teable SSO Provider** you created in Step 3 * **Launch URL**: (Optional) `https://app.teable.ai` * **UI settings**: (Optional) Upload Teable logo and customize appearance Click **Create** to finish. ## Step 6: Configure OAuth Endpoints In Teable, fill in the following OAuth endpoints using your Authentik domain: * **Authorization URL**: `https://{your-authentik-domain}/application/o/authorize/` * **Token URL**: `https://{your-authentik-domain}/application/o/token/` * **User Info URL**: `https://{your-authentik-domain}/application/o/userinfo/` * **Issuer**: `https://{your-authentik-domain}/application/o/{application-slug}/` Replace `{your-authentik-domain}` with your actual Authentik instance domain and `{application-slug}` with the slug you configured (e.g., `teable`). ## Step 7: Configure Application Access ### Create or Use Existing Flow 1. Navigate to **Flows & Stages** → **Flows** 2. You can use the default flows or create custom ones 3. Typical flows needed: * **Authentication flow**: For user login * **Authorization flow**: For OAuth2/OIDC authorization ### Assign Access Policy (Optional) 1. Go back to your application settings 2. Scroll to **Policy / Group / User Bindings** section 3. Click **Bind existing policy** to restrict access based on: * **Groups**: Only allow specific groups * **Users**: Only allow specific users * **Custom policies**: Create complex access rules ## Step 8: Configure Scopes and Claims (Optional) ### Review Scopes 1. Navigate to **Customization** → **Property Mappings** 2. Review the **Scope Mappings** for OAuth2/OIDC 3. Ensure the following scopes include the right claims: * `openid`: Contains `sub` claim * `email`: Contains `email` and `email_verified` * `profile`: Contains `name`, `given_name`, `family_name`, etc. ### Add Custom Claims If you need custom user attributes: 1. Go to **Customization** → **Property Mappings** 2. Click **Create** → **Scope Mapping** 3. Define your custom claims: * **Name**: Custom claim name * **Scope name**: Scope identifier (e.g., `custom_claims`) * **Expression**: Python expression to extract user data 4. Attach the scope to your provider ## Step 9: Test SSO Login You have two options to enable SSO login: **Option 1: Direct Authentication URL** * Use the authorization URL as your SSO login URL * Users will be redirected to Authentik for authentication **Option 2: Domain Verification** 1. In Teable, configure domain verification 2. Verify your custom domain 3. Visit [https://app.teable.ai](https://app.teable.ai) 4. Click the SSO login button 5. Enter your email address under the verified domain to log in ## Additional Configuration (Optional) ### Configure Multi-Factor Authentication 1. Navigate to **Flows & Stages** → **Stages** 2. Create MFA stages (e.g., TOTP, WebAuthn, SMS) 3. Go to **Flows & Stages** → **Flows** 4. Edit your authentication flow 5. Add MFA stages to the flow 6. Configure MFA policies and bindings ### Set Up User Enrollment 1. Navigate to **Flows & Stages** → **Flows** 2. Create or edit an enrollment flow 3. Add stages for: * User details collection * Email verification * Password setup 4. Link the enrollment flow to your application ### Configure Password Policies 1. Navigate to **Flows & Stages** → **Policies** 2. Create password policies with requirements like: * Minimum length * Complexity requirements * Password history * Expiration rules ### Enable Session Management 1. Navigate to **Events** → **Sessions** 2. Monitor active user sessions 3. Configure session timeout settings in **System** → **Settings** ### Custom Branding 1. Navigate to **Customization** → **Tenants** 2. Edit your tenant settings 3. Customize: * Logo and favicon * Theme colors * Footer text and links 4. Users will see your branding when logging in through Authentik ### Enable Audit Logging 1. Navigate to **Events** → **Logs** 2. Review authentication events and errors 3. Set up notification rules for important events 4. Configure event retention policies in **System** → **Settings** # Azure Entra ID SSO Source: https://help.teable.ai/en/basic/sso/azure-entra-id Configure Azure Entra ID as your SSO authentication provider for Teable Available for Business plan and above ## Step 1: Create Authentication Provider in Teable 1. Navigate to your Teable SSO settings 2. Create a new authentication provider and name it **Azure Entra ID** and select **OpenID Connect** Azure Entra ID SSO setup step 1 ## Step 2: Access Azure Entra ID 1. Log in to your Azure account 2. Navigate to **Microsoft Entra ID** (formerly Azure Active Directory) Azure Entra ID SSO setup step 2 ## Step 3: Configure OAuth Endpoints Fill in the following OAuth endpoints in Teable using your **Tenant ID**: Azure Entra ID SSO setup step 3 * **Authorization URL**: `https://login.microsoftonline.com/_YOUR_TENANT_ID_/oauth2/v2.0/authorize` * **Token URL**: `https://login.microsoftonline.com/_YOUR_TENANT_ID_/oauth2/v2.0/token` * **User Info URL**: `https://graph.microsoft.com/oidc/userinfo` * **Issuer**: `https://login.microsoftonline.com/_YOUR_TENANT_ID_/v2.0` Replace `_YOUR_TENANT_ID_` with your actual Azure Tenant ID. ## Step 4: Register a New Application 1. In Azure Entra ID, click **App registrations** in the left menu 2. Click **+ New registration** Azure Entra ID app registration ## Step 5: Configure Application Registration Fill in the application registration form: Azure Entra ID SSO setup step 5 Azure Entra ID SSO setup step 6 * **Name**: Teable SSO * **Supported account types**: Select based on your needs * **Platform**: Web * **Redirect URI**: Paste the **Callback URL** from Teable Click **Register** to create the application. ## Step 6: Save the Client ID 1. Copy the **Application (client) ID** from the application overview page Azure Entra ID SSO setup step 7 2. Paste the Client ID into the Teable SSO configuration Azure Entra ID SSO setup step 8 ## Step 7: Create Client Secret 1. In your application, click **Certificates & secrets** in the left menu Azure Entra ID SSO setup step 9 2. Click **+ Add a certificate or secret** Azure Entra ID SSO setup step 10 3. Add a description and set the expiration period 4. Click **Add** 5. **Important**: Copy the secret **Value** immediately and save it as your Client Secret in Teable Azure Entra ID SSO setup step 11 The secret value is only visible once. Make sure to save it immediately. ## Step 8: Configure API Permissions 1. Click **API permissions** in the left menu 2. Click **+ Add a permission** Azure Entra ID SSO setup step 12 Azure Entra ID SSO setup step 13 3. Select **Microsoft Graph** 4. Choose **Delegated permissions** 5. Add the following permissions: * `email` * `openid` * `profile` 6. Click **Add permissions** Azure Entra ID SSO setup step 14 7. Click **Grant admin consent for \[Your Directory]** to approve the permissions ## Step 9: Test SSO Login You have two options to enable SSO login: Azure Entra ID SSO setup step 15 **Option 1: Direct Authentication URL** * Use the authentication URL as your SSO login URL **Option 2: Domain Verification** 1. Click **Domain verification** in the left menu 2. Verify your custom domain 3. Visit your teable login page 4. Click the SSO login button 5. Enter your email address under the verified domain to log in # Google Workspace SSO Source: https://help.teable.ai/en/basic/sso/google-workspace Configure Google Workspace as your SSO authentication provider for Teable Available for Business plan and above ## Step 1: Create Authentication Provider in Teable 1. Navigate to your Teable SSO settings 2. Create a new authentication provider and name it **Google Workspace** and select **OpenID Connect** ## Step 2: Access Google Cloud Console 1. Go to [Google Cloud Console](https://console.cloud.google.com) 2. Log in with your Google Workspace admin account 3. Select or create a project for Teable SSO integration ## Step 3: Enable Google Identity Services 1. In the Google Cloud Console, navigate to **APIs & Services** → **Library** 2. Search for **Google Identity** or **Google+ API** 3. Click **Enable** if not already enabled ## Step 4: Configure OAuth Consent Screen 1. Go to **APIs & Services** → **OAuth consent screen** 2. Select **Internal** (for Google Workspace users only) or **External** 3. Fill in the required information: * **App name**: Teable SSO * **User support email**: Your email address * **App logo**: (Optional) Upload Teable logo * **Authorized domains**: Add your Teable domain * **Developer contact information**: Your email address 4. Click **Save and Continue** ### Configure Scopes 1. Click **Add or Remove Scopes** 2. Add the following scopes: * `openid` * `email` * `profile` 3. Click **Update** and then **Save and Continue** ### Add Test Users (if using External) If you selected "External", add test users during development: 1. Click **Add Users** 2. Enter email addresses of test users 3. Click **Save and Continue** ## Step 5: Create OAuth Client ID 1. Go to **APIs & Services** → **Credentials** 2. Click **Create Credentials** → **OAuth client ID** 3. Select **Web application** as the application type 4. Configure the client: * **Name**: Teable SSO Client * **Authorized JavaScript origins**: (Optional) `https://app.teable.ai` * **Authorized redirect URIs**: Paste the **Callback URL** from Teable 5. Click **Create** ## Step 6: Save Client Credentials After creating the OAuth client, a dialog will appear with your credentials: 1. Copy the **Client ID** 2. Copy the **Client Secret** 3. Click **OK** 4. Paste both values into the Teable SSO configuration You can always retrieve these credentials later from the Credentials page. ## Step 7: Configure OAuth Endpoints In Teable, fill in the following OAuth endpoints: * **Authorization URL**: `https://accounts.google.com/o/oauth2/v2/auth` * **Token URL**: `https://oauth2.googleapis.com/token` * **User Info URL**: `https://openidconnect.googleapis.com/v1/userinfo` * **Issuer**: `https://accounts.google.com` ## Step 8: Test SSO Login You have two options to enable SSO login: **Option 1: Direct Authentication URL** * Use the authorization URL as your SSO login URL **Option 2: Domain Verification** 1. In Teable, configure domain verification 2. Verify your Google Workspace domain 3. Visit [https://app.teable.ai](https://app.teable.ai) 4. Click the SSO login button 5. Enter your Google Workspace email address to log in ## Additional Configuration (Optional) ### Restrict Access by Domain If you want to restrict access to specific Google Workspace domains: 1. In your application code or Teable settings, configure domain restrictions 2. Only allow email addresses from your verified domain(s) ### Configure Session Duration 1. In Google Admin Console, go to **Security** → **Authentication** 2. Configure **Google session control** settings 3. Set session duration and re-authentication policies ### Enable 2-Step Verification 1. In Google Admin Console, go to **Security** → **Authentication** → **2-Step Verification** 2. Enable 2-Step Verification for your organization 3. Configure enforcement policies for users # Okta SSO Source: https://help.teable.ai/en/basic/sso/okta Configure Okta as your SSO authentication provider for Teable Available for Business plan and above ## Step 1: Create Authentication Provider in Teable 1. Navigate to your Teable SSO settings 2. Create a new authentication provider and name it **Okta** and select **OpenID Connect** ## Step 2: Access Okta Admin Console 1. Log in to your Okta account 2. Navigate to **Admin Dashboard** 3. Go to **Applications** → **Applications** in the left menu ## Step 3: Create a New Application 1. Click **Create App Integration** 2. Select **OIDC - OpenID Connect** as the sign-in method 3. Select **Web Application** as the application type 4. Click **Next** ## Step 4: Configure Application Settings Fill in the application configuration form: * **App integration name**: Teable SSO * **Grant type**: Select **Authorization Code** * **Sign-in redirect URIs**: Paste the **Callback URL** from Teable * **Sign-out redirect URIs**: (Optional) `https://app.teable.ai` * **Controlled access**: Choose who can access this application Click **Save** to create the application. ## Step 5: Save Client Credentials After creating the application, you'll see the application details page: 1. Copy the **Client ID** 2. Copy the **Client Secret** (click "Show" if needed) 3. Paste both values into the Teable SSO configuration Keep your Client Secret secure and never share it publicly. ## Step 6: Configure OAuth Endpoints In Teable, fill in the following OAuth endpoints: * **Authorization URL**: `https://{yourOktaDomain}/oauth2/v1/authorize` * **Token URL**: `https://{yourOktaDomain}/oauth2/v1/token` * **User Info URL**: `https://{yourOktaDomain}/oauth2/v1/userinfo` * **Issuer**: `https://{yourOktaDomain}` Replace `{yourOktaDomain}` with your actual Okta domain (e.g., `dev-123456.okta.com` or `mycompany.okta.com`) ## Step 7: Assign Users or Groups 1. In your Okta application, go to the **Assignments** tab 2. Click **Assign** → **Assign to People** or **Assign to Groups** 3. Select the users or groups who should have access to Teable via SSO 4. Click **Assign** and **Done** ## Step 8: Test SSO Login You have two options to enable SSO login: **Option 1: Direct Authentication URL** * Use the authorization URL as your SSO login URL **Option 2: Domain Verification** 1. In Teable, configure domain verification 2. Verify your custom domain 3. Visit [https://app.teable.ai](https://app.teable.ai) 4. Click the SSO login button 5. Enter your email address under the verified domain to log in ## Additional Configuration (Optional) ### Configure Custom Claims If you need to map additional user attributes: 1. Go to **Security** → **API** in Okta Admin 2. Select your authorization server (usually "default") 3. Go to the **Claims** tab 4. Add custom claims as needed (e.g., department, role) ### Enable Multi-Factor Authentication 1. Go to **Security** → **Authenticators** in Okta Admin 2. Configure your preferred MFA methods 3. Create an authentication policy for your Teable application # OneLogin SSO Source: https://help.teable.ai/en/basic/sso/onelogin Configure OneLogin as your SSO authentication provider for Teable Available for Business plan and above ## Step 1: Create Authentication Provider in Teable 1. Navigate to your Teable SSO settings 2. Create a new authentication provider and name it **OneLogin** and select **OpenID Connect** ## Step 2: Access OneLogin Admin Portal 1. Log in to your [OneLogin Admin Portal](https://app.onelogin.com/login) 2. Ensure you have administrator privileges 3. Navigate to **Applications** in the top menu ## Step 3: Add a New Application 1. Click **Applications** → **Applications** in the menu 2. Click **Add App** button 3. Search for **OpenId Connect (OIDC)** in the search box 4. Select **OpenId Connect (OIDC)** from the results 5. Click **Save** ## Step 4: Configure Application Settings ### Display Information In the **Configuration** tab: 1. **Display Name**: Teable SSO 2. **Description**: (Optional) SSO integration for Teable 3. **Logo**: (Optional) Upload Teable logo 4. Click **Save** ### Configuration Settings Go to the **Configuration** tab and configure: 1. **Redirect URIs**: Paste the **Callback URL** from Teable 2. **Login Url**: (Optional) `https://app.teable.ai` 3. **Application Type**: Web 4. Click **Save** ## Step 5: Get Client Credentials Go to the **SSO** tab: 1. Find the **Client ID** field and copy the value 2. Find the **Client Secret** field and copy the value (you may need to click "Show" first) 3. Paste both values into the Teable SSO configuration Keep your Client Secret secure. You can regenerate it if needed from this page. ## Step 6: Configure OAuth Endpoints In the **SSO** tab, you'll find your OneLogin subdomain. Use it to configure the endpoints in Teable: * **Authorization URL**: `https://{subdomain}.onelogin.com/oidc/2/auth` * **Token URL**: `https://{subdomain}.onelogin.com/oidc/2/token` * **User Info URL**: `https://{subdomain}.onelogin.com/oidc/2/me` * **Issuer**: `https://{subdomain}.onelogin.com/oidc/2` Replace `{subdomain}` with your actual OneLogin subdomain (e.g., `mycompany.onelogin.com`). You can find this in your OneLogin portal URL. ## Step 7: Configure Application Access ### Assign Roles Go to the **Access** tab: 1. **Roles**: Select which roles should have access to this application 2. You can select: * Specific roles * All users * Custom conditions 3. Click **Save** ### Assign Users Go to the **Users** tab: 1. Click **Add Users** or **Add Users by Role** 2. Select the users who should have access to Teable via SSO 3. Click **Continue** and **Save** ## Step 8: Configure Parameters (Optional) Go to the **Parameters** tab to map user attributes: 1. Click **Add parameter** to create custom claims 2. Configure standard OIDC claims: * **email**: User email address * **name**: User full name * **given\_name**: User first name * **family\_name**: User last name 3. Map each parameter to the corresponding OneLogin user field 4. Click **Save** ## Step 9: Enable the Application 1. Make sure all configurations are saved 2. The application should now be enabled and visible to assigned users 3. Users will see the Teable app in their OneLogin portal ## Step 10: Test SSO Login You have three options to enable SSO login: **Option 1: Direct Authentication URL** * Use the authorization URL as your SSO login URL **Option 2: OneLogin Portal** * Users can log in to their OneLogin portal and click the Teable application icon **Option 3: Domain Verification** 1. In Teable, configure domain verification 2. Verify your custom domain 3. Visit [https://app.teable.ai](https://app.teable.ai) 4. Click the SSO login button 5. Enter your email address under the verified domain to log in ## Additional Configuration (Optional) ### Configure MFA 1. In OneLogin Admin Portal, go to **Security** → **Multi-Factor Authentication** 2. Enable MFA policies for your organization or specific users 3. Configure MFA requirements (e.g., always require, require for new devices) ### Set Up Provisioning (SCIM) If you want to automatically provision users from OneLogin to Teable: 1. Go to the **Provisioning** tab in your Teable application 2. Enable provisioning 3. Configure the SCIM endpoint (if Teable supports SCIM) 4. Map user attributes 5. Enable user creation, updates, and deletion ### Configure Session Duration 1. Go to **Settings** → **Sessions** in OneLogin 2. Configure session timeout settings 3. Set idle timeout and maximum session duration ### Custom Branding 1. Go to **Customization** → **Portal** in OneLogin 2. Customize the OneLogin portal appearance 3. Add your company logo, colors, and custom CSS 4. This affects what users see when they log in to OneLogin # Single Sign-On (SSO) Source: https://help.teable.ai/en/basic/sso/overview Configure SSO for a Teable space. Available for Business plan and above ## Overview In Teable Cloud, enter the target space: 1. Click `···` in the upper-right corner of the space 2. Open **Space Settings** 3. Go to **Authentication** 4. Add or manage an SSO provider ## Supported Identity Providers Configure SSO using Microsoft Azure Entra ID (formerly Azure Active Directory) Configure SSO using Okta identity platform Configure SSO using Google Workspace accounts Configure SSO using Auth0 identity platform Configure SSO using OneLogin identity management Configure SSO using Authentik open-source identity provider ## How It Works All integrations use the **OpenID Connect (OIDC)** protocol based on OAuth 2.0: 1. User clicks SSO login on Teable 2. User is redirected to your identity provider 3. User authenticates with their credentials 4. Identity provider sends user information back to Teable 5. User is logged into Teable ## For Self-Hosted Users If you're running a self-hosted instance, you can configure any OIDC-compatible identity provider: Configure OIDC authentication for your self-hosted instance # Teable vs Excel Source: https://help.teable.ai/en/compare/teable-vs-excel Compare Teable's modern database capabilities with Excel's spreadsheet functionality. Discover which solution better handles data security, collaboration at scale, and complex analytics for your business needs. ## Database vs Spreadsheet: Key Differences Explained When managing business data, understanding the distinction between modern database solutions like Teable and traditional spreadsheets like Excel is crucial. Here's our comprehensive comparison: ### 1. Data Security and Access Control Teable provides enterprise-grade security with: * Granular user permissions * Role-based access controls * Audit trails for data changes Excel offers basic password protection but lacks: * User-specific access levels * Change tracking at scale * Enterprise authentication integration ### 2. Collaborative Data Management For team-based workflows: * **Teable** enables real-time collaboration with: * Simultaneous multi-user editing * Conflict-free merge operations * Version history tracking * **Excel** requires manual reconciliation of: * Conflicting document versions * Disconnected file sharing * Email-based collaboration ### 3. Handling Large Datasets Teable's database architecture supports: * Millions of records with consistent performance * Advanced indexing for fast queries * Automatic memory optimization Excel struggles with: * Performance degradation beyond 100k rows * Manual optimization requirements * Frequent crashes with complex calculations ### 4. Advanced Data Operations Teable enables professional data workflows through: * SQL query support * Cross-table relationships * Automated data pipelines * BI tool integrations (Tableau, Power BI) Excel limits users to: * Basic formulas and pivot tables * Manual data imports/exports * Static chart generation ### 5. Data Integrity and Compliance Teable ensures accuracy with: * Custom validation rules * Type enforcement * Audit-compliant versioning * Automatic backups Excel risks include: * Human entry errors * Version confusion * Manual backup dependencies ## When to Choose Which Solution **Opt for Teable when:** * Managing sensitive business data * Collaborating across teams/departments * Processing >100,000 records * Requiring real-time analytics **Use Excel for:** * Personal data analysis * Quick ad-hoc calculations * Small datasets * Simple visualizations ## FAQ: Common User Questions **Q: Can Teable replace Excel entirely?**\ A: While Teable handles complex data operations better, Excel remains useful for quick personal analysis. **Q: How difficult is transitioning from Excel to Teable?**\ A: Teable offers spreadsheet-like interfaces alongside database features, making transition smooth for Excel users. **Q: Which offers better value for teams?**\ A: Teable's collaboration features and centralized data management typically provide better ROI for growing organizations. # Subscribe and Activate License Source: https://help.teable.ai/en/deploy/activate Learn how to buy, subscribe, and activate a Teable self-hosted license. Get your license key and unlock premium features for your self-hosted deployment. This guide will walk you through the process of subscribing to a Teable self-hosted plan and activating your license. ## Overview Teable offers different plans for self-hosted deployments, each with its own set of features. To unlock these features, you need to first install Teable, get your Instance ID, subscribe to a plan, and then activate your instance with a license key. ## Step 1: Install Teable Before subscribing to a plan, you need to have Teable installed and running on your server. If you haven't installed Teable yet, please follow one of these installation guides: * [Docker Deployment](/en/deploy/docker) (Recommended for quick setup) * [Full-featured platform](/en/deploy/architecture) (AI features and App Builder, Docker or Kubernetes) Make sure your Teable instance is up and running before proceeding to the next steps. ## Step 2: Access the Admin Panel After successfully installing Teable: 1. Log in to your self-hosted Teable instance 2. Navigate to the **Admin Panel** 3. You can access the Admin Panel from the user menu If this is your first time opening the instance, sign up on the instance URL first. Teable does not provide a default administrator account; the first registered user becomes the instance administrator. Admin Panel entry ## Step 3: Copy Your Instance ID In the Admin Panel, navigate to **Self-hosted License** to find your unique Instance ID: 1. Go to **Admin Panel** → **Self-hosted License** 2. Click the **Copy** button to copy your Instance ID 3. Keep this Instance ID ready - you'll need it during the subscription process Copy the Instance ID from the Self-hosted License page Copy the Instance ID from the Self-hosted License page Your Instance ID is a unique identifier for your self-hosted installation. It's required to bind your license to your specific instance. ## Step 4: Subscribe to a Plan Now that you have your Instance ID, you can proceed to subscribe: 1. Visit the [Teable Self-Hosted Pricing Page](https://app.teable.ai/public/pricing?host=self-hosted) 2. Compare features across different plans 3. Choose the plan that meets your requirements 4. Complete the subscription process 5. During subscription, you'll be asked to provide your **Instance ID** Enter the Instance ID during subscription 6. After successful subscription, you'll receive a **License Key** License detail after subscription Make sure to copy your License Key immediately after subscription. You'll need it in the next step. ## Step 5: Activate Your License Once you have your License Key, return to your Teable instance to activate it: 1. Go back to the **Admin Panel** in your self-hosted Teable instance 2. Navigate to **Self-hosted License** section 3. Paste your **License Key** into the activation field 4. Click the activation button 5. Wait for the confirmation message License activation confirmation After successful activation, your instance will immediately have access to all features included in your subscribed plan. ## Step 6: Manage Your License You can view and manage your licenses at any time: * Visit the [License Management Page](https://app.teable.ai/setting/license) * Here you can: * View all your active licenses * Check license expiration dates * Renew or upgrade your licenses * View usage details * Manage multiple instances if you have more than one ## Auto-renew Your License When registering or updating a license in **Admin Panel** → **Self-hosted License**, turn on **Auto-renew** if your instance can reach the Teable license server: Teable tests the connection before saving the setting, renews the license after each billing period, shows administrators a banner with **Retry** if renewal fails, and still requires manual updates when the instance cannot reach Teable Cloud. ## Frequently Asked Questions No, your Instance ID remains constant throughout application updates. It's a permanent identifier for your self-hosted installation. When migrating environments, perform a complete database migration. This ensures your Instance ID remains unchanged, as the Instance ID is stored in the database. Simply migrate your entire PostgreSQL database to the new environment. If your **billable user count** exceeds the subscribed seats in a paid plan, usage will be restricted and users will receive blocking notifications when attempting to access features. To restore full functionality, you'll need to upgrade your subscription to accommodate more seats. **Billable users** are counted at the **instance level** and include users with **Editor** role or higher (Owner, Creator, Editor). Users with **Commenter** or **Viewer** (Read-only) roles are free and do not count towards your seat limit. Administrators can disable "Allow everyone to create new spaces" in **Admin Panel** → **Instance settings** to prevent users from creating spaces that add billable collaborators. When your subscription expires, your Teable instance will revert to the basic version. However, all your data will be preserved and remain safe. Once you renew and reactivate your subscription, all premium features will be immediately restored. Teable provides a 7-day grace period after subscription expiration. During this grace period: * All features remain fully functional * Administrators receive email reminders * You have time to renew without service interruption We recommend renewing before the grace period ends to ensure uninterrupted access to premium features. For Docker Compose deployments, you have several backup options: **Option 1: Full Virtual Machine Backup** (Recommended for simplicity) * Regularly backup the entire virtual machine hosting Teable * Provides complete system recovery capability **Option 2: Docker Volume Backup** * Backup all Docker volumes defined in your `docker-compose.yaml` * Use `docker volume ls` to list volumes * Use `docker run --rm -v :/data -v $(pwd):/backup alpine tar czf /backup/.tar.gz /data` **Option 3: Component-Level Backup** (Recommended for granular control) * **PostgreSQL database**: Backup using `pg_dump` (contains all table data) ```bash theme={null} docker exec teable-db pg_dump -U teable teable > backup.sql ``` * **Redis database**: Backup RDB file (contains automation queue data) ```bash theme={null} docker exec teable-cache redis-cli --rdb /data/dump.rdb ``` * **Data directory**: Backup the `teable-data` volume (contains all attachment files) For production environments, we recommend setting up automated daily backups with retention policies. ## Troubleshooting If your license activation fails, please check: * The License Key is copied correctly without extra spaces * The license hasn't expired If issues persist, contact support at [support@teable.ai](mailto:support@teable.ai) If features don't appear immediately after activation: * Try refreshing your browser * Clear your browser cache * Verify the activation status in the License Management Page * Check that your subscription is active and not expired ## Next Steps After activating your license, you can: * Configure additional features available in your plan * Set up team members and permissions * Explore enterprise features For more information on deployment and configuration, see: * [Docker Deployment](/en/deploy/docker) * [Environment Configuration](/en/deploy/env) * [Email Configuration](/en/deploy/email) # Architecture Source: https://help.teable.ai/en/deploy/architecture Deploying Teable gives you four platforms in one: a secure agent sandbox, a resource-efficient app deployment platform, an AI workflow engine, and a full-featured collaboration platform on PostgreSQL. Self-hosting Teable deploys four platforms in one: * **A secure, scalable agent sandbox** — every AI session runs in its own isolated container, started on demand and gone when the session ends. * **A resource-efficient app deployment platform** — every app your team builds and publishes runs as its own lightweight, long-lived container. * **An AI workflow engine** — automations triggered by record changes, schedules, and webhooks, with AI steps, running right where your data lives. * **A full-featured database collaboration platform on PostgreSQL** — tables, views, and API. Self-hosting Teable wraps your own compute into an **agent-ready, fully controlled productivity environment** — putting AI in the hands of everyone on your team. This page explains the services behind this and how they fit together. The deployable assets (compose files, Helm chart, values) live in [teableio/teable-deployment](https://github.com/teableio/teable-deployment). AI features are available for self-hosted Business plan and above. ## What a deployment runs | Service | Purpose | | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Teable app** | Web UI, API, automations, AI chat — a single image: `ghcr.io/teableio/teable` | | **PostgreSQL** | The main database: all your tables, views, and metadata | | **Redis** | Cache, queues, realtime collaboration | | **Object storage** | S3-compatible file storage with three buckets: **public** (avatars and other public assets), **private** (attachments), **build artifacts** (App Builder output) | | **Infra Service** | The single entry point the Teable app connects to; coordinates builds and app deployments, with its own console and API | | **Sandbox engine** | Runs every AI session in its own isolated container | | **Git registry** | Stores the source code of the apps you build (App Builder pushes here) | | **Preview gateway** | Routes browsers to sandbox previews and deployed apps | The last four make up the runtime plane. The deployment assets install all of this as one platform. ## How it fits together ```mermaid theme={null} graph LR U["Browser"] subgraph "App & data" T["Teable app"] P[("PostgreSQL")] R[("Redis")] S[("Object storage")] end subgraph "Runtime plane" I["Infra Service"] E["Sandboxes — one per AI session"] A["Deployed apps — one container each"] G["Git registry"] W["Preview gateway"] end U --> T T --> P T --> R T -- "attachments" --> S T -- "AI sessions" --> I I -- "starts" --> E I -- "deploys" --> A E -. "source" .-> G E -. "artifacts" .-> S U -- "sandbox previews" --> W U -- "deployed apps" --> W W --> E W --> A style T fill:#0D9373,stroke:#0a7a5e,color:#fff style E fill:#F59E0B,stroke:#b45309,color:#fff style A fill:#F59E0B,stroke:#b45309,color:#fff ``` The Teable app talks to the runtime plane through **one connection**: the Infra Service (`TEABLE_INFRA_API_URL` / `TEABLE_INFRA_API_KEY`). Everything behind it is internal. Two kinds of workload do the real work — and they are what consume your machine: * **Sandboxes.** Every AI chat or App Builder session gets its own isolated container, started when the session begins and removed when it ends. This is the platform's main load, and it arrives in bursts: size your machine by **peak concurrent AI sessions**, not by user count (per-sandbox resource limits can be set in the admin panel). * **Deployed apps.** Every app someone publishes runs as its own long-lived container, served at `*.app.`. Sandboxes come and go; deployed apps add up and keep running. The other services play supporting roles: building happens inside the session's sandbox, the git registry and object storage keep what it produces (source code and build artifacts), and the gateway routes each browser request to the right sandbox or app. ## One domain, four DNS records Everything is served under **one base domain** — typically a subdomain of yours, such as `teable.example.com`: | Record | Serves | | -------------------- | ---------------------------------------------------------------------------------------------------------- | | `` | The Teable app | | `infra.` | The Infra Service console and API; git (`/git`) and object storage are also served from paths on this host | | `*.app.` | Apps you built and deployed | | `*.sandbox.` | Sandbox previews in the browser | Each name is only a default, and every hostname can be overridden individually (see the values example in the deployment repository). ## Versioning The platform ships as **platform releases** (`v..`) of the deployment repository: * A release **tag** is a verified snapshot: `versions.yaml` locks the exact version of every component, and the repository's `CHANGELOG.md` says what changed and what, if anything, you must do. * The repository's `main` branch is the rolling latest. * The bundled **doctor** script compares what your deployment actually runs against the release and reports one of three results: compatible, upgrade the Teable app, or an unknown (unverified) combination. The Teable app has its own release line (date-based tags; `latest` is the stable channel) — see [Version Upgrade](/en/deploy/upgrade). Each platform release states which app versions it has been verified with, and the doctor checks this for you. The sandbox agent behind AI sessions always follows the app's version on its own — there is nothing extra to upgrade or manage. ## Deploy it Both paths install the whole platform and are covered end to end in the deployment repository: Everything on one machine — first full deployment, `local` or `server` mode. A single Helm chart on an existing cluster; only `global.baseDomain` is required. Don't need AI yet? You can run just the app with PostgreSQL, Redis, and storage — a **standalone** deployment ([Docker Deployment](/en/deploy/docker)) — and attach the runtime plane later with your data in place. Related topics, all maintained in the deployment repository: * **Already running standalone Teable?** Your data stays in place — the runtime plane installs next to it: [migration guide](https://github.com/teableio/teable-deployment/blob/main/migration/2026-07-basic-to-full-featured.md) * **Company-internal certificates?** If your domain uses a private or corporate CA, sandboxes need to be told to trust it — [private-ca.md](https://github.com/teableio/teable-deployment/blob/main/helm/private-ca.md) * **Sizing, versions and mirrors**: [VERSIONS.md](https://github.com/teableio/teable-deployment/blob/main/VERSIONS.md) · [images/README.md](https://github.com/teableio/teable-deployment/blob/main/images/README.md) * **When something fails**: run the doctor first, then [TROUBLESHOOTING.md](https://github.com/teableio/teable-deployment/blob/main/TROUBLESHOOTING.md) After deploying, connect the Teable app to the runtime plane with `TEABLE_INFRA_API_URL` / `TEABLE_INFRA_API_KEY` (the deployment guides cover this), then set resource limits in [Admin Panel → Sandbox Agent](/en/basic/admin-panel/sandbox-agent). # Deployment Source: https://help.teable.ai/en/deploy/choose Pick between Teable Cloud, standalone self-hosting, and the full-featured self-hosted platform. Three ways to run Teable — pick by what you need: | | **Teable Cloud** | **Full-featured self-host** | **Standalone self-host** | | -------------------------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | | Tables, collaboration, API, automation | ✅ | ✅ | ✅ | | AI features (chat, agents) | ✅ | ✅ | ❌ | | App Builder (build & deploy apps) | ✅ | ✅ | ❌ | | Sandboxes / previews | ✅ | ✅ | ❌ | | Runs on | [teable.ai](https://teable.ai) — nothing to deploy | one machine (Docker) or a Kubernetes cluster | one machine: app + PostgreSQL | | Start here | [teable.ai](https://teable.ai) | [Architecture](/en/deploy/architecture) → [teableio/teable-deployment](https://github.com/teableio/teable-deployment) | [Docker Deployment](/en/deploy/docker) | **Already running Teable?** Upgrading an existing deployment to the full-featured platform is covered step by step by the [migration guide](https://github.com/teableio/teable-deployment/blob/main/migration/2026-07-basic-to-full-featured.md) in the deployment repository: the runtime plane installs next to your existing Teable, and your data stays in place. ## Let an AI agent deploy it The deployment repository is written to be driven by AI agents. Point your agent harness (Claude Code, Codex, …) at [teableio/teable-deployment](https://github.com/teableio/teable-deployment), tell it which environment you're deploying to, and it can take the deployment end to end. Prepare three things: 1. **A domain** — everything derives from one base domain, e.g. `teable.example.com`. 2. **A DNS token** — an API token for the platform hosting your DNS (Cloudflare, Route 53, …), so DNS records and TLS certificates can be set up automatically. Scope it to that one zone. 3. **Access to the deployment target:** | Target | What to hand the agent | | -------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | Your own machine — Docker all-in-one, `local` mode | Just Docker on the machine — no domain or DNS token needed (everything runs on `*.localhost`) | | A cloud server — Docker all-in-one | SSH access to the machine | | A managed cluster on AWS (EKS) / GCP (GKE) / Azure (AKS) | Create the cluster, then hand over its `kubeconfig` | | Any existing Kubernetes cluster | A `kubeconfig` that can install Helm releases | That's all it takes — the repository's guides, doctor scripts, and version manifests carry the agent through the rest. # Configure Email Service Source: https://help.teable.ai/en/deploy/email Enable email service to activate in-app email notifications, self-service password reset, invitation emails, and other features. ## Configuration Methods Teable supports two ways to configure email service: Visual configuration with live testing. No restart required. Traditional configuration via `.env` file. Requires container restart. *** ## Option 1: Admin Panel (Recommended) The easiest way to configure email is through the Admin Panel: 1. Log in as an administrator (the first registered user) 2. Go to **Admin Panel** → **Instance settings** 3. Find the **Email** section 4. Configure **Notify email** and **Automation email** as needed The Admin Panel configuration supports **live testing** — you can verify your SMTP settings work before saving. * **Notify email**: Used for user verification, password reset, invitations, system notifications, and similar emails. * **Automation email**: Used as the default mail service for automation Send Email actions. A single Send Email action can also configure its own [custom SMTP server](/en/basic/automation/actions/communication/smtp-sender). ### Configuration sources and priority We recommend configuring mail service in **Admin Panel → Instance settings → Email** first. The effective priority is: 1. **Custom mail server inside the Send Email action**: Applies only to that specific Send Email action in the current automation. 2. **Admin Panel → Instance settings → Email → Automation email**: Used by automation emails when the Send Email action does not configure its own mail server. 3. **Admin Panel → Instance settings → Email → Notify email**: Used for user verification, password reset, invitations, system notifications, and similar emails. It is also used as the fallback for automation emails if Automation email is not configured. 4. **`BACKEND_MAIL_*` environment variables**: Deployment-level default mail configuration. Used only as a fallback when the corresponding mailbox is not configured in the Admin Panel. ### Configuration Fields | Field | Description | Example | | -------------- | ----------------------------- | -------------------------- | | Server address | SMTP server address | `smtp.gmail.com` | | Port | SMTP port | `465` (SSL) or `587` (TLS) | | SSL/TLS | Whether to use SSL/TLS | `true` | | Username | SMTP authentication user | `noreply@company.com` | | Password | SMTP password or app password | `xxxxxxxxxxxxxx` | | Sender address | From address | `noreply@company.com` | | Sender name | Display name | `Teable Notification` | *** ## Option 2: Environment Variables For deployments where you prefer file-based configuration, use environment variables: We recommend configuring Notify email and Automation email in **Admin Panel → Instance settings → Email** first. Environment variables are mainly used as deployment-level defaults and fallback configuration. ```sh theme={null} BACKEND_MAIL_HOST=smtp.example.com BACKEND_MAIL_PORT=465 BACKEND_MAIL_SECURE=true BACKEND_MAIL_SENDER=noreply@company.com BACKEND_MAIL_SENDER_NAME=Teable BACKEND_MAIL_AUTH_USER=username BACKEND_MAIL_AUTH_PASS=your_password ``` After changing environment variables, you must **restart** the Teable container for changes to take effect. *** ## SMTP Provider Examples ```sh theme={null} # How to obtain: AWS Console → Simple Email Service → SMTP Settings → Create SMTP Credentials BACKEND_MAIL_HOST=email-smtp.us-east-1.amazonaws.com # Replace with your region BACKEND_MAIL_PORT=465 BACKEND_MAIL_SECURE=true BACKEND_MAIL_SENDER=noreply@yourdomain.com # Must be a verified sender address BACKEND_MAIL_SENDER_NAME=Teable Notification BACKEND_MAIL_AUTH_USER=your_smtp_username # AWS SMTP username BACKEND_MAIL_AUTH_PASS=xxxxxxxxxxxxxx # AWS SMTP password ``` ```sh theme={null} # How to obtain: Google Account → Security → 2-Step Verification → App Passwords BACKEND_MAIL_HOST=smtp.gmail.com BACKEND_MAIL_PORT=465 BACKEND_MAIL_SECURE=true BACKEND_MAIL_SENDER=you@gmail.com BACKEND_MAIL_SENDER_NAME=Teable Notification BACKEND_MAIL_AUTH_USER=you@gmail.com BACKEND_MAIL_AUTH_PASS=xxxxxxxxxxxxxx # 16-digit app password ``` ```sh theme={null} # How to obtain: Microsoft 365 admin center → Security → Policies & rules → Email authentication BACKEND_MAIL_HOST=smtp.office365.com BACKEND_MAIL_PORT=587 BACKEND_MAIL_SECURE=true BACKEND_MAIL_SENDER=your.name@yourdomain.com BACKEND_MAIL_SENDER_NAME=Teable Notification BACKEND_MAIL_AUTH_USER=your.name@yourdomain.com BACKEND_MAIL_AUTH_PASS=xxxxxxxxxxxxxx # Your Microsoft 365 password or app password ``` ```sh theme={null} # How to obtain: SendGrid Dashboard → Settings → API Keys → Create API Key BACKEND_MAIL_HOST=smtp.sendgrid.net BACKEND_MAIL_PORT=465 BACKEND_MAIL_SECURE=true BACKEND_MAIL_SENDER=noreply@yourdomain.com BACKEND_MAIL_SENDER_NAME=Teable Notification BACKEND_MAIL_AUTH_USER=apikey BACKEND_MAIL_AUTH_PASS=xxxxxxxxxxxxxx # Your SendGrid API Key ``` *** ## Related Documentation * [Environment Variables Reference](/en/deploy/env) * [Admin Panel Overview](/en/basic/admin-panel/overview) # Environment Variables Source: https://help.teable.ai/en/deploy/env Here are all available environment variables in Teable and their explanations | Environment Variable | Description | Default Value | Required | Example | | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -------- | -------------------------------------------------------------------------------------------- | | **Core Configuration** | | | | | | PUBLIC\_ORIGIN | Public origin for generating complete URLs, must be set to your app's access address | - | Yes | [https://app.teable.ai](https://app.teable.ai) | | SECRET\_KEY | Root secret for JWTs, sessions, and sharing. Generate a strong random value | - | Yes | `openssl rand -base64 32` | | BACKEND\_JWT\_SECRET | Signs auth, share, and plugin JWTs. Falls back to SECRET\_KEY | SECRET\_KEY | - | `openssl rand -base64 32` | | BACKEND\_SESSION\_SECRET | Signs login session cookies. Falls back to SECRET\_KEY | SECRET\_KEY | - | `openssl rand -base64 32` | | BACKEND\_STORAGE\_ENCRYPTION\_KEY | Encrypts attachment access tokens. Required when BACKEND\_STORAGE\_PROVIDER is `local` | - | Yes | 16-char random string | | BACKEND\_STORAGE\_ENCRYPTION\_IV | Encryption IV paired with BACKEND\_STORAGE\_ENCRYPTION\_KEY | - | Yes | 16-char random string | | BACKEND\_ACCESS\_TOKEN\_ENCRYPTION\_KEY | Encrypts personal access tokens | - | Yes | 16-char random string | | BACKEND\_ACCESS\_TOKEN\_ENCRYPTION\_IV | Encryption IV paired with BACKEND\_ACCESS\_TOKEN\_ENCRYPTION\_KEY | - | Yes | 16-char random string | | PORT | Port on which the application runs | 3000 | - | 3000 | | LOG\_LEVEL | Log level, options: fatal, error, warn, info, debug, trace | info | - | debug | | **Storage Configuration** | | | | | | BACKEND\_STORAGE\_PROVIDER | Storage provider, options: local, minio, s3, aliyun | local | - | s3 | | BACKEND\_STORAGE\_LOCAL\_PATH | Local storage path | .assets/uploads | - | .assets/uploads | | BACKEND\_STORAGE\_PUBLIC\_BUCKET | Public bucket name | public | - | teable-public | | BACKEND\_STORAGE\_PRIVATE\_BUCKET | Private bucket name for attachments, app files, archived data, and other protected content | private | - | teable-private | | BACKEND\_STORAGE\_PUBLIC\_URL | Public URL override for public bucket (optional) | - | - | [https://cdn.example.com](https://cdn.example.com) | | BACKEND\_STORAGE\_PRIVATE\_BUCKET\_ENDPOINT | Private bucket endpoint override (optional) | - | - | [https://private-bucket.endpoint](https://private-bucket.endpoint) | | BACKEND\_STORAGE\_S3\_REGION | S3 storage region, required when BACKEND\_STORAGE\_PROVIDER is s3 | - | - | us-east-2 | | BACKEND\_STORAGE\_S3\_ENDPOINT | S3 storage endpoint, required when BACKEND\_STORAGE\_PROVIDER is s3 | - | - | [https://s3.us-east-2.amazonaws.com](https://s3.us-east-2.amazonaws.com) | | BACKEND\_STORAGE\_S3\_INTERNAL\_ENDPOINT | S3 internal endpoint (optional) | - | - | [http://s3.internal](http://s3.internal) | | BACKEND\_STORAGE\_S3\_FORCE\_PATH\_STYLE | Use path-style URLs (`endpoint/bucket/key`) for browser-facing S3 requests. Enable this when the public endpoint cannot serve bucket subdomains. Cannot be combined with BACKEND\_STORAGE\_PRIVATE\_BUCKET\_ENDPOINT | false | - | true | | BACKEND\_STORAGE\_S3\_INTERNAL\_FORCE\_PATH\_STYLE | Override path-style addressing for internal S3 requests. When unset, it inherits the public setting if both clients share an endpoint; a separate internal endpoint keeps virtual-hosted addressing | - | - | true | | BACKEND\_STORAGE\_S3\_ACCESS\_KEY | S3 storage access key, required when BACKEND\_STORAGE\_PROVIDER is s3 | - | - | your\_access\_key | | BACKEND\_STORAGE\_S3\_SECRET\_KEY | S3 storage secret key, required when BACKEND\_STORAGE\_PROVIDER is s3 | - | - | your\_secret\_key | | BACKEND\_STORAGE\_S3\_MAX\_SOCKETS | S3 max sockets (optional) | 100 | - | 100 | | BACKEND\_STORAGE\_MINIO\_ENDPOINT | MinIO storage endpoint | - | - | minio.example.com | | BACKEND\_STORAGE\_MINIO\_PORT | MinIO port | 9000 | - | 443 | | BACKEND\_STORAGE\_MINIO\_USE\_SSL | Whether MinIO uses SSL | false | - | true | | BACKEND\_STORAGE\_MINIO\_ACCESS\_KEY | MinIO access key | - | - | access-key | | BACKEND\_STORAGE\_MINIO\_SECRET\_KEY | MinIO secret key | - | - | secret-key | | BACKEND\_STORAGE\_MINIO\_INTERNAL\_ENDPOINT | MinIO internal endpoint (optional, no HTTPS) | - | - | minio.internal | | BACKEND\_STORAGE\_MINIO\_INTERNAL\_PORT | MinIO internal port (optional) | 9000 | - | 9000 | | BACKEND\_STORAGE\_MINIO\_REGION | MinIO region (optional) | - | - | us-east-1 | | BACKEND\_STORAGE\_UPLOAD\_METHOD | Upload method | put | - | put | | STORAGE\_PREFIX | Storage prefix, defaults to PUBLIC\_ORIGIN | PUBLIC\_ORIGIN | - | [http://localhost:3000](http://localhost:3000) | | **Cache Configuration** | | | | | | BACKEND\_CACHE\_PROVIDER | Cache provider, options: sqlite, memory, redis | sqlite | - | redis | | BACKEND\_CACHE\_REDIS\_URI | Required Redis connection URI for computed task delivery; also used for cache when BACKEND\_CACHE\_PROVIDER is redis | - | Yes | redis\://default:teable\@127.0.0.1:6379/0 | | **Performance Cache Configuration** | | | | | | BACKEND\_PERFORMANCE\_CACHE | Performance cache Redis URL for query result caching, improves multi-user collaboration efficiency. Recommended to use separate Redis instance from BACKEND\_CACHE\_REDIS\_URI | - | - | redis\://default:teable\@127.0.0.1:6379/0 | | **Authentication Configuration** | | | | | | SOCIAL\_AUTH\_PROVIDERS | List of social auth providers, comma-separated | - | - | github,google,oidc | | BACKEND\_GITHUB\_CLIENT\_ID | GitHub OAuth client ID | - | - | github\_client\_id | | BACKEND\_GITHUB\_CLIENT\_SECRET | GitHub OAuth client secret | - | - | github\_client\_secret | | BACKEND\_GOOGLE\_CLIENT\_ID | Google OAuth client ID | - | - | google\_client\_id | | BACKEND\_GOOGLE\_CLIENT\_SECRET | Google OAuth client secret | - | - | google\_client\_secret | | BACKEND\_OIDC\_CLIENT\_ID | OIDC client ID | - | - | google\_client\_id | | BACKEND\_OIDC\_CLIENT\_SECRET | OIDC client secret | - | - | google\_client\_secret | | BACKEND\_OIDC\_CALLBACK\_URL | OIDC callback URL | - | - | [https://app.teable.ai/api/auth/oidc/callback](https://app.teable.ai/api/auth/oidc/callback) | | **Security & Verification** | | | | | | TURNSTILE\_SITE\_KEY | Cloudflare Turnstile site key for authentication verification | - | - | 1x00000000000000000000AA | | TURNSTILE\_SECRET\_KEY | Cloudflare Turnstile secret key for authentication verification | - | - | 1x0000000000000000000000000000000AA | | TEABLE\_SSRF\_PROTECTION\_DISABLED | Disable protection that blocks outbound requests to loopback, private, link-local, and other reserved network addresses. Set to true only in trusted self-hosted deployments that must access internal endpoints | false | - | true | | BACKEND\_SIGNUP\_VERIFICATION\_CODE\_RATE\_LIMIT\_SECONDS | Rate limit interval (seconds) for sending signup verification emails | - | - | 30 | | BACKEND\_TRUST\_PROXY | Reverse proxy trust setting used to resolve the client IP behind a proxy. Affects audit logs and related security records. Accepts `true`, `false`, a hop count, or an IP/CIDR/preset list. Empty trusts private-network proxies | loopback, linklocal, uniquelocal | - | loopback, linklocal, uniquelocal | | **Email Configuration (Deprecated - Use Admin Panel > Instance settings > Email)** | | | | | | BACKEND\_MAIL\_HOST | Default mail server address. We recommend configuring Notify email and Automation email visually in Admin Panel > Instance settings > Email | smtp.teable.ai | - | smtp.gmail.com | | BACKEND\_MAIL\_PORT | Default mail server port | 465 | - | 465 | | BACKEND\_MAIL\_SECURE | Whether the default mail service uses SSL/TLS | true | - | true | | BACKEND\_MAIL\_SENDER | Default sender address | noreply.teable.ai | - | [noreply@company.com](mailto:noreply@company.com) | | BACKEND\_MAIL\_SENDER\_NAME | Default sender name | Teable | - | Teable | | BACKEND\_MAIL\_AUTH\_USER | Default mail server authentication username | - | - | username | | BACKEND\_MAIL\_AUTH\_PASS | Default mail server authentication password | - | - | usertoken | | BACKEND\_MAIL\_INVITE\_USER\_NAME\_MAX\_LENGTH | Maximum inviter name length in invitation email subjects. Empty or 0 disables truncation | - | - | 32 | | BACKEND\_MAIL\_INVITE\_SPACE\_NAME\_MAX\_LENGTH | Maximum space or Base name length in invitation email subjects. Empty or 0 disables truncation | - | - | 32 | | **Session/JWT Configuration** | | | | | | BACKEND\_SESSION\_EXPIRES\_IN | Session expiration time | 7d | - | 7d | | BACKEND\_SESSION\_COOKIE\_SECURE | Whether to secure session cookie | false | - | true | | BACKEND\_SESSION\_ORIGIN\_CHECK\_ENABLED | Enable Origin and Fetch Metadata checks for unsafe browser session-cookie API requests. Enable only when your reverse proxy or CDN preserves these headers | false | - | false | | BACKEND\_JWT\_EXPIRES\_IN | JWT expiration time | 20d | - | 20d | | BACKEND\_RESET\_PASSWORD\_EMAIL\_EXPIRES\_IN | Reset password email expiration time | 30m | - | 30m | | **Resource Limits** | | | | | | MAX\_COPY\_CELLS | Maximum number of cells to copy in a single request | - | - | 50000 | | MAX\_READ\_ROWS | Maximum number of rows to read in a single request | - | - | 10000 | | MAX\_ATTACHMENT\_UPLOAD\_SIZE | Maximum attachment upload size (bytes) | - | - | 2147483648 | | TASK\_MAX\_FIELDS\_PER\_BATCH | Maximum number of AI fields sent to the model in one batch request. Values are clamped from 1 to 20 | 5 | - | 5 | | TASK\_MAX\_CONCURRENCY | Maximum pending AI field task runs dispatched in one scheduling cycle. Values are clamped from 1 to 20 | 5 | - | 5 | | TABLE\_LIMIT\_FIELD\_OPTIONS\_MAX\_BYTES | Maximum serialized field option bytes | 262144 | - | 262144 | | TABLE\_LIMIT\_SELECT\_CHOICES\_MAX | Maximum select choices per select field | 1000 | - | 1000 | | TABLE\_LIMIT\_SELECT\_CHOICE\_NAME\_MAX\_LENGTH | Maximum select choice name length | 1000 | - | 1000 | | TABLE\_LIMIT\_SELECT\_DEFAULT\_VALUES\_MAX | Maximum select default values | 100 | - | 100 | | TABLE\_LIMIT\_CELL\_VALUE\_MAX\_BYTES | Maximum cell value bytes | 262144 | - | 262144 | | TABLE\_LIMIT\_RECORD\_FIELDS\_MAX\_BYTES | Maximum serialized record fields bytes | 1048576 | - | 1048576 | | TABLE\_LIMIT\_RECORDS\_PER\_MUTATION\_MAX | Maximum records per mutation | 20000 | - | 20000 | | TABLE\_LIMIT\_COMPUTED\_CELL\_VALUE\_MAX\_BYTES | Maximum computed cell value bytes | 262144 | - | 262144 | | TABLE\_LIMIT\_FORMULA\_MAX\_LENGTH | Maximum formula length | 8192 | - | 8192 | | TABLE\_LIMIT\_TABLES\_PER\_BASE\_MAX | Maximum tables per base | 1000 | - | 1000 | | TABLE\_LIMIT\_FIELDS\_PER\_TABLE\_MAX | Maximum fields per table | 500 | - | 500 | | TABLE\_LIMIT\_VIEWS\_PER\_TABLE\_MAX | Maximum views per table | 100 | - | 100 | | TABLE\_LIMIT\_CREATE\_TABLE\_FIELDS\_MAX | Maximum fields accepted when creating a table | 1000 | - | 1000 | | TABLE\_LIMIT\_CREATE\_TABLE\_VIEWS\_MAX | Maximum views accepted when creating a table | 20 | - | 20 | | TABLE\_LIMIT\_CREATE\_TABLE\_RECORDS\_MAX | Maximum records accepted when creating a table | 20000 | - | 20000 | | TABLE\_LIMIT\_RECORDS\_PER\_TABLE\_MAX | Maximum rows per table. Empty means no instance-level row limit | - | - | 1000000 | | TABLE\_LIMIT\_VIEW\_FILTER\_ITEMS\_MAX | Maximum filter items in a view | 100 | - | 100 | | TABLE\_LIMIT\_VIEW\_FILTER\_DEPTH\_MAX | Maximum nested filter depth in a view | 5 | - | 5 | | TABLE\_LIMIT\_VIEW\_SORT\_ITEMS\_MAX | Maximum sort items in a view | 20 | - | 20 | | TABLE\_LIMIT\_VIEW\_GROUP\_ITEMS\_MAX | Maximum group items in a view | 3 | - | 3 | | TABLE\_LIMIT\_VIEW\_OPTIONS\_MAX\_BYTES | Maximum serialized view option bytes | 262144 | - | 262144 | | TABLE\_LIMIT\_NAME\_MAX\_LENGTH | Maximum display name length for supported table objects | 100 | - | 100 | | TABLE\_LIMIT\_DESCRIPTION\_MAX\_LENGTH | Maximum description length for supported table objects | 2000 | - | 2000 | | AUTOMATION\_MIN\_SCHEDULED\_MINUTES\_INTERVAL | Shortest interval (minutes) a scheduled trigger may use with the Minutes frequency. Set above 60 to disable minute-level schedules | 10 | - | 15 | | AUTOMATION\_MIN\_EMAIL\_POLL\_INTERVAL\_MINUTES | Shortest mailbox poll interval (minutes) an email trigger may use | 10 | - | 15 | | **AI & App Builder (runtime plane connection)** | | | | | | SANDBOX\_PROVIDER | Sandbox provider for AI sessions; `opensandbox` connects to a self-hosted runtime plane | - | - | opensandbox | | TEABLE\_INFRA\_API\_URL | Runtime plane entry URL — must be the public entry (it routes `/v1` to the sandbox engine), not an internal service address | - | - | [https://infra.teable.example.com](https://infra.teable.example.com) | | TEABLE\_INFRA\_API\_KEY | API key shared with the runtime plane | - | - | your-infra-api-key | | TEABLE\_INFRA\_BUCKET | Bucket for the AI workspace data plane | teable-agent | - | teable-agent | | SANDBOX\_OPENSANDBOX\_IMAGE | Sandbox agent image **prefix without a tag** — Teable appends its own release tag so the agent always matches the app version. China deployments use the Aliyun mirror prefix | - | - | ghcr.io/teableio/teable-sandbox-agent | | SANDBOX\_OPENSANDBOX\_RUNTIME | Sandbox engine runtime type: `kubernetes` or `docker`. Must be `docker` on Docker deployments | kubernetes | - | docker | | SANDBOX\_OPENSANDBOX\_USE\_SERVER\_PROXY | Route sandbox endpoints through the engine's path-based proxy instead of per-port subdomains (used by Docker local mode) | false | - | true | | APP\_DEPLOY\_PROVIDER | App Builder deployment backend; full-featured self-host uses `docker-runtime` | vercel | - | docker-runtime | | SANDBOX\_JWT\_SECRET | Secret signing sandbox sessions. Generate a random value per host, and use the same value in the sandbox service | - | Yes | random string | | SANDBOX\_CPU | vCPUs per sandbox (admin panel settings take precedence) | 2 | - | 2 | | SANDBOX\_MEMORY | Memory (GiB) per sandbox (admin panel settings take precedence) | 4 | - | 4 | | SANDBOX\_DISK | Ephemeral disk (GiB) per sandbox (admin panel settings take precedence) | 15 | - | 15 | | **Feature Toggles** | | | | | | RECORD\_HISTORY\_DISABLED | Whether to disable record history, defaults to false | false | - | true | | BACKEND\_STORAGE\_COLD\_ARCHIVE\_DISABLED | Whether to stop scheduled archiving of historical data. Already-archived data stays readable | false | - | true | | PASSWORD\_LOGIN\_DISABLED | Whether to disable password login (OAuth and OIDC still available) | false | - | true | | V2\_TABLE\_QUERY\_OPS\_ENABLED | Whether to enable Table Query Ops; while off, the **Table Query Ops** admin page has no data. Restart after changing it | false | - | true | | **Analytics & Monitoring** | | | | | | MICROSOFT\_CLARITY\_ID | Microsoft Clarity metrics ID, for enabling Microsoft Clarity analytics | - | - | your-metrics-id | | OTEL\_EXPORTER\_OTLP\_ENDPOINT | OpenTelemetry OTLP endpoint | - | - | [http://jaeger:4317](http://jaeger:4317) | | TELEMETRY\_REPORT\_DISABLED | Disable self-hosted telemetry reporting, including license compliance reports from connected instances | false | - | true | | **Database Configuration** | | | | | | PRISMA\_DATABASE\_URL | Database connection URL, must be configured | - | Yes | postgresql://teable:teable\@127.0.0.1:5432/teable | | PUBLIC\_DATABASE\_PROXY | Externally reachable database address (host:port) used in the credentials generated by the base "Database Connection" panel; set it to enable external read-only SQL access | - | - | db.example.com:42345 | | PRISMA\_TRANSACTION\_TIMEOUT | Maximum time (ms) a transaction can run before timing out. Increase for long-running transactions (e.g., bulk updates with many foreign keys) | 5000 | - | 60000 | | PRISMA\_TRANSACTION\_MAX\_WAIT | Maximum time (ms) to wait to acquire a transaction from the pool | 2000 | - | 5000 | | BIG\_TRANSACTION\_TIMEOUT | Timeout (ms) for large internal transactions, such as exporting large bases | 600000 | - | 1200000 | ## Secrets and rotation Every value above marked as a secret should come from your own configuration. The server checks them once at startup, but a missing secret never blocks startup: Teable falls back to the default built into older versions, logs the missing variables, and starts. Those built-in values are public, so anyone can forge tokens or decrypt data protected by them. That is fine for a quick local try-out and unsafe for anything else. **Upgrading an existing deployment.** An instance that ran without these variables was implicitly using the old built-in values, and still is. The startup warning prints the exact block to add so current sessions, tokens, and encrypted data keep working. Copy it as-is, restart, then plan a rotation. If your configuration format needs it, remember to escape `$` in the values. **New deployment.** Generate fresh values instead: ```bash theme={null} openssl rand -base64 32 ``` Use `openssl rand -hex 8` for the 16-character `*_ENCRYPTION_KEY` and `*_ENCRYPTION_IV` slots. The startup log also warns when a secret is explicitly set to a publicly known former default. The instance keeps running so your data stays reachable, but anyone can forge tokens or decrypt data protected by that value. Rotate it. # OIDC Single Sign-On Source: https://help.teable.ai/en/deploy/oidc Configure OpenID Connect (OIDC) authentication for your self-hosted Teable instance. Teable supports OIDC single sign-on, allowing you to integrate with external identity providers for user authentication. ## Environment Variables To enable OIDC in your self-hosted Teable, configure these environment variables: ```sh theme={null} # Core OIDC Configuration BACKEND_OIDC_CLIENT_ID=your_client_id BACKEND_OIDC_CLIENT_SECRET=your_client_secret BACKEND_OIDC_CALLBACK_URL=https://your-teable-domain.com/api/auth/oidc/callback # OAuth Endpoints (from your IdP) BACKEND_OIDC_AUTHORIZATION_URL=https://your-idp.com/authorize BACKEND_OIDC_TOKEN_URL=https://your-idp.com/token BACKEND_OIDC_USER_INFO_URL=https://your-idp.com/userinfo BACKEND_OIDC_ISSUER=https://your-idp.com # Additional Options BACKEND_OIDC_OTHER={"scope":["email","profile"]} # Enable OIDC as auth provider SOCIAL_AUTH_PROVIDERS=oidc ``` ## Configuration Reference | Variable | Description | | -------------------------------- | ---------------------------------------------------- | | `BACKEND_OIDC_CLIENT_ID` | Client ID from your identity provider | | `BACKEND_OIDC_CLIENT_SECRET` | Client secret from your identity provider | | `BACKEND_OIDC_CALLBACK_URL` | Teable's callback URL (must match IdP configuration) | | `BACKEND_OIDC_AUTHORIZATION_URL` | IdP's authorization endpoint | | `BACKEND_OIDC_TOKEN_URL` | IdP's token endpoint | | `BACKEND_OIDC_USER_INFO_URL` | IdP's user info endpoint | | `BACKEND_OIDC_ISSUER` | IdP's issuer identifier | | `BACKEND_OIDC_OTHER` | Additional options in JSON format (e.g., scopes) | | `SOCIAL_AUTH_PROVIDERS` | Include `oidc` to enable OIDC login button | ## Enabling Multiple Auth Providers You can enable multiple authentication methods: ```sh theme={null} SOCIAL_AUTH_PROVIDERS=github,google,oidc ``` This allows users to log in via GitHub, Google, or your OIDC provider. *** ## Identity Provider Security Requirements Teable trusts the email address returned by your IdP and uses it to automatically link OIDC logins to existing accounts with the same email. The identity provider you connect **must guarantee that user email addresses are verified**. Do not connect identity providers that let users set arbitrary, unverified email addresses (for example, multi-tenant IdPs with open registration). On such providers, an attacker can register an account using the email address of an existing user on your instance and take over that account by signing in via OIDC. This risk is especially acute when local password login is also enabled on the same instance. Recommendations: * Only connect enterprise-grade IdPs under your control (such as Okta, Azure Entra ID, Google Workspace, or Keycloak) with email verification enabled. * If your instance uses SSO exclusively, set [`PASSWORD_LOGIN_DISABLED=true`](/en/deploy/env) to disable local password login and further reduce the attack surface. *** ## Important Notes 1. **HTTPS Required**: All URLs must use HTTPS in production 2. **Callback URL Must Match**: The callback URL in Teable must exactly match what's configured in your IdP 3. **Restart Required**: After changing environment variables, restart Teable for changes to take effect 4. **Secure Storage**: Never commit secrets to version control; use environment variables or secret managers 5. **IdP Must Verify Emails**: See [Identity Provider Security Requirements](#identity-provider-security-requirements) above *** ## Related Documentation * [Environment Variables Reference](/en/deploy/env) # One-Click Cloud Deployment (Deprecated) Source: https://help.teable.ai/en/deploy/one-key Deploy Teable quickly using cloud provider templates, then subscribe to unlock paid features and activate your license. **Deprecated.** One-click templates are no longer a recommended way to deploy Teable — start from [Deployment](/en/deploy/choose). If you already run Teable from one of them, here is what you have and where to go next: these templates give you a **standalone** Teable (app + PostgreSQL + Redis): tables, collaboration, API, and automations, but no AI features. One-click platforms cannot start containers, so the [runtime plane](/en/deploy/architecture) that powers AI sessions, App Builder, and app deployments cannot run on them. Two ways to the full platform: 1. **Keep your platform and attach a runtime plane**: deploy it on a machine you control following the [migration guide](https://github.com/teableio/teable-deployment/blob/main/migration/2026-07-basic-to-full-featured.md), then add the connection environment variables from the guide to your platform service and redeploy. Your data stays in place, and rollback is just removing the variables again. 2. **Migrate to the [standard deployment](/en/deploy/choose)**: back up a PostgreSQL dump plus your uploaded files, restore them into a Docker all-in-one or Kubernetes install, and repoint your domain. ## One-Click Cloud Deployment One-click templates help you bootstrap a Teable environment quickly. After deployment, if you want paid features (for self-hosted plans), you should **subscribe** and **activate your license** using your Instance ID. ## Step 1: Deploy with a template Choose a template below and deploy. [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/NtH5uD?referralCode=rE4BjB) [![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/QF8695) [![Deploy to RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploylobe.svg)](https://repocloud.io/details/?app_id=273) [![Deploy on Elestio](https://elest.io/images/logos/deploy-to-elestio-btn.png)](https://elest.io/open-source/teable) ## Step 2: Subscribe (paid features) If you are deploying **self-hosted** and need paid features, subscribe with your **Instance ID**: 1. Open the Admin Panel in your deployed instance and copy the **Instance ID** 2. Go to the self-hosted pricing page and subscribe: `https://app.teable.ai/public/pricing?host=self-hosted` 3. After subscribing, you will get a **License Key** Then activate it in your instance: * Documentation: [Subscribe and Activate License](/en/deploy/activate) If you are using **Teable Cloud** (hosted by Teable), manage your plan in-app: see [Billing & Subscription](/en/basic/space/billing). ## Need help? If you have questions about subscription or licensing, contact `support@teable.ai`. # Telemetry Source: https://help.teable.ai/en/deploy/telemetry Learn how Teable self-hosted telemetry works, what is reported, and how to disable it. ## Overview License activation can work offline after you obtain and enter a valid License Key. If a self-hosted instance can reach the Internet, it may send a minimal telemetry report for license compliance, security review, fraud prevention, and investigation of unauthorized distributions. This telemetry is separate from optional product analytics. It is designed for self-hosted administration and compliance, similar to common service ping, license validation, and anonymous usage reporting practices in self-managed software. ## What May Be Reported Telemetry reports may include product authorization identifiers such as Instance ID and, when a license is installed, License ID; license plan, seat limit, and expiration dates when available; software edition, application version, build version, image digest, and build channel; aggregated usage counts and buckets; instance last activity time; hashed public origin hostname and hashed machine hostname; platform, CPU architecture, and Node.js version; and compliance risk signals. Product authorization identifiers such as Instance ID and License ID may be sent in their original form because they are used to validate the deployment and license status. Customer or host identifying values such as public origin hostname and machine hostname are hashed before transmission. ## What Is Not Reported Telemetry reports do not include customer workspace content, table records, schema names, field values, SQL queries, application secrets, access credentials, authentication tokens, License Keys, user email lists, user names, or the full public origin URL. ## Transmission and Retention Telemetry reports are encrypted in transit. Teable retains raw telemetry events only for as long as reasonably necessary for license compliance, security review, fraud prevention, dispute handling, and audit purposes. Teable may retain aggregated or derived compliance status for the duration of the customer relationship and any legally required retention period. ## Disable Telemetry Reporting Self-hosted administrators can disable telemetry reporting by setting: ```env theme={null} TELEMETRY_REPORT_DISABLED=true ``` Disabling telemetry reporting does not by itself prevent offline license activation, but may limit Teable's ability to verify license compliance, detect unauthorized distributions, or investigate license disputes. # Version Upgrade Source: https://help.teable.ai/en/deploy/upgrade This document describes how to upgrade a self-hosted Teable deployment. ## Release channels and version tags The Teable app publishes **date-based release tags** in the form `release..` (for example `release.2026-07-14T12-24-39Z.2228`), plus two floating channels: | Tag | Meaning | | ----------------------------- | ------------------------------------------------------------------------ | | `latest` | The **stable** channel — always points at the most recent stable release | | `beta` | The rolling channel — the newest build, ahead of stable | | `release..` | An immutable, specific release | Releases ship frequently (often several per week); you decide when to upgrade. All tags are listed on [GitHub Packages](https://github.com/teableio/teable/pkgs/container/teable). Before performing any upgrade, we strongly recommend backing up your data first. ## Routine updates: follow the changelog New features and fixes are announced in the [Changelog](/en/changelog), and every Teable release tag carries its build date — so "do I have this yet?" is just a date comparison. To pick up something you read about, move your Teable image to any release dated at or after that entry: * **Docker deployments** can simply ride the `latest` channel: ```bash theme={null} cd teable # your deployment directory docker compose pull docker compose up -d ``` Containers are recreated on the new image; your data lives in Docker volumes (or your external database) and is not touched. * **Kubernetes deployments** should not run a floating tag: keep the Teable image pinned and **bump the pinned tag deliberately on each update**. The deployment repository's `pin-image.sh` resolves which concrete release `latest` currently points to. ## Best practice: upgrade the whole platform together A full-featured deployment has two version lines — the Teable app and the platform itself (see [Architecture](/en/deploy/architecture)). The most reliable routine ties them together, with [`VERSIONS.md`](https://github.com/teableio/teable-deployment/blob/main/VERSIONS.md) as the upgrade sheet. On each round: 1. Upgrade the runtime plane to the **newest platform release** (`v..`): each git tag is a verified snapshot of every runtime component, and its [`CHANGELOG.md`](https://github.com/teableio/teable-deployment/blob/main/CHANGELOG.md) entry states what changed and what, if anything, you must do (most releases are hot-swappable). Work from the repository checked out at that tag. 2. Move the Teable app to the **concrete release tag that `latest` currently corresponds to** (`pin-image.sh` resolves it) — a pinned, verified combination instead of a floating channel. 3. Run the bundled **doctor** — it checks health and compares what is actually running against the platform release manifest (compatible / upgrade the Teable app / unknown combination). ## Required secrets Teable no longer falls back to built-in default secrets. If your deployment relied on those defaults, the first start after upgrading stops with a list of the environment variables it needs and a copy-paste block that preserves your existing sessions, tokens, and encrypted data. Add the block, restart, then plan a rotation. See [Secrets and rotation](/en/deploy/env#secrets-and-rotation). ## Database migration Teable executes database migrations automatically on startup; no manual step is required. If anything looks wrong after an upgrade, check the logs: ```bash theme={null} docker compose logs teable | grep -i migration ``` ## Rollback If you hit issues after upgrading: 1. Set the image tag in `docker-compose.yaml` back to the previous release tag (this is why pinning beats `latest`: the previous version is written down). 2. `docker compose up -d` Rolling back **after** a release that migrated the database schema may not be safe — restore from your pre-upgrade backup in that case. This is the main reason for the backup recommendation above. ## FAQ No. Your data is stored in Docker volumes or external databases, and upgrading containers will not affect your data. However, we still recommend backing up before upgrading. No. Your Instance ID remains unchanged during application updates. It is a permanent identifier for your self-hosted installation. Typically, pulling new images takes a few minutes (depending on network speed), and container restart only takes a few seconds. The entire process usually completes within 5-10 minutes. Using `docker compose up -d` there will be a brief service interruption (usually a few seconds to tens of seconds). You can check the current version by: * Viewing the version number at the bottom left of the Teable interface * Using an admin account to access the admin panel * Running `docker inspect --format='{{.Config.Image}}'` to check the image version. If you run the `latest` channel, the full-featured deployment ships a `pin-image.sh` helper that resolves which release `latest` currently is. 1. First check container logs to troubleshoot: `docker compose logs teable` 2. If it's a database migration issue, try restoring from backup 3. If the issue persists, rollback to the previous version 4. Contact support at [support@teable.ai](mailto:support@teable.ai) # Post attachmentsnotify Source: https://help.teable.ai/en/api-reference/attachments/post-attachmentsnotify /swagger.json post /attachments/notify/{token} Get Attachment information # Create a base from template or apply a template to a base Source: https://help.teable.ai/en/api-reference/base/create-a-base-from-template-or-apply-a-template-to-a-base /swagger.json post /base/create-from-template Create a base from template or apply a template to a base # Delete base Source: https://help.teable.ai/en/api-reference/base/delete-base /swagger.json delete /base/{baseId} Delete a base by baseId # Delete base collaborators Source: https://help.teable.ai/en/api-reference/base/delete-base-collaborators /swagger.json delete /base/{baseId}/collaborators Delete a base collaborators # Delete base invitationlink Source: https://help.teable.ai/en/api-reference/base/delete-base-invitationlink /swagger.json delete /base/{baseId}/invitation/link/{invitationId} Delete a invitation link to your # Delete base permanent Source: https://help.teable.ai/en/api-reference/base/delete-base-permanent /swagger.json delete /base/{baseId}/permanent Permanently delete a base by baseId # Delete trashreset items Source: https://help.teable.ai/en/api-reference/base/delete-trashreset-items /swagger.json delete /trash/reset-items Reset trash items for a base or table # Execute SQL query Source: https://help.teable.ai/en/api-reference/base/execute-sql-query /swagger.json post /base/{baseId}/sql-query Execute SQL query on a base # Get base Source: https://help.teable.ai/en/api-reference/base/get-base /swagger.json get /base/{baseId} Get a base by baseId # Get base collaborator user list Source: https://help.teable.ai/en/api-reference/base/get-base-collaborator-user-list /swagger.json get /base/{baseId}/collaborators/users Get base collaborator user list # Get base collaborators Source: https://help.teable.ai/en/api-reference/base/get-base-collaborators /swagger.json get /base/{baseId}/collaborators List a base collaborator # Get base erd Source: https://help.teable.ai/en/api-reference/base/get-base-erd /swagger.json get /base/{baseId}/erd Get the erd of a base # Get base export Source: https://help.teable.ai/en/api-reference/base/get-base-export /swagger.json get /base/{baseId}/export export a base by baseId # Get base invitationlink Source: https://help.teable.ai/en/api-reference/base/get-base-invitationlink /swagger.json get /base/{baseId}/invitation/link List a invitation link to your # Get base permission Source: https://help.teable.ai/en/api-reference/base/get-base-permission /swagger.json get /base/{baseId}/permission Get a base permission # Get baseaccessall Source: https://help.teable.ai/en/api-reference/base/get-baseaccessall /swagger.json get /base/access/all Get base list by query # Get baseshared base Source: https://help.teable.ai/en/api-reference/base/get-baseshared-base /swagger.json get /base/shared-base # Get space base Source: https://help.teable.ai/en/api-reference/base/get-space-base /swagger.json get /space/{spaceId}/base Get base list by query # import a base Source: https://help.teable.ai/en/api-reference/base/import-a-base /swagger.json post /base/import import a base # import a base with SSE progress events Source: https://help.teable.ai/en/api-reference/base/import-a-base-with-sse-progress-events /swagger.json post /base/import-stream import a base with SSE progress stream # move a base to another space Source: https://help.teable.ai/en/api-reference/base/move-a-base-to-another-space /swagger.json put /base/{baseId}/move move a base to another space # Patch base Source: https://help.teable.ai/en/api-reference/base/patch-base /swagger.json patch /base/{baseId} Update a base info # Patch base collaborators Source: https://help.teable.ai/en/api-reference/base/patch-base-collaborators /swagger.json patch /base/{baseId}/collaborators Update a base collaborator # Patch base invitationlink Source: https://help.teable.ai/en/api-reference/base/patch-base-invitationlink /swagger.json patch /base/{baseId}/invitation/link/{invitationId} Update a invitation link to your # Post base collaborator Source: https://help.teable.ai/en/api-reference/base/post-base-collaborator /swagger.json post /base/{baseId}/collaborator Add a collaborator to a base # Post base invitationemail Source: https://help.teable.ai/en/api-reference/base/post-base-invitationemail /swagger.json post /base/{baseId}/invitation/email Send invitations by e-mail # Post base invitationlink Source: https://help.teable.ai/en/api-reference/base/post-base-invitationlink /swagger.json post /base/{baseId}/invitation/link Create a invitation link to your # Post baseduplicate Source: https://help.teable.ai/en/api-reference/base/post-baseduplicate /swagger.json post /base/duplicate duplicate a base # publish or unpublish a base Source: https://help.teable.ai/en/api-reference/base/publish-or-unpublish-a-base /swagger.json put /base/{baseId}/publish publish or unpublish a base # Put base order Source: https://help.teable.ai/en/api-reference/base/put-base-order /swagger.json put /base/{baseId}/order Update base order # Sign attachment URLs Source: https://help.teable.ai/en/api-reference/base/sign-attachment-urls /swagger.json post /base/{baseId}/sign-attachment-urls Generate signed URLs for attachment files # Delete base dashboard Source: https://help.teable.ai/en/api-reference/dashboard/delete-base-dashboard /swagger.json delete /base/{baseId}/dashboard/{id} Delete a dashboard by id # Delete base dashboard plugin Source: https://help.teable.ai/en/api-reference/dashboard/delete-base-dashboard-plugin /swagger.json delete /base/{baseId}/dashboard/{dashboardId}/plugin/{pluginInstallId} Remove a plugin from a dashboard # Duplicate a dashboard Source: https://help.teable.ai/en/api-reference/dashboard/duplicate-a-dashboard /swagger.json post /base/{baseId}/dashboard/{id}/duplicate Duplicate a dashboard # Duplicate a dashboard installed plugin Source: https://help.teable.ai/en/api-reference/dashboard/duplicate-a-dashboard-installed-plugin /swagger.json post /base/{baseId}/dashboard/{id}/plugin/{installedId}/duplicate Duplicate a dashboard installed plugin # Get base dashboard Source: https://help.teable.ai/en/api-reference/dashboard/get-base-dashboard /swagger.json get /base/{baseId}/dashboard Get a list of dashboards in base # Get base dashboard 1 Source: https://help.teable.ai/en/api-reference/dashboard/get-base-dashboard-1 /swagger.json get /base/{baseId}/dashboard/{id} Get a dashboard by id # Get base dashboard plugin Source: https://help.teable.ai/en/api-reference/dashboard/get-base-dashboard-plugin /swagger.json get /base/{baseId}/dashboard/{dashboardId}/plugin/{pluginInstallId} Get a dashboard install plugin by id # Patch base dashboard layout Source: https://help.teable.ai/en/api-reference/dashboard/patch-base-dashboard-layout /swagger.json patch /base/{baseId}/dashboard/{id}/layout Update a dashboard layout by id # Patch base dashboard plugin rename Source: https://help.teable.ai/en/api-reference/dashboard/patch-base-dashboard-plugin-rename /swagger.json patch /base/{baseId}/dashboard/{dashboardId}/plugin/{pluginInstallId}/rename Rename a plugin in a dashboard # Patch base dashboard plugin update storage Source: https://help.teable.ai/en/api-reference/dashboard/patch-base-dashboard-plugin-update-storage /swagger.json patch /base/{baseId}/dashboard/{dashboardId}/plugin/{pluginInstallId}/update-storage Update storage of a plugin in a dashboard # Patch base dashboard rename Source: https://help.teable.ai/en/api-reference/dashboard/patch-base-dashboard-rename /swagger.json patch /base/{baseId}/dashboard/{dashboardId}/rename Rename a dashboard by id # Post base dashboard Source: https://help.teable.ai/en/api-reference/dashboard/post-base-dashboard /swagger.json post /base/{baseId}/dashboard Create a new dashboard # Post base dashboard plugin Source: https://help.teable.ai/en/api-reference/dashboard/post-base-dashboard-plugin /swagger.json post /base/{baseId}/dashboard/{id}/plugin Install a plugin to a dashboard # Delete plugin Source: https://help.teable.ai/en/api-reference/plugin/delete-plugin /swagger.json delete /plugin/{id} Delete a plugin # Get plugin Source: https://help.teable.ai/en/api-reference/plugin/get-plugin /swagger.json get /plugin Get plugins # Get plugin 1 Source: https://help.teable.ai/en/api-reference/plugin/get-plugin-1 /swagger.json get /plugin/{pluginId} Get a plugin # Get plugin token Source: https://help.teable.ai/en/api-reference/plugin/get-plugin-token /swagger.json get /plugin/{pluginId}/token Get a token # Get plugincenterlist Source: https://help.teable.ai/en/api-reference/plugin/get-plugincenterlist /swagger.json get /plugin/center/list Get a list of plugins center # Get pluginchart dashboard query Source: https://help.teable.ai/en/api-reference/plugin/get-pluginchart-dashboard-query /swagger.json get /plugin/chart/{pluginInstallId}/dashboard/{positionId}/query Get a dashboard install plugin query by id # Get pluginchart plugin panel query Source: https://help.teable.ai/en/api-reference/plugin/get-pluginchart-plugin-panel-query /swagger.json get /plugin/chart/{pluginInstallId}/plugin-panel/{positionId}/query Get a plugin panel install plugin query by id # Patch plugin submit Source: https://help.teable.ai/en/api-reference/plugin/patch-plugin-submit /swagger.json patch /plugin/{pluginId}/submit Submit a plugin # Patch plugin unpublish Source: https://help.teable.ai/en/api-reference/plugin/patch-plugin-unpublish /swagger.json patch /plugin/{pluginId}/unpublish # Post plugin Source: https://help.teable.ai/en/api-reference/plugin/post-plugin /swagger.json post /plugin Create a plugin # Post plugin authcode Source: https://help.teable.ai/en/api-reference/plugin/post-plugin-authcode /swagger.json post /plugin/{pluginId}/authCode Get an auth code # Post plugin refreshtoken Source: https://help.teable.ai/en/api-reference/plugin/post-plugin-refreshtoken /swagger.json post /plugin/{pluginId}/refreshToken Refresh a token # Post plugin regenerate secret Source: https://help.teable.ai/en/api-reference/plugin/post-plugin-regenerate-secret /swagger.json post /plugin/{id}/regenerate-secret Regenerate a plugin secret # Put plugin Source: https://help.teable.ai/en/api-reference/plugin/put-plugin /swagger.json put /plugin/{id} Update a plugin # Delete template Source: https://help.teable.ai/en/api-reference/template/delete-template /swagger.json delete /template/{templateId} delete a template # Delete templatecategory Source: https://help.teable.ai/en/api-reference/template/delete-templatecategory /swagger.json delete /template/category/{templateCategoryId} delete a template category # Delete templateunpublish Source: https://help.teable.ai/en/api-reference/template/delete-templateunpublish /swagger.json delete /template/unpublish/{templateId} unpublish a template # Get template Source: https://help.teable.ai/en/api-reference/template/get-template /swagger.json get /template get template list # get template by baseId Source: https://help.teable.ai/en/api-reference/template/get-template-by-baseid /swagger.json get /template/by-base/{baseId} get template by baseId # get template detail by templateId Source: https://help.teable.ai/en/api-reference/template/get-template-detail-by-templateid /swagger.json get /template/{templateId} get template detail by templateId # Get template permalink redirect URL Source: https://help.teable.ai/en/api-reference/template/get-template-permalink-redirect-url /swagger.json get /template/permalink/{identifier} Get template redirect URL for permalink # Get templatecategorylist Source: https://help.teable.ai/en/api-reference/template/get-templatecategorylist /swagger.json get /template/category/list get template category list # Get templatepublished Source: https://help.teable.ai/en/api-reference/template/get-templatepublished /swagger.json get /template/published get published template list # Increment template visit count Source: https://help.teable.ai/en/api-reference/template/increment-template-visit-count /swagger.json patch /template/{templateId}/visit Increment template visit count # Patch template Source: https://help.teable.ai/en/api-reference/template/patch-template /swagger.json patch /template/{templateId} update a template # Patch template pin top Source: https://help.teable.ai/en/api-reference/template/patch-template-pin-top /swagger.json patch /template/{templateId}/pin-top pin top a template # Patch templatecategory Source: https://help.teable.ai/en/api-reference/template/patch-templatecategory /swagger.json patch /template/category/{templateCategoryId} update a template category name # Post template snapshot Source: https://help.teable.ai/en/api-reference/template/post-template-snapshot /swagger.json post /template/{templateId}/snapshot create a template snapshot # Post templatecategorycreate Source: https://help.teable.ai/en/api-reference/template/post-templatecategorycreate /swagger.json post /template/category/create create a template category # Post templatecreate Source: https://help.teable.ai/en/api-reference/template/post-templatecreate /swagger.json post /template/create create a template # Put template order Source: https://help.teable.ai/en/api-reference/template/put-template-order /swagger.json put /template/{templateId}/order Update template order # Put templatecategory order Source: https://help.teable.ai/en/api-reference/template/put-templatecategory-order /swagger.json put /template/category/{templateCategoryId}/order Update template category order # Delete table view Source: https://help.teable.ai/en/api-reference/view/delete-table-view /swagger.json delete /table/{tableId}/view/{viewId} Delete a view # Get table view Source: https://help.teable.ai/en/api-reference/view/get-table-view /swagger.json get /table/{tableId}/view/{viewId} Get a view # Get table view filter link records Source: https://help.teable.ai/en/api-reference/view/get-table-view-filter-link-records /swagger.json get /table/{tableId}/view/{viewId}/filter-link-records Getting associated records for a view filter configuration. # Get table view plugin Source: https://help.teable.ai/en/api-reference/view/get-table-view-plugin /swagger.json get /table/{tableId}/view/{viewId}/plugin Get a view install plugin by id # Get view list Source: https://help.teable.ai/en/api-reference/view/get-view-list /swagger.json get /table/{tableId}/view Get view list # Patch table view options Source: https://help.teable.ai/en/api-reference/view/patch-table-view-options /swagger.json patch /table/{tableId}/view/{viewId}/options Update view option # Patch table view plugin Source: https://help.teable.ai/en/api-reference/view/patch-table-view-plugin /swagger.json patch /table/{tableId}/view/{viewId}/plugin/{pluginInstallId} Update storage of a plugin in a view # Post table view Source: https://help.teable.ai/en/api-reference/view/post-table-view /swagger.json post /table/{tableId}/view Create a view # Post table view disable share Source: https://help.teable.ai/en/api-reference/view/post-table-view-disable-share /swagger.json post /table/{tableId}/view/{viewId}/disable-share Disable view share # Post table view duplicate Source: https://help.teable.ai/en/api-reference/view/post-table-view-duplicate /swagger.json post /table/{tableId}/view/{viewId}/duplicate Duplicate a view # Post table view enable share Source: https://help.teable.ai/en/api-reference/view/post-table-view-enable-share /swagger.json post /table/{tableId}/view/{viewId}/enable-share Enable view share # Post table view refresh share id Source: https://help.teable.ai/en/api-reference/view/post-table-view-refresh-share-id /swagger.json post /table/{tableId}/view/{viewId}/refresh-share-id Refresh view share id # Post table viewplugin Source: https://help.teable.ai/en/api-reference/view/post-table-viewplugin /swagger.json post /table/{tableId}/view/plugin Install a plugin to a view # Put table view column meta Source: https://help.teable.ai/en/api-reference/view/put-table-view-column-meta /swagger.json put /table/{tableId}/view/{viewId}/column-meta Update view column meta # Put table view description Source: https://help.teable.ai/en/api-reference/view/put-table-view-description /swagger.json put /table/{tableId}/view/{viewId}/description Update view description # Put table view filter Source: https://help.teable.ai/en/api-reference/view/put-table-view-filter /swagger.json put /table/{tableId}/view/{viewId}/filter Update view filter # Put table view group Source: https://help.teable.ai/en/api-reference/view/put-table-view-group /swagger.json put /table/{tableId}/view/{viewId}/group Update view group condition # Put table view locked Source: https://help.teable.ai/en/api-reference/view/put-table-view-locked /swagger.json put /table/{tableId}/view/{viewId}/locked Update the locked status of the view # Put table view manual sort Source: https://help.teable.ai/en/api-reference/view/put-table-view-manual-sort /swagger.json put /table/{tableId}/view/{viewId}/manual-sort Update view raw order # Put table view name Source: https://help.teable.ai/en/api-reference/view/put-table-view-name /swagger.json put /table/{tableId}/view/{viewId}/name Update view name # Put table view order Source: https://help.teable.ai/en/api-reference/view/put-table-view-order /swagger.json put /table/{tableId}/view/{viewId}/order Update view order # Put table view record order Source: https://help.teable.ai/en/api-reference/view/put-table-view-record-order /swagger.json put /table/{tableId}/view/{viewId}/record-order Update record order in view # Put table view share meta Source: https://help.teable.ai/en/api-reference/view/put-table-view-share-meta /swagger.json put /table/{tableId}/view/{viewId}/share-meta Update view share meta # Put table view sort Source: https://help.teable.ai/en/api-reference/view/put-table-view-sort /swagger.json put /table/{tableId}/view/{viewId}/sort Update view sort condition # Delete adminobservabilityworkflow Source: https://help.teable.ai/en/api-reference/admin/delete-adminobservabilityworkflow /swagger.json delete /admin/observability/workflow/{workflowId} Delete a workflow observability # Delete adminorganization Source: https://help.teable.ai/en/api-reference/admin/delete-adminorganization /swagger.json delete /admin/organization/{organizationId} Delete an organization by organization ID for admin # Delete adminspace Source: https://help.teable.ai/en/api-reference/admin/delete-adminspace /swagger.json delete /admin/space/{spaceId} Delete a space by space ID for admin # Delete adminuser Source: https://help.teable.ai/en/api-reference/admin/delete-adminuser /swagger.json delete /admin/user/{userId} Delete a user by user ID for admin # Delete adminuser permanent delete Source: https://help.teable.ai/en/api-reference/admin/delete-adminuser-permanent-delete /swagger.json delete /admin/user/{userId}/permanent-delete Permanent delete a user by user ID for admin # Export admin reward list as CSV Source: https://help.teable.ai/en/api-reference/admin/export-admin-reward-list-as-csv /swagger.json get /admin/reward/export/{spaceId} Export all reward records for a specific space as CSV file. Supports filtering by date range. # Get admin reward detail Source: https://help.teable.ai/en/api-reference/admin/get-admin-reward-detail /swagger.json get /admin/reward/{rewardId} Get detailed information of a specific reward including full metadata # Get admin reward list Source: https://help.teable.ai/en/api-reference/admin/get-admin-reward-list /swagger.json get /admin/reward/list Get paginated and filtered list of reward for admin management. Supports filtering by space, status, platform, verification result, and search. # Get admin reward overview by spaces Source: https://help.teable.ai/en/api-reference/admin/get-admin-reward-overview-by-spaces /swagger.json get /admin/reward/overview Get aggregated reward statistics grouped by space for admin management. Returns pending, approved, consumed, available and expiring amounts per space. # Get adminaudit logs Source: https://help.teable.ai/en/api-reference/admin/get-adminaudit-logs /swagger.json get /admin/audit-logs Get audit logs with filtering and pagination # Get adminenterprise license Source: https://help.teable.ai/en/api-reference/admin/get-adminenterprise-license /swagger.json get /admin/enterprise-license Get enterprise license information # Get adminenterprise licensestatus Source: https://help.teable.ai/en/api-reference/admin/get-adminenterprise-licensestatus /swagger.json get /admin/enterprise-license/status Get enterprise license expiration status # Get adminobservabilityworkflow Source: https://help.teable.ai/en/api-reference/admin/get-adminobservabilityworkflow /swagger.json get /admin/observability/workflow get observability workflow list # Get adminobservabilityworkflow run history Source: https://help.teable.ai/en/api-reference/admin/get-adminobservabilityworkflow-run-history /swagger.json get /admin/observability/workflow/{workflowId}/run-history get workflow run history # Get adminobservabilityworkflowsummary Source: https://help.teable.ai/en/api-reference/admin/get-adminobservabilityworkflowsummary /swagger.json get /admin/observability/workflow/summary Retrieves a summary of workflow observability # Get adminorganization Source: https://help.teable.ai/en/api-reference/admin/get-adminorganization /swagger.json get /admin/organization Get paginated organizations for the instance # Get adminorganization admin Source: https://help.teable.ai/en/api-reference/admin/get-adminorganization-admin /swagger.json get /admin/organization/{organizationId}/admin Get organization admin users # Get adminsetting Source: https://help.teable.ai/en/api-reference/admin/get-adminsetting /swagger.json get /admin/setting Get the instance settings # Get adminsettingai key stats Source: https://help.teable.ai/en/api-reference/admin/get-adminsettingai-key-stats /swagger.json get /admin/setting/ai-key-stats Get per-key usage statistics for AI Gateway API keys # Get adminsettingpublic Source: https://help.teable.ai/en/api-reference/admin/get-adminsettingpublic /swagger.json get /admin/setting/public Get the public instance settings # Get adminsettingtest public access Source: https://help.teable.ai/en/api-reference/admin/get-adminsettingtest-public-access /swagger.json get /admin/setting/test-public-access Test if this Teable instance is publicly accessible from the internet # Get adminspace Source: https://help.teable.ai/en/api-reference/admin/get-adminspace /swagger.json get /admin/space Get paginated spaces for the instance # Get adminuser Source: https://help.teable.ai/en/api-reference/admin/get-adminuser /swagger.json get /admin/user Get paginated users for the instance # Get all spaces with reward records Source: https://help.teable.ai/en/api-reference/admin/get-all-spaces-with-reward-records /swagger.json get /admin/reward/spaces Get a list of all spaces that have reward records for admin filtering # Patch adminenterprise license Source: https://help.teable.ai/en/api-reference/admin/patch-adminenterprise-license /swagger.json patch /admin/enterprise-license/{licenseId} Update a enterprise license by license ID # Patch adminplugin publish Source: https://help.teable.ai/en/api-reference/admin/patch-adminplugin-publish /swagger.json patch /admin/plugin/{pluginId}/publish Publish a plugin # Patch adminplugin unpublish Source: https://help.teable.ai/en/api-reference/admin/patch-adminplugin-unpublish /swagger.json patch /admin/plugin/{pluginId}/unpublish Admin unpublish a plugin # Patch adminsetting Source: https://help.teable.ai/en/api-reference/admin/patch-adminsetting /swagger.json patch /admin/setting Get the instance settings # Patch adminsettinglogo Source: https://help.teable.ai/en/api-reference/admin/patch-adminsettinglogo /swagger.json patch /admin/setting/logo Upload logo # Patch adminspace Source: https://help.teable.ai/en/api-reference/admin/patch-adminspace /swagger.json patch /admin/space/{spaceId} update enterprise space information # Patch adminuser Source: https://help.teable.ai/en/api-reference/admin/patch-adminuser /swagger.json patch /admin/user/{userId} Update a user info # Patch adminuser admin Source: https://help.teable.ai/en/api-reference/admin/patch-adminuser-admin /swagger.json patch /admin/user/{userId}/admin Set or unset admin privilege for a user # Post adminenterprise license Source: https://help.teable.ai/en/api-reference/admin/post-adminenterprise-license /swagger.json post /admin/enterprise-license Create a enterprise license # Post adminobservabilityworkflow deactivate Source: https://help.teable.ai/en/api-reference/admin/post-adminobservabilityworkflow-deactivate /swagger.json post /admin/observability/workflow/{workflowId}/deactivate Deactivate a workflow observability # Post adminorganization Source: https://help.teable.ai/en/api-reference/admin/post-adminorganization /swagger.json post /admin/organization Create a new organization # Post adminsettingbatch test llm Source: https://help.teable.ai/en/api-reference/admin/post-adminsettingbatch-test-llm /swagger.json post /admin/setting/batch-test-llm Batch test all configured LLM models to verify compatibility with AI field features # Post adminsettingtest api key Source: https://help.teable.ai/en/api-reference/admin/post-adminsettingtest-api-key /swagger.json post /admin/setting/test-api-key Test API key validity for AI Gateway or v0, optionally test attachment transfer modes # Post adminsettingtest llm Source: https://help.teable.ai/en/api-reference/admin/post-adminsettingtest-llm /swagger.json post /admin/setting/test-llm Test LLM provider configuration # Post adminuser restore delete Source: https://help.teable.ai/en/api-reference/admin/post-adminuser-restore-delete /swagger.json post /admin/user/{userId}/restore-delete Restore a deleted user # Put adminorganization admin Source: https://help.teable.ai/en/api-reference/admin/put-adminorganization-admin /swagger.json put /admin/organization/{organizationId}/admin Update organization admin status for a user # Put adminsettingset mail transport config Source: https://help.teable.ai/en/api-reference/admin/put-adminsettingset-mail-transport-config /swagger.json put /admin/setting/set-mail-transport-config Set mail transporter # Get aggregated statistics Source: https://help.teable.ai/en/api-reference/aggregation/get-aggregated-statistics /swagger.json get /table/{tableId}/aggregation Returns statistical aggregations of table data based on specified functions and grouping criteria # Get daily calendar data Source: https://help.teable.ai/en/api-reference/aggregation/get-daily-calendar-data /swagger.json get /table/{tableId}/aggregation/calendar-daily-collection Returns records and count distribution across dates based on specified date range and fields # Get group points Source: https://help.teable.ai/en/api-reference/aggregation/get-group-points /swagger.json get /table/{tableId}/aggregation/group-points Returns the distribution and count of records across different group points in the view # Get record index Source: https://help.teable.ai/en/api-reference/aggregation/get-record-index /swagger.json get /table/{tableId}/aggregation/record-index Returns the 0-based row index of a specific record in the current query context (respecting view filters, sort order, link filters) # Get record indices for search Source: https://help.teable.ai/en/api-reference/aggregation/get-record-indices-for-search /swagger.json get /table/{tableId}/aggregation/search-index Returns the indices and record IDs of records matching the search criteria # Get task status collection Source: https://help.teable.ai/en/api-reference/aggregation/get-task-status-collection /swagger.json get /table/{tableId}/aggregation/task-status-collection Returns records and count distribution across task status based on specified date range and fields # Get total count of search Source: https://help.teable.ai/en/api-reference/aggregation/get-total-count-of-search /swagger.json get /table/{tableId}/aggregation/search-count Returns the total count of records matching the specified search criteria and filters # Get total row count Source: https://help.teable.ai/en/api-reference/aggregation/get-total-row-count /swagger.json get /table/{tableId}/aggregation/row-count Returns the total number of rows in a view based on applied filters and criteria # Get attachments Source: https://help.teable.ai/en/api-reference/attachments/get-attachments /swagger.json get /attachments/{token} Upload attachment # Post attachmentssignature Source: https://help.teable.ai/en/api-reference/attachments/post-attachmentssignature /swagger.json post /attachments/signature Retrieve upload signature. # Post attachmentsupload Source: https://help.teable.ai/en/api-reference/attachments/post-attachmentsupload /swagger.json post /attachments/upload/{token} Upload attachment # Auto-fill a field by AI Source: https://help.teable.ai/en/api-reference/field/auto-fill-a-field-by-ai /swagger.json post /table/{tableId}/field/{fieldId}/auto-fill Automatically generate suggestions for filling a specific field # Convert field type Source: https://help.teable.ai/en/api-reference/field/convert-field-type /swagger.json put /table/{tableId}/field/{fieldId}/convert Convert field to a different type with automatic type casting and symmetric field handling # Create field Source: https://help.teable.ai/en/api-reference/field/create-field /swagger.json post /table/{tableId}/field Create a new field in the specified table with the given configuration # Delete field Source: https://help.teable.ai/en/api-reference/field/delete-field /swagger.json delete /table/{tableId}/field/{fieldId} Permanently remove a field from the specified table # Delete multiple fields Source: https://help.teable.ai/en/api-reference/field/delete-multiple-fields /swagger.json delete /table/{tableId}/field Permanently remove multiple fields from the specified table # Duplicate field Source: https://help.teable.ai/en/api-reference/field/duplicate-field /swagger.json post /table/{tableId}/field/{fieldId}/duplicate Duplicate field # Get a field Source: https://help.teable.ai/en/api-reference/field/get-a-field /swagger.json get /table/{tableId}/field/{fieldId} Retrieve detailed information about a specific field by its ID # Get linked records for filter Source: https://help.teable.ai/en/api-reference/field/get-linked-records-for-filter /swagger.json get /table/{tableId}/field/{fieldId}/filter-link-records Retrieve associated records that match the view filter configuration for a linked field # Get table fielddelete references Source: https://help.teable.ai/en/api-reference/field/get-table-fielddelete-references /swagger.json get /table/{tableId}/field/delete-references Get resources that reference the given fields (for delete impact analysis) # List fields Source: https://help.teable.ai/en/api-reference/field/list-fields /swagger.json get /table/{tableId}/field Retrieve a list of fields in a table with optional filtering # Stop auto-fill a field by AI Source: https://help.teable.ai/en/api-reference/field/stop-auto-fill-a-field-by-ai /swagger.json post /table/{tableId}/field/{fieldId}/stop-fill Stop auto-fill a field by AI # Update field Source: https://help.teable.ai/en/api-reference/field/update-field /swagger.json patch /table/{tableId}/field/{fieldId} Update common properties of a field (name, description, dbFieldName). For other property changes, use the convert field API # Post mail sendertest transport config Source: https://help.teable.ai/en/api-reference/mail/post-mail-sendertest-transport-config /swagger.json post /mail-sender/test-transport-config Test mail transporter # Delete table field plan Source: https://help.teable.ai/en/api-reference/plan/delete-table-field-plan /swagger.json delete /table/{tableId}/field/{fieldId}/plan Generate calculation plan for deleting the field # Get table field plan Source: https://help.teable.ai/en/api-reference/plan/get-table-field-plan /swagger.json get /table/{tableId}/field/{fieldId}/plan Generate calculation plan for the field # Post table fieldplan Source: https://help.teable.ai/en/api-reference/plan/post-table-fieldplan /swagger.json post /table/{tableId}/field/plan Generate calculation plan for creating the field # Put table field plan Source: https://help.teable.ai/en/api-reference/plan/put-table-field-plan /swagger.json put /table/{tableId}/field/{fieldId}/plan Generate calculation plan for converting the field # Clear selected range content Source: https://help.teable.ai/en/api-reference/selection/clear-selected-range-content /swagger.json patch /table/{tableId}/selection/clear Remove all content from the selected table range # Copy selected table content Source: https://help.teable.ai/en/api-reference/selection/copy-selected-table-content /swagger.json get /table/{tableId}/selection/copy Copy content from selected table ranges including headers if specified # Delete selected range data Source: https://help.teable.ai/en/api-reference/selection/delete-selected-range-data /swagger.json delete /table/{tableId}/selection/delete Delete records or fields within the selected table range # Get ids from range Source: https://help.teable.ai/en/api-reference/selection/get-ids-from-range /swagger.json get /table/{tableId}/selection/range-to-id Retrieve record and field identifiers based on the selected range coordinates in a table # Paste content into selected range Source: https://help.teable.ai/en/api-reference/selection/paste-content-into-selected-range /swagger.json patch /table/{tableId}/selection/paste Apply paste operation to insert content into the selected table range # Preview paste operation results Source: https://help.teable.ai/en/api-reference/selection/preview-paste-operation-results /swagger.json patch /table/{tableId}/selection/temporaryPaste Preview the results of a paste operation without applying changes to the table # Create table Source: https://help.teable.ai/en/api-reference/table/create-table /swagger.json post /base/{baseId}/table/ Create a new table in the specified base with customizable fields, views, and initial records. Default configurations will be applied if not specified. # Delete table Source: https://help.teable.ai/en/api-reference/table/delete-table /swagger.json delete /base/{baseId}/table/{tableId} Move a table to trash. The table can be restored within the retention period. # Duplicate a table Source: https://help.teable.ai/en/api-reference/table/duplicate-a-table /swagger.json post /base/{baseId}/table/{tableId}/duplicate Duplicate a table # Get abnormal indexes Source: https://help.teable.ai/en/api-reference/table/get-abnormal-indexes /swagger.json get /base/{baseId}/table/{tableId}/abnormal-index Retrieve a list of abnormal database indexes for a specific table by index type. This helps identify potential performance or maintenance issues. # Get activated index Source: https://help.teable.ai/en/api-reference/table/get-activated-index /swagger.json post /base/{baseId}/table/{tableId}/activated-index Get the activated index of a table # Get default view id Source: https://help.teable.ai/en/api-reference/table/get-default-view-id /swagger.json get /base/{baseId}/table/{tableId}/default-view-id Get default view id # Get table details Source: https://help.teable.ai/en/api-reference/table/get-table-details /swagger.json get /base/{baseId}/table/{tableId} Retrieve detailed information about a specific table, including its schema, name, and configuration. # Get table permissions Source: https://help.teable.ai/en/api-reference/table/get-table-permissions /swagger.json get /base/{baseId}/table/{tableId}/permission Retrieve the current user's permissions for a table, including access rights for table operations, views, records, and fields. # List tables Source: https://help.teable.ai/en/api-reference/table/list-tables /swagger.json get /base/{baseId}/table Retrieve a list of all tables in the specified base, including their basic information and configurations. # Permanently delete table Source: https://help.teable.ai/en/api-reference/table/permanently-delete-table /swagger.json delete /base/{baseId}/table/{tableId}/permanent Permanently delete a table and all its data. This action cannot be undone. # Repair table index Source: https://help.teable.ai/en/api-reference/table/repair-table-index /swagger.json patch /base/{baseId}/table/{tableId}/index/repair Repair table index # Toggle table index Source: https://help.teable.ai/en/api-reference/table/toggle-table-index /swagger.json post /base/{baseId}/table/{tableId}/index Toggle table index # Update db table name Source: https://help.teable.ai/en/api-reference/table/update-db-table-name /swagger.json put /base/{baseId}/table/{tableId}/db-table-name Update the physical database table name. Must be 1-63 characters, start with letter or underscore, contain only letters, numbers and underscore, and be unique within the base. # Update table description Source: https://help.teable.ai/en/api-reference/table/update-table-description /swagger.json put /base/{baseId}/table/{tableId}/description Update or remove the description of a table. Set to null to remove the description. # Update table name Source: https://help.teable.ai/en/api-reference/table/update-table-name /swagger.json put /base/{baseId}/table/{tableId}/name Update the display name of a table. This will not affect the underlying database table name. # Update table order Source: https://help.teable.ai/en/api-reference/table/update-table-order /swagger.json put /base/{baseId}/table/{tableId}/order Update the display order of a table in the base. This affects the order in which tables are shown in the UI. # Update table tcon Source: https://help.teable.ai/en/api-reference/table/update-table-tcon /swagger.json put /base/{baseId}/table/{tableId}/icon Update the emoji icon of a table. The icon must be a valid emoji character. # Get userlast visit Source: https://help.teable.ai/en/api-reference/user/get-userlast-visit /swagger.json get /user/last-visit Get user last visited resource # Get userlast visitlist base Source: https://help.teable.ai/en/api-reference/user/get-userlast-visitlist-base /swagger.json get /user/last-visit/list-base # Get userlast visitmap Source: https://help.teable.ai/en/api-reference/user/get-userlast-visitmap /swagger.json get /user/last-visit/map Get user last visited resource map # Patch useravatar Source: https://help.teable.ai/en/api-reference/user/patch-useravatar /swagger.json patch /user/avatar Update user avatar # Patch userlang Source: https://help.teable.ai/en/api-reference/user/patch-userlang /swagger.json patch /user/lang Update user language # Patch username Source: https://help.teable.ai/en/api-reference/user/patch-username /swagger.json patch /user/name Update user name # Patch usernotify meta Source: https://help.teable.ai/en/api-reference/user/patch-usernotify-meta /swagger.json patch /user/notify-meta Update user notification meta # Post userlast visit Source: https://help.teable.ai/en/api-reference/user/post-userlast-visit /swagger.json post /user/last-visit Update or create user last visit record # Delete access token Source: https://help.teable.ai/en/api-reference/access-token/delete-access-token /swagger.json delete /access-token/{id} Delete access token # Get access token Source: https://help.teable.ai/en/api-reference/access-token/get-access-token /swagger.json get /access-token List access token # Get access token 1 Source: https://help.teable.ai/en/api-reference/access-token/get-access-token-1 /swagger.json get /access-token/{id} Get access token # Post access token Source: https://help.teable.ai/en/api-reference/access-token/post-access-token /swagger.json post /access-token Create access token # Post access token refresh Source: https://help.teable.ai/en/api-reference/access-token/post-access-token-refresh /swagger.json post /access-token/{id}/refresh Refresh access token # Put access token Source: https://help.teable.ai/en/api-reference/access-token/put-access-token /swagger.json put /access-token/{id} Update access token # Delete authuser Source: https://help.teable.ai/en/api-reference/auth/delete-authuser /swagger.json delete /auth/user Delete user # Get authtemp token Source: https://help.teable.ai/en/api-reference/auth/get-authtemp-token /swagger.json get /auth/temp-token Get temp token # Get authuser Source: https://help.teable.ai/en/api-reference/auth/get-authuser /swagger.json get /auth/user Get user information via access token # Get authuserme Source: https://help.teable.ai/en/api-reference/auth/get-authuserme /swagger.json get /auth/user/me Get user information # Get authwaitlist Source: https://help.teable.ai/en/api-reference/auth/get-authwaitlist /swagger.json get /auth/waitlist Get waitlist # Patch authchange email Source: https://help.teable.ai/en/api-reference/auth/patch-authchange-email /swagger.json patch /auth/change-email Change email # Patch authchange password Source: https://help.teable.ai/en/api-reference/auth/patch-authchange-password /swagger.json patch /auth/change-password Change password # Post authadd password Source: https://help.teable.ai/en/api-reference/auth/post-authadd-password /swagger.json post /auth/add-password Add password # Post authinvite waitlist Source: https://help.teable.ai/en/api-reference/auth/post-authinvite-waitlist /swagger.json post /auth/invite-waitlist Invite waitlist # Post authjoin waitlist Source: https://help.teable.ai/en/api-reference/auth/post-authjoin-waitlist /swagger.json post /auth/join-waitlist Join waitlist # Post authreset password Source: https://help.teable.ai/en/api-reference/auth/post-authreset-password /swagger.json post /auth/reset-password Reset password # Post authsend change email code Source: https://help.teable.ai/en/api-reference/auth/post-authsend-change-email-code /swagger.json post /auth/send-change-email-code Send change email code # Post authsend reset password email Source: https://help.teable.ai/en/api-reference/auth/post-authsend-reset-password-email /swagger.json post /auth/send-reset-password-email Send reset password email # Post authsend signup verification code Source: https://help.teable.ai/en/api-reference/auth/post-authsend-signup-verification-code /swagger.json post /auth/send-signup-verification-code Send signup verification code # Post authsignin Source: https://help.teable.ai/en/api-reference/auth/post-authsignin /swagger.json post /auth/signin Sign in # Post authsignout Source: https://help.teable.ai/en/api-reference/auth/post-authsignout /swagger.json post /auth/signout Sign out # Post authsignup Source: https://help.teable.ai/en/api-reference/auth/post-authsignup /swagger.json post /auth/signup Sign up # Post authwaitlist invite code Source: https://help.teable.ai/en/api-reference/auth/post-authwaitlist-invite-code /swagger.json post /auth/waitlist-invite-code Gen waitlist invite code # Delete space billingsubscription Source: https://help.teable.ai/en/api-reference/billing/delete-space-billingsubscription /swagger.json delete /space/{spaceId}/billing/subscription Cancel subscription for a space # Get billingadd on products Source: https://help.teable.ai/en/api-reference/billing/get-billingadd-on-products /swagger.json get /billing/add-on-products Get add-on products list # Get billingall products Source: https://help.teable.ai/en/api-reference/billing/get-billingall-products /swagger.json get /billing/all-products Get all products collection # Get billingbase products Source: https://help.teable.ai/en/api-reference/billing/get-billingbase-products /swagger.json get /billing/base-products Get base products list # Get billingsubscriptionlicense Source: https://help.teable.ai/en/api-reference/billing/get-billingsubscriptionlicense /swagger.json get /billing/subscription/license/{licenseId} Get license details for the self-hosted related subscription # Get billingsubscriptionlicense 1 Source: https://help.teable.ai/en/api-reference/billing/get-billingsubscriptionlicense-1 /swagger.json get /billing/subscription/license Get license list # Get billingsubscriptionlicensemanage billingavailability Source: https://help.teable.ai/en/api-reference/billing/get-billingsubscriptionlicensemanage-billingavailability /swagger.json get /billing/subscription/license/manage-billing/availability Get manage billing portal availability # Get billingsubscriptionsummary Source: https://help.teable.ai/en/api-reference/billing/get-billingsubscriptionsummary /swagger.json get /billing/subscription/summary Retrieves a summary of subscription information across all spaces # Get space billing Source: https://help.teable.ai/en/api-reference/billing/get-space-billing /swagger.json get /space/{spaceId}/billing Get space billing details # Get space billingcredit detail Source: https://help.teable.ai/en/api-reference/billing/get-space-billingcredit-detail /swagger.json get /space/{spaceId}/billing/credit-detail Get space credit usage detail by month # Get space billingcredit history Source: https://help.teable.ai/en/api-reference/billing/get-space-billingcredit-history /swagger.json get /space/{spaceId}/billing/credit-history Get space credit history list with cursor pagination # Get space billingcredit summary Source: https://help.teable.ai/en/api-reference/billing/get-space-billingcredit-summary /swagger.json get /space/{spaceId}/billing/credit-summary Get space credit summary # Get space billinginvoicebase list Source: https://help.teable.ai/en/api-reference/billing/get-space-billinginvoicebase-list /swagger.json get /space/{spaceId}/billing/invoice/base-list Get paginated invoice list by spaceId # Get space billingmanage portal Source: https://help.teable.ai/en/api-reference/billing/get-space-billingmanage-portal /swagger.json get /space/{spaceId}/billing/manage-portal Get Stripe customer portal URL for managing billing details # Get space billingsubscription Source: https://help.teable.ai/en/api-reference/billing/get-space-billingsubscription /swagger.json get /space/{spaceId}/billing/subscription Get subscription detail by spaceId # Get space billingsubscriptionplan Source: https://help.teable.ai/en/api-reference/billing/get-space-billingsubscriptionplan /swagger.json get /space/{spaceId}/billing/subscription/plan Retrieves the plan subscription # Get space billingsubscriptionsummary Source: https://help.teable.ai/en/api-reference/billing/get-space-billingsubscriptionsummary /swagger.json get /space/{spaceId}/billing/subscription/summary Retrieves a summary of subscription information for a space # Post billingsubscriptionlicensecheckout Source: https://help.teable.ai/en/api-reference/billing/post-billingsubscriptionlicensecheckout /swagger.json post /billing/subscription/license/checkout Get checkout session url for a self-hosted license # Post billingsubscriptionlicensemanage billing Source: https://help.teable.ai/en/api-reference/billing/post-billingsubscriptionlicensemanage-billing /swagger.json post /billing/subscription/license/manage-billing Manage billing # Post space billingsubscriptioncheckout Source: https://help.teable.ai/en/api-reference/billing/post-space-billingsubscriptioncheckout /swagger.json post /space/{spaceId}/billing/subscription/checkout Get checkout session url for a space # Delete comment Source: https://help.teable.ai/en/api-reference/comment/delete-comment- /swagger.json delete /comment/{tableId}/{recordId}/{commentId} delete record comment # Delete comment reaction Source: https://help.teable.ai/en/api-reference/comment/delete-comment--reaction /swagger.json delete /comment/{tableId}/{recordId}/{commentId}/reaction delete record comment reaction # Delete comment subscribe Source: https://help.teable.ai/en/api-reference/comment/delete-comment-subscribe /swagger.json delete /comment/{tableId}/{recordId}/subscribe unsubscribe record comment # Get comment Source: https://help.teable.ai/en/api-reference/comment/get-comment- /swagger.json get /comment/{tableId}/{recordId}/{commentId} Get record comment detail # Get comment attachment Source: https://help.teable.ai/en/api-reference/comment/get-comment-attachment /swagger.json get /comment/{tableId}/{recordId}/attachment/{path} Get record comment attachment url # Get comment list Source: https://help.teable.ai/en/api-reference/comment/get-comment-list /swagger.json get /comment/{tableId}/{recordId}/list Get record comment list # Get comment subscribe Source: https://help.teable.ai/en/api-reference/comment/get-comment-subscribe /swagger.json get /comment/{tableId}/{recordId}/subscribe get record comment subscribe detail # Patch comment Source: https://help.teable.ai/en/api-reference/comment/patch-comment- /swagger.json patch /comment/{tableId}/{recordId}/{commentId} update record comment # Post comment reaction Source: https://help.teable.ai/en/api-reference/comment/post-comment--reaction /swagger.json post /comment/{tableId}/{recordId}/{commentId}/reaction create record comment reaction # Post comment create Source: https://help.teable.ai/en/api-reference/comment/post-comment-create /swagger.json post /comment/{tableId}/{recordId}/create create record comment # Post comment subscribe Source: https://help.teable.ai/en/api-reference/comment/post-comment-subscribe /swagger.json post /comment/{tableId}/{recordId}/subscribe subscribe record comment's active # Delete base connection Source: https://help.teable.ai/en/api-reference/db-connection/delete-base-connection /swagger.json delete /base/{baseId}/connection Delete a db connection # Get base connection Source: https://help.teable.ai/en/api-reference/db-connection/get-base-connection /swagger.json get /base/{baseId}/connection Get db connection info # Post base connection Source: https://help.teable.ai/en/api-reference/db-connection/post-base-connection /swagger.json post /base/{baseId}/connection Create a db connection url # Get export Source: https://help.teable.ai/en/api-reference/export/get-export /swagger.json get /export/{tableId} export csv from table # Get importanalyze Source: https://help.teable.ai/en/api-reference/import/get-importanalyze /swagger.json get /import/analyze Get a column info from analyze sheet # Patch import Source: https://help.teable.ai/en/api-reference/import/patch-import- /swagger.json patch /import/{baseId}/{tableId} import table inplace # Post import Source: https://help.teable.ai/en/api-reference/import/post-import /swagger.json post /import/{baseId} create table from file # Post invitationlinkaccept Source: https://help.teable.ai/en/api-reference/invitation/post-invitationlinkaccept /swagger.json post /invitation/link/accept Accept invitation link # Get notifications Source: https://help.teable.ai/en/api-reference/notification/get-notifications /swagger.json get /notifications List a user notification # Get notificationsunread count Source: https://help.teable.ai/en/api-reference/notification/get-notificationsunread-count /swagger.json get /notifications/unread-count User notification unread count # Patch notifications status Source: https://help.teable.ai/en/api-reference/notification/patch-notifications-status /swagger.json patch /notifications/{notificationId}/status Patch notification status # Patch notificationsread all Source: https://help.teable.ai/en/api-reference/notification/patch-notificationsread-all /swagger.json patch /notifications/read-all mark all notifications as read # Delete oauthclient Source: https://help.teable.ai/en/api-reference/oauth/delete-oauthclient /swagger.json delete /oauth/client/{clientId} Delete an OAuth application # Delete oauthclient secret Source: https://help.teable.ai/en/api-reference/oauth/delete-oauthclient-secret /swagger.json delete /oauth/client/{clientId}/secret/{secretId} Delete the OAuth secret # Get oauthclient Source: https://help.teable.ai/en/api-reference/oauth/get-oauthclient /swagger.json get /oauth/client/{clientId} Get the OAuth application # Get oauthclient 1 Source: https://help.teable.ai/en/api-reference/oauth/get-oauthclient-1 /swagger.json get /oauth/client Get the list of OAuth applications # Get oauthclientauthorizedlist Source: https://help.teable.ai/en/api-reference/oauth/get-oauthclientauthorizedlist /swagger.json get /oauth/client/authorized/list Get the list of authorized applications # Get oauthdecision Source: https://help.teable.ai/en/api-reference/oauth/get-oauthdecision /swagger.json get /oauth/decision/{transactionId} Get the OAuth application # Post oauthclient Source: https://help.teable.ai/en/api-reference/oauth/post-oauthclient /swagger.json post /oauth/client Create a new OAuth application # Post oauthclient revoke access Source: https://help.teable.ai/en/api-reference/oauth/post-oauthclient-revoke-access /swagger.json post /oauth/client/{clientId}/revoke-access # Post oauthclient revoke token Source: https://help.teable.ai/en/api-reference/oauth/post-oauthclient-revoke-token /swagger.json post /oauth/client/{clientId}/revoke-token # Post oauthclient secret Source: https://help.teable.ai/en/api-reference/oauth/post-oauthclient-secret /swagger.json post /oauth/client/{clientId}/secret Generate a new OAuth secret # Put oauthclient Source: https://help.teable.ai/en/api-reference/oauth/put-oauthclient /swagger.json put /oauth/client/{clientId} Update an OAuth application # Delete pin Source: https://help.teable.ai/en/api-reference/pin/delete-pin /swagger.json delete /pin Delete pin # Get pinlist Source: https://help.teable.ai/en/api-reference/pin/get-pinlist /swagger.json get /pin/list Get pin list # Post pin Source: https://help.teable.ai/en/api-reference/pin/post-pin /swagger.json post /pin/ Add pin # Put pinorder Source: https://help.teable.ai/en/api-reference/pin/put-pinorder /swagger.json put /pin/order Update pin order # Button click Source: https://help.teable.ai/en/api-reference/share/button-click /swagger.json post /share/{shareId}/view/record/{recordId}/{fieldId}/button-click Button click # Get share view Source: https://help.teable.ai/en/api-reference/share/get-share-view /swagger.json get /share/{shareId}/view get share view info # Get share viewaggregations Source: https://help.teable.ai/en/api-reference/share/get-share-viewaggregations /swagger.json get /share/{shareId}/view/aggregations Get share view aggregations # Get share viewcalendar daily collection Source: https://help.teable.ai/en/api-reference/share/get-share-viewcalendar-daily-collection /swagger.json get /share/{shareId}/view/calendar-daily-collection Get calendar daily collection for the share view # Get share viewcollaborators Source: https://help.teable.ai/en/api-reference/share/get-share-viewcollaborators /swagger.json get /share/{shareId}/view/collaborators View collaborators in a view with a user field selector. # Get share viewcopy Source: https://help.teable.ai/en/api-reference/share/get-share-viewcopy /swagger.json get /share/{shareId}/view/copy Copy operations in Share view # Get share viewgroup points Source: https://help.teable.ai/en/api-reference/share/get-share-viewgroup-points /swagger.json get /share/{shareId}/view/group-points Get group points for the share view # Get share viewlink records Source: https://help.teable.ai/en/api-reference/share/get-share-viewlink-records /swagger.json get /share/{shareId}/view/link-records In a view with a field selector, link the records list of the associated field selector to get the. Linking the desired ones inside the share view should fetch the ones that have already been selected. # Get share viewrecords Source: https://help.teable.ai/en/api-reference/share/get-share-viewrecords /swagger.json get /share/{shareId}/view/records Get records for the share view # Get share viewrow count Source: https://help.teable.ai/en/api-reference/share/get-share-viewrow-count /swagger.json get /share/{shareId}/view/row-count Get row count for the share view # Get share viewsearch count Source: https://help.teable.ai/en/api-reference/share/get-share-viewsearch-count /swagger.json get /share/{shareId}/view/search-count Get share view search result count with query # Get share viewsearch index Source: https://help.teable.ai/en/api-reference/share/get-share-viewsearch-index /swagger.json get /share/{shareId}/view/search-index Get share view record index with search query # Post share viewauth Source: https://help.teable.ai/en/api-reference/share/post-share-viewauth /swagger.json post /share/{shareId}/view/auth share view auth password # Post share viewform submit Source: https://help.teable.ai/en/api-reference/share/post-share-viewform-submit /swagger.json post /share/{shareId}/view/form-submit share form view submit new record # Get base usage Source: https://help.teable.ai/en/api-reference/usage/get-base-usage /swagger.json get /base/{baseId}/usage Get usage information for the base # Get instanceusage Source: https://help.teable.ai/en/api-reference/usage/get-instanceusage /swagger.json get /instance/usage Get usage information for the instance # Get space usage Source: https://help.teable.ai/en/api-reference/usage/get-space-usage /swagger.json get /space/{spaceId}/usage Get usage information for the space # Get userlast visitbase node Source: https://help.teable.ai/en/api-reference/user/get-userlast-visitbase-node /swagger.json get /user/last-visit/base-node Get user last visited base node # Get aiconfig Source: https://help.teable.ai/en/api-reference/ai/get--aiconfig /swagger.json get /{baseId}/ai/config Get the configuration of ai, including instance and space configuration # Get aidisable ai actions Source: https://help.teable.ai/en/api-reference/ai/get--aidisable-ai-actions /swagger.json get /{baseId}/ai/disable-ai-actions Get the disable ai actions # Post api aigenerate Source: https://help.teable.ai/en/api-reference/ai/post-api-aigenerate /swagger.json post /api/{baseId}/ai/generate Generate AI text (non-streaming) # Post api aigenerate stream Source: https://help.teable.ai/en/api-reference/ai/post-api-aigenerate-stream /swagger.json post /api/{baseId}/ai/generate-stream Generate ai stream # Delete base workflow action Source: https://help.teable.ai/en/api-reference/automation/delete-base-workflow-action /swagger.json delete /base/{baseId}/workflow/{workflowId}/action/{actionId} delete a automation workflow action # Delete base workflow logic Source: https://help.teable.ai/en/api-reference/automation/delete-base-workflow-logic /swagger.json delete /base/{baseId}/workflow/{workflowId}/logic/{logicId} delete a automation workflow logic # Get base workflow action Source: https://help.teable.ai/en/api-reference/automation/get-base-workflow-action /swagger.json get /base/{baseId}/workflow/{workflowId}/action/{actionId} get a automation workflow action # Get base workflow action script input Source: https://help.teable.ai/en/api-reference/automation/get-base-workflow-action-script-input /swagger.json get /base/{baseId}/workflow/{workflowId}/action/{actionId}/script-input Get script integrations for a workflow action # Get base workflow logic Source: https://help.teable.ai/en/api-reference/automation/get-base-workflow-logic /swagger.json get /base/{baseId}/workflow/{workflowId}/logic/{logicId} get a automation workflow logic # Get base workflow trigger Source: https://help.teable.ai/en/api-reference/automation/get-base-workflow-trigger /swagger.json get /base/{baseId}/workflow/{workflowId}/trigger/{triggerId} get a automation workflow trigger # Post base workflow action Source: https://help.teable.ai/en/api-reference/automation/post-base-workflow-action /swagger.json post /base/{baseId}/workflow/{workflowId}/action Create a automation workflow action # Post base workflow action duplicate Source: https://help.teable.ai/en/api-reference/automation/post-base-workflow-action-duplicate /swagger.json post /base/{baseId}/workflow/{workflowId}/action/{actionId}/duplicate duplicate a automation workflow action # Post base workflow logic Source: https://help.teable.ai/en/api-reference/automation/post-base-workflow-logic /swagger.json post /base/{baseId}/workflow/{workflowId}/logic Create a automation workflow logic # Put base workflow action Source: https://help.teable.ai/en/api-reference/automation/put-base-workflow-action /swagger.json put /base/{baseId}/workflow/{workflowId}/action/{actionId} update a automation workflow action # Put base workflow logic Source: https://help.teable.ai/en/api-reference/automation/put-base-workflow-logic /swagger.json put /base/{baseId}/workflow/{workflowId}/logic/{logicId} update a automation workflow logic # Delete base node Source: https://help.teable.ai/en/api-reference/base-node/delete-base-node /swagger.json delete /base/{baseId}/node/{nodeId} Delete a node for a base # Delete base node permanent Source: https://help.teable.ai/en/api-reference/base-node/delete-base-node-permanent /swagger.json delete /base/{baseId}/node/{nodeId}/permanent Permanent delete a node for a base # Delete base nodefolder Source: https://help.teable.ai/en/api-reference/base-node/delete-base-nodefolder /swagger.json delete /base/{baseId}/node/folder/{folderId} Delete a node folder and move its children to parent # Get base node Source: https://help.teable.ai/en/api-reference/base-node/get-base-node /swagger.json get /base/{baseId}/node/{nodeId} Get nodes for a base # Get base nodelist Source: https://help.teable.ai/en/api-reference/base-node/get-base-nodelist /swagger.json get /base/{baseId}/node/list Get list nodes of a base # Get base nodetree Source: https://help.teable.ai/en/api-reference/base-node/get-base-nodetree /swagger.json get /base/{baseId}/node/tree Get tree nodes for a base # Patch base nodefolder Source: https://help.teable.ai/en/api-reference/base-node/patch-base-nodefolder /swagger.json patch /base/{baseId}/node/folder/{folderId} Rename a node folder # Post base node Source: https://help.teable.ai/en/api-reference/base-node/post-base-node /swagger.json post /base/{baseId}/node Create a hierarchical node for a base # Post base node duplicate Source: https://help.teable.ai/en/api-reference/base-node/post-base-node-duplicate /swagger.json post /base/{baseId}/node/{nodeId}/duplicate Duplicate a node for a base # Post base nodefolder Source: https://help.teable.ai/en/api-reference/base-node/post-base-nodefolder /swagger.json post /base/{baseId}/node/folder Create a folder node in base # Put base node Source: https://help.teable.ai/en/api-reference/base-node/put-base-node /swagger.json put /base/{baseId}/node/{nodeId} Update a node for a base # Put base node move Source: https://help.teable.ai/en/api-reference/base-node/put-base-node-move /swagger.json put /base/{baseId}/node/{nodeId}/move Move or reorder a node # Delete base share Source: https://help.teable.ai/en/api-reference/base-share/delete-base-share /swagger.json delete /base/{baseId}/share/{shareId} Delete a base share link # Get base share Source: https://help.teable.ai/en/api-reference/base-share/get-base-share /swagger.json get /base/{baseId}/share Get all shared node IDs for a base # Get base sharenode Source: https://help.teable.ai/en/api-reference/base-share/get-base-sharenode /swagger.json get /base/{baseId}/share/node/{nodeId} Get a base share by node ID # Get share base Source: https://help.teable.ai/en/api-reference/base-share/get-share-base /swagger.json get /share/{shareId}/base Get shared base information # Patch base share Source: https://help.teable.ai/en/api-reference/base-share/patch-base-share /swagger.json patch /base/{baseId}/share/{shareId} Update a base share link # Post base share Source: https://help.teable.ai/en/api-reference/base-share/post-base-share /swagger.json post /base/{baseId}/share Create a base share link # Post base share refresh Source: https://help.teable.ai/en/api-reference/base-share/post-base-share-refresh /swagger.json post /base/{baseId}/share/{shareId}/refresh Refresh/regenerate a base share link ID # Post share baseauth Source: https://help.teable.ai/en/api-reference/base-share/post-share-baseauth /swagger.json post /share/{shareId}/base/auth Authenticate with password to access shared base # Post share basecopy Source: https://help.teable.ai/en/api-reference/base-share/post-share-basecopy /swagger.json post /share/{shareId}/base/copy Copy a shared base to a target space # Get comment count Source: https://help.teable.ai/en/api-reference/comment/get-comment-count /swagger.json get /comment/{tableId}/count Get record comment counts by query # Get comment count 1 Source: https://help.teable.ai/en/api-reference/comment/get-comment-count-1 /swagger.json get /comment/{tableId}/{recordId}/count Get record comment count # Get integritybase link check Source: https://help.teable.ai/en/api-reference/integrity/get-integritybase-link-check /swagger.json get /integrity/base/{baseId}/link-check Check integrity of link fields in a base # Post integritybase link fix Source: https://help.teable.ai/en/api-reference/integrity/post-integritybase-link-fix?tableid= /swagger.json post /integrity/base/{baseId}/link-fix?tableId={tableId} Fix integrity of link fields in a base # Delete organization department Source: https://help.teable.ai/en/api-reference/organization/delete-organization-department /swagger.json delete /organization/{organizationId}/department/{departmentId} # Delete organization department user Source: https://help.teable.ai/en/api-reference/organization/delete-organization-department-user /swagger.json delete /organization/{organizationId}/department-user # Delete organization user Source: https://help.teable.ai/en/api-reference/organization/delete-organization-user /swagger.json delete /organization/{organizationId}/user Delete organization user # Get instanceorganization Source: https://help.teable.ai/en/api-reference/organization/get-instanceorganization /swagger.json get /instance/organization Get instance organization, only for enterprise edition # Get organization Source: https://help.teable.ai/en/api-reference/organization/get-organization /swagger.json get /organization/{organizationId} Get organization # Get organization department Source: https://help.teable.ai/en/api-reference/organization/get-organization-department /swagger.json get /organization/{organizationId}/department/{departmentId} # Get organization department 1 Source: https://help.teable.ai/en/api-reference/organization/get-organization-department-1 /swagger.json get /organization/{organizationId}/department # Get organization department user Source: https://help.teable.ai/en/api-reference/organization/get-organization-department-user /swagger.json get /organization/{organizationId}/department-user # Get organization me Source: https://help.teable.ai/en/api-reference/organization/get-organization-me /swagger.json get /organization/{organizationId}/me Get organization me # Get organization setting Source: https://help.teable.ai/en/api-reference/organization/get-organization-setting /swagger.json get /organization/{organizationId}/setting Get organization setting # Get organization space Source: https://help.teable.ai/en/api-reference/organization/get-organization-space /swagger.json get /organization/{organizationId}/space Get organization space # Get organization user Source: https://help.teable.ai/en/api-reference/organization/get-organization-user /swagger.json get /organization/{organizationId}/user/{userId} # Get organization user exists Source: https://help.teable.ai/en/api-reference/organization/get-organization-user-exists /swagger.json get /organization/{organizationId}/user-exists # Get organization users Source: https://help.teable.ai/en/api-reference/organization/get-organization-users /swagger.json get /organization/{organizationId}/users Get organization users # Get organizationdepartment Source: https://help.teable.ai/en/api-reference/organization/get-organizationdepartment /swagger.json get /organization/department # Get organizationdepartment user Source: https://help.teable.ai/en/api-reference/organization/get-organizationdepartment-user /swagger.json get /organization/department-user # Get organizationme Source: https://help.teable.ai/en/api-reference/organization/get-organizationme /swagger.json get /organization/me Get my organization # Patch organization department move Source: https://help.teable.ai/en/api-reference/organization/patch-organization-department-move /swagger.json patch /organization/{organizationId}/department/{departmentId}/move # Patch organization department rename Source: https://help.teable.ai/en/api-reference/organization/patch-organization-department-rename /swagger.json patch /organization/{organizationId}/department/{departmentId}/rename # Patch organization department userdepartment Source: https://help.teable.ai/en/api-reference/organization/patch-organization-department-userdepartment /swagger.json patch /organization/{organizationId}/department-user/department # Patch organization department usermove Source: https://help.teable.ai/en/api-reference/organization/patch-organization-department-usermove /swagger.json patch /organization/{organizationId}/department-user/move # Patch organization user Source: https://help.teable.ai/en/api-reference/organization/patch-organization-user /swagger.json patch /organization/{organizationId}/user/{userId} Update organization user # Post organization department Source: https://help.teable.ai/en/api-reference/organization/post-organization-department /swagger.json post /organization/{organizationId}/department # Post organization department user Source: https://help.teable.ai/en/api-reference/organization/post-organization-department-user /swagger.json post /organization/{organizationId}/department-user # Post organization user Source: https://help.teable.ai/en/api-reference/organization/post-organization-user /swagger.json post /organization/{organizationId}/user Add organization user # Post organization user activate Source: https://help.teable.ai/en/api-reference/organization/post-organization-user-activate /swagger.json post /organization/{organizationId}/user/{userId}/activate Activate organization user # Post organization user deactivate Source: https://help.teable.ai/en/api-reference/organization/post-organization-user-deactivate /swagger.json post /organization/{organizationId}/user/{userId}/deactivate Deactivate organization user # Post organization users Source: https://help.teable.ai/en/api-reference/organization/post-organization-users /swagger.json post /organization/{organizationId}/users # Put organization department scope Source: https://help.teable.ai/en/api-reference/organization/put-organization-department-scope /swagger.json put /organization/{organizationId}/department-scope Update department scope # Put organization rename Source: https://help.teable.ai/en/api-reference/organization/put-organization-rename /swagger.json put /organization/{organizationId}/rename Rename organization # Put organization update auto space Source: https://help.teable.ai/en/api-reference/organization/put-organization-update-auto-space /swagger.json put /organization/{organizationId}/update-auto-space Update auto space # Delete table plugin context menu Source: https://help.teable.ai/en/api-reference/plugin-context-menu/delete-table-plugin-context-menu /swagger.json delete /table/{tableId}/plugin-context-menu/{pluginInstallId} Remove a plugin context menu # Get table plugin context menu Source: https://help.teable.ai/en/api-reference/plugin-context-menu/get-table-plugin-context-menu /swagger.json get /table/{tableId}/plugin-context-menu/{pluginInstallId} # Get table plugin context menu 1 Source: https://help.teable.ai/en/api-reference/plugin-context-menu/get-table-plugin-context-menu-1 /swagger.json get /table/{tableId}/plugin-context-menu # Get table plugin context menu storage Source: https://help.teable.ai/en/api-reference/plugin-context-menu/get-table-plugin-context-menu-storage /swagger.json get /table/{tableId}/plugin-context-menu/{pluginInstallId}/storage # Patch table plugin context menu rename Source: https://help.teable.ai/en/api-reference/plugin-context-menu/patch-table-plugin-context-menu-rename /swagger.json patch /table/{tableId}/plugin-context-menu/{pluginInstallId}/rename Rename a plugin context menu # Post table plugin context menuinstall Source: https://help.teable.ai/en/api-reference/plugin-context-menu/post-table-plugin-context-menuinstall /swagger.json post /table/{tableId}/plugin-context-menu/install Install a plugin context menu # Put table plugin context menu move Source: https://help.teable.ai/en/api-reference/plugin-context-menu/put-table-plugin-context-menu-move /swagger.json put /table/{tableId}/plugin-context-menu/{pluginInstallId}/move # Put table plugin context menu update storage Source: https://help.teable.ai/en/api-reference/plugin-context-menu/put-table-plugin-context-menu-update-storage /swagger.json put /table/{tableId}/plugin-context-menu/{pluginInstallId}/update-storage # Delete table plugin panel Source: https://help.teable.ai/en/api-reference/plugin-panel/delete-table-plugin-panel /swagger.json delete /table/{tableId}/plugin-panel/{pluginPanelId} Delete a plugin panel # Delete table plugin panel plugin Source: https://help.teable.ai/en/api-reference/plugin-panel/delete-table-plugin-panel-plugin /swagger.json delete /table/{tableId}/plugin-panel/{pluginPanelId}/plugin/{pluginInstallId} Remove a plugin from a plugin panel # Duplicate a dashboard installed plugin Source: https://help.teable.ai/en/api-reference/plugin-panel/duplicate-a-dashboard-installed-plugin /swagger.json post /table/{tableId}/plugin-panel/{pluginPanelId}/plugin/{installedId}/duplicate Duplicate a dashboard installed plugin # Duplicate a plugin panel Source: https://help.teable.ai/en/api-reference/plugin-panel/duplicate-a-plugin-panel /swagger.json post /table/{tableId}/plugin-panel/{pluginPanelId}/duplicate Duplicate a plugin panel # Get table plugin panel Source: https://help.teable.ai/en/api-reference/plugin-panel/get-table-plugin-panel /swagger.json get /table/{tableId}/plugin-panel/{pluginPanelId} Get a plugin panel # Get table plugin panel 1 Source: https://help.teable.ai/en/api-reference/plugin-panel/get-table-plugin-panel-1 /swagger.json get /table/{tableId}/plugin-panel Get all plugin panels # Get table plugin panel plugin Source: https://help.teable.ai/en/api-reference/plugin-panel/get-table-plugin-panel-plugin /swagger.json get /table/{tableId}/plugin-panel/{pluginPanelId}/plugin/{pluginInstallId} Get a plugin in plugin panel # Patch table plugin panel layout Source: https://help.teable.ai/en/api-reference/plugin-panel/patch-table-plugin-panel-layout /swagger.json patch /table/{tableId}/plugin-panel/{pluginPanelId}/layout Update the layout of a plugin panel # Patch table plugin panel plugin rename Source: https://help.teable.ai/en/api-reference/plugin-panel/patch-table-plugin-panel-plugin-rename /swagger.json patch /table/{tableId}/plugin-panel/{pluginPanelId}/plugin/{pluginInstallId}/rename Rename a plugin in a plugin panel # Patch table plugin panel plugin update storage Source: https://help.teable.ai/en/api-reference/plugin-panel/patch-table-plugin-panel-plugin-update-storage /swagger.json patch /table/{tableId}/plugin-panel/{pluginPanelId}/plugin/{pluginInstallId}/update-storage Update storage of a plugin in a plugin panel # Patch table plugin panel rename Source: https://help.teable.ai/en/api-reference/plugin-panel/patch-table-plugin-panel-rename /swagger.json patch /table/{tableId}/plugin-panel/{pluginPanelId}/rename Rename a plugin panel # Post table plugin panel Source: https://help.teable.ai/en/api-reference/plugin-panel/post-table-plugin-panel /swagger.json post /table/{tableId}/plugin-panel Create a plugin panel # Post table plugin panel install Source: https://help.teable.ai/en/api-reference/plugin-panel/post-table-plugin-panel-install /swagger.json post /table/{tableId}/plugin-panel/{pluginPanelId}/install Install a plugin to a table plugin panel # Get unsubscribe Source: https://help.teable.ai/en/api-reference/unsubscribe/get-unsubscribe /swagger.json get /unsubscribe/{token} Get unsubscribe information # Get unsubscribeexport list Source: https://help.teable.ai/en/api-reference/unsubscribe/get-unsubscribeexport-list /swagger.json get /unsubscribe/export-list/{baseId} Export unsubscribe list # Get unsubscribelist Source: https://help.teable.ai/en/api-reference/unsubscribe/get-unsubscribelist /swagger.json get /unsubscribe/list/{baseId} Get paginated unsubscribe list by baseId # Post unsubscribe Source: https://help.teable.ai/en/api-reference/unsubscribe/post-unsubscribe /swagger.json post /unsubscribe/{token} Update subscription status # Post unsubscribeimport list Source: https://help.teable.ai/en/api-reference/unsubscribe/post-unsubscribeimport-list /swagger.json post /unsubscribe/import-list/{baseId} Import unsubscribe list # Delete user integrations Source: https://help.teable.ai/en/api-reference/user-integration/delete-user-integrations /swagger.json delete /user-integrations/{integrationId} Delete user integration # Get user integrations Source: https://help.teable.ai/en/api-reference/user-integration/get-user-integrations /swagger.json get /user-integrations Get user integration list # Put user integrations name Source: https://help.teable.ai/en/api-reference/user-integration/put-user-integrations-name /swagger.json put /user-integrations/{integrationId}/name Update user integration name # Delete app Source: https://help.teable.ai/en/api-reference/app/delete-app /swagger.json delete /base/{baseId}/app/{appId} Delete app by its ID. # Get base app deploystatus Source: https://help.teable.ai/en/api-reference/app/get-base-app-deploystatus /swagger.json get /base/{baseId}/app/{appId}/deploy/status Get app deployment status # Get base app export code Source: https://help.teable.ai/en/api-reference/app/get-base-app-export-code /swagger.json get /base/{baseId}/app/{appId}/export-code Export app source code as a ZIP file # Patch base app files Source: https://help.teable.ai/en/api-reference/app/patch-base-app-files /swagger.json patch /base/{baseId}/app/{appId}/files Update app files # Patch base app props Source: https://help.teable.ai/en/api-reference/app/patch-base-app-props /swagger.json patch /base/{baseId}/app/{appId}/props Update app props # Permanently delete app Source: https://help.teable.ai/en/api-reference/app/permanently-delete-app /swagger.json delete /base/{baseId}/app/{appId}/permanent Permanently delete an app and all its data. This action cannot be undone. # Post base app deploy Source: https://help.teable.ai/en/api-reference/app/post-base-app-deploy /swagger.json post /base/{baseId}/app/{appId}/deploy Deploy app to Vercel # Post base app import code Source: https://help.teable.ai/en/api-reference/app/post-base-app-import-code /swagger.json post /base/{baseId}/app/{appId}/import-code Import app source code from a ZIP file # Post base app run Source: https://help.teable.ai/en/api-reference/app/post-base-app-run /swagger.json post /base/{baseId}/app/{appId}/run Run the app code # Delete base authority matrix role Source: https://help.teable.ai/en/api-reference/authority-matrix/delete-base-authority-matrix-role /swagger.json delete /base/{baseId}/authority-matrix-role/{authorityMatrixRoleId} Delete authority matrix role # Get base authority matrix Source: https://help.teable.ai/en/api-reference/authority-matrix/get-base-authority-matrix /swagger.json get /base/{baseId}/authority-matrix Get authority matrix # Get base authority matrix role Source: https://help.teable.ai/en/api-reference/authority-matrix/get-base-authority-matrix-role /swagger.json get /base/{baseId}/authority-matrix-role Get authority matrix role list # Get base authority matrix role 1 Source: https://help.teable.ai/en/api-reference/authority-matrix/get-base-authority-matrix-role-1 /swagger.json get /base/{baseId}/authority-matrix-role/{authorityMatrixRoleId} Get authority matrix role # Get base authority matrix role table filter link records Source: https://help.teable.ai/en/api-reference/authority-matrix/get-base-authority-matrix-role-table-filter-link-records /swagger.json get /base/{baseId}/authority-matrix-role-table/{tableId}/filter-link-records Get authority matrix table link records # Patch base authority matrix role description Source: https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrix-role-description /swagger.json patch /base/{baseId}/authority-matrix-role/{authorityMatrixRoleId}/description Update authority matrix role description # Patch base authority matrix role name Source: https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrix-role-name /swagger.json patch /base/{baseId}/authority-matrix-role/{authorityMatrixRoleId}/name Update authority matrix role name # Patch base authority matrix role status Source: https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrix-role-status /swagger.json patch /base/{baseId}/authority-matrix-role/{authorityMatrixRoleId}/status Update authority matrix role status # Patch base authority matrix role user Source: https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrix-role-user /swagger.json patch /base/{baseId}/authority-matrix-role/{authorityMatrixRoleId}/user Update authority matrix role user # Patch base authority matrixadmin user Source: https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrixadmin-user /swagger.json patch /base/{baseId}/authority-matrix/admin-user Update admin user # Patch base authority matrixstatus Source: https://help.teable.ai/en/api-reference/authority-matrix/patch-base-authority-matrixstatus /swagger.json patch /base/{baseId}/authority-matrix/status Enable authority # Post base authority matrix role Source: https://help.teable.ai/en/api-reference/authority-matrix/post-base-authority-matrix-role /swagger.json post /base/{baseId}/authority-matrix-role Add authority matrix role # Post base authority matrix role duplicate Source: https://help.teable.ai/en/api-reference/authority-matrix/post-base-authority-matrix-role-duplicate /swagger.json post /base/{baseId}/authority-matrix-role/{authorityMatrixRoleId}/duplicate Duplicate authority matrix role # Put base authority matrix Source: https://help.teable.ai/en/api-reference/authority-matrix/put-base-authority-matrix /swagger.json put /base/{baseId}/authority-matrix Update authority matrix # Put base authority matrix role Source: https://help.teable.ai/en/api-reference/authority-matrix/put-base-authority-matrix-role /swagger.json put /base/{baseId}/authority-matrix-role/{authorityMatrixRoleId} Update authority matrix role # Delete base workflow Source: https://help.teable.ai/en/api-reference/automation/delete-base-workflow /swagger.json delete /base/{baseId}/workflow/{workflowId} delete a automation workflow # Get base workflow Source: https://help.teable.ai/en/api-reference/automation/get-base-workflow /swagger.json get /base/{baseId}/workflow/{workflowId} get a automation workflow # Get base workflow 1 Source: https://help.teable.ai/en/api-reference/automation/get-base-workflow-1 /swagger.json get /base/{baseId}/workflow get automation workflow list in base # Get base workflow active snapshot Source: https://help.teable.ai/en/api-reference/automation/get-base-workflow-active-snapshot /swagger.json get /base/{baseId}/workflow/{workflowId}/active-snapshot Get the currently active (published) snapshot of a workflow. Returns the version that is actually running, as opposed to the draft version returned by getWorkflow. # Get base workflow run Source: https://help.teable.ai/en/api-reference/automation/get-base-workflow-run /swagger.json get /base/{baseId}/workflow/{workflowId}/run/{runId} get automation workflow run list # Get base workflow run 1 Source: https://help.teable.ai/en/api-reference/automation/get-base-workflow-run-1 /swagger.json get /base/{baseId}/workflow/{workflowId}/run get automation workflow run history list # Get base workflow runsummary Source: https://help.teable.ai/en/api-reference/automation/get-base-workflow-runsummary /swagger.json get /base/{baseId}/workflow/{workflowId}/run/summary get automation workflow run summary statistics # Permanently delete workflow Source: https://help.teable.ai/en/api-reference/automation/permanently-delete-workflow /swagger.json delete /base/{baseId}/workflow/{workflowId}/permanent Permanently delete a workflow and all its data. This action cannot be undone. # Post base workflow Source: https://help.teable.ai/en/api-reference/automation/post-base-workflow /swagger.json post /base/{baseId}/workflow Create a automation workflow # Post base workflow duplicate Source: https://help.teable.ai/en/api-reference/automation/post-base-workflow-duplicate /swagger.json post /base/{baseId}/workflow/{workflowId}/duplicate duplicate a automation workflow # Post base workflow filter link records Source: https://help.teable.ai/en/api-reference/automation/post-base-workflow-filter-link-records /swagger.json post /base/{baseId}/workflow/{tableId}/filter-link-records get automation workflow list in base # Post base workflow test Source: https://help.teable.ai/en/api-reference/automation/post-base-workflow-test /swagger.json post /base/{baseId}/workflow/{workflowId}/test/{nodeId} test a automation workflow node # Post base workflow test all Source: https://help.teable.ai/en/api-reference/automation/post-base-workflow-test-all /swagger.json post /base/{baseId}/workflow/{workflowId}/test-all test a automation workflow all # Post base workflow trigger Source: https://help.teable.ai/en/api-reference/automation/post-base-workflow-trigger /swagger.json post /base/{baseId}/workflow/{workflowId}/trigger Create a automation workflow trigger # Post base workflow trigger generate webhook token Source: https://help.teable.ai/en/api-reference/automation/post-base-workflow-trigger-generate-webhook-token /swagger.json post /base/{baseId}/workflow/{workflowId}/trigger/{triggerId}/generate-webhook-token Generate a new webhook token for the trigger # Put base workflow Source: https://help.teable.ai/en/api-reference/automation/put-base-workflow /swagger.json put /base/{baseId}/workflow/{workflowId} update a automation workflow # Put base workflow active Source: https://help.teable.ai/en/api-reference/automation/put-base-workflow-active /swagger.json put /base/{baseId}/workflow/{workflowId}/active active or inactive a automation workflow # Put base workflow order Source: https://help.teable.ai/en/api-reference/automation/put-base-workflow-order /swagger.json put /base/{baseId}/workflow/{workflowId}/order Update workflow order # Put base workflow trigger Source: https://help.teable.ai/en/api-reference/automation/put-base-workflow-trigger /swagger.json put /base/{baseId}/workflow/{workflowId}/trigger/{triggerId} update a automation workflow trigger # Delete base chat delete Source: https://help.teable.ai/en/api-reference/chat/delete-base-chat-delete /swagger.json delete /base/{baseId}/chat/{chatId}/delete # Delete base chat messages Source: https://help.teable.ai/en/api-reference/chat/delete-base-chat-messages /swagger.json delete /base/{baseId}/chat/{chatId}/messages Clear all messages in a chat # Get base chat messages Source: https://help.teable.ai/en/api-reference/chat/get-base-chat-messages /swagger.json get /base/{baseId}/chat/{chatId}/messages Get chat messages # Get base chathistory Source: https://help.teable.ai/en/api-reference/chat/get-base-chathistory /swagger.json get /base/{baseId}/chat/history Get chat history # Get chatonboardingscenarios Source: https://help.teable.ai/en/api-reference/chat/get-chatonboardingscenarios /swagger.json get /chat/onboarding/scenarios Get onboarding scenarios with presigned URLs for attachments # Patch base chat rename Source: https://help.teable.ai/en/api-reference/chat/patch-base-chat-rename /swagger.json patch /base/{baseId}/chat/{chatId}/rename # Post base chat stop Source: https://help.teable.ai/en/api-reference/chat/post-base-chat-stop /swagger.json post /base/{baseId}/chat/{chatId}/stop Stop an active chat stream and prevent resume # Post base chatcreate Source: https://help.teable.ai/en/api-reference/chat/post-base-chatcreate /swagger.json post /base/{baseId}/chat/create Create chat # Post base chatexecute script Source: https://help.teable.ai/en/api-reference/chat/post-base-chatexecute-script /swagger.json post /base/{baseId}/chat/execute-script Execute TypeScript code in sandbox for chat tools # Post base chatresolve attachments Source: https://help.teable.ai/en/api-reference/chat/post-base-chatresolve-attachments /swagger.json post /base/{baseId}/chat/resolve-attachments Resolve attachment tokens to presigned URLs # Post base chatsuggestions Source: https://help.teable.ai/en/api-reference/chat/post-base-chatsuggestions /swagger.json post /base/{baseId}/chat/suggestions # Post base chattext extract Source: https://help.teable.ai/en/api-reference/chat/post-base-chattext-extract /swagger.json post /base/{baseId}/chat/text-extract Extract text content from attachments # Post chatonboardingattachments Source: https://help.teable.ai/en/api-reference/chat/post-chatonboardingattachments /swagger.json post /chat/onboarding/attachments Get attachment info by tokens. Used for landing page onboarding flow. # Delete enterprise authentication Source: https://help.teable.ai/en/api-reference/enterprise/delete-enterprise-authentication /swagger.json delete /enterprise/{organizationId}/authentication/{id} Delete a authentication # Delete enterprise domain verification Source: https://help.teable.ai/en/api-reference/enterprise/delete-enterprise-domain-verification /swagger.json delete /enterprise/{organizationId}/domain-verification Delete a domain verification # Get enterprise authentication Source: https://help.teable.ai/en/api-reference/enterprise/get-enterprise-authentication /swagger.json get /enterprise/{organizationId}/authentication/{id} Get a authentication # Get enterprise authentication 1 Source: https://help.teable.ai/en/api-reference/enterprise/get-enterprise-authentication-1 /swagger.json get /enterprise/{organizationId}/authentication Get a authentication list # Get enterprise authenticationproviders Source: https://help.teable.ai/en/api-reference/enterprise/get-enterprise-authenticationproviders /swagger.json get /enterprise/{organizationId}/authentication/providers Get providers # Get enterprise domain verification Source: https://help.teable.ai/en/api-reference/enterprise/get-enterprise-domain-verification /swagger.json get /enterprise/{organizationId}/domain-verification Get a domain verification # Post enterprise authentication Source: https://help.teable.ai/en/api-reference/enterprise/post-enterprise-authentication /swagger.json post /enterprise/{organizationId}/authentication Create a authentication # Post enterprise domain verification Source: https://help.teable.ai/en/api-reference/enterprise/post-enterprise-domain-verification /swagger.json post /enterprise/{organizationId}/domain-verification Create a domain verification # Post enterprise domain verificationsend verification email Source: https://help.teable.ai/en/api-reference/enterprise/post-enterprise-domain-verificationsend-verification-email /swagger.json post /enterprise/{organizationId}/domain-verification/send-verification-email Send email verification # Put enterprise authentication Source: https://help.teable.ai/en/api-reference/enterprise/put-enterprise-authentication /swagger.json put /enterprise/{organizationId}/authentication/{id} Update a authentication # Claim a reward Source: https://help.teable.ai/en/api-reference/reward/claim-a-reward /swagger.json post /space/{spaceId}/reward/claim Submit a reward claim (e.g., social share) # Get reward credit list Source: https://help.teable.ai/en/api-reference/reward/get-reward-credit-list /swagger.json get /space/{spaceId}/reward/credit-list Get reward credit list for a space # Get reward details Source: https://help.teable.ai/en/api-reference/reward/get-reward-details /swagger.json get /space/{spaceId}/reward/{rewardId} Get details of a specific reward including its verification status # Delete enterprise space manage remove organization Source: https://help.teable.ai/en/api-reference/space-manage/delete-enterprise-space-manage-remove-organization /swagger.json delete /enterprise/{organizationId}/space-manage/{spaceId}/remove-organization Remove space from organization # Get enterprise space manage Source: https://help.teable.ai/en/api-reference/space-manage/get-enterprise-space-manage /swagger.json get /enterprise/{organizationId}/space-manage Get space manage list # Get enterprise space manage 1 Source: https://help.teable.ai/en/api-reference/space-manage/get-enterprise-space-manage-1 /swagger.json get /enterprise/{organizationId}/space-manage/{spaceId} Get space manage detail # Get enterprise space managecount Source: https://help.teable.ai/en/api-reference/space-manage/get-enterprise-space-managecount /swagger.json get /enterprise/{organizationId}/space-manage/count Get space manage list total # Post enterprise space manage add organization Source: https://help.teable.ai/en/api-reference/space-manage/post-enterprise-space-manage-add-organization /swagger.json post /enterprise/{organizationId}/space-manage/{spaceId}/add-organization Add space to organization # Security Source: https://help.teable.ai/en/basic/security Learn about Teable's security architecture, data protection, and compliance measures AES-256 & TLS Certified US-West Oregon OIDC Protocol Teable is committed to maintaining the security and privacy of your data. Our security practices are designed to protect your information while giving you full control over your workspace. ## Data Encryption ### Encryption in Transit All data transmitted between your browser and Teable servers is protected using **256-bit SSL/TLS encryption**. We enforce HTTPS for all connections with automatic HTTP to HTTPS redirection. ### Encryption at Rest All data stored in our databases is encrypted using **AES-256 encryption** through AWS infrastructure. This includes: * Database storage (PostgreSQL on AWS RDS) * File attachments * Backups You have full control over your encryption configuration based on your infrastructure requirements. We recommend: * Enabling database-level encryption * Using encrypted storage volumes * Implementing backup encryption ## Infrastructure Security Teable Cloud is hosted on **Amazon Web Services (AWS)** in the US-West (Oregon) region, leveraging AWS's enterprise-grade security infrastructure. Implementation of Helmet and Content Security Policy (CSP) to prevent common web vulnerabilities like XSS and clickjacking. Cloudflare Turnstile integration to prevent automated attacks and spam registrations. Protection against brute-force attacks on login attempts with account lockout, and rate limiting on email verification and password reset operations. All passwords are hashed using bcrypt algorithm with unique salts, making them resistant to rainbow table attacks. ## Access Controls ### Role-Based Permissions Teable provides granular role-based access control with five permission levels: | Role | Capabilities | | ------------- | --------------------------------------------------------------- | | **Owner** | Full control over the workspace, including billing and deletion | | **Creator** | Can create tables, views, and manage workspace structure | | **Editor** | Can edit records and field values | | **Commenter** | Can view content and add comments | | **Viewer** | Read-only access to content | ### Authority Matrix Authority Matrix allows fine-grained permission control at the field, record, and view level, enabling you to precisely define what each user or role can see and modify. This feature is particularly useful for: * Restricting sensitive fields (e.g., salary, personal information) * Limiting record access based on ownership or department * Creating custom views with different permission sets ### Share Link Protection Protect your shared views with password authentication. When enabled, recipients must enter the correct password before accessing the shared content. ## Data Management ### Record History Track all changes made to your records with a comprehensive revision history: * See who made changes and when * View previous values before modifications * Understand the complete lifecycle of your data ### Trash & Recovery Deleted items are moved to trash and can be recovered within the retention period, providing protection against accidental data loss. ### Data Backup & Export Teable provides multiple options for backing up your data: | Method | Description | Use Case | | ---------------------------------------------------------------------- | ------------------------------------------------------------------ | ---------------------- | | **[Base Export](/en/basic/base#export-base-backup-&-migration)** | Download entire Base as `.tea` file (structure, data, automations) | Full backup, migration | | **[Base Duplicate](/en/basic/base#duplicate-a-base-to-another-space)** | Create a copy of Base within Teable | Quick snapshot | | **[CSV Export](/en/basic/table/export)** | Export individual table data | Data portability | | **[API Export](/en/api-doc/record/get)** | Programmatically export records via REST API | Automated backups | You can manually back up your bases by exporting the entire Base as a `.tea` file, exporting individual tables as CSV files, or retrieving your data via the Teable API. ## Single Sign-On (SSO) Teable supports enterprise SSO through the **OIDC (OpenID Connect)** protocol, compatible with major identity providers: ## Compliance Teable Cloud has achieved ISO 27001 certification, demonstrating our commitment to information security management best practices. ## Self-Hosted Deployment For organizations with strict security or compliance requirements, Teable offers self-hosted deployment options: Keep all data within your own infrastructure and geographic boundaries Deploy within your VPC with custom firewall rules and network policies Integrate with your existing security stack, SIEM, and monitoring tools Implement your own backup and disaster recovery procedures ## Security Best Practices We recommend the following practices to maximize your workspace security: Create passwords with a mix of uppercase, lowercase, numbers, and symbols. Consider using a password manager. Single Sign-On provides centralized authentication management and additional security controls. Audit your workspace members and their permission levels periodically to ensure least-privilege access. When sharing views externally, always enable password protection for sensitive data. ## Contact For security-related inquiries or to report a vulnerability, please contact us at **[support@teable.ai](mailto:support@teable.ai)** # Changelog 2026 Source: https://help.teable.ai/en/changelog # Security, performance, and stability updates ## Feature Updates * **Added secure credential support for Email automations**: Email triggers can use authorized credentials, avoiding stored passwords and diagnostic exposure. * **Added Chat resource change summaries**: After each conversation, Chat summarizes resources created or modified by the Agent. ## Bug Fixes & Improvements * **Improved large-table performance and stability**: Reduced lag, timeouts, and failures when editing, inserting, pasting, or reordering records in older views. * **Improved comment count reliability**: Comment counts now update more promptly and accurately when records are edited. * **Improved calculation activity refresh stability**: Enhanced refreshes during reconnections and high activity while enforcing access permissions. * **Optimized table search**: Shows only published, available indexes; correctly falls back when none exist and improves large-table response times. * **Fixed Number field display settings**: Bar or ring chart settings are now cleared when switching back to standard number display. * **Fixed Agent operation progress**: Progress cards now display correctly when creating an app and performing other actions simultaneously. * **Improved Chat navigation stability**: Prevents resources created in other Bases from causing unexpected redirects or persistent processing states. * **Fixed user field mode switching**: Grid views load correctly and existing assignments remain when switching between single-select and multi-select. * **Improved App Builder export security**: Copies and downloads exclude authorized credentials and connection secrets; owners must provide them separately. # Scraper Expansion and Stability Improvements ## Feature Updates * **Expanded Scraper capabilities**: Added discovery for X profiles, Facebook content, Amazon sellers, Walmart reviews, and Crunchbase people, with localized labels. ## Bug Fixes & Improvements * **Improved long-tail Scraper dataset access**: Search shows discovery modes and supports raw dataset IDs with `discoverBy`. * **Improved Scraper CLI workflow**: `teable scrape run` returns snapshot IDs immediately; use `teable scrape status --wait` to await completion. * **Improved Scraper safety and billing accuracy**: Refined limits and pending-request reuse to prevent duplicate charges during concurrent status queries. * **Improved large-workspace table analysis stability**: Reduced database stalls and temporary 503 errors, making analysis more reliable. * **Improved computation task tracking**: Ensured consistent batch reruns within stages and clarified serial retries for easier troubleshooting. * **Clarified complexity metric naming**: Renamed “Dirty Records” to “Estimated Complexity,” making computation workload easier to assess. * **Improved app and automation credential wording**: Renamed secret “Rotate” to “Edit” without changing how updates work. * **Fixed user avatars in credentials and configurations**: Owner avatars display correctly, with initials shown when no avatar exists. * **Improved credential usage lists**: Shows only additional resources, truncates long names with tooltips, preserves actions, and displays access grant times. * **Improved computed field updates under high concurrency**: Enhanced data processing to reduce timeouts and update failures. * **Fixed Lookup and Rollup field inconsistencies**: Unified handling of saved and transformed options, cross-Base references, and version changes. * **Improved table loading and connection stability**: Reduced unnecessary requests during initial loads, reconnections, and frequent operations for smoother use. * **Fixed computation activity notifications**: Prevented subscription errors from triggering unrelated global notifications. * **Fixed User field filters after type changes**: Preserves filters and values across selection modes, preventing failures and Grid loading issues. * **Fixed empty-search loading issues**: Opening search with `Cmd+F` no longer loops Grid row loading or resets filters, sorting, and grouping. * **Improved shared view loading reliability**: More consistent field and record loading reduces missing or out-of-sync data. # URL recognition, credentials, and search optimization ## Feature Updates * **Automatic URL detection**: Clickable links work across text fields, including Formula, Rollup, and Long Text, with CJK and touch support. * **Automatic links for AI-created URL fields**: New website and URL columns use auto-linking plain text fields; existing configurations remain supported. * **Centralized credential management**: Manage reusable personal API keys and third-party connections in Settings › Integrations, with resource permissions and usage tracking. * **Secure credential binding**: Apps, automations, and transferred resources retain placeholders; collaborators bind credentials and use aliases for multiple users. * **AI credential confirmation**: AI-assisted building requests confirmation before using credentials and masks keys in test output. * **Scraper data access**: The chat “+” menu adds a Scraper option for curated datasets, localized prompts, and permission-based access. * **Natural-language Scraper discovery**: Find datasets beyond the curated catalog and view required inputs more clearly for faster data collection. ## Fixes & Improvements * **Improved all-field search scope**: Uses configured indexes, includes newly added fields, and limits unindexed ILIKE searches to 20 eligible fields. * **Improved text search compatibility**: Records with inconsistent or unsupported date values are no longer skipped or cause failures. * **Clearer calculation timelines**: Improved status labels and task relationships show progress from source updates through processing to completion. * **Fixed idle table calculation status**: Idle tables no longer remain on “Checking calculation status” when other tables have queued tasks. * **Improved credential usage display**: Summaries now count only hidden resources, with better truncation for long resource names and aliases. * **Improved Scraper reliability**: Unavailable posts no longer appear as verification failures, and LinkedIn scraping avoids premature timeouts. * **Improved table query reliability**: Applies sensible defaults when query options are omitted, preventing parameter-related errors. * **Faster Table Query Ops overview**: Shows only recent data by default, improving page load times and administrative responsiveness. * **Faster calculations and conditional aggregations**: Improves high-load processing for quicker data updates and statistical results. * **More stable real-time table activity**: Better handles load spikes and delayed calculation activity, reducing connection errors and repeated retries. * **Improved sharing and batch requests**: Ignores inaccessible private activity data, preventing one permission issue from failing the entire request. * **Fixed OAuth authorization**: App Builder integrations always show authorization prompts, and Google Sheets proceeds beyond selection after authorization. * **Consistent OAuth service support**: Aligned App Builder Chat, General Chat, App Builder Agent Computer, and related CLI commands. * **Improved resilience during brief database outages**: Reduces intermittent errors across tables, records, comments, sharing, and chat during connection recovery. * **Fixed date-grouped summaries**: Group-level values now match visible daily and monthly groups instead of appearing incorrect or empty. * **Fixed filtered comment counts**: Corrected legacy single-value date lookup fields while preserving permissions, pagination, collapsed groups, and substring search. # Calculation, Search, and Stability Optimization ## Fixes & Improvements * **Improved calculated field stability**: Fixed idle tables remaining stuck on “Checking calculation status” after Lookup or linked record updates. * **Improved multi-level calculation accuracy**: Fixed missing or delayed downstream formula updates during multi-step Lookup and calculated field recalculation. * **Optimized calculated field performance**: Reduced unnecessary calculations, Lookup, and Rollup updates when no records or results changed. * **Improved calculation status messaging**: Prevented false warnings, clarified empty tasks, and retained unresolved errors for accurate progress tracking. * **Improved calculation activity reliability**: Displayed errors clearly and preserved existing status after check failures or timeouts. * **Prevented redundant invalid tasks**: Stopped retries for tasks tied to deleted or missing Bases, improving stability. * **Improved shared document stability**: Enhanced error handling for collaboration, loading, and activity replay failures, with clearer permission messages. * **Improved AI settings**: Fixed crashes when provider data is missing and allowed administrators to save empty custom provider configurations. * **Improved full-field search performance**: Optimized large-table searches across lists, counts, groups, and aggregations, including numbers, rounded values, and short keywords. * **Improved search task responsiveness**: Statistical queries now stop when users change or cancel searches, reducing wasted time and resources. * **Improved restricted-user access**: Fixed false permission errors for readable calculated fields and improved reliability after permission changes or reconnection. # GPT-6 Is Now in Teable GPT-6 now in Teable GPT-6 Astra brings a major leap in tackling complex business tasks. Compared with GPT-5.6 Sol, it completes **2.3x as many multistep business workflows** on AutomationBench, with scores roughly **34% higher on data science tasks** and **50% higher on database migration tasks** in OpenAI’s evaluations. For Teable users, this means more capable AI for analyzing data, building apps, and creating workflows. It understands your requirements better, stays on track through longer tasks, and produces results that more closely match your business needs. You can try it in Teable now. # Query Deduplication and AI Import Optimization ## Feature Updates * **Added Lookup field deduplication**: Removes duplicate values from multiple linked records for cleaner, more readable results. * **Added AI import recommendations**: Prioritizes AI import when creating tables from existing content for faster, more accurate organization. ## Bug Fixes & Improvements * **Improved Cuppy context window indicator**: Uses a neutral gray progress ring to clarify automatic context compression. * **Improved filter layout**: Value inputs use available row width, with better Current User and statistical field filtering. * **Improved public automation Webhook stability**: Fixed persistent 429 errors below documented rate limits, ensuring throttling states recover and reset properly. * **Improved AI import reliability**: Better handles quota-related rejections and edge cases for more stable, consistent results. * **Optimized large-table search**: Improved full-field search across lists, counts, groups, aggregations, shared views, and concurrent queries. * **Optimized statistical query cancellation**: Reduces unnecessary processing when search criteria change or queries are canceled, improving responsiveness. * **Improved Rollup conversion stability**: Fixed switching from “Unique Array” to “Count All” and validates formats against new result types. * **Improved nested formula stability and performance**: Optimized repeated empty checks for Attachment, User, or Lookup fields, reducing computed-field update timeouts. * **Fixed Lookup field filtering**: “Contains any → Current User” now correctly filters referenced User fields. # New Pricing: More AI Credits. Save 44% Yearly. > More AI Credits, a deeper yearly discount: yearly billing saves approximately **44%** compared with monthly billing, while delivering **50% more AI Credits per dollar** than before—making team growth more cost-effective and predictable. Teable Cloud yearly pricing with Pro and Business credit allocations ## 1. What’s Changed We are introducing new pricing for Cloud and Self-hosted plans, with more AI Credits included. Yearly billing saves approximately **44%** compared with monthly billing: * **Pro (Cloud)** * Monthly: \$12 → \$24 * Yearly: \$120 → \$160 (\$10 → \$13.33/month) * AI Credits: 1,000 → 2,000 per seat/month * **Business (Cloud and Self-hosted)** * Monthly: \$24 → \$36 * Yearly: unchanged at \$240 (\$20/month) * AI Credits (Cloud only): 2,000 → 3,000 per seat/month For yearly Pro customers, included AI Credits increase by **100%**, while the monthly-equivalent price increases by only **\$3.33, or 33%**. For yearly Business customers, pricing remains unchanged across Cloud and Self-hosted, while Cloud customers receive **50% more Credits**. ## 2. How Seats and Credits Work A Teable Cloud subscription is now based on two things: the number of paid seats your team needs and the amount of AI Credits included with each seat. All Credits are combined into one shared monthly pool: **Purchased seats × Credits per seat = your team’s shared monthly Credits** For example, five Pro seats include a shared pool of **10,000 Credits per month**. Owner, Creator, and Editor roles occupy paid seats, while Viewers and Commenters remain free. If your team needs more AI capacity, you can select a higher Credit level directly within your plan. Larger Business Credit levels also include volume pricing. For new subscriptions, this replaces the previous model of purchasing recurring Credit add-ons separately. ## 3. Why We’re Making This Change Since the beginning of the year, Teable’s paid user base has grown more than 60×. Teams are increasingly relying on Teable AI for important workflows, applications, and day-to-day operations, raising expectations for product quality, reliability, and model capability. This update enables us to keep investing in a faster and more reliable product, continued access to leading AI models, and better support for production and business-critical workflows. At the same time, the larger yearly discount gives long-term customers a substantially lower and more predictable cost, helping us invest consistently in the product they depend on. ## 4. Existing Customers Get More at the Same Price Existing customers keep their current price and automatically receive more AI Credits (for Cloud customers)—no action required. For example, existing Pro yearly customers remain at the equivalent of **\$10 per seat/month**, while included Credits double from **1,000 to 2,000 per seat/month**. Seat changes keep the legacy price. Switching plans, billing cycles, or Credit levels moves the subscription to current pricing. We’re grateful to the customers who have grown with Teable. We’ll continue honoring that trust by bringing long-term customers more value with every meaningful product and AI upgrade. # Automation, attachments, and intelligent collaboration ## Feature Updates * **Webhook synchronous responses**: Automation triggers support custom responses for Feishu/Lark, Slack, WeCom, and DingTalk URL verification; existing defaults remain unchanged. * **Attachment deletion in previews**: Delete files while previewing; automatically switch to adjacent attachments for smoother review and organization. * **Multi-Base Chat agents**: Discover and use accessible Bases in the current Space, or specify a target Base per command. ## Bug Fixes & Improvements * **Improved computed-field pausing**: Allows safe writes during pauses; blocked writes return clear conflict messages and recommended retry times. * **Standardized Secrets Manager terminology**: All languages use “Name” for Secret identifiers and “Secret” for values, reducing configuration confusion. * **Stable table and schema updates**: Better handles timeouts, missing columns, and rollbacks, reducing failures, misleading messages, and manual recovery. * **Reliable calculations and backfills**: Fixed multi-value Lookup, linked-record Rollup, and `max`/`min`/`and`/`or` failures; timed-out calculations retry automatically. * **Fixed formula field creation**: Failed creation no longer makes related tables temporarily unavailable, allowing continued data access and operations. * **Improved Webhook testing and configuration**: Tests show received requests; editing some settings preserves authorization and response configurations. * **Linked-record Rollup results**: Compressed results show readable titles, preserve duplicates, and match UI/API behavior; integrations using legacy structures may need updates. * **Improved conditional Rollup filters**: Preserves nested groups after reopening, works in narrow panels, and aligns Lookup-number results with API filters. * **Attachment preview compatibility**: Displays file icons in thumbnails and previews when images fail to render, preventing blank or broken content. * **Chat agent Base detection**: Improves discovery for Base-level users and prevents Base context leaking into shared or restored sessions. * **Fixed API Access page**: Opening tables from the app sidebar no longer hangs; Advanced now uses the selected table. * **Fixed long text field actions**: Referenced fields now open record context menus while preserving native browser menus for selected read-only text. * **Improved Field AI errors**: Clarifies cancellation reasons for billing, quotas, authentication, account issues, and image-generation failures. * **Reliable CLI Artifact operations**: Fixed operations using personal access or OAuth tokens; permissions and Space/Base restrictions are always enforced. * **Consistent Artifact permissions after moves**: Artifacts follow their Base across Spaces and retain applicable access and sharing rules. * **More stable App Builder chat**: Improves recovery after interruptions, prevents persistent “Recovering” states, and enhances rich-content display stability and security. * **Improved mobile settings**: Refined layouts and navigation for smoother browsing and operation on mobile devices. * **Faster wide-table queries**: Requests for limited fields load less unnecessary data, reducing resource usage and accelerating record queries. # Artifact and stability upgrades ## Feature Updates * **Cross-session Artifact updates**: Agents update existing Artifacts, preserve history, and see names in tabs; Artifact API/CLI dropped legacy chat parameters. * **HEIC attachment thumbnails**: Generates PNG previews when supported; otherwise shows placeholders to prevent display issues. * **App Builder publishing guidance**: Preview/Live switching is smoother and remembered per app; apps without Live versions receive clear publishing guidance. * **AI field concurrency settings**: Space admins can configure concurrency; above-limit values are retained while the effective limit is displayed. ## Bug Fixes & Improvements * **Updated API table creation defaults**: Tables created without records via API are empty; UI-created tables retain three blank records. * **Faster large-table browsing**: Lists and grids load less via cursor pagination; API clients must request totals or use the count endpoint. * **Refined substring search**: Prioritizes text and text-returning Formula/Lookup fields; wide-table or unsupported-field results may change. * **Improved record-query performance and stability**: High-traffic reads use fewer resources while preserving existing query behavior and improving access efficiency. * **Fixed recent Base ordering and duplicate collaborators**: New copies appear first; duplicates merge under the highest available role. * **Improved conditional Rollup configuration**: Fixes nested OR and dynamic-match saving/calculation issues and improves narrow-screen controls. * **Improved Rollup validation**: APIs enforce UI source-field and aggregation rules with clear errors; invalid legacy configurations require client updates. * **More reliable computed-field updates**: Formula, Lookup, Rollup, and summary fields recalculate reliably after linked or dependent data changes. * **Faster conditional Rollup calculations**: Multiple Rollups sharing linked records recalculate more efficiently, reducing timeout risks. * **Improved Computed Outbox diagnostics**: Reliable task and error links, shared links, and Copy for Agent output accelerate troubleshooting. * **Fixed linked-record selection state**: Selections and checkboxes remain synchronized across tab switches, reopened pickers, and asynchronous loading. * **Streamlined Agent Computer browser tasks**: AI tasks use built-in browser tools, eliminating downloads and path setup for faster, consistent execution. * **Fixed AI chat external-link dialog layout**: Controls no longer overlap, improving readability and usability. * **Improved short-link redirects**: Links now redirect directly to canonical targets, reducing intermediate loading and wait time. * **Fixed Auto Number filtering**: “Greater than” no longer breaks loading or row counts; saved values display correctly when reopened. * **Secured editable shared views**: Record and field changes, including range paste, clear, and delete, are restricted to authorized views. * **Fixed cross-Base Lookup/Rollup configuration**: Linked tables remain available when reopened; empty external Base references follow current-Base handling. * **More accurate selected-row summaries**: Aggregations reliably honor filters, sorting, search, row ranges, and collapsed groups, with improved Timestamp support. * **Fixed Single Select Rollups**: Unique values retain first-seen order; Count includes only unique non-empty values, potentially reducing results. * **Improved linked-field failure resilience**: Record creation and schema updates remain stable when imports or deletions create inconsistent references. * **Faster AI-assisted workflows**: Reduced redundant refreshes and requests across script editing, publishing, chat, and automations for smoother interactions. * **Fixed record comment permissions**: Authorized collaborators can comment; read-only users only view discussions, and shared links hide comment controls. * **Improved comment deletion and image uploads**: Deleted comments stay removed; uploads show clearer progress and errors, with sending blocked until completion. * **Improved App Builder workspace recovery**: Temporary connection issues preserve workspaces and drafts; corrected version-history alignment prevents publishing failures. * **Improved permission matrix usability**: Clearer status icons, tooltips, and better narrow-screen sidebar usability. * **Fixed record archiving and export permissions**: Authorized collaborators archive without delete rights; archive exports respect permissions, and views update promptly. * **Unified Skill and Teable CLI instance configuration**: Instructions, commands, authentication, settings, and errors now use the current instance address. # Introducing Artifacts: Share Data Reports Anywhere > Turn your Teable data into visual reports with AI, refine them through conversation, and share them with a link. ## 1. Create Artifacts with AI Ask Teable AI to create a report, chart, summary, or comparison from your data. It generates an Artifact that you can open directly from the chat.