Get a temporary URL to download a change request's content as PDF

Generates a temporary URL (valid for 1 hour) to download the change request's draft content as a PDF. Optionally scope the export to a single page using the page and only parameters. Use this to share or archive the draft content before merging.

Available in MCP

get

Authorizations

useroauth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

changeRequestIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

Query parameters

onlybooleanOptional

Generate a PDF only for the provided page.

pagestringOptional

ID of a specific page to generate a PDF for.

Responses

200

URL of the PDF

application/json

urlstring · uri · max: 2048Required

Temporary URL to print the content. The URL will work for 1h.

get/spaces/{spaceId}/change-requests/{changeRequestId}/pdf

HTTPcURLJavaScriptPython

GET /v1/spaces/{spaceId}/change-requests/{changeRequestId}/pdf HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

URL of the PDF

{
  "url": "https://example.com"
}