Skip to main content
GET
/
v1
/
external
/
notes
/
{noteGuid}
Get Note
curl --request GET \
  --url https://api.tiro.ooo/v1/external/notes/{noteGuid} \
  --header 'Authorization: Bearer <token>'
{
  "guid": "note-abc123-def456",
  "title": "Weekly Team Meeting",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T11:45:00Z",
  "sourceType": "live-voice",
  "recordingStartAt": "2024-01-15T10:30:10Z",
  "recordingEndAt": "2024-01-15T11:30:15Z",
  "recordingDurationSeconds": 3605,
  "transcribeLocale": "ko_KR",
  "translateLocale": "en_US",
  "webUrl": "https://tiro.ooo/n/abc123def456",
  "collaborators": [],
  "participants": [
    {
      "name": "Alice Kim",
      "email": "alice@example.com"
    },
    {
      "name": "Bob Park",
      "email": null
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.tiro.ooo/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key in format {id}.{secret}

Path Parameters

​
noteGuid
string
required

Note GUID

Response

Note details

The top-level container for a single recording session. A Note holds its transcribed content as Paragraphs, and can be summarized into NoteSummary or rendered into a NoteDocument. See Data Model for the full structure.

​
guid
string
required

Unique identifier for the note

Example:

"note-guid-123"

​
title
string
required

Note title

Example:

"Meeting notes"

​
createdAt
string<date-time>
required

ISO-8601 creation timestamp

Example:

"2025-07-20T10:00:00Z"

​
updatedAt
string<date-time>
required

ISO-8601 last update timestamp

Example:

"2025-07-20T11:10:00Z"

​
sourceType
enum<string>
required

Source type of the note:

  • live-voice: Real-time voice recording
  • recording: Uploaded audio file
  • text: Text-only note
  • video: Video recording
  • webpage: Web page content
  • offline-mode: Offline recording
  • onboarding: Onboarding sample note
Available options:
onboarding,
text,
live-voice,
recording,
offline-mode,
webpage,
video
Example:

"live-voice"

​
recordingDurationSeconds
integer
required

Actual recording length in seconds. Returns 0 for non-recording source types.

Example:

3600

​
webUrl
string<uri>
required

Web URL to access the note

Example:

"https://tiro.ooo/n/123"

​
collaborators
object[]
required

Array of collaborators with their roles

​
participants
object[]
required

Array of meeting participants tagged in the note

​
recordingStartAt
string<date-time> | null

Actual recording start timestamp. Null for non-recording source types.

Example:

"2025-07-20T10:00:10Z"

​
recordingEndAt
string<date-time> | null

Actual recording end timestamp. Null for non-recording source types.

Example:

"2025-07-20T11:00:10Z"

​
transcribeLocale
string | null

Language locale used for transcription. Null for non-recording source types.

Example:

"en_US"

​
translateLocale
string | null

Language locale used for translation. Null when no translation was requested.

Example:

"ko_KR"

​
matchedSnippets
string[] | null

OpenSearch highlight snippets for the keyword that matched this note. Present only on responses to POST /v1/external/notes/search; absent (null) on plain list responses.

​
documents
object[] | null

Note's primary documents (one-pager / custom). Present only on responses to POST /v1/external/notes/search; absent (null) on plain list responses. Each item's truncated flag indicates whether the deep-search budget was exceeded.