开发者 · Zapier
TypeHop Zapier API 参考
Zapier 上的 TypeHop 应用有一个触发器:New Dictation。它使用下面四个端点,并接收一种事件。一切均为基于 HTTPS 的 JSON。下载 OpenAPI 3.1 规范。
认证
每个请求都以 Bearer 令牌的形式携带专用的 Zapier 密钥。一个密钥属于一个工作区中的一位用户。可在 typehop.com/zapier/connect 创建或撤销密钥。工作区需要包含 webhook 的套餐(Pro 或更高)。
- 基础 URL
https://api.typehop.com/v1/zapier- 请求头
Authorization: Bearer thp_zap_<64 hex characters>- 错误
- 非 2xx 响应返回
{ "error": "<message>" },且绝不会被缓存。
测试密钥
GEThttps://api.typehop.com/v1/zapier/auth
确认密钥有效且工作区可使用 webhook。返回工作区名称,Zapier 将其显示为连接标签。
使用方:认证测试
响应 · 200
{
"accountLabel": "Acme workspace"
}错误
401密钥缺失、格式错误、无效或已被撤销。403工作区套餐不包含 webhook(需 Pro 或更高),或订阅未生效。
列出最近的听写
GEThttps://api.typehop.com/v1/zapier/notes
该工作区中密钥所有者最近的十条听写,按时间由新到旧。构建 Zap 时,Zapier 将其用作示例数据。
使用方:New Dictation 触发器(performList)
响应 · 200
{
"notes": [
{
"id": "a0cf17ac-0c67-49df-a875-05c84063161c",
"cleanedText": "Idea: let teammates share a custom dictionary.",
"startedAt": "2026-11-10T10:00:00.000Z",
"source": "macos"
}
]
}错误
401密钥缺失、格式错误、无效或已被撤销。403工作区套餐不包含 webhook(需 Pro 或更高),或订阅未生效。
订阅 Zap
POSThttps://api.typehop.com/v1/zapier/subscriptions
注册一个 Zapier REST hook。仅接受 hooks.zapier.com 上的 HTTPS URL。重复订阅同一 URL 会返回已有订阅。每个订阅都会计入套餐的 webhook 上限。
使用方:New Dictation 触发器(performSubscribe)
请求体
{
"targetUrl": "https://hooks.zapier.com/hooks/standard/123/abc/"
}响应 · 201
{
"id": "5d1f2c4e-8a1b-4f8e-9a77-3d2f6c1b0e21"
}错误
400JSON 无效,或 targetUrl 不是 HTTPS 的 hooks.zapier.com URL。401密钥缺失、格式错误、无效或已被撤销。403工作区套餐不包含 webhook(需 Pro 或更高),或订阅未生效。403已达到套餐的 webhook 上限。413请求体超过 4 KB。
取消订阅 Zap
DELETEhttps://api.typehop.com/v1/zapier/subscriptions/{id}
删除使用此密钥创建的订阅。未知 ID 会静默成功,因此重试取消订阅是安全的。
使用方:New Dictation 触发器(performUnsubscribe)
响应 · 204
无请求体。
错误
400该 ID 不是 UUID。401密钥缺失、格式错误、无效或已被撤销。
note.transcribed 事件
听写完成后,TypeHop 会向每个已订阅的 hook 发送一个 POST。请求头包括 x-talktome-event 和 x-talktome-event-id(note.transcribed:<note id>)。投递失败会采用退避策略重试;笔记 ID 保持不变,因此可据此丢弃重复项。
{
"event": "note.transcribed",
"timestamp": "2026-11-10T10:00:04.112Z",
"note": {
"id": "a0cf17ac-0c67-49df-a875-05c84063161c",
"cleanedText": "Idea: let teammates share a custom dictionary.",
"startedAt": "2026-11-10T10:00:00.000Z",
"source": "macos"
}
}Zapier 触发器输出四个字段:id、text(整理后的文本)、createdAt 和 source。
无需 Mac 即可测试
- 登录 typehop.com/zapier/connect 并创建一个 Zapier 密钥。
- 在 Zapier 中,使用该密钥连接 TypeHop,选择 New Dictation,然后开启该 Zap。
- 回到连接页面,在浏览器中录制一段简短听写或输入一条测试笔记,然后点击 Send to my Zaps。
Zap 会在几秒内运行。有疑问:support@typehop.com。密钥页面:https://typehop.com/zapier/connect。