Export project
POST
/v1/projects/{id}/export
Generate a downloadable file from a book's translated pages, in Markdown, DOCX, EPUB, or PDF. Omit the format and it falls back to your saved default (Markdown if you've never set one). For a PDF, set matchSourcePages to lay out one output sheet per source page instead of flowing text freely.
Authorizations
Bearer
JWT bearer token from POST /v1/auth/login.
Type
HTTP (bearer)
or
ApiKey
Scoped API key for non-interactive clients (issued by PBI #1426).
Type
API Key (header: X-Api-Key)
Parameters
Path Parameters
id*
Type
Requiredstring
Format
"uuid"Request Body
application/json
One of
Request body for export, choosing the output format and (optionally) the PDF page-for-page layout.
MatchSourcePages (#1928) is off when omitted; only the PDF export honours it.
The output format to generate.
Valid values
"All""Markdown""PlainText""Html""Epub""Docx""Pdf""Archive"PDF only — lay out one output sheet per source page instead of flowing text freely; omit or false for the default packed layout.
Responses
OK
application/json
The result of an export operation.
Which format was produced.
Valid values
"All""Markdown""PlainText""Html""Epub""Docx""Pdf""Archive"Optional human-readable note (e.g. why an export was skipped).
Absolute paths to the file(s) written.
Whether the export completed.