Skip to content
calternal docs

Read a Wikilink preview page

GET
/api/v1/notes/wikilinks/{id}
curl --request GET \
  --url https://example.com/api/v1/notes/wikilinks/example \
  --header 'Authorization: Bearer <token>'

Requires the User who created the preview. It returns 404 when the preview is missing or has expired. Route: /api/v1/notes/wikilinks/{id}. Inputs: id, cursor, limit. Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Conversion operation ID

Query Parameters

Section titled “Query Parameters”
cursor
string

Opaque page cursor returned by the previous response.

limit
integer format: int64

Number of Note previews. The server caps this at 20.

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
}

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