Skip to content
calternal docs

Save a bookmark or clip as a Note

POST
/api/v1/notes/bookmarks
curl --request POST \
  --url https://example.com/api/v1/notes/bookmarks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "favicon": "example", "highlights": [ "example" ], "kind": "bookmark", "selected_text": "example", "tags": [ "example" ], "title": "example", "url": "example" }'

Requires a signed-in User with the data scope. It saves the URL as a Bookmark Note or fetches a page clip. It returns 400 for invalid input, 413 when the page is too large, or 429 when capture is busy. Route: /api/v1/notes/bookmarks. 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
description

Page description supplied by the capturing client.

string | null
favicon

Favicon address supplied by the capturing client.

string | null
highlights

Selected passages to add as blockquotes.

Array<string>
kind

Capture a link as a bookmark or fetch and extract it as a clip.

string
Allowed values: bookmark clip
selected_text

The selected text at capture time.

string | null
tags

Tags to add to the Note frontmatter.

Array<string>
title

Page title. The server uses the extracted title or site when omitted.

string | null
url
required

Absolute HTTP or HTTPS address to save.

string

Responses

Section titled “Responses”

201

Section titled “201”

Saved bookmark or clip Note

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"
}

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"
  }
}

403

Section titled “403”
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"
  }
}

413

Section titled “413”
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"
  }
}

422

Section titled “422”
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"
  }
}

429

Section titled “429”
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"
  }
}