Skip to main content
Tiro アプリの画面に表示される名前と、API レスポンスのフィールド名がいつも同じとはかぎりません。同じ概念なのに名前が違うものから確認しておくと、レスポンスのなかから目当てのデータをすばやく見つけられます。

名前が違うものから確認

画面のラベルと API の名前がいちばん混同しやすいのは、次の2つです。
画面の「ワンページサマリー」を API で探しても見つかりません。API では summary です。同じように、画面の「スクリプト」は API では transcript(段落は paragraphs)と呼びます。

用語の対応一覧

画面・API ともにフォルダを folder と呼びます。ただし Tiro の内部実装では thread と呼ぶため、一部のレガシーフィールド(例: legacyThreadId)にその名残が見えることがあります。新しく書くコードでは folder 関連のフィールドだけを使えば問題ありません。