Skip to main content

Overview

Tiro provides two types of template-based document generation features: NoteDocument and NoteSummary. These are separate systems with different purposes and API support. Template-based document types in Tiro

NoteDocument vs NoteSummary

FeatureNoteDocumentNoteSummary
PurposeStructured meeting documentsQuick format templates
Templates회의록 (Meeting Minutes), Custom templatesOne-Pager, Pitch, etc.
API Support✅ Full support✅ Full support
Webhook Supportnote_document.* eventsnote_summary.* events
Created viaAPI or Tiro appTiro app only

NoteDocument

NoteDocument is designed for structured, section-based documents that you can create, retrieve, and manage via the API. Key characteristics:
  • Created using templates with defined sections
  • Supports custom templates with user instructions
  • Full API CRUD operations available
  • Webhook events for real-time notifications
Example templates:
  • 회의록 (Meeting Minutes)
  • Custom templates you create
API endpoints:
  • POST /v1/external/notes/{noteGuid}/documents - Generate document
  • GET /v1/external/notes/{noteGuid}/documents - List documents
  • GET /v1/external/notes/{noteGuid}/documents/{documentId} - Get document

NoteSummary

NoteSummary provides quick-format templates for different presentation styles. Key characteristics:
  • Optimized for specific use cases (pitches, one-pagers, etc.)
  • Full API support for retrieving summaries
  • Webhook events for real-time notifications
  • Currently created through Tiro app interface only
Example templates:
  • One-Pager
  • Pitch
  • And other format-specific templates
API endpoints:
  • GET /v1/external/notes/{noteGuid}/summaries - List summaries
  • GET /v1/external/notes/{noteGuid}/summaries/{summaryId} - Get summary with content
Webhook events:
  • note_summary.generated - Summary creation complete
  • note_summary.updated - Summary modified
  • note_summary.deleted - Summary deleted

API Support Status

Currently Supported

NoteDocument API

Create and retrieve structured documents via API

NoteDocument Webhooks

Real-time notifications for document events

NoteSummary API

Retrieve summaries via API

NoteSummary Webhooks

Real-time notifications for summary events

Generate Document API

API reference for creating NoteDocuments

Document Events

Webhook events for NoteDocument

List Templates

Get available NoteDocument templates

Webhooks Overview

Set up webhook notifications