RNote API
A REST API for reading and writing your notepads from scripts and integrations.
Authentication
Every request is authenticated with a personal access token, sent as a bearer token. Generate one from Account → API Tokens while logged in. The plaintext token is shown once, so so store it somewhere safe.
Authorization: Bearer <your-token>
Tokens are scoped to two abilities: notepads:read and notepads:write. Every token created from your account gets both. The API only ever reads or writes notepads the token's owning user actually owns, not notepads shared with them by someone else.
Base URL
https://rnote.org/api/v1
Rate limits
Requests are limited to 60 per minute per token. If you go over, you'll get a 429 Too Many Requests response.
Endpoints
List your notepads. Add ?folder=<uid> to list one folder.
Requires ability: notepads:read
Example request
curl https://rnote.org/api/v1/notepads \
-H "Authorization: Bearer <your-token>"
Example response
{
"status": "success",
"notepads": [
{
"uid": "8f2c1a3e-...",
"title": "Groceries",
"type": 1,
"color": "#0d42dd",
"folder_uid": "Qm3kz8Wd2LpXa1Rt",
"updated_at": "2026-07-29T09:12:03+00:00"
}
]
}
Fetch a single notepad, including its content.
Requires ability: notepads:read
Example request
curl https://rnote.org/api/v1/notepads/8f2c1a3e-... \
-H "Authorization: Bearer <your-token>"
Example response
{
"status": "success",
"uid": "8f2c1a3e-...",
"title": "Groceries",
"content": "- Milk\n- Eggs\n- Bread",
"type": 1,
"markdown_view": 1,
"color": "#0d42dd",
"archived": false,
"order": 1,
"folder_uid": "Qm3kz8Wd2LpXa1Rt",
"updated_at": "2026-07-29T09:12:03+00:00"
}
Not found
// 404
{
"status": "error",
"message": "Notepad not found"
}
Create a new notepad.
Requires ability: notepads:write
Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
title | string, max 255 | No | Defaults to a generated name like "New 3". |
type | integer | No | 1 = plain text, 2 = Markdown, 3 = rich text (HTML), 4 = sketch. Defaults to 1. |
content | string | No | Defaults to empty. For type 3, this is HTML and is sanitized on save (a safe subset of formatting tags, tables and images uploaded to your account is kept; scripts, styles, external images and event handlers are stripped). For type 4, a sketch document (see below); defaults to a blank sketch. |
Example request
curl https://rnote.org/api/v1/notepads \
-X POST \
-H "Authorization: Bearer <your-token>" \
-H "Content-Type: application/json" \
-d '{"title": "Trip planning", "type": 2, "content": "# Trip\n\n- [ ] Book flights"}'
Example response
// 201
{
"status": "success",
"uid": "3b91d0c4-...",
"title": "Trip planning",
"type": 2,
"color": "#0d42dd"
}
Replace or append to a notepad's content.
Requires ability: notepads:write
Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
content | string | Yes | New content, or text to append. For rich-text (type 3) notepads this is HTML and is sanitized on save. For sketches (type 4) it is the complete sketch document, which replaces the drawing. |
append | boolean | No | When true, adds to the end of the existing content instead of replacing it. Defaults to false. Not allowed for sketches. |
Example request
curl https://rnote.org/api/v1/notepads/3b91d0c4-.../content \
-X PATCH \
-H "Authorization: Bearer <your-token>" \
-H "Content-Type: application/json" \
-d '{"content": "\n- [ ] Pack sunscreen", "append": true}'
Example response
{
"status": "success",
"uid": "3b91d0c4-...",
"content": "# Trip\n\n- [ ] Book flights\n- [ ] Pack sunscreen",
"updated_at": "2026-07-29T09:14:51+00:00"
}
Move a notepad into another of your folders.
Requires ability: notepads:write
Example request
curl https://rnote.org/api/v1/notepads/3b91d0c4-.../folder \
-X PATCH \
-H "Authorization: Bearer <your-token>" \
-H "Content-Type: application/json" \
-d '{"folder_uid": "Qm3kz8Wd2LpXa1Rt"}'
Folders
Every notepad sits in exactly one folder, and every account has at least one. Folders use the same abilities as notepads: notepads:read to list them, notepads:write to change them. Creating a notepad without a folder_uid puts it in your first folder.
List your folders in the order they appear in the app, with how many active notepads each holds.
Requires ability: notepads:read
Example response
{
"status": "success",
"folders": [
{ "uid": "Qm3kz8Wd2LpXa1Rt", "name": "Main", "order": 0, "notepad_count": 4 },
{ "uid": "Zr7yQe1Vb5NcTt0u", "name": "Work", "order": 1, "notepad_count": 2 }
]
}
Create a folder at the end of the list. Names are up to 60 characters and must be unique for you, ignoring case.
Requires ability: notepads:write
Example request
curl https://rnote.org/api/v1/folders \
-X POST \
-H "Authorization: Bearer <your-token>" \
-H "Content-Type: application/json" \
-d '{"name": "Work"}'
Rename a folder with name, or move it to a zero-based position with order.
Requires ability: notepads:write
Delete a folder. Its notepads, archived ones included, move to move_to first, so nothing is lost. Your last folder can't be deleted.
Requires ability: notepads:write
Errors
// 422
{
"status": "error",
"code": "last_folder",
"message": "You need at least one folder."
}
Sketch documents
A sketch (type 4) holds a JSON drawing on a page 1000 units wide that grows downward. Documents are validated and rewritten on save; invalid ones are rejected with 422 and "code": "invalid_sketch". The limit is 5 MB.
{
"v": 1,
"bg": "blank",
"elements": [
{"id": "a1", "k": "stroke", "t": "pen", "c": "ink", "s": 4,
"p": [[100, 100, 0.5], [200, 140, 0.5], [300, 100, 0.5]]},
{"id": "a2", "k": "text", "x": 100, "y": 200, "w": 320, "s": 32,
"c": "#e5383b", "text": "Hello"}
]
}
| Field | Notes |
|---|---|
bg | blank, lined or grid. |
stroke t | pen or highlighter. c is ink (follows light and dark mode) or #rrggbb. s is the width, 0.5 to 64. Optional sh is line, rect or ellipse. |
stroke p | Points as [x, y, pressure], pressure 0 to 1 (optional, default 0.5). Up to 5000 points per stroke. |
| text | x, y is the top left, w the wrap width (20 to 1000), s the font size (8 to 200), text plain text up to 2000 characters. |
id | Unique per element, letters, digits, _ and -, up to 32 characters. |
Errors
Errors always have a JSON body with "status": "error".
| Status | Meaning |
|---|---|
401 | Missing or invalid token. |
403 | Token doesn't have the required ability. |
404 | Notepad not found, or not owned by the token's user. |
422 | Validation failed - the response includes an errors object. |
429 | Rate limit exceeded. |
Ready to connect something?
Create your account, generate a token, and start reading and writing notepads.