Sign in
PDF Export

Generate an SEO audit PDF report

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.

post/v3/pdf

Request body

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' | 'geo' | 'combined'

Which PDF document to render: website-audit page or overview, or PageSpeed page or overview.

dataobject required

Payload — shape depends on type. Must include pageUrl (use the base URL for overview variants).

emailstring email

Recipient address. Required when action is email.

teamIdstring

Team that owns the audit. Membership is enforced by checkMembership.

whiteLabelboolean

Apply the org's white-label brand mark (when enabled and plan-gated). Pass false to force the SnowSEO mark for this export.

Changes

Changed in 3 of the 47 revisions of this API.14

  • e0163b1c37cb11See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    • ○

      endpoint added

      endpoint-added

  • c44f51a92d952See the full diff
    • ○

      added the new combined enum value to the request property

      request-property-enum-value-added

    • ○

      added the new geo enum value to the request property

      request-property-enum-value-added

  • c6b2fabd21be1See the full diff
    • ○

      endpoint added

      endpoint-added