Create a Note
POST
/api/v1/notes
const url = 'https://example.com/api/v1/notes';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"body":"example","canvas":true,"folder":"example","tags":["example"],"title":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/notes \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "body": "example", "canvas": true, "folder": "example", "tags": [ "example" ], "title": "example" }'Requires a signed-in User with the data scope. It creates a Note in the Home. It returns 400 when the title or content is invalid. Route: /api/v1/notes. Inputs: . Do not automatically replay this operation after an uncertain result.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
body
string | null
canvas
Canvas creation reuses the Note writer; later edits use collaboration only (§60).
boolean
folder
New Notes use the flat Notes/ root, so only that value is accepted.
string | null
tags
Array<string> | null
title
required
string
Examplegenerated
{ "body": "example", "canvas": true, "folder": "example", "tags": [ "example" ], "title": "example"}Responses
Section titled “Responses”Media typeapplication/json
object
body
required
string
canvas
Validated render data for Canvas; an invalid imported file has no scene.
etag
required
string
id
required
string
path
required
string
properties
required
title
required
string
Examplegenerated
{ "body": "example", "canvas": "example", "etag": "example", "id": "example", "path": "example", "properties": "example", "title": "example"}