Skip to main content
バックエンドからは REST API を、Claude や ChatGPT などの AI クライアントからは MCP Server をご利用ください。

API keyを取得する

Tiro Platform API Keysページにアクセスして、アカウントのAPIキーを作成します。アカウントのAPIキーは、現在アクセスできるすべてのワークスペースで本人の権限で動作します。
1

ログイン

platform.tiro.ooo/me/api-keysにアクセスします。
2

アカウントのAPIキーを作成

Create New API Keyをクリックします。ドットを含むfull keyをコピーしてください。例: abc123.xR7mK9pL2qW4...
3

保存

環境変数として保存します。作成ダイアログを閉じると、keyを再度表示することはできません。
API keyは環境変数に保存してください。ハードコーディングしたり、コミットしたりしないでください。

ワークスペースを探す

ノートはワークスペースに紐づいています。GET /v1/external/workspaces でアクセス可能なワークスペースの一覧を取得し、レスポンスの workspaces 配列から任意の項目の guid を選んでおいてください — 以下で workspaceGuid として使用します。
ワークスペースを指定しない GET /v1/external/notes は、ワークスペースの数にかかわらず非推奨のエンドポイントです(後方互換性のため引き続き利用できます)。ワークスペースが1つだけの場合でも、常に GET /v1/external/workspaces/{workspaceGuid}/notes を使ってください。

最初のリクエストを実行する

前の手順で選んだワークスペースの guid を使って、ノート一覧を取得します。
Tiroはノートのページ分割されたリストを返します。各オブジェクトには、タイトル、作成日、処理ステータス、そしてトランスクリプト、サマリー、ドキュメントの取得に使用するguidが含まれます。 リストを取得できたら、Note Data Modelを読んで、各guidで何ができるか(トランスクリプト、サマリー、ドキュメント、フォルダ)を理解しましょう。