Skip to main content
POST
/
v1
/
external
/
notes
/
{noteGuid}
/
documents
Generate Note Document
curl --request POST \
  --url https://api.tiro.ooo/v1/external/notes/{noteGuid}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateId": 1,
  "locale": "ko_KR"
}
'
{
  "id": 456,
  "noteGuid": "note-abc123-def456",
  "note": {
    "guid": "note-abc123-def456",
    "webUrl": "https://tiro.ooo/n/xQ8YKnZUPGHNB"
  },
  "template": {
    "id": 1,
    "title": "영업 보고서"
  },
  "locale": "ko_KR",
  "sections": [
    {
      "content": {
        "type": "text/plain",
        "content": "회의는 신제품 출시 계획에 대해 논의했습니다..."
      },
      "createdAt": "2025-10-20T12:35:26Z"
    }
  ],
  "createdAt": "2025-10-20T12:35:26Z",
  "updatedAt": "2025-10-20T12:35:26Z"
}

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

Query Parameters

​
format
enum<string>
default:text/markdown

Content format for generated sections

Available options:
text/plain,
text/markdown

Body

application/json
​
templateId
integer<int64>
required

Template ID

Example:

1

​
locale
enum<string>
required

Language locale for document generation (AUTO is not supported)

Available options:
ko_KR,
en_US,
de_DE,
ja_JP,
es_ES,
fr_FR,
id_ID,
vi_VN,
tr_TR,
uk_UA,
ru_RU,
hi_IN,
it_IT,
zh_CN,
ms_MY,
th_TH,
sv_SE
Example:

"ko_KR"

Response

Document generated successfully

A structured multi-section document (e.g., meeting minutes, action items) generated from a NoteDocumentTemplate. Unlike NoteSummary, it is divided into predefined sections. See Data Model.

​
id
integer<int64>
required

Document ID

Example:

456

​
noteGuid
string
required

The GUID of the note this document belongs to

Example:

"note-abc123-def456"

​
note
object
required

Note reference with minimal information

​
template
object
required

Summary information of a note document template

​
locale
enum<string>
required

Supported language locale

Available options:
ko_KR,
en_US,
de_DE,
ja_JP,
es_ES,
fr_FR,
id_ID,
vi_VN,
tr_TR,
uk_UA,
ru_RU,
hi_IN,
it_IT,
zh_CN,
ms_MY,
th_TH,
sv_SE
Example:

"ko_KR"

​
sections
object[]
required

Array of document sections

​
createdAt
string<date-time>
required

Document creation timestamp

Example:

"2025-10-20T12:35:26Z"

​
updatedAt
string<date-time>
required

Document last update timestamp

Example:

"2025-10-20T13:45:30Z"

​
truncated
boolean
default:false

true when the document was emitted as part of a deep-search response and its combined section text exceeded the search budget (5,000 chars). Plain document fetches always emit false.