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"
}
'
{
  "documentId": 456,
  "noteId": 123,
  "document": {
    "id": 456,
    "noteGuid": "note-abc123-def456",
    "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"
  },
  "createdAt": "2025-10-20T12:35:26Z"
}

Authorizations

​
Authorization
string
header
required

API key in format {id}.{secret}

Path Parameters

​
noteGuid
string
required

Note GUID

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

​
documentId
integer<int64>
required

Generated document ID

Example:

456

​
noteId
integer<int64>
required

Note ID

Example:

123

​
document
object
required

Complete note document with all sections

​
createdAt
string<date-time>
required

Document creation timestamp

Example:

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