メインコンテンツへスキップ
Tiro APIは、ノート、トランスクリプト、サマリー、フォルダへのプログラムによるアクセスを提供します。

Base URL

すべてのAPIリクエストは、次のURLに対して行ってください。

ワークスペース

すべての Tiro API リクエストは、1 つのワークスペースの中で実行されます。API キーは 1 つのワークスペースに限定され、そのワークスペースのリソース(ノート、トランスクリプト、サマリー、フォルダ)にのみ到達します。キーが別のワークスペースをまたぐことはありません。 GET /v1/external/workspaces を呼び出すと、アカウントがアクセスできるワークスペースの一覧が返ります。各エントリには guidnameisWikiEnabled が含まれます。GET /v1/external/workspaces/me を呼び出すと、現在のキーが対応するワークスペースを確認できます。 ワークスペース単位のリソースは workspaceGuid を公開します。フォルダのエンドポイントはこれをパスで受け取ります — POST /v1/external/workspaces/{workspaceGuid}/folders は特定のワークスペース内にフォルダを作成します。連携が複数のワークスペースにまたがる場合は、ワークスペースごとにキーを 1 つずつ作成してください。

Rate Limits

公平な利用とシステムの安定性を確保するため、Tiro APIはAPIキーごとに60秒あたり600リクエストまで許可しています。超過すると、再試行のタイミングを示すRetry-AfterX-RateLimit-*ヘッダーがレスポンスに含まれます。

Rate Limit Exceeded

rate limitを超過すると、429 Too Many Requestsレスポンスが返されます。

レスポンス形式

すべてのAPIレスポンスは、一貫したJSON形式に従います。

成功レスポンス(リスト)

成功レスポンス(単一リソース)

エラーレスポンス

エラーには、デバッグのための詳細な情報が含まれます。