0

Get a site preview URL

by
Published Oct 17, 2025

Generate a URL to preview the published content of a site. The URL will be valid for 1 hour.

Script gitbook Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Gitbook = {
3
  token: string;
4
};
5
/**
6
 * Get a site preview URL
7
 * Generate a URL to preview the published content of a site. The URL will be valid for 1 hour.
8
 */
9
export async function main(
10
  auth: Gitbook,
11
  organizationId: string,
12
  siteId: string,
13
  siteSpace: string | undefined,
14
  claims: string | undefined,
15
) {
16
  const url = new URL(
17
    `https://api.gitbook.com/v1/orgs/${organizationId}/sites/${siteId}/publishing/preview`,
18
  );
19
  for (const [k, v] of [
20
    ["siteSpace", siteSpace],
21
    ["claims", claims],
22
  ]) {
23
    if (v !== undefined && v !== "" && k !== undefined) {
24
      url.searchParams.append(k, v);
25
    }
26
  }
27
  const response = await fetch(url, {
28
    method: "GET",
29
    headers: {
30
      Authorization: "Bearer " + auth.token,
31
    },
32
    body: undefined,
33
  });
34
  if (!response.ok) {
35
    const text = await response.text();
36
    throw new Error(`${response.status} ${text}`);
37
  }
38
  return await response.json();
39
}
40