Read public website metadata for a conversation link preview

Verified workspace members only. Checks public DNS and each redirect, limits HTML to 512 KiB and six seconds, and never executes scripts or forwards credentials. Returns null when the site cannot be previewed.

POST

https://api.channelautomation.com/api/link-preview

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Request body JSON required

url
string
required
maxLength: 4096

Returns

200

Public page metadata or null when unavailable

JSON

preview
optional
object
or null
- title
  optional
  string
- description
  optional
  string
- image
  optional
  string
  or null
}

400

Invalid or private URL

401

Verified session required

403

Workspace membership required

429

Preview request limit reached

503

Authentication or membership lookup unavailable

Read public website metadata for a conversation link preview

curl --request POST \
  --url https://api.channelautomation.com/api/link-preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "string"
}
'

const url = 'https://api.channelautomation.com/api/link-preview';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({url: 'string'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/link-preview"

payload = { "url": "string" }
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "preview": {
    "title": "string",
    "description": "string",
    "image": "string"
  }
}