> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tiro.ooo/llms.txt
> Use this file to discover all available pages before exploring further.

# Note

> Canonical Note data model

export const Json = ({data, lang = 'json', spaces = 2}) => <pre>
    <code className={`language-${lang}`}>{JSON.stringify(data, null, spaces)}</code>
  </pre>;

export const NoteFieldList = <ul>
    <li><strong>guid</strong>: Unique identifier for the note</li>
    <li><strong>workspaceGuid</strong>: GUID of the workspace the note belongs to (<code>null</code> if not associated with a workspace)</li>
    <li><strong>title</strong>: Note title</li>
    <li><strong>createdAt</strong> / <strong>updatedAt</strong>: ISO-8601 timestamps for creation and last modification</li>
    <li><strong>sourceType</strong>: Source type (<code>live-voice</code>, <code>recording</code>, <code>text</code>, <code>video</code>, <code>webpage</code>, <code>offline-mode</code>, <code>onboarding</code>)</li>
    <li><strong>recordingStartAt</strong> / <strong>recordingEndAt</strong>: Actual recording start and end timestamps</li>
    <li><strong>recordingDurationSeconds</strong>: Actual recording length in seconds</li>
    <li><strong>transcribeLocale</strong> / <strong>translateLocale</strong>: Language locales in <code>en_US</code> format</li>
    <li><strong>webUrl</strong>: Web URL to access the note.</li>
    <li><strong>collaborators</strong>: Array of collaborators with guid, name, email, and role (OWNER/EDITOR/VIEWER)</li>
    <li><strong>participants</strong>: Array of meeting participants tagged in the note, with name and email (both nullable)</li>
  </ul>;

export const NoteBaseJson = {
  guid: 'note-guid-123',
  workspaceGuid: 'ws_a1b2c3d4',
  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',
  webUrl: 'https://tiro.ooo/n/123',
  collaborators: [{
    guid: 'user-guid-123',
    name: 'John Doe',
    email: 'john@example.com',
    role: 'OWNER'
  }, {
    guid: 'user-guid-456',
    name: 'Jane Smith',
    email: 'jane@example.com',
    role: 'EDITOR'
  }, {
    guid: 'user-guid-789',
    name: 'Sam',
    email: 'sam@example.com',
    role: 'VIEWER'
  }],
  participants: [{
    name: 'Alice Kim',
    email: 'alice@example.com'
  }, {
    name: 'Bob Park',
    email: null
  }]
};

## 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
* **Participants**: Meeting participants tagged in the note

## Base shape

<Json data={NoteBaseJson} />

{NoteFieldList}