Skip to main content
Tiro API では、ノート、文字起こし、サマリー、フォルダを取得・管理できます。

Base URL

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

認証情報ごとのワークスペースアクセス

ユーザー API キーはユーザーの識別情報と権限を持ち、そのユーザーが現在アクセスできるすべてのワークスペースで動作します。ワークスペースのAPIキーは紐づく 1 つのワークスペース、組織のAPIキーは組織に所属するワークスペースに限定されます。 GET /v1/external/workspaces を呼び出すと、現在の認証情報がアクセスできるワークスペースの一覧が返ります。各エントリには guidnameisWikiEnabled が含まれます。GET /v1/external/workspaces/me は、アカウントのAPIキーのデフォルトワークスペース、またはワークスペースのAPIキーに紐づくワークスペースを返します。 ワークスペース単位のリソースには workspaceGuid が含まれます。たとえば POST /v1/external/workspaces/{workspaceGuid}/folders は、そのワークスペースにフォルダを作成します。1 つのアカウントのAPIキーで複数のワークスペースと連携する場合は、GET /v1/external/workspaces から現在アクセスできる workspaceGuid を取得してください。

Rate Limits

API キー 1 つにつき 60 秒あたり 600 リクエストまで送信できます。超過すると 429 レスポンスと Retry-AfterX-RateLimit-* ヘッダーが返ります。

Rate Limit Exceeded

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

レスポンス形式

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

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

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

エラーレスポンス

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