Skip to content
calternal docs

Read cached metadata for a standalone Note link

GET
/api/v1/notes/link-previews
curl --request GET \
  --url 'https://example.com/api/v1/notes/link-previews?url=example' \
  --header 'Authorization: Bearer <token>'

Route: /api/v1/notes/link-previews. Inputs: url. Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
url
required
string

Public HTTP(S) URL; private networks are rejected during every fetch and redirect.

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Describe a pending, ready, disabled, or silently unavailable preview (#1151).

object
preview
One of:

Cache fields contain only a public URL and bounded head metadata (#1151).

object
description
string | null
favicon_url
string | null
image_url
string | null
site_name
string | null
title
string | null
stale
required
boolean
state
required
string
Examplegenerated
{
  "preview": {
    "description": "example",
    "favicon_url": "example",
    "image_url": "example",
    "site_name": "example",
    "title": "example"
  },
  "stale": true,
  "state": "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"
  }
}

401

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