Weav

Get draft article preview link

POST https://api.weav.com/v1/kb-articles/{id}/preview-link

Requires a token with the external-api:write ability.

Path parameters

idstringrequired

Format: uuid.

Request

cURL
curl --request POST \
  --url 'https://api.weav.com/v1/kb-articles/{id}/preview-link' \
  --header "Authorization: Bearer ${WEAV_API_TOKEN}"
JavaScript
const response = await fetch("https://api.weav.com/v1/kb-articles/{id}/preview-link", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.WEAV_API_TOKEN}`
  }
});
console.log(await response.json());
Python
import os
import requests

headers = {"Authorization": f"Bearer {os.environ['WEAV_API_TOKEN']}"}
response = requests.post("https://api.weav.com/v1/kb-articles/{id}/preview-link", headers=headers)
print(response.json())
PHP
use GuzzleHttp\Client;

$client = new Client();
$response = $client->request('POST', 'https://api.weav.com/v1/kb-articles/{id}/preview-link', [
    'headers' => ['Authorization' => 'Bearer '.getenv('WEAV_API_TOKEN')],
]);
echo $response->getBody();

Response

200 OK
{
    "preview_url": "https://example.com"
}
  • 404 Not Found
  • 409 Conflict
  • 401 Unauthorized

Response fields

preview_urlstring

Format: uri.