メインコンテンツへスキップ

​
概要

Tiro は、テンプレートをベースとしたドキュメント生成機能を 2 種類提供しています。NoteDocument と NoteSummary です。これらは目的も API サポートも異なる別々のシステムです。 これらがより広範な Note 構造（Paragraph、Folder、各エンティティ間の関係）の中でどのように位置づけられるかについては、Note Data Model をご覧ください。 Template-based document types in Tiro

​
NoteDocument と NoteSummary の比較

機能NoteDocumentNoteSummary
目的構造化された会議ドキュメントクイックフォーマットのテンプレート
テンプレート회의록 (Meeting Minutes)、カスタムテンプレートOne-Pager、Pitch など
API サポート✅ フルサポート✅ フルサポート
Webhook サポート✅ note_document.* イベント✅ note_summary.* イベント
作成方法API または Tiro アプリTiro アプリのみ

​
NoteDocument

NoteDocument は、API を通じて作成、取得、管理できる、構造化されたセクションベースのドキュメント向けに設計されています。 主な特徴:
  • セクションが定義されたテンプレートを使って作成
  • ユーザーの指示によるカスタムテンプレートに対応
  • フルの API CRUD 操作が利用可能
  • リアルタイム通知のための Webhook イベント
テンプレートの例:
  • 회의록 (Meeting Minutes)
  • ご自身で作成するカスタムテンプレート
API エンドポイント:
  • POST /v1/external/notes/{noteGuid}/documents - ドキュメントを生成
  • GET /v1/external/notes/{noteGuid}/documents - ドキュメントの一覧を取得
  • GET /v1/external/notes/{noteGuid}/documents/{documentId} - ドキュメントを取得

​
NoteSummary

NoteSummary は、さまざまなプレゼンテーションスタイルに向けたクイックフォーマットのテンプレートを提供します。 主な特徴:
  • 特定のユースケース（pitch、one-pager など）に最適化
  • 要約を取得するためのフルの API サポート
  • リアルタイム通知のための Webhook イベント
  • 現在は Tiro アプリのインターフェースからのみ作成可能
テンプレートの例:
  • One-Pager
  • Pitch
  • その他、フォーマット別のテンプレート
API エンドポイント:
  • GET /v1/external/notes/{noteGuid}/summaries - 要約の一覧を取得
  • GET /v1/external/notes/{noteGuid}/summaries/{summaryId} - コンテンツ付きで要約を取得
Webhook イベント:
  • note_summary.generated - 要約の作成が完了
  • note_summary.updated - 要約が変更された
  • note_summary.deleted - 要約が削除された