# Send Teable to your agent
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
## Fast path
- Download the package from Yavira.
- Extract it into a folder your agent can access.
- Paste one of the prompts below and point your agent at the extracted folder.
## Suggested prompts
### New install

```text
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete.
```
### Upgrade existing

```text
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run.
```
## Machine-readable fields
```json
{
  "schemaVersion": "1.0",
  "item": {
    "slug": "teable-api",
    "name": "Teable",
    "source": "tencent",
    "type": "skill",
    "category": "开发工具",
    "sourceUrl": "https://clawhub.ai/killgfat/teable-api",
    "canonicalUrl": "https://clawhub.ai/killgfat/teable-api",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadUrl": "/downloads/teable-api",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=teable-api",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "packageFormat": "ZIP package",
    "primaryDoc": "SKILL.md",
    "includedAssets": [
      "README.md",
      "SKILL.md",
      "clawhub.json",
      "examples/usage_examples.md",
      "references/data-types-and-typecast.md",
      "requirements.txt"
    ],
    "downloadMode": "redirect",
    "sourceHealth": {
      "source": "tencent",
      "slug": "teable-api",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-05-09T19:26:18.804Z",
      "expiresAt": "2026-05-16T19:26:18.804Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=teable-api",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=teable-api",
        "contentDisposition": "attachment; filename=\"teable-api-1.0.6.zip\"",
        "redirectLocation": null,
        "bodySnippet": null,
        "slug": "teable-api"
      },
      "scope": "item",
      "summary": "Item download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this item.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/teable-api"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    }
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/teable-api",
    "downloadUrl": "https://openagent3.xyz/downloads/teable-api",
    "agentUrl": "https://openagent3.xyz/skills/teable-api/agent",
    "manifestUrl": "https://openagent3.xyz/skills/teable-api/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/teable-api/agent.md"
  }
}
```
## Documentation

### Teable API

Complete Teable API management skill for OpenClaw. Provides full CRUD operations for records, bases, spaces, tables, dashboards, and trash.

### Metadata

name: teable-api
description: Complete Teable API management - manage records, bases, spaces, tables, dashboards, and trash
author: Cortana
version: 1.0.6
created: 2026-02-27
requires:
  env: [TEABLE_API_KEY]

Note: TEABLE_URL is optional for self-hosted instances (defaults to https://app.teable.ai)

### Prerequisites

Install the required Python package:

pipx install requests
# or globally
pip3 install requests

### Environment Variables

Required: Set the TEABLE_API_KEY environment variable before using any scripts:

# Temporary (current shell session)
export TEABLE_API_KEY="your_personal_access_token_here"

# Permanent (add to ~/.bashrc or ~/.zshrc)
echo 'export TEABLE_API_KEY="your_personal_access_token_here"' >> ~/.bashrc
source ~/.bashrc

Getting Your Teable API Token:

Log in to your Teable instance
Go to Settings → Access Token
Create a new Personal Access Token
Copy and save the token (shown only once)

Optional: For self-hosted Teable instances, set TEABLE_URL:

export TEABLE_URL="https://your-teable-instance.com"
# Default: https://app.teable.ai

### Command-Line Scripts

All scripts are located in the scripts/ directory:

# Record operations
python3 scripts/teable_record.py list --table-id <tableId>
python3 scripts/teable_record.py create --table-id <tableId> --fields '{"Name":"Test","Age":30}'
python3 scripts/teable_record.py update --table-id <tableId> --record-id <recordId> --fields '{"Name":"Updated"}'
python3 scripts/teable_record.py delete --table-id <tableId> --record-ids '["rec1","rec2"]'

# Base operations
python3 scripts/teable_base.py list --space-id <spaceId>
python3 scripts/teable_base.py get --base-id <baseId>
python3 scripts/teable_base.py create --space-id <spaceId> --name "My Base"
python3 scripts/teable_base.py delete --base-id <baseId>

# Space operations
python3 scripts/teable_space.py list
python3 scripts/teable_space.py get --space-id <spaceId>
python3 scripts/teable_space.py create --name "My Space"
python3 scripts/teable_space.py delete --space-id <spaceId>

# Table operations
python3 scripts/teable_table.py list --base-id <baseId>
python3 scripts/teable_table.py get --table-id <tableId>
python3 scripts/teable_table.py create --base-id <baseId> --name "My Table"
python3 scripts/teable_table.py delete --table-id <tableId>

# Dashboard operations
python3 scripts/teable_dashboard.py list --base-id <baseId>
python3 scripts/teable_dashboard.py create --base-id <baseId> --name "My Dashboard"
python3 scripts/teable_dashboard.py delete --dashboard-id <dashboardId>

# Trash operations
python3 scripts/teable_trash.py list --base-id <baseId>
python3 scripts/teable_trash.py reset --resource-id <baseId> --resource-type base

### Python API

from teable_record import TeableRecordClient

# Initialize client
client = TeableRecordClient()

# List records
records = client.list_records(table_id="tblXXXX", take=100)

# Create a record
new_record = client.create_record(
    table_id="tblXXXX",
    fields={"Name": "Test", "Age": 30}
)

# Update a record
updated = client.update_record(
    table_id="tblXXXX",
    record_id="recXXXX",
    fields={"Status": "Completed"}
)

# Delete records
client.delete_records(table_id="tblXXXX", record_ids=["rec1", "rec2"])

### teable_record.py - Record Management

CommandDescriptionRequired ParameterslistList records--table-idgetGet single record--table-id, --record-idcreateCreate record--table-id, --fieldsupdateUpdate record--table-id, --record-id, --fieldsdeleteDelete records--table-id, --record-idsduplicateDuplicate record--table-id, --record-idhistoryGet record history--table-id, --record-id

Optional Parameters:

--view-id: Specify view
--take: Number of records (max 1000)
--skip: Skip count (pagination)
--field-key-type: Field key type (name/id/dbFieldName)
--cell-format: Cell format (json/text)
--projection: Return only specified fields
--order-by: Sorting
--filter: Filter conditions
--typecast: Enable automatic type conversion

### teable_base.py - Base Management

CommandDescriptionRequired ParameterslistList bases--space-id (optional)getGet base details--base-idcreateCreate base--space-id, --nameupdateUpdate base--base-iddeleteDelete base--base-idduplicateDuplicate base--base-idexportExport base--base-id, --outputcollaboratorsList collaborators--base-id

### teable_space.py - Space Management

CommandDescriptionRequired ParameterslistList spacesNonegetGet space details--space-idcreateCreate space--nameupdateUpdate space--space-iddeleteDelete space--space-idbasesList bases in space--space-id

### teable_table.py - Table Management

CommandDescriptionRequired ParameterslistList tables--base-idgetGet table details--table-idcreateCreate table--base-id, --nameupdateUpdate table--table-iddeleteDelete table--table-idfieldsList fields--table-idviewsList views--table-id

### teable_dashboard.py - Dashboard Management

CommandDescriptionRequired ParameterslistList dashboards--base-idgetGet dashboard details--dashboard-idcreateCreate dashboard--base-id, --nameupdateUpdate dashboard--dashboard-iddeleteDelete dashboard--dashboard-idinstall-pluginInstall plugin--dashboard-id, --plugin-id

### teable_trash.py - Trash Management

CommandDescriptionRequired ParameterslistList trash items--base-idresetEmpty trash--resource-id, --resource-typerestoreRestore item--item-iddeletePermanently delete--item-id

### Create a Record with Typecast

# Enable typecast for automatic type conversion
python3 scripts/teable_record.py create \\
  --table-id "tblABC123" \\
  --fields '{"Name":"John","Age":"30","Completed":"yes","DueDate":"2024-01-15"}' \\
  --typecast

### Batch Create Records

python3 scripts/teable_record.py create \\
  --table-id "tblABC123" \\
  --fields '[{"Name":"Alice"},{"Name":"Bob"},{"Name":"Charlie"}]'

### List Records with Pagination

# Get first 100 records
python3 scripts/teable_record.py list --table-id "tblABC123" --take 100

# Get next 100 (skip first 100)
python3 scripts/teable_record.py list --table-id "tblABC123" --take 100 --skip 100

### Filter and Sort Records

python3 scripts/teable_record.py list \\
  --table-id "tblABC123" \\
  --filter '{"operator":"and","filterSet":[{"fieldId":"fld1","operator":"is","value":"Active"}]}' \\
  --order-by '[{"fieldId":"fld2","order":"asc"}]'

### Complete Workflow Example

# 1. Create a space
python3 scripts/teable_space.py create --name "Project Alpha" --icon "🚀"

# 2. Create a base in the space
python3 scripts/teable_base.py create --space-id "spcXXX" --name "Task Manager"

# 3. Create a table in the base
python3 scripts/teable_table.py create --base-id "bseXXX" --name "Tasks"

# 4. Add records
python3 scripts/teable_record.py create \\
  --table-id "tblXXX" \\
  --fields '{"Task":"Design","Status":"In Progress","Priority":"High"}'

### Base URL

Teable Cloud: https://app.teable.ai
Self-hosted: Your instance URL (set via TEABLE_URL)

All API endpoints are relative to the base URL and start with /api.

### Authentication

All requests require Bearer token authentication:

curl -H 'Authorization: Bearer YOUR_TOKEN' \\
  'https://app.teable.ai/api/table/tblXXX/record'

### ID Formats

ResourceID FormatExampleSpacespc...spcABC123Basebse...bseDEF456Tabletbl...tblGHI789Recordrec...recJKL012Fieldfld...fldMNO345Viewviw...viwPQR678Dashboarddbd...dbdSTU901

### 401 Unauthorized

Check that TEABLE_API_KEY is correctly set:

echo $TEABLE_API_KEY

### 403 Forbidden

Your token lacks the required permissions. Create a new token with appropriate scopes in Teable settings.

### 404 Not Found

Verify that IDs are correct (spaceId, baseId, tableId, recordId, etc.) and match the expected format.

### Connection Timeout

Self-hosted users: Check that TEABLE_URL is accessible
Users in mainland China accessing official API: Use proxychains
proxychains python3 scripts/teable_record.py list --table-id "tblXXX"

### Typecast Not Working

Ensure the --typecast flag is included in your command:

python3 scripts/teable_record.py create \\
  --table-id "tblXXX" \\
  --fields '{"Age":"30"}' \\
  --typecast  # Required for string-to-number conversion

### Data Types Reference

For detailed information about Teable field types and typecast functionality, see:

Data Types Guide: references/data-types-and-typecast.md

This guide covers:

All 20+ field types with examples
Typecast automatic conversion rules
Best practices for data import
Common issues and solutions

### Additional Resources

Teable Official Documentation
Getting IDs Guide
Record Field Interface
API Error Codes

### License

MIT License

### Support

For issues or questions, please open an issue on the GitHub repository or contact the skill author.
## Trust
- Source: tencent
- Verification: Indexed source record
- Publisher: killgfat
- Version: 1.0.6
## Source health
- Status: healthy
- Item download looks usable.
- Yavira can redirect you to the upstream package for this item.
- Health scope: item
- Reason: direct_download_ok
- Checked at: 2026-05-09T19:26:18.804Z
- Expires at: 2026-05-16T19:26:18.804Z
- Recommended action: Download for OpenClaw
## Links
- [Detail page](https://openagent3.xyz/skills/teable-api)
- [Send to Agent page](https://openagent3.xyz/skills/teable-api/agent)
- [JSON manifest](https://openagent3.xyz/skills/teable-api/agent.json)
- [Markdown brief](https://openagent3.xyz/skills/teable-api/agent.md)
- [Download page](https://openagent3.xyz/downloads/teable-api)