title: “Airtable — Airtable REST API via curl” sidebar_label: “Airtable” description: “Airtable REST API via curl”
{/* 本页面由 website/scripts/generate-skill-docs.py 根据技能对应的 SKILL.md 文件自动生成。请直接编辑源文件 SKILL.md,而非此页面。 */}
Airtable
通过 curl 调用 Airtable REST API,支持记录的创建、读取、更新和删除操作,以及数据筛选与合并写入功能。
技能元数据
| 来源 | 内置(默认已安装) |
| 路径 | skills/productivity/airtable |
| 版本 | 1.1.0 |
| 开发者 | 社区用户 |
| 许可协议 | MIT |
| 支持平台 | linux、macos、windows |
| 标签 | Airtable、效率工具、数据库、API |
参考:完整的 SKILL.md 文件
Airtable — 基础库、表格与记录
使用 terminal 工具通过 curl 直接调用 Airtable 的 REST API。无需 MCP 服务器、OAuth 认证流程或 Python SDK,仅需 curl 以及个人访问令牌即可。
先决条件
- 访问 https://airtable.com/create/tokens 创建个人访问令牌(PAT)(此类令牌以
pat...开头)。 - 至少授予以下权限:
data.records:read— 读取记录行data.records:write— 创建、更新或删除记录行schema.bases:read— 列出所有基础库及表格
- 重要提示: 在同一令牌设置界面中,将需要访问的每个基础库添加到令牌的访问权限列表中。个人访问令牌的权限是针对特定基础库设置的——在错误的基础库上使用的有效令牌也会返回
403错误。 - 将该令牌存储在
${HERMES_HOME:-~/.hermes}/.env文件中(或通过hermes setup命令设置)。AIRTABLE_API_KEY=pat_your_token_here
注意:旧版的
key...API 密钥已于 2024 年 2 月被弃用。目前仅支持 PAT 和 OAuth 令牌。
API 基础知识
- 端点地址:
https://api.airtable.com/v0 - 认证标头:
Authorization: Bearer $AIRTABLE_API_KEY - 所有请求均采用 JSON 格式(对于 POST/PATCH/PUT 请求的请求体,需设置
Content-Type: application/json)。 - 对象标识符规则: 数据库标识为
app...,表格标识为tbl...,记录标识为rec...,字段标识为fld...。这些标识符永不更改,而名称则可能变化。在自动化流程中建议优先使用标识符。 - 速率限制: 每个数据库每秒最多 5 次请求。若收到
429错误码,应延迟后重试;单个数据库的突发请求量也会受到限制。
数据库的 curl 请求格式:
curl -s "https://api.airtable.com/v0/$BASE_ID/$TABLE?maxRecords=5" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" | python3 -m json.tool
-s 选项可隐藏 curl 的进度条——请在每次调用时都保留该选项,以确保 Hermes 能接收到整洁的工具输出。若需生成易于阅读的 JSON 格式,可通过 python3 -m json.tool(始终可用)或 jq(如已安装)进行转换。
字段类型(请求体格式)
| 字段类型 | 写入格式 |
|---|---|
| 单行文本 | "Name": "hello" |
| 长文本 | "Notes": "multi\nline" |
| 数字 | "Score": 42 |
| 复选框 | "Done": true |
| 单选选项 | "Status": "Todo"(除非设置了 typecast: true,否则该选项名称必须已存在) |
| 多选选项 | "Tags": ["urgent", "bug"] |
| 日期 | "Due": "2026-04-01" |
| 时间戳(UTC) | "At": "2026-04-01T14:30:00.000Z" |
| URL / 邮箱 / 电话号码 | "Link": "https://…" |
| 附件 | "Files": [{"url": "https://…"}](Airtable 会自动获取并重新上传) |
| 关联记录 | "Owner": ["recXXXXXXXXXXXXXX"](记录 ID 的数组形式) |
| 用户 | "AssignedTo": {"id": "usrXXXXXXXXXXXXXX"} |
在创建/更新请求体的最顶层添加 "typecast": true,即可让 Airtable 自动转换数值类型(例如即时创建新的单选选项,或将 "42" 转换为数字 42)。
常用查询
列出当前令牌可访问的数据库
curl -s "https://api.airtable.com/v0/meta/bases" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" | python3 -m json.tool
查看某个数据库的表列表及结构信息
curl -s "https://api.airtable.com/v0/meta/bases/$BASE_ID/tables" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" | python3 -m json.tool
在执行数据修改操作之前,请先使用此功能——它可确认确切的字段名称与编号,针对可选字段显示 options.choices 选项,同时还会标明主键字段的名称。
列出记录(前10条)
curl -s "https://api.airtable.com/v0/$BASE_ID/$TABLE?maxRecords=10" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" | python3 -m json.tool
获取单条记录
curl -s "https://api.airtable.com/v0/$BASE_ID/$TABLE/$RECORD_ID" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" | python3 -m json.tool
过滤记录(filterByFormula)
Airtable 公式必须进行 URL 编码。建议使用 Python 标准库来完成该操作,切勿手动编码:
FORMULA="{Status}='Todo'"
ENC=$(python3 -c 'import sys, urllib.parse; print(urllib.parse.quote(sys.argv[1], safe=""))' "$FORMULA")
curl -s "https://api.airtable.com/v0/$BASE_ID/$TABLE?filterByFormula=$ENC&maxRecords=20" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" | python3 -m json.tool
常用公式模式:
- 精确匹配:
{Email}='user@example.com' - 包含内容:
FIND('bug', LOWER({Title})) - 多条件组合:
AND({Status}='Todo', {Priority}='High') - 或关系:
OR({Owner}='alice', {Owner}='bob') - 非空检查:
NOT({Assignee}='') - 日期比较:
IS_AFTER({Due}, TODAY())
排序并筛选特定字段
curl -s "https://api.airtable.com/v0/$BASE_ID/$TABLE?sort%5B0%5D%5Bfield%5D=Priority&sort%5B0%5D%5Bdirection%5D=asc&fields%5B%5D=Name&fields%5B%5D=Status" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" | python3 -m json.tool
查询参数中的方括号必须进行 URL 编码(即使用 %5B / %5D)。
使用命名视图
curl -s "https://api.airtable.com/v0/$BASE_ID/$TABLE?view=Grid%20view&maxRecords=50" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" | python3 -m json.tool
视图会在服务器端应用其保存的筛选条件与排序规则。
常见操作
创建记录
curl -s -X POST "https://api.airtable.com/v0/$BASE_ID/$TABLE" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"fields":{"Name":"New task","Status":"Todo","Priority":"High"}}' | python3 -m json.tool
单次调用最多可创建10条记录
curl -s -X POST "https://api.airtable.com/v0/$BASE_ID/$TABLE" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"typecast": true,
"records": [
{"fields": {"Name": "Task A", "Status": "Todo"}},
{"fields": {"Name": "Task B", "Status": "In progress"}}
]
}' | python3 -m json.tool
批量接口的每条请求处理记录数上限为10条。若需插入更多数据,建议以10条为一组分批处理,并在每次处理间稍作休眠,以此遵守每秒5次请求的基础限制。
更新记录(PATCH操作——合并数据并保留未更改的字段)
curl -s -X PATCH "https://api.airtable.com/v0/$BASE_ID/$TABLE/$RECORD_ID" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"fields":{"Status":"Done"}}' | python3 -m json.tool
通过合并字段进行插入或更新(无需提供编号)
curl -s -X PATCH "https://api.airtable.com/v0/$BASE_ID/$TABLE" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"performUpsert": {"fieldsToMergeOn": ["Email"]},
"records": [
{"fields": {"Email": "user@example.com", "Status": "Active"}}
]
}' | python3 -m json.tool
performUpsert 用于创建合并字段值为空的新记录,同时更新那些合并字段值已存在的记录。这一功能非常适合实现幂等同步。
删除记录
curl -s -X DELETE "https://api.airtable.com/v0/$BASE_ID/$TABLE/$RECORD_ID" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" | python3 -m json.tool
单次调用可删除最多10条记录
curl -s -X DELETE "https://api.airtable.com/v0/$BASE_ID/$TABLE?records%5B%5D=rec1&records%5B%5D=rec2" \
-H "Authorization: Bearer $AIRTABLE_API_KEY" | python3 -m json.tool
分页机制
列表接口每次最多返回每页100条记录。如果响应中包含 "offset": "..." 字段,需在后续请求中继续传入该值。重复此操作,直至该字段不再出现为止:
OFFSET=""
while :; do
URL="https://api.airtable.com/v0/$BASE_ID/$TABLE?pageSize=100"
[ -n "$OFFSET" ] && URL="$URL&offset=$OFFSET"
RESP=$(curl -s "$URL" -H "Authorization: Bearer $AIRTABLE_API_KEY")
echo "$RESP" | python3 -c 'import json,sys; d=json.load(sys.stdin); [print(r["id"], r["fields"].get("Name","")) for r in d["records"]]'
OFFSET=$(echo "$RESP" | python3 -c 'import json,sys; d=json.load(sys.stdin); print(d.get("offset",""))')
[ -z "$OFFSET" ] && break
done
Hermes的典型工作流程
- 确认身份认证。 执行命令:
curl -s -o /dev/null -w "%{http_code}\n" https://api.airtable.com/v0/meta/bases -H "Authorization: Bearer $AIRTABLE_API_KEY",预期返回状态码为200。 - 定位目标数据表。 可先通过上一步列出所有数据表,或者如果令牌未包含
schema.bases:read权限,则直接让用户提供app...ID。 - 检查数据结构。 执行请求:
GET /v0/meta/bases/$BASE_ID/tables。在对数据进行任何修改之前,需将具体的字段名及主键名称缓存到当前会话中。 - 先读取再写入。 对于“根据条件Y更新X”的操作,应先使用
filterByFormula查询以获取rec...ID,然后再执行PATCH /v0/$BASE_ID/$TABLE/$RECORD_ID操作。切勿尝试猜测记录ID。 - 批量写入。 将相关的创建操作合并为一次包含10条记录的POST请求,以此避免超过每秒5次请求的限制。
- 不可逆的操作。 通过API无法撤销删除操作。如果用户要求“删除所有X”,应先反馈筛选条件及记录数量,并在确认后才能执行删除。
常见陷阱
filterByFormula的参数必须进行URL编码。 包含空格或非ASCII字符的字段名同样需要编码(例如{My Field}应编码为%7BMy%20Field%7D)。建议使用Python标准库中的相关函数进行编码,切勿手动处理。- 响应中缺失的空字段不会被列出。 如果响应中缺少
"Assignee"这一键值,并不意味着该字段根本不存在,而只是表示该记录的对应值为空。在判定某个字段缺失之前,请先检查数据结构(步骤3)。 PATCH与PUT的区别。PATCH会将提供的字段值合并到现有记录中;而PUT会完全替换整个记录,并清除所有未包含的字段。建议默认使用PATCH。- 单选选项必须预先存在。 如果字段的选项列表中不存在 “Shipping” 这一选项,直接写入
"Status": "Shipping"将会触发INVALID_MULTIPLE_CHOICE_OPTIONS错误。除非设置"typecast": true(该选项会自动创建缺失的选项),否则应避免此类情况。 - 令牌的权限是针对特定数据表的。 如果某个数据表返回
403错误,而其他数据表可以正常访问,那说明该令牌的访问列表中未包含该数据表,而非权限范围或认证问题。此时应引导用户前往 https://airtable.com/create/tokens 为该数据表授予相应权限。 - 速率限制是针对单个数据表,而非整个令牌。
baseA每秒5次请求、baseB每秒5次请求是允许的;但仅baseA就达到每秒6次请求则会被限流。遇到429错误时,请查看响应中的Retry-After头部信息以确定重试时间。
Hermes使用注意事项
- 始终结合
curl使用terminal工具。 严禁使用web_extract(它无法发送认证头信息),也避免使用browser_navigate(需要通过用户界面进行认证且速度较慢)。 - 当加载此技能时,
AIRTABLE_API_KEY会自动从${HERMES_HOME:-~/.hermes}/.env文件中读取并传递给子进程,无需在每次执行curl命令前再次导出该密钥。 - 在公式中处理大括号时需格外小心。 在heredoc内容中,
{Status}是字面值;而在shell参数中,只要不在{...}的扩展上下文中,{Status}即可安全使用。不过,若要将动态字符串插入URL中,仍需先通过python3 urllib.parse.quote进行编码。 - 建议始终使用
python3 -m json.tool进行结果美化显示(该工具为必选),而非可选的jq工具。只有在需要过滤或提取特定字段时才使用jq。 - 分页是针对每页数据而言的,而非全局分页。 Airtable 对单条记录的限制为100条,此为硬性限制,无法更改。需通过
offset参数循环查询,直到不再返回相关数据为止。 - 对于非2xx状态的响应,请查看
errors数组——Airtable会返回结构化的错误代码,如AUTHENTICATION_REQUIRED、INVALID_PERMISSIONS、MODEL_ID_NOT_FOUND、INVALID_MULTIPLE_CHOICE_OPTIONS等,这些代码能准确指示问题所在。