Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

projectId
string<uuid>
required

Project UUID

Body

application/json
sheetIds
string<uuid>[]

Sheet UUIDs to include in the export. Defaults to all sheets in the project.

printMode
enum<string>
default:summary

Level of detail in the PDF. supersummary = one-line per sheet, summary = standard output, details = full working.

Available options:
supersummary,
summary,
details
paperSize
enum<string>
default:Letter
Available options:
A4,
Letter
locale
string
default:en-US

BCP-47 locale used for number and unit formatting (e.g. en-US, en-AU, en-GB).

includeToc
boolean
default:false

Include a table-of-contents page at the start of the PDF.

Response

Export job accepted. Poll GET /v1/exports/{exportId} until state === "completed".

Async PDF export status. exportUrl is null while the export is processing or failed, and is populated with a presigned download URL only once state === "completed"; that URL then expires 10 minutes after each poll.

exportId
string<uuid>
required
state
enum<string>
required
Available options:
processing,
completed,
failed
progressPercent
number
required
Required range: 0 <= x <= 100
exportUrl
string<uri> | null
required

Presigned S3 URL, or null while the export is still processing or has failed. Populated only once state === "completed", after which it expires 10 minutes after this response.