---
title: "Generate a website audit PDF report"
method: POST
path: "/v3/website-audit/pdf/"
tags: ["Website Audit"]
---

# Generate a website audit PDF report

`POST /v3/website-audit/pdf/`

Generates a PDF for a page or overview audit and either downloads it, uploads it to R2 (share link), or emails it as an attachment.

## Request body

- object
  - `action` 'download' | 'share' | 'email', required — What to do with the generated PDF: stream as download, upload to R2 and return a share URL, or email it to `email`.
  - `type` 'page' | 'overview' | 'page-speed-page' | 'page-speed-overview' — Which PDF document to render: website-audit page or overview, or PageSpeed page or overview.
  - `data` object, required — Payload — shape depends on `type`. Must include `pageUrl` (use the base URL for overview variants).
  - `email` string, email — Recipient address. Required when `action` is `email`.
  - `teamId` string — Team that owns the audit. Membership is enforced by checkMembership.
  - `whiteLabel` boolean — Apply the org's white-label brand mark (when enabled and plan-gated). Pass false to force the SnowSEO mark for this export.

## Other responses

- `400` — Default Response
- `401` — Default Response
- `403` — Default Response
- `404` — Default Response
- `500` — Default Response

---

[API](https://skmtc.net/snowseo/apis/snowseo-api.md) · [All operations](https://skmtc.net/snowseo/apis/snowseo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/snowseo/snowseo-api/versions/6e50f4761eea/schema)