Skip to main content

Overview

Standard schema for the Note resource. Important: Note resources contain comprehensive metadata including meeting details, participants, and organizational information. For transcript content and actual text data, use the Note’s paragraphs endpoint to retrieve paragraphs associated with the note.

Metadata Categories

The Note schema includes several categories of metadata:
  • Basic Information: Title, timestamps, source type
  • Recording Details: Start/end times, duration, locales
  • Collaboration: Collaborator information with roles and identifiers

Base shape

{
  "guid": "note-guid-123",
  "title": "Meeting notes",
  "createdAt": "2025-07-20T10:00:00Z",
  "updatedAt": "2025-07-20T11:10:00Z",
  "sourceType": "live-voice",
  "recordingStartAt": "2025-07-20T10:00:10Z",
  "recordingEndAt": "2025-07-20T11:00:10Z",
  "recordingDurationSeconds": 3600,
  "transcribeLocale": "en_US",
  "translateLocale": "ko_KR",
  "web_url": "https://tiro.ooo/n/123",
  "collaborators": [
    {
      "guid": "user-guid-123",
      "name": "John Doe",
      "email": "[email protected]",
      "role": "OWNER"
    },
    {
      "guid": "user-guid-456",
      "name": "Jane Smith",
      "email": "[email protected]",
      "role": "EDITOR"
    },
    {
      "guid": "user-guid-789",
      "name": "Sam",
      "email": "[email protected]",
      "role": "VIEWER"
    }
  ]
}