Skip to content
calternal docs

Preview Wikilink changes

POST
/api/v1/notes/wikilinks/preview
curl --request POST \
  --url https://example.com/api/v1/notes/wikilinks/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "convert_unresolved": true, "note_ids": [ "example" ] }'

Requires a signed-in User with the data scope. It checks selected Notes and stores a temporary preview. It returns 400 for an invalid selection or 413 when the preview is too large. Route: /api/v1/notes/wikilinks/preview. 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
convert_unresolved

Create Markdown links for unresolved references only when explicitly enabled.

boolean
note_ids

Omit to convert every indexed Note. Provide stable Note IDs for a selection.

Array<string> | null
Examplegenerated
{
  "convert_unresolved": true,
  "note_ids": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
change_count
required
integer format: int64
changed_notes
required
integer format: int64
examined_notes
required
integer format: int64
id
required
string
items
required
Array<object>
object
changes
required
Array<object>
object
after
required
string
before
required
string
line
required
integer
id
required
string
path
required
string
unresolved
required
Array<object>
object
ambiguous
required
boolean
line
required
integer
source
required
string
next_cursor
string | null
state
required
string
unresolved_count
required
integer format: int64
Examplegenerated
{
  "change_count": 1,
  "changed_notes": 1,
  "examined_notes": 1,
  "id": "example",
  "items": [
    {
      "changes": [
        {
          "after": "example",
          "before": "example",
          "line": 1
        }
      ],
      "id": "example",
      "path": "example",
      "unresolved": [
        {
          "ambiguous": true,
          "line": 1,
          "source": "example"
        }
      ]
    }
  ],
  "next_cursor": "example",
  "state": "example",
  "unresolved_count": 1
}

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

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