開発者 · Zapier
TypeHop Zapier APIリファレンス
ZapierのTypeHopアプリには、トリガーが1つあります。New Dictationです。以下の4つのエンドポイントを使い、1種類のイベントを受信します。すべてHTTPS上のJSONです。OpenAPI 3.1仕様をダウンロード。
認証
各リクエストには、専用のZapierキーをBearerトークンとして付けます。キーは1つのワークスペースの1人のユーザーに紐づきます。キーの作成と無効化は次のページで行えます: 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
そのワークスペースにおけるキーの所有者の最新のディクテーション10件を、新しい順に返します。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を2回サブスクライブすると、既存のサブスクリプションが返ります。各サブスクリプションは、プランの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
ボディなし。
エラー
400IDがUUIDではありません。401キーがない、形式が不正、無効、または無効化されています。
note.transcribedイベント
ディクテーションの準備ができると、TypeHopはサブスクライブ中のすべてのフックにPOSTを送信します。ヘッダーには x-talktome-event と x-talktome-event-id(note.transcribed:<note id>)が含まれます。配信に失敗した場合はバックオフを入れて再試行されます。ノート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 の4つのフィールドを出力します。
Macなしでテストする
- Sign in at typehop.com/zapier/connectにサインインし、Zapierキーを作成します。
- Zapierでそのキーを使ってTypeHopを接続し、New Dictationを選んでZapをオンにします。
- 接続ページに戻り、ブラウザで短いディクテーションを録音するかテストノートを入力して、Send to my Zapsを押します。
Zapは数秒以内に実行されます。お問い合わせ: support@typehop.com。キーのページ: https://typehop.com/zapier/connect。