Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,8 @@
"en/basic/field/basic/multiple-select",
"en/basic/field/basic/date",
"en/basic/field/basic/rating",
"en/basic/field/basic/checkbox"
"en/basic/field/basic/checkbox",
"en/basic/field/basic/attachment"
]
},
{
Expand Down Expand Up @@ -303,6 +304,8 @@
"en/basic/admin-panel/template-admin",
"en/basic/admin-panel/settings",
"en/basic/admin-panel/ai-setting",
"en/basic/admin-panel/automation-management",
"en/basic/admin-panel/sandbox-agent",
"en/basic/admin-panel/multitenancy"
]
},
Expand Down Expand Up @@ -432,7 +435,8 @@
"zh/basic/space/space-invite",
"zh/basic/space/base-invite",
"zh/basic/space/space-permission",
"zh/basic/space/billing"
"zh/basic/space/billing",
"zh/basic/space/im-integration"
]
},
{
Expand Down Expand Up @@ -534,7 +538,8 @@
"zh/basic/field/basic/multiple-select",
"zh/basic/field/basic/date",
"zh/basic/field/basic/rating",
"zh/basic/field/basic/checkbox"
"zh/basic/field/basic/checkbox",
"zh/basic/field/basic/attachment"
]
},
{
Expand Down Expand Up @@ -666,6 +671,8 @@
"zh/basic/admin-panel/template-admin",
"zh/basic/admin-panel/settings",
"zh/basic/admin-panel/ai-setting",
"zh/basic/admin-panel/automation-management",
"zh/basic/admin-panel/sandbox-agent",
"zh/basic/admin-panel/multitenancy"
]
},
Expand Down
15 changes: 7 additions & 8 deletions en/api-doc/record/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ POST /api/table/\{tableId\}/record
```json
[
{
fields: {
"fields": {
"Name": "John Doe",
"Age": 30,
"Email": "john@example.com"
}
},
{
fields: {
"fields": {
"Name": "Jane Smith",
"Age": 28,
"Email": "jane@example.com"
Expand All @@ -50,7 +50,7 @@ POST /api/table/\{tableId\}/record
* When set to "name":
```json
{
fields: {
"fields": {
"Name": "John Doe",
"Age": 30
}
Expand All @@ -59,7 +59,7 @@ POST /api/table/\{tableId\}/record
* When set to "id":
```json
{
fields: {
"fields": {
"fldABCDEFGHIJKLMN": "John Doe",
"fldOPQRSTUVWXYZ12": 30
}
Expand Down Expand Up @@ -112,9 +112,9 @@ POST /api/table/\{tableId\}/record
* Complete example:
```json
{
viewId: "viwABCDEFGHIJKLMN",
anchorId: "rec123456789ABCDE",
position: "after"
"viewId": "viwABCDEFGHIJKLMN",
"anchorId": "rec123456789ABCDE",
"position": "after"
}
```
* Note: Using order allows precise control of new record positions in a specific view.
Expand Down Expand Up @@ -239,4 +239,3 @@ POST /api/table/\{tableId\}/record
print(response.json())
```
</CodeGroup>

21 changes: 18 additions & 3 deletions en/api-doc/record/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To clear a field's value, explicitly pass `null`. If a field name is not include
* When set to "name":
```json
{
fields: {
"fields": {
"Name": "John Doe",
"Age": 30
}
Expand All @@ -54,7 +54,7 @@ To clear a field's value, explicitly pass `null`. If a field name is not include
* When set to "id":
```json
{
fields: {
"fields": {
"fldABCDEFGHIJKLMN": "John Doe",
"fldOPQRSTUVWXYZ12": 30
}
Expand Down Expand Up @@ -88,6 +88,22 @@ To clear a field's value, explicitly pass `null`. If a field name is not include

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
{
"viewId": "viwABCDEFGHIJKLMN",
"anchorId": "rec123456789ABCDE",
"position": "after"
}
```

### Response

#### Success Response
Expand Down Expand Up @@ -191,4 +207,3 @@ For uploading new files to attachment fields, please refer to the [Upload Attach
print(response.json())
```
</CodeGroup>

62 changes: 62 additions & 0 deletions en/basic/admin-panel/automation-management.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: "Automation management"
description: "View automation run status, success rate, and run history in the Admin Panel."
---

<Tip>Available for self-hosted Business plan and above</Tip>

Path: Admin Panel → Automation management

**Automation management** is used to view automation run status across the instance.

## 1. 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 |

## 2. 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.

## 3. 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**.

## 4. 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.

## 5. Actions

From the automation list, you can:

- **Deactivate**: Stop the automation from being triggered.
- **Mark for deletion**: Mark the automation for deletion.
4 changes: 0 additions & 4 deletions en/basic/admin-panel/multitenancy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,3 @@ Teable Instance
├── Marketing Department Organization
└── Sales Department Organization
```

<Note>
Organization functionality requires a subscription license. To upgrade your license, please visit the license management page.
</Note>
13 changes: 8 additions & 5 deletions en/basic/admin-panel/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "Overview"
description: "Teable's self-hosted deployments include an admin panel for managing your instance."
description: "Teable's self-hosted Admin Panel is used to manage instance users, spaces, and system configuration."
---

<Tip>Available for self-hosted Business plan and above</Tip>

The Admin Panel provides centralized management for your Teable instance. As an administrator, you can manage Users, Spaces, Template Admin, Instance Settings, and AI Settings.
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

Expand All @@ -17,9 +17,12 @@ After logging in as an administrator, click the "Admin Panel" button in the uppe

- **[Users](/en/basic/admin-panel/users)** - Manage user accounts, permissions, and access
- **[Spaces](/en/basic/admin-panel/spaces)** - Manage spaces and auto-join settings
- **[Template Admin](/en/basic/admin-panel/template-admin)** - Configure template center and custom templates
- **[Instance Settings](/en/basic/admin-panel/settings)** - Configure system-wide settings and permissions
- **[AI Settings](/en/basic/admin-panel/ai-setting)** - Configure AI features and models
- **[Self-hosted license](/en/deploy/activate)** - Register, update, and view the current instance license
- **[Template admin](/en/basic/admin-panel/template-admin)** - Configure template center and custom templates
- **[Instance settings](/en/basic/admin-panel/settings)** - Configure system-wide settings and permissions
- **[AI settings](/en/basic/admin-panel/ai-setting)** - Configure AI features and models
- **[Automation management](/en/basic/admin-panel/automation-management)** - View automation run status and run history
- **[Sandbox Agent](/en/basic/admin-panel/sandbox-agent)** - Configure Sandbox Agent runtime limits and base snapshots

### Administrator Permissions

Expand Down
47 changes: 47 additions & 0 deletions en/basic/admin-panel/sandbox-agent.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: "Sandbox Agent"
description: "Configure Sandbox Agent enablement scope, runtime limits, and base snapshots."
---

<Tip>Available for self-hosted Business plan and above</Tip>

Path: Admin Panel → Sandbox Agent

The **Sandbox Agent** page contains **Settings** and **Sandboxes** tabs for configuring how AI Chat runs in sandboxes.

## 1. Enablement Scope

In the **Settings** tab:

1. Turn on **Enable Sandbox Agent**.
2. Configure spaces in **Enabled Spaces**.
3. To enable all spaces, use **Enable for All Spaces**.

## 2. Runtime Limits

Configure runtime limits in the **Settings** tab:

| Setting | Description |
|------|------|
| **Models** | Configure available models for each agent type |
| **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 AI chats each user can run at the same time |
| **vCPUs** | Set the number of vCPUs for each sandbox instance |
| **Thinking Effort** | Set the default thinking effort for agents |

Click **Save** after configuring the settings.

## 3. Base Snapshots

Create and manage snapshots in **Base Snapshots**.

- Use **Quick Setup** to complete **Import Skills**, **Chat Snapshot**, and **App Builder**.
- Use **Create Snapshot** to customize Agent SDK, system tools, Skills, and custom apt packages.
- After a snapshot status is **Ready**, it can be set as **Active**.

## 4. Sandboxes Tab

In the **Sandboxes** tab, view active sandboxes and session history.

The list shows Sandbox ID, Provider, Status, Uptime, and Last Activity. When needed, follow the page prompts to destroy a sandbox.
7 changes: 3 additions & 4 deletions en/basic/ai/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ Teable integrates powerful AI capabilities throughout the platform to help you w
<Card title="AI Fields" icon="sparkles" href="/en/basic/field/ai/ai-field">
Automatically generate, summarize, translate, and extract information from your data using AI-powered fields.
</Card>
<Card title="AI Action" icon="bolt" href="/en/basic/automation/ai-action">
<Card title="AI generate" icon="bolt" href="/en/basic/automation/actions/ai/ai-generate">
Integrate AI processing into your automation workflows for intelligent data handling.
</Card>
<Card title="AI Script" icon="code" href="/en/basic/automation/ai-script">
<Card title="Run script" icon="code" href="/en/basic/automation/actions/ai/ai-script">
Write custom AI-powered scripts to extend automation capabilities.
</Card>
<Card title="AI Chat" icon="messages" href="/en/basic/ai/ai-chat">
Expand Down Expand Up @@ -46,5 +46,4 @@ Teable integrates powerful AI capabilities throughout the platform to help you w
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 Actions in your workflows for intelligent processing

5. **Build Automations** - Use AI generate and Run script actions in your workflows
3 changes: 2 additions & 1 deletion en/basic/automation/action.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: "Actions"
---

<Note>This page is deprecated and no longer appears in the documentation navigation. It is kept only for old links. Please use the specific action pages under Automation instead.</Note>

Actions define specific operations to be executed when a trigger is activated. Teable offers various action types to help you achieve different automation needs. Here's a detailed guide on action configuration:

### 1. Create Record
Expand Down Expand Up @@ -197,4 +199,3 @@ The system will automatically create corresponding records upon execution.
* Bulk information validation

By combining these actions flexibly, you can build complex automation workflows to significantly improve work efficiency and data processing accuracy.

11 changes: 6 additions & 5 deletions en/basic/automation/actions/ai/ai-generate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Use AI models to generate text or structured data in a workflow"
---

<Tip>
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.
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.
</Tip>
Expand Down Expand Up @@ -178,12 +178,13 @@ Text: {{Content}}
- 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 → Integrations if the default models do not meet your needs.
- 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).

<Tip>Connect third-party AI models via **Space → Settings → Integrations**.</Tip>
<Tip>Connect third-party AI models via **Space → Settings → AI settings**.</Tip>

## Related

- [Loop (batch)](../logic/loop-run) — process multiple records with AI in a single automation run
- [AI script guide](/en/basic/automation/ai/scripting/ai-script-guide) — for custom logic that goes beyond prompt-based generation
- [Create record](/en/basic/automation/actions/records/create-record) — store AI-generated data as new records
- [Run script guide](/en/basic/automation/ai/scripting/ai-script-guide) — 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)
6 changes: 3 additions & 3 deletions en/basic/automation/actions/ai/ai-script.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Describe what you need in plain language and let AI write the auto
---

<Tip>
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.
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.
</Tip>
Expand All @@ -24,8 +24,8 @@ Describe the goal once, and the workflow is ready — no manual setup needed.
## 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**
- **Open the editor** — in the configuration panel, click **Open Editor**
- **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
Expand Down
Loading
Loading