Write a note
Write a note in a vault's Knowledge.
Every field is optional. A note without a title is called “Untitled note”. Without a folder it goes to the first folder of the vault, and a vault without any folder gets one called “General” to hold it.
The change is written to the account log.
Parameters
Sent as JSON. Anything not listed here is ignored.
The vault, named either by the readable name it reports as slug or by its id. A vault of another account answers 404.
The title of the note, up to 255 characters. Markup is stripped.
The text of the note in Markdown, up to 200,000 characters: # for a heading, - for a bullet, - [ ] for a task, > for a quote, **bold**. Web addresses become links on their own.
The id of a folder of the vault, as the knowledge folders endpoints give it. A folder of another vault answers 404.
Returns
The knowledge note object that was written.
The knowledge note.
Always knowledge_note. It names the kind of record, so a caller holding several kinds can tell them apart without looking at where they came from.
The id of this record, as a string even when it reads as a number. It is what every endpoint naming this record takes.
Everything the record holds.
The title of the note.
The folder the note sits in.
The id of the folder, as the knowledge folders endpoints give it.
What the folder is called.
When the note was written, as a count of seconds since 1970.
When it last changed, as a count of seconds, or null.
The text of the note in Markdown, exactly as written, or null. It is never drawn: raw HTML in it stays text, and the application escapes it when it shows the note.
The headings of the text, from the first level to the third, in reading order.
One heading.
What the heading says.
Its level, 1 to 3.
The anchor the application gives it, to open the note at that heading with links.web followed by # and the anchor.
Where to find this record.
The absolute address this record is read from.
The note in the application, which opens for somebody signed in rather than for a key. It is the link to give a person.
Rate limit
Sixty requests per minute, per user, shared by every key and device. Every answer carries the budget left in X-RateLimit-Remaining.
Keys act as you, with exactly the access you have. Make one per integration so you can revoke it alone.