Tiro アプリの画面に表示される名前と、API レスポンスのフィールド名がいつも同じとはかぎりません。同じ概念なのに名前が違うものから確認しておくと、レスポンスのなかから目当てのデータをすばやく見つけられます。
名前が違うものから確認
画面のラベルと API の名前がいちばん混同しやすいのは、次の2つです。
| 画面に表示される名前 | API で使う名前 | 同じ概念 |
|---|
| ワンページサマリー | summary | AI が作成したノートの要約です。ノートを取得するときに include: ["summary"] で受け取ります。 |
| スクリプト | transcript | 音声を書き起こした発話の記録です。include: ["transcript"] で受け取り、段落単位は paragraphs です。 |
画面の「ワンページサマリー」を API で探しても見つかりません。API では summary です。同じように、画面の「スクリプト」は API では transcript（段落は paragraphs）と呼びます。
用語の対応一覧
| 画面に表示される名前 | API で使う名前 | 備考 |
|---|
| ノート | note（noteGuid で識別） | 画面・API ともに同じ |
| ワンページサマリー | summary | 名前が違います（上記を参照） |
| スクリプト | transcript · paragraphs | 名前が違います（上記を参照） |
| ドキュメント | document | テンプレートから生成したドキュメント |
| テンプレート | documentTemplate | |
| フォルダ | folder | 画面・API ともに同じ。内部実装での名称は異なります（下記を参照） |
| 共有リンク | shareLink | |
| 単語帳 | wordMemory | |
| ウィキ | wiki · wikiPage | |
| 音声ファイル | voiceFile | アップロードした音声・動画ファイル |
| ワークスペース | workspace（workspaceGuid） | 一部のレスポンスにはレガシーな isTeamFolder など「team」表現が残っています |
画面・API ともにフォルダを folder と呼びます。ただし Tiro の内部実装では thread と呼ぶため、一部のレガシーフィールド（例: legacyThreadId）にその名残が見えることがあります。新しく書くコードでは folder 関連のフィールドだけを使えば問題ありません。
