Link-preview image of an open share

GET

/api/share/{token}/og-image

const url = 'http://localhost:8080/api/share/example/og-image';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/share/example/og-image

The app’s own raster thumbnail (thumbnail.png/.jpg/.webp), as a JPEG at most 1200 px wide and ~300 KB (so WhatsApp shows the large card), for Open Graph crawlers. Only for a share anyone can open (enabled, no password); otherwise — or when the app has no raster thumbnail — 404, and the share page points crawlers at the generic /og-default.png instead. Cached publicly by blob oid.

Parameters

Path Parameters

token

required

string

Responses

2XX

Successful response

application/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}