Skip to content
calternal docs

Create a Note from a template

POST
/api/v1/notes/from-template
curl --request POST \
  --url https://example.com/api/v1/notes/from-template \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "folder": "example", "template_id": "example", "title": "example" }'

Requires a signed-in User with the data scope. It creates a regular Note from a template. It returns 400 for invalid input, 404 when the template is missing, or 409 when the Note cannot be created. Route: /api/v1/notes/from-template. 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
folder

New Notes use the flat Notes/ root, so only that value is accepted.

string | null
template_id
string | null
title
required
string
Examplegenerated
{
  "folder": "example",
  "template_id": "example",
  "title": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”
Media typeapplication/json
object
cursor_offset
integer | null
note
required
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
{
  "cursor_offset": 1,
  "note": {
    "body": "example",
    "canvas": "example",
    "etag": "example",
    "id": "example",
    "path": "example",
    "properties": "example",
    "title": "example"
  }
}

400

Section titled “400”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

404

Section titled “404”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

409

Section titled “409”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}